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