Deactivate a user
PATCH {{baseUrl}}/scim2/Users/:userId
Use this API to activate or deactivate a user.
OAuth Scope: scim2
Rate Limit Label: Light
Request Body
{"schemas"=>["<string>", "<string>"], "Operations"=>[{"op"=>"replace", "value"=>{"active"=>"<boolean>"}}, {"op"=>"replace", "value"=>{"active"=>"<boolean>"}}]}
HEADERS
| Key | Datatype | Required | Description |
|---|---|---|---|
Content-Type | string | ||
Accept | string |
RESPONSES
status: OK
{"id":"\u003cstring\u003e","meta":{"resourceType":"\u003cstring\u003e","location":"\u003cstring\u003e","version":"\u003cstring\u003e"},"schemas":["\u003cstring\u003e","\u003cstring\u003e"],"name":{"givenName":"\u003cstring\u003e","familyName":"\u003cstring\u003e"},"emails":[{"type":"\u003cstring\u003e","value":"\u003cemail\u003e","primary":"\u003cboolean\u003e"},{"type":"\u003cstring\u003e","value":"\u003cemail\u003e","primary":"\u003cboolean\u003e"}],"displayName":"\u003cstring\u003e","userName":"\u003cemail\u003e","active":"\u003cboolean\u003e","userType":"Basic","title":"\u003cstring\u003e","locale":"\u003cstring\u003e","phoneNumbers":[{"type":"home","value":"\u003cstring\u003e"},{"type":"work","value":"\u003cstring\u003e"}],"roles":[{"display":"\u003cstring\u003e","value":"\u003cstring\u003e","primary":"\u003cboolean\u003e"},{"display":"\u003cstring\u003e","value":"\u003cstring\u003e","primary":"\u003cboolean\u003e"}],"groups":[{"display":"\u003cstring\u003e","type":"\u003cstring\u003e","primary":"\u003cstring\u003e"},{"display":"\u003cstring\u003e","type":"\u003cstring\u003e","primary":"\u003cstring\u003e"}],"urn:ietf:params:scim:schemas:extension:enterprise:2.0:User":{"{customAttribute}":"\u003cstring\u003e","department":"\u003cstring\u003e","organization":"\u003cstring\u003e"},"urn:ietf:params:scim:schemas:extension:zoom:1.0:User":{"{customAttribute}":"\u003cstring\u003e","personalLinkName":"\u003cstring\u003e","pronouns":"\u003cstring\u003e","zoomUnited":"\u003cstring\u003e","zoomOneBizPlus":"\u003cstring\u003e","zoomIQ":"\u003cboolean\u003e","zoomCustomerManagedKey":"\u003cboolean\u003e","zoomWhiteboard":"\u003cboolean\u003e","zoomWhiteboardPlus":"\u003cboolean\u003e","zoomTranslatedCaptions":"\u003cboolean\u003e","zoomHuddles":"\u003cboolean\u003e"}}