{"openapi":"3.0.0","info":{"title":"SCIM2","description":"SCIM2 (System for Cross-domain Identity Management) is a specification designed to automate the provisioning of user and group identities across various cloud-based applications and services using SSO services and Identity Providers. The Zoom SCIM2 API provides support for user and group provisioning through the **User** and **Group** resources.\n\n SCIM uses HTTP methods compatible with the REST architecture style. The payloads require schema definitions, attributes, and values for requests. With the SCIM API, you can use additional features such as attribute filters and search criteria. \n\n While using the SCIM APIs, set the value of the Accept header as `application/scim+json`. \n\n **Prerequisites** \n* Zoom Owner or Admin privileges. \n* Business or Education account with approved [Vanity URL](https://support.zoom.us/hc/en-us/articles/215062646-Guidelines-for-Vanity-URL-Requests). \n* [Single Sign-On](https://support.zoom.us/hc/en-us/articles/201363003-Getting-Started-with-SSO) enabled. \n\n ## Authentication \n\n The SCIM2 API supports OAuth authentication. To use Oauth 2.0, create an [OAuth app](https://developers.zoom.us/docs/integrations/create/) or a [server-to-server OAuth app](https://developers.zoom.us/docs/internal-apps/create/) on the Zoom App Marketplace and select `SCIM2` as the scope for your app. Next, [generate an OAuth token](https://developers.zoom.us/docs/integrations/oauth/) for your app and start making SCIM2 API calls.","termsOfService":"https://zoom.us/docs/en-us/zoom_api_license_and_tou.html","contact":{"name":"Zoom Developers","url":"https://developer.zoom.us"},"version":"1.0"},"externalDocs":{"description":"Find out more about Swagger","url":"https://swagger.io"},"servers":[{"url":"https://api.zoom.us"}],"paths":{"/scim2/Groups":{"get":{"tags":["Group"],"summary":"List groups","description":"List all groups. Use additional query parameters to filter specific groups.\n\n**[Scopes](https://developers.zoom.us/docs/integrations/oauth-scopes-overview/):** `scim2`\n\n**[Granular Scopes](https://developers.zoom.us/docs/integrations/oauth-scopes-overview/):** `scim2:admin`\n\n**[Rate Limit Label](https://marketplace.zoom.us/docs/api-reference/rate-limits#rate-limits):** `MEDIUM`","operationId":"groupSCIM2List","parameters":[{"name":"startIndex","in":"query","description":"The start index of the records to be returned.","required":false,"schema":{"type":"integer","example":1,"default":1}},{"name":"count","in":"query","description":"The number of records returned in a single API call.","required":false,"schema":{"maximum":100,"minimum":0,"type":"integer","example":1,"default":1}},{"name":"filter","in":"query","description":"The type of query: \n* `displayName eq {groupName}` — Provide the group's name to filter the response to a specific group.","required":false,"schema":{"type":"string","example":"displayName eq G1"}}],"responses":{"200":{"description":"**HTTP Status Code:** `200` <br>\nGroup information returned.","content":{"application/json":{"schema":{"type":"object","properties":{"schemas":{"type":"array","description":"A list of schemas.","example":["urn:ietf:params:scim:api:messages:2.0:ListResponse"],"items":{"type":"string","example":"urn:ietf:params:scim:api:messages:2.0:ListResponse"}},"totalResults":{"type":"integer","description":"The total number of all records across pages.","example":20},"startIndex":{"type":"integer","description":"The start index for the records.","example":1},"itemsPerPage":{"type":"integer","description":"The number of records returned with a single API call.","example":10},"Resources":{"type":"array","description":"The group resource's information.","items":{"type":"object","properties":{"id":{"type":"string","description":"The group's ID.","example":"kuWhUCrrT4q9Xy17rSR8js"},"meta":{"type":"object","properties":{"resourceType":{"type":"string","description":"The resource type. The value is always `Group` for the Group resource type.","example":"Group"},"version":{"type":"string","description":"The resource's version number.","example":"1.0.0"},"location":{"type":"string","description":"The resource's URI in the `https://api.zoom.us/scim2/Groups/{groupId}` format.","example":"https://api.zoom.us/scim2/Groups/k&KdKr6TLWuxdDtk0hjSzL"},"created":{"type":"string","description":"The group's creation time.","example":"2023-11-24T05:13:15Z"},"lastModified":{"type":"string","description":"The group's last modification time.","example":"2023-11-27T11:36:20Z"}},"description":"The group resource's metadata."},"schemas":{"type":"array","description":"A list of schemas.","example":["urn:ietf:params:scim:schemas:core:2.0:Group","urn:ietf:params:scim:schemas:extension:zoom:2.0:Group"],"items":{"type":"string","example":"urn:ietf:params:scim:schemas:core:2.0:Group"}},"displayName":{"type":"string","description":"A human-readable name for the group.","example":"SCIM group"},"urn:ietf:params:scim:schemas:extension:zoom:2.0:Group":{"type":"object","properties":{"emailAlias":{"type":"string","description":"The group's email address (optional).","example":"test@example.com"}}}}}}}}}}},"400":{"description":"**HTTP Status Code:** `400` <br>\n Bad Request  \n\n **Error Code:** `400` <br>\n The current filter does not support the filter name: {filter} <br>\n"},"403":{"description":"**HTTP Status Code:** `403` <br>\n Forbidden  \n\n **Error Code:** `403` <br>\n The request was denied due to insufficient permissions: \"Group:Read\". <br>\n"},"429":{"description":"**HTTP Status Code:** `429` <br>\n Too Many Requests. For more information, see [rate limits](https://developers.zoom.us/docs/api/rest/rate-limits/). \n\n "}},"security":[{"openapi_oauth":["scim2","scim2:admin"],"openapi_authorization":[]}],"x-extensions":{"x-permissions":["Group:Read"],"x-macro-scopes":["scim2"],"x-granular-scopes":["scim2:admin"]}},"post":{"tags":["Group"],"summary":"Create a group","description":"Create a new group.\n\n**[Scopes](https://developers.zoom.us/docs/integrations/oauth-scopes-overview/):** `scim2`\n\n**[Granular Scopes](https://developers.zoom.us/docs/integrations/oauth-scopes-overview/):** `scim2:admin`\n\n**[Rate Limit Label](https://marketplace.zoom.us/docs/api-reference/rate-limits#rate-limits):** `MEDIUM`","operationId":"groupScim2Create","requestBody":{"content":{"application/json":{"schema":{"type":"object","properties":{"schemas":{"type":"array","description":"A list of schemas.","example":["urn:ietf:params:scim:schemas:core:2.0:Group"],"items":{"type":"string","example":"urn:ietf:params:scim:schemas:core:2.0:Group"}},"displayName":{"type":"string","description":"A human-readable name for the group.","example":"SCIM group"},"urn:ietf:params:scim:schemas:extension:zoom:2.0:Group":{"type":"object","properties":{"emailAlias":{"type":"string","description":"The group's email address (optional).","example":"test@example.com"}}}}}}}},"responses":{"201":{"description":"**HTTP Status Code:** `201` <br>\nGroup created.","content":{"application/json":{"schema":{"type":"object","properties":{"id":{"type":"string","description":"The group's ID.","example":"kuWhUCrrT4q9Xy17rSR8js"},"meta":{"type":"object","properties":{"resourceType":{"type":"string","description":"The resource type. The value is always `Group` for the group resource type.","example":"Group"},"version":{"type":"string","description":"The resource's version number.","example":"1.0.0"},"location":{"type":"string","description":"The resource's URI in `https://api.zoom.us/scim2/Groups/{groupId}` format.","example":"https://api.zoom.us/scim2/Groups/k&KdKr6TLWuxdDtk0hjSzL"},"created":{"type":"string","description":"The group's creation time.","example":"2023-11-24T05:13:15Z"},"lastModified":{"type":"string","description":"The group's last modification time.","example":"2023-11-24T05:13:15Z"}},"description":"The group resource's metadata."},"schemas":{"type":"array","description":"A list of schemas.","example":["urn:ietf:params:scim:schemas:core:2.0:Group","urn:ietf:params:scim:schemas:extension:zoom:2.0:Group"],"items":{"type":"string","example":"urn:ietf:params:scim:schemas:core:2.0:Group"}},"displayName":{"type":"string","description":"A human-readable name for the group.","example":"SCIM Group"},"urn:ietf:params:scim:schemas:extension:zoom:2.0:Group":{"type":"object","properties":{"emailAlias":{"type":"string","description":"The group's email address (optional).","example":"test@example.com"}}}}}}}},"400":{"description":"**HTTP Status Code:** `400` <br>\n Bad Request  \n\n **Error Code:** `400` <br>\n The request body must be in JSON format. <br>\n**Error Code:** `400` <br>\n The request JSON must not be empty. <br>\n**Error Code:** `400` <br>\n The \"DisplayName\" of the request is invalid. <br>\n**Error Code:** `400` <br>\n Create group failed. <br>\n"},"403":{"description":"**HTTP Status Code:** `403` <br>\n Forbidden  \n\n **Error Code:** `403` <br>\n The request was denied due to insufficient permissions: \"Group:Edit\". <br>\n"},"409":{"description":"**HTTP Status Code:** `409` <br>\n Conflict  \n\n **Error Code:** `409` <br>\n Group {groupName} exists. <br>\n"},"429":{"description":"**HTTP Status Code:** `429` <br>\n Too Many Requests. For more information, see [rate limits](https://developers.zoom.us/docs/api/rest/rate-limits/). \n\n "}},"security":[{"openapi_oauth":["scim2","scim2:admin"],"openapi_authorization":[]}],"x-extensions":{"x-permissions":["Group:Edit"],"x-macro-scopes":["scim2"],"x-granular-scopes":["scim2:admin"]}}},"/scim2/Groups/{groupId}":{"get":{"tags":["Group"],"summary":"Get a group","description":"Get the specific group's information.\n\n**[Scopes](https://developers.zoom.us/docs/integrations/oauth-scopes-overview/):** `scim2`\n\n**[Granular Scopes](https://developers.zoom.us/docs/integrations/oauth-scopes-overview/):** `scim2:admin`\n\n**[Rate Limit Label](https://marketplace.zoom.us/docs/api-reference/rate-limits#rate-limits):** `LIGHT`","operationId":"groupSCIM2Get","parameters":[{"name":"groupId","in":"path","description":"The group's ID.","required":true,"schema":{"type":"string","example":"kuWhUCrrT4q9Xy17rSR8js"}}],"responses":{"200":{"description":"**HTTP Status Code:** `200` <br>\n Group object returned.","content":{"application/json":{"schema":{"type":"object","properties":{"id":{"type":"string","description":"The group's ID.","example":"kuWhUCrrT4q9Xy17rSR8js"},"meta":{"type":"object","properties":{"resourceType":{"type":"string","description":"The resource type. The value is always `Group` for the Group resource type.","example":"Group"},"version":{"type":"string","description":"The resource's version number.","example":"1.0.0"},"location":{"type":"string","description":"The resource's URI in `https://api.zoom.us/scim2/Groups/{groupId}` format.","example":"https://api.zoom.us/scim2/Groups/k&KdKr6TLWuxdDtk0hjSzL"},"created":{"type":"string","description":"The group's creation time.","example":"2023-11-24T05:13:15Z"},"lastModified":{"type":"string","description":"The group's last modification time.","example":"2023-11-27T11:36:20Z"}},"description":"The group resource's metadata."},"schemas":{"type":"array","description":"A list of schemas.","example":["urn:ietf:params:scim:schemas:core:2.0:Group","urn:ietf:params:scim:schemas:extension:zoom:2.0:Group"],"items":{"type":"string","example":"urn:ietf:params:scim:schemas:core:2.0:Group"}},"displayName":{"type":"string","description":"A human-readable name for the group.","example":"SCIM group"},"urn:ietf:params:scim:schemas:extension:zoom:2.0:Group":{"type":"object","properties":{"emailAlias":{"type":"string","description":"The group's email address (optional).","example":"test@example.com"}}}}}}}},"403":{"description":"**HTTP Status Code:** `403` <br>\n Forbidden  \n\n **Error Code:** `403` <br>\n The request was denied due to insufficient permissions: \"Group:Read\". <br>\n"},"404":{"description":"**HTTP Status Code:** `404` <br>\n Not Found  \n\n **Error Code:** `404` <br>\n Group does not exist. <br>\n"},"429":{"description":"**HTTP Status Code:** `429` <br>\n Too Many Requests. For more information, see [rate limits](https://developers.zoom.us/docs/api/rest/rate-limits/). \n\n "}},"security":[{"openapi_oauth":["scim2","scim2:admin"],"openapi_authorization":[]}],"x-extensions":{"x-permissions":["Group:Read"],"x-macro-scopes":["scim2"],"x-granular-scopes":["scim2:admin"]}},"delete":{"tags":["Group"],"summary":"Delete a group","description":"Delete a group.\n\n**[Scopes](https://developers.zoom.us/docs/integrations/oauth-scopes-overview/):** `scim2`\n\n**[Granular Scopes](https://developers.zoom.us/docs/integrations/oauth-scopes-overview/):** `scim2:admin`\n\n**[Rate Limit Label](https://marketplace.zoom.us/docs/api-reference/rate-limits#rate-limits):** `MEDIUM`","operationId":"groupSCIM2Delete","parameters":[{"name":"groupId","in":"path","description":"The group's ID.","required":true,"schema":{"type":"string","example":"kuWhUCrrT4q9Xy17rSR8js"}}],"responses":{"204":{"description":"**HTTP Status Code:** `204` <br>\nGroup deleted."},"400":{"description":"**HTTP Status Code:** `400` <br>\n Bad Request  \n\n **Error Code:** `400` <br>\n Cannot delete account default group. <br>\n"},"403":{"description":"**HTTP Status Code:** `403` <br>\n Forbidden  \n\n **Error Code:** `403` <br>\n The request was denied due to insufficient permissions: \"Group:Edit\". <br>\n"},"404":{"description":"**HTTP Status Code:** `404` <br>\n Not Found  \n\n **Error Code:** `404` <br>\n Group does not exist. <br>\n"},"429":{"description":"**HTTP Status Code:** `429` <br>\n Too Many Requests. For more information, see [rate limits](https://developers.zoom.us/docs/api/rest/rate-limits/). \n\n "}},"security":[{"openapi_oauth":["scim2","scim2:admin"],"openapi_authorization":[]}],"x-extensions":{"x-permissions":["Group:Edit"],"x-macro-scopes":["scim2"],"x-granular-scopes":["scim2:admin"]}},"patch":{"tags":["Group"],"summary":"Update a group","description":"Update group information and manage its members, including adding, removing, and replacing members.\n\n**[Scopes](https://developers.zoom.us/docs/integrations/oauth-scopes-overview/):** `scim2`\n\n**[Granular Scopes](https://developers.zoom.us/docs/integrations/oauth-scopes-overview/):** `scim2:admin`\n\n**[Rate Limit Label](https://marketplace.zoom.us/docs/api-reference/rate-limits#rate-limits):** `MEDIUM`","operationId":"groupSCIM2Update","parameters":[{"name":"groupId","in":"path","description":"The group's ID.","required":true,"schema":{"type":"string","example":"kuWhUCrrT4q9Xy17rSR8js"}}],"requestBody":{"description":"The following schema displays a list of properties that you can update. When you make an update request, include **only** the parameters that you want to update and the required `schemas` parameter in the `RequestBody`. The request body must be in valid JSON format, cannot be empty, and must not exceed 100,000 characters. If your request exceeds this limit, reduce the payload size or contact Zoom Support to request an increase.","content":{"application/json":{"schema":{"oneOf":[{"title":"Update Group [Non-member attributes]","type":"object","properties":{"schemas":{"type":"array","description":"A list of schemas in `urn:ietf:params:scim:api:messages:2.0:{operation}` format.","example":["urn:ietf:params:scim:api:messages:2.0:PatchOp"],"items":{"type":"string","example":"urn:ietf:params:scim:api:messages:2.0:PatchOp"}},"Operations":{"type":"array","description":"Array of operations to perform on the group.","items":{"anyOf":[{"title":"Update Group Name ","type":"object","properties":{"op":{"type":"string","description":"The operation type to perform.","example":"replace"},"value":{"type":"object","properties":{"displayName":{"type":"string","description":"A human-readable name for the group.","example":"SCIM group"}},"description":"The new values to apply for the operation."}}},{"title":"Update Group Email","type":"object","properties":{"op":{"type":"string","description":"The operation type to perform.","example":"replace"},"value":{"type":"object","properties":{"urn:ietf:params:scim:schemas:extension:zoom:2.0:Group:emailAlias":{"type":"string","description":"The group's email address (optional).","example":"group@example.com"}},"description":"The new values to apply for the operation."}}}]}}},"description":"Update Group."},{"title":"Update Group [Add Members]","type":"object","properties":{"schemas":{"type":"array","description":"A list of schemas in `urn:ietf:params:scim:api:messages:2.0:{operation}` format.","example":["urn:ietf:params:scim:api:messages:2.0:PatchOp"],"items":{"type":"string","example":"urn:ietf:params:scim:api:messages:2.0:PatchOp"}},"Operations":{"type":"array","description":"Array of operations to perform on the group.","items":{"type":"object","properties":{"op":{"type":"string","description":"The operation type to perform.","example":"add"},"path":{"type":"string","description":"A string containing an attribute path describing the target of the operation.","example":"members"},"value":{"type":"array","description":"The new values to apply for the operation.","items":{"type":"object","properties":{"value":{"type":"string","description":"The user's ID.","example":"exZxfwvaQXOJxUyRV-YslA"}}}}}}}},"description":"Add members."},{"title":"Update Group [Remove Members]","type":"object","properties":{"schemas":{"type":"array","description":"A list of schemas in `urn:ietf:params:scim:api:messages:2.0:{operation}` format.","example":["urn:ietf:params:scim:api:messages:2.0:PatchOp"],"items":{"type":"string","example":"urn:ietf:params:scim:api:messages:2.0:PatchOp"}},"Operations":{"type":"array","description":"Array of operations to perform on the group.","items":{"type":"object","properties":{"op":{"type":"string","description":"The operation type to perform.","example":"remove"},"path":{"type":"string","description":"A string containing an attribute path describing the target of the operation.","example":"members[value eq \"k&KdKr6TLWuxdDtk0hjSzL\"]"}}}}},"description":"Remove members."},{"title":"Update Group [Replace Members]","type":"object","properties":{"schemas":{"type":"array","description":"A list of schemas in `urn:ietf:params:scim:api:messages:2.0:{operation}` format.","example":["urn:ietf:params:scim:api:messages:2.0:PatchOp"],"items":{"type":"string","example":"urn:ietf:params:scim:api:messages:2.0:PatchOp"}},"Operations":{"type":"array","description":"Array of operations to perform on the group.","items":{"type":"object","properties":{"op":{"type":"string","description":"The operation type to perform.","example":"replace"},"path":{"type":"string","description":"A string containing an attribute path describing the target of the operation.","example":"members"},"value":{"type":"array","description":"The new values to apply for the operation.","items":{"type":"object","properties":{"value":{"type":"string","description":"The user's ID.","example":"exZxfwvaQXOJxUyRV-YslA"}}}}}}}},"description":"Replace members."}]}}}},"responses":{"204":{"description":"**HTTP Status Code:** `204` <br>\nGroup updated."},"400":{"description":"**HTTP Status Code:** `400` <br>\n Bad Request  \n\n **Error Code:** `400` <br>\n The request body must be in JSON format. <br>\n**Error Code:** `400` <br>\n The request JSON must not be empty. <br>\n**Error Code:** `400` <br>\n The \"Operations\" of the request is invalid. <br>\n**Error Code:** `400` <br>\n The request body size exceeds the 100,000 character limit. Please reduce the payload size or contact Zoom Support to request a limit increase. <br>\n"},"403":{"description":"**HTTP Status Code:** `403` <br>\n Forbidden  \n\n **Error Code:** `403` <br>\n The request was denied due to insufficient permissions: \"Group:Edit\". <br>\n"},"404":{"description":"**HTTP Status Code:** `404` <br>\n Not Found  \n\n **Error Code:** `404` <br>\n Group does not exist. <br>\n"},"429":{"description":"**HTTP Status Code:** `429` <br>\n Too Many Requests. For more information, see [rate limits](https://developers.zoom.us/docs/api/rest/rate-limits/). \n\n "}},"security":[{"openapi_oauth":["scim2","scim2:admin"],"openapi_authorization":[]}],"x-extensions":{"x-permissions":["Group:Edit"],"x-macro-scopes":["scim2"],"x-granular-scopes":["scim2:admin"]}}},"/scim2/Users":{"get":{"tags":["User"],"summary":"List users","description":"Lists all users. You can use additional query parameters to filter specific users.\n\n**[Scopes](https://developers.zoom.us/docs/integrations/oauth-scopes-overview/):** `scim2`\n\n**[Granular Scopes](https://developers.zoom.us/docs/integrations/oauth-scopes-overview/):** `scim2:admin`\n\n**[Rate Limit Label](https://marketplace.zoom.us/docs/api-reference/rate-limits#rate-limits):** `MEDIUM`","operationId":"userSCIM2List","parameters":[{"name":"startIndex","in":"query","description":"The start index of records to be returned.","required":false,"schema":{"type":"integer","example":1,"default":1}},{"name":"count","in":"query","description":"The number of records returned in a single API call.","required":false,"schema":{"maximum":100,"minimum":0,"type":"integer","example":1,"default":1}},{"name":"filter","in":"query","description":"The query type: \n* `userName eq {userEmail}` — Provide the user's email address to filter the response to a specific user. \n* `externalId eq {userId}` — Filter the response by the user's ID (`userId`).","required":false,"schema":{"type":"string","example":"externalId eq ABCD1345"}}],"responses":{"200":{"description":"**HTTP Status Code:** `200` <br>\nUser information returned.","content":{"application/json":{"schema":{"type":"object","properties":{"schemas":{"type":"array","description":"A list of schemas.","items":{"type":"string","example":"urn:ietf:params:scim:api:messages:2.0:ListResponse"}},"totalResults":{"type":"integer","description":"The total number of all records across pages.","example":20},"startIndex":{"type":"integer","description":"The start index for the records.","example":1},"itemsPerPage":{"type":"integer","description":"The number of records returned with a single API call.","example":10},"Resources":{"type":"array","description":"The user's resource information.","items":{"type":"object","properties":{"id":{"type":"string","description":"The user's ID.","example":"k&KdKr6TLWuxdDtk0hjSzL"},"meta":{"type":"object","properties":{"resourceType":{"type":"string","description":"The resource type. The value is always `User` for the User resource type.","example":"User"},"location":{"type":"string","description":"The resource's URI in `https://api.zoom.us/scim2/Users/{userId}` format.","example":"https://api.zoom.us/scim2/Users/k&KdKr6TLWuxdDtk0hjSzL"},"version":{"type":"string","description":"The resource's version number.","example":"1.0.0"},"created":{"type":"string","description":"The user'screation time.","example":"2023-11-24T05:13:15Z"},"lastModified":{"type":"string","description":"The user's last modification time.","example":"2023-11-25T06:23:17Z"}},"description":"The user's resource metadata."},"schemas":{"type":"array","description":"A list of schemas.","items":{"type":"string","example":"urn:ietf:params:scim:api:messages:2.0:ListResponse"}},"name":{"type":"object","properties":{"givenName":{"type":"string","description":"The user's first name.","example":"Jill"},"familyName":{"type":"string","description":"The user's last name.","example":"Chill"}},"description":"The information about the user's name."},"emails":{"type":"array","description":"The user's email information.","items":{"type":"object","properties":{"type":{"type":"string","description":"The email address label. For example `work`.","example":"work"},"value":{"type":"string","description":"The user's email address.","format":"email","example":"jchill@example.com"},"primary":{"type":"boolean","description":"Whether the email address is the user's primary email address.","example":true}}}},"displayName":{"type":"string","description":"The user's display name.","example":"Jill Chill"},"userName":{"type":"string","description":"The user's username.","format":"email","example":"jchill@example.com"},"active":{"type":"boolean","description":"Whether the user is active.","example":true},"userType":{"type":"string","description":"Note: You can continue using this field, but it is planned for deprecation. No timeline has been set.\nThe user type: \n* `Collaboration` - Not supported with Microsoft Entra due to a Microsoft-specific limitation. It functions as expected with other identity providers (e.g., Okta), and through direct API calls.\n* `Basic` \n* `Licensed` \n* `On-Prem`","example":"On-Prem","deprecated":true,"enum":["Collaboration","Basic","Licensed","On-Prem"]},"urn:ietf:params:scim:schemas:extension:enterprise:2.0:User":{"type":"object","properties":{"department":{"type":"string","description":"The user's department.","example":"Development"}},"description":"User information."},"urn:us:zoom:scim:schemas:extension:1.0:ZoomUser":{"type":"object","properties":{"loginType":{"type":"object","properties":{"workEmail":{"type":"boolean","description":"Whether the ability to log in with an work email address is enabled.","example":true},"sso":{"type":"boolean","description":"Whether Single Sign On (SSO) login is enabled.","example":true}},"description":"The user's login method information."}},"description":"User information."}}}}}}}}},"400":{"description":"**HTTP Status Code:** `400` <br>\n Bad Request  \n\n **Error Code:** `400` <br>\n Account has not enabled Single Sign-On.  <br>\n**Error Code:** `400` <br>\n The current filter is not supported, the filter name: {filter} <br>\n"},"403":{"description":"**HTTP Status Code:** `403` <br>\n Forbidden  \n\n **Error Code:** `403` <br>\n The current login user does not have the \"User:Read\" permission. <br>\n"},"429":{"description":"**HTTP Status Code:** `429` <br>\n Too Many Requests. For more information, see [rate limits](https://developers.zoom.us/docs/api/rest/rate-limits/). \n\n "}},"security":[{"openapi_oauth":["scim2","scim2:admin"],"openapi_authorization":[]}],"x-extensions":{"x-permissions":["User:Read"],"x-macro-scopes":["scim2"],"x-granular-scopes":["scim2:admin"]}},"post":{"tags":["User"],"summary":"Create a user","description":"Creates a new user.\n\n**[Scopes](https://developers.zoom.us/docs/integrations/oauth-scopes-overview/):** `scim2`\n\n**[Granular Scopes](https://developers.zoom.us/docs/integrations/oauth-scopes-overview/):** `scim2:admin`\n\n**[Rate Limit Label](https://marketplace.zoom.us/docs/api-reference/rate-limits#rate-limits):** `LIGHT`","operationId":"userScim2Create","requestBody":{"content":{"application/json":{"schema":{"type":"object","properties":{"schemas":{"type":"array","description":"A list of schemas in `urn:ietf:params:scim:api:messages:2.0:{operation}` format.","items":{"type":"string","example":"urn:ietf:params:scim:api:messages:2.0:ListResponse"}},"userName":{"type":"string","description":"The user's email address.","format":"email","example":"jchill@example.com"},"userType":{"type":"string","description":"Note: You can continue using this field, but it is planned for deprecation. No timeline has been set.\nThe user type: \n* `Collaboration` - Not supported with Microsoft Entra due to a Microsoft-specific limitation. It functions as expected with other identity providers (e.g., Okta), and through direct API calls.\n* `Basic` \n* `Licensed` \n* `On-Prem`","example":"On-Prem","deprecated":true,"enum":["Collaboration","Basic","Licensed","On-Prem"]},"name":{"type":"object","properties":{"givenName":{"type":"string","description":"The user's first name.","example":"Jill"},"familyName":{"type":"string","description":"The user's last name.","example":"Chill"}},"description":"Information about the user's name."},"displayName":{"type":"string","description":"The user's display name. Note: If you do not add a display name, Zoom generates one by concatenating the first name and last name provided.","example":"Jill Chill"},"title":{"type":"string","description":"The user's job title.","example":"Developer"},"locale":{"type":"string","description":"The user's location.","example":"San Jose"},"phoneNumbers":{"type":"array","description":"A list of the user's assigned phone numbers.","items":{"type":"object","properties":{"type":{"type":"string","description":"The phone number's label:\n* `mobile`\n* `office`\n* `home`\n* `fax`\n* `work`\n\nThis value defaults to `work`.","example":"work","default":"work","enum":["mobile","office","home","fax","work"]},"value":{"type":"string","description":"The phone number.","example":"+015550100"}}}},"roles":{"type":"array","description":"The user's assigned [roles](https://support.zoom.com/hc/en/article?id=zm_kb&sysparm_article=KB0064983) information.","items":{"type":"object","properties":{"display":{"type":"string","description":"The role's display name.","example":"Developer"},"value":{"type":"string","description":"The role name.","example":"Developer"},"primary":{"type":"boolean","description":"Whether the role is the user's primary role.","example":true}}}},"groups":{"type":"array","description":"The user's assigned [groups](https://support.zoom.com/hc/en/article?id=zm_kb&sysparm_article=KB0062584) information.","items":{"type":"object","properties":{"display":{"type":"string","description":"The group's display name.","example":"Developers"},"type":{"type":"string","description":"The group type. This value defaults to `direct`.","example":"direct","default":"direct"},"value":{"type":"string","description":"The group name.","example":"Developers"},"primary":{"type":"boolean","description":"Whether the group is the user's primary group.","example":true,"deprecated":true}}}},"urn:ietf:params:scim:schemas:extension:enterprise:2.0:User":{"type":"object","properties":{"department":{"type":"string","description":"The user's department.","example":"Development"},"organization":{"type":"string","description":"The user's organization.","example":"Example"},"costCenter":{"type":"string","description":"The user's cost center.","example":"US01"},"employeeNumber":{"type":"string","description":"The user's employee ID.","example":"123"},"manager":{"type":"string","description":"The email address of the user's manager.","format":"email","example":"thill@example.com"}}},"urn:ietf:params:scim:schemas:extension:zoom:1.0:User":{"type":"object","properties":{"zoomPhoneExtNumber":{"type":"string","description":"The user's Zoom Phone extension number. To automatically assign an extension number, set this field's value to `0`.","example":"0"},"zoomPhoneNumber":{"type":"string","description":"The user's assigned Zoom Phone number. This value must be an unassigned number in the Zoom account.","example":"5550100"},"zoomPhoneSite":{"type":"string","description":"The Zoom Phone site to assign the user to. If you do not provide this value, the user will be assigned to the main site.","example":"main"},"zoomPhoneCallingPlan":{"type":"string","description":"The user's assigned [Zoom Phone calling plan](/docs/api/references/phone-calling-plans/).","example":"phone_calling_usca_monthly_unlimited"},"{customAttribute}":{"maxItems":5,"type":"string","description":"A custom attribute and its value. This field returns as the custom attribute's name. For example, `currentState` and the `California` value.","example":"\"Custom attribute name\" : \"custom attribute value\""},"personalLinkName":{"type":"string","description":"The user's customized [personal link](https://support.zoom.com/hc/en/article?id=zm_kb&sysparm_article=KB0068443#h_08f381ef-1e88-417c-b014-a2b9ad4abbda).","example":"user001"},"transferee":{"type":"string","description":"The transferee is another user within the same account designated to receive the original user's data when that user is deactivated or deleted.","example":"transferee@example.com"},"pronouns":{"type":"string","description":"The user's pronouns.","example":"They/Them/Their"},"zoomUnited":{"type":"string","description":"The user's number of [Zoom United licenses](https://zoom.us/pricing/zoom-bundles). The license options:\n* `1` - Zoom United Pro-United with US/CA Unlimited.\n* `2` - Zoom United Pro-United with UK/IR Unlimited.\n* `4` - Zoom United Pro-United with AU/NZ Unlimited.\n* `8` - Zoom United Pro-United with Global Select.\n* `16` - Zoom United Pro-United with Zoom Phone Pro.\n* `32` - Zoom United Biz-United with US/CA Unlimited.\n* `64` - Zoom United Biz-United with UK/IR Unlimited.\n* `128` - Zoom United Biz-United with AU/NZ Unlimited.\n* `256` - Zoom United Biz-United with Global Select.\n* `512` - Zoom United Biz-United with Zoom Phone Pro.\n* `1024` - Zoom United Ent-United with US/CA Unlimited.\n* `2048` - Zoom United Ent-United with UK/IR Unlimited.\n* `4096` - Zoom United Ent-United with AU/NZ Unlimited.\n* `8192` - Zoom United Ent-United with Global Select.\n* `16384` - Zoom United Ent-United with Zoom Phone Pro.\n* `32768` - Zoom United Pro-United with JP Unlimited.\n* `65536` - Zoom United Biz-United with JP Unlimited.\n* `131072` - Zoom United Ent-United with JP Unlimited.","example":"16","enum":["1","2","4","8","16","32","64","128","256","512","1024","2048","4096","8192","16384","32768","65536","131072"]},"zoomOneBizPlus":{"type":"string","description":"The Zoom Workplace plan option:\n* `16` - Zoom Workplace Business Plus with US/CA Unlimited.\n* `32` - Zoom Workplace Business Plus with UK/IR Unlimited.\n* `64` - Zoom Workplace Business Plus with AU/NZ Unlimited.\n* `128` - Zoom Workplace Business Plus with Japan Unlimited.\n* `33554432` - Zoom Workplace Business Plus with Global Select.\n\nThe Zoom One plan option for Gov accounts:\n* `16` - Zoom One Business Plus.","example":"16","deprecated":true,"enum":["16","32","64","128","33554432"]},"zoomOneEdu":{"type":"string","description":"Zoom One for Education Enterprise Student.\n* `576460752303423488` - Zoom One for Education Enterprise Student.","example":"576460752303423488","deprecated":true},"zoomOneSchoolCampusPlus":{"type":"string","description":"The Zoom One plan option:\n* `137438953472` - Zoom One for Education School and Campus Plus with US/CA Unlimited.\n* `274877906944` - Zoom One for Education School and Campus Plus with Japan Unlimited.\n* `549755813888` - Zoom One for Education School and Campus Plus with UK/Ireland Unlimited.\n* `1099511627776` - Zoom One for Education School and Campus Plus with AU/NZ Unlimited.\n* `2199023255552` - Zoom One for Education School and Campus Plus with Global Select.","example":"137438953472","deprecated":true,"enum":["137438953472","274877906944","549755813888","1099511627776","2199023255552"]},"zoomOneEntPremier":{"type":"string","description":"The Zoom One plan option:\n* `134217728` - Zoom One Enterprise Premier with US/CA Unlimited.\n* `268435456` - Zoom One Enterprise Premier with Japan Unlimited.\n* `536870912` - Zoom One Enterprise Premier with UK/Ireland Unlimited.\n* `1073741824` - Zoom One Enterprise Premier with AU/NZ Unlimited.\n* `2147483648` - Zoom One Enterprise Premier with Global Select.","example":"134217728","deprecated":true,"enum":["134217728","268435456","536870912","1073741824","2147483648"]},"zoomOneEduEntPremier":{"type":"string","description":"The Zoom One plan option:\n* `4294967296` - Zoom One for Education Enterprise Premier with US/CA Unlimited.\n* `8589934592` - Zoom One for Education Enterprise Premier with Japan Unlimited.\n* `17179869184` - Zoom One for Education Enterprise Premier with UK/Ireland Unlimited.\n* `34359738368` - Zoom One for Education Enterprise Premier with AU/NZ Unlimited.\n* `68719476736` - Zoom One for Education Enterprise Premier with Global Select.","example":"4294967296","deprecated":true,"enum":["4294967296","8589934592","17179869184","34359738368","68719476736"]},"zoomIQ":{"type":"boolean","description":"Zoom IQ Plan.","example":true,"deprecated":true},"zoomRevenueAccelerator":{"type":"boolean","description":"Zoom Revenue Accelerator Plan.","example":true},"zoomCustomerManagedKey":{"type":"boolean","description":"Zoom Customer Managed Key Plan.","example":true},"zoomWhiteboard":{"type":"boolean","description":"Zoom Whiteboard Plan.","example":true},"zoomWhiteboardPlus":{"type":"boolean","description":"Zoom Whiteboard Plus Plan.","example":true},"zoomTranslatedCaptions":{"type":"boolean","description":"Zoom Translated Captions Plan.","example":true},"zoomHuddles":{"type":"boolean","description":"Zoom Huddles Plan.","example":true,"deprecated":true},"zoomWorkforceManagement":{"type":"boolean","description":"Zoom Workforce Management Plan.","example":true},"zoomQualityManagement":{"type":"boolean","description":"Zoom Quality Management Plan.","example":true},"zoomScheduler":{"type":"boolean","description":"Zoom Scheduler Plan.","example":true},"zoomClipsPlus":{"type":"boolean","description":"Zoom Clips Plus Plan.","example":true},"zoomMailAndCalendar":{"type":"boolean","description":"Zoom Mail and Calendar Plan.","example":true},"visitorManagement":{"type":"boolean","description":"Zoom Visitor Management Plan.","example":true},"zoomComplianceManagement":{"type":"boolean","description":"Zoom Compliance Management Plan.","example":true,"deprecated":true},"zoomDocs":{"type":"boolean","description":"Zoom Docs Plan.","example":true},"zoomContactCenterPackage":{"type":"string","description":"The Zoom Contact Center Plan to assign to the user. An empty value will not assign the user to Zoom Contact Center. Package options:\n* `Essentials` - Zoom Contact Center Essentials Package.\n* `Premium` - Zoom Contact Center Premium Package.\n* `Elite` - Zoom Contact Center Elite Package.","example":"Essentials","enum":["Essentials","Premium","Elite"]},"zoomContactCenterAddonsPlan":{"type":"string","description":"The Zoom Contact Center add-on plan to assign to the user. An empty value will not assign the user to a Zoom Contact Center add-on package. To assign multiple plans, concatenate them as a comma-separated list (e.g., `plan1,plan2`). Add-on package options:\n* `ai_expert_assist` — Zoom Contact Center AI Expert Assist package.\n* `service_cloud_voice` — Zoom Contact Center for Service Cloud Voice package.\n* `epic` — Zoom Contact Center for Epic package.\n* `servicenow_unified_view` — Zoom Contact Center Unified View for ServiceNow package.","example":"ai_expert_assist","enum":["ai_expert_assist","service_cloud_voice","epic","servicenow_unified_view"]},"zoomContactCenterRole":{"type":"string","description":"The Zoom Contact Center role to assign to the user. If you do not provide this value, Zoom assigns the default Agent role to the user.","example":"Admin"},"zoomContactCenterRegion":{"type":"string","description":"The Zoom Contact Center region to assign to the user. If you do not provide this value, Zoom assigns the main region to the user.","example":"Main Region"},"zoomContactCenterUserTemplate":{"type":"string","description":"The Zoom Contact Center Add Template to apply to the user. You can only use add-type templates when creating users. If you use an update-type template, it will be ignored. If you provide the add-type template value, leave all other fields blank to apply all settings from the template. If you specify both individual SCIM values and a template in the request, the individual values will take priority over the template settings.","example":"Add Template"},"zoomClinicians":{"type":"boolean","description":"Zoom Workplace for Clinicians.","example":true,"deprecated":true},"zoomCustomAICompanion":{"type":"boolean","description":"Zoom Custom AI Companion.","example":true},"zoomAICompanion":{"type":"boolean","description":"Zoom AI Companion.","example":true},"zoomRevenueAcceleratorRole":{"type":"string","description":"Zoom Revenue Accelerator Role.","example":"Sales Manager"},"zoomAutoDialer":{"type":"string","description":"The plan option of Zoom Auto Dialer.\n* `1073741824` - Zoom Auto Dialer Plus US/Canada.\n* `-9223372036854775808` - Zoom Auto Dialer Plus Japan.\n* `2305843009213693952` - Zoom Auto Dialer Plus UK/IR.\n* `4611686018427387904` - Zoom Auto Dialer Plus AU/NZ.","example":"1073741824","enum":["1073741824","-9223372036854775808","2305843009213693952","4611686018427387904"]},"zoomFrontline":{"type":"string","description":"The plan option of Zoom Workplace for Frontline.\n* `2048` - Zoom Workplace for Frontline.","example":"2048","enum":["2048"]},"cxInsights":{"type":"string","description":"The plan option of CX Insights.\n* `1099511627776` - CX Insights Leader.","example":"1099511627776","enum":["1099511627776"]},"zoomEnhancedMedia":{"type":"string","description":"The plan option of Zoom Enhanced Media.\n`4503599627370496` - Zoom Enhanced Media.","example":"4503599627370496","enum":["4503599627370496"]},"aiSalesAssist":{"type":"string","description":"The plan option of AI Sales Assist.\n`128` - AI Sales Assist.","example":"128","enum":["128"]},"eduStandardStudent":{"type":"string","description":"The plan option of Education for Standard Student.\n`1152921504606846976` - Education for Standard Student.","example":"1152921504606846976","enum":["1152921504606846976"]},"zoomWorkplaceSubscription":{"type":"string","description":"The [subscription](https://zoom.us/billing) ID or name for the Zoom Workplace license. Ignore this field if your account doesn't include the Multiple Subscription Quoting feature.","example":"2025 Subscription"},"zoomPhoneCallingPlanSubscription":{"type":"string","description":"The [subscription](https://zoom.us/billing) ID or name for the Zoom Phone calling plan. Ignore this field if your account doesn't include the Multiple Subscription Quoting feature.","example":"2025 Subscription"},"zoomRevenueAcceleratorSubscription":{"type":"string","description":"The [subscription](https://zoom.us/billing) ID or name for the Zoom Revenue Accelerator plan. Ignore this field if your account doesn't include the Multiple Subscription Quoting feature.","example":"2025 Subscription"},"zoomCustomerManagedKeySubscription":{"type":"string","description":"The [subscription](https://zoom.us/billing) ID or name for the Zoom Customer Managed Key. Ignore this field if your account doesn't include the Multiple Subscription Quoting feature.","example":"2025 Subscription"},"zoomWhiteboardSubscription":{"type":"string","description":"The [subscription](https://zoom.us/billing) ID or name for the Zoom Whiteboard and Zoom Whiteboard Plus plan. Ignore this field if your account doesn't include the Multiple Subscription Quoting feature.","example":"2025 Subscription"},"zoomTranslatedCaptionsSubscription":{"type":"string","description":"The [subscription](https://zoom.us/billing) ID or name for the Zoom Translated Captions plan. Ignore this field if your account doesn't include the Multiple Subscription Quoting feature.","example":"2025 Subscription"},"zoomWorkforceManagementSubscription":{"type":"string","description":"The [subscription](https://zoom.us/billing) ID or name for the Zoom Workforce Management plan. Ignore this field if your account doesn't include the Multiple Subscription Quoting feature.","example":"2025 Subscription"},"zoomQualityManagementSubscription":{"type":"string","description":"The [subscription](https://zoom.us/billing) ID or name for the Zoom Quality Management plan. Ignore this field if your account doesn't include the Multiple Subscription Quoting feature.","example":"2025 Subscription"},"zoomSchedulerSubscription":{"type":"string","description":"The [subscription](https://zoom.us/billing) ID or name for the Zoom Scheduler plan. Ignore this field if your account doesn't include the Multiple Subscription Quoting feature.","example":"2025 Subscription"},"zoomClipsPlusSubscription":{"type":"string","description":"The [subscription](https://zoom.us/billing) ID or name for the Zoom Clips Plus plan. Ignore this field if your account doesn't include the Multiple Subscription Quoting feature.","example":"2025 Subscription"},"visitorManagementSubscription":{"type":"string","description":"The [subscription](https://zoom.us/billing) ID or name for the Visitor Management plan. Ignore this field if your account doesn't include the Multiple Subscription Quoting feature.","example":"2025 Subscription"},"zoomComplianceManagementSubscription":{"type":"string","description":"The [subscription](https://zoom.us/billing) ID or name for the Zoom Compliance Management plan. Ignore this field if your account doesn't include the Multiple Subscription Quoting feature.","example":"2025 Subscription"},"zoomDocsSubscription":{"type":"string","description":"The [subscription](https://zoom.us/billing) ID or name for the Zoom Docs plan. Ignore this field if your account doesn't include the Multiple Subscription Quoting feature.","example":"2025 Subscription"},"zoomAutoDialerSubscription":{"type":"string","description":"The [subscription](https://zoom.us/billing) ID or name for the Zoom Auto Dialer plan. Ignore this field if your account doesn't include the Multiple Subscription Quoting feature.","example":"2025 Subscription"},"zoomAICompanionSubscription":{"type":"string","description":"The [subscription](https://zoom.us/billing) ID or name for the Zoom AI Companion and Zoom Custom AI Companion plan. Ignore this field if your account doesn't include the Multiple Subscription Quoting feature.","example":"2025 Subscription"},"aiSalesAssistSubscription":{"type":"string","description":"The [subscription](https://zoom.us/billing) ID or name for the AI Sales Assist plan. Ignore this field if your account doesn't include the Multiple Subscription Quoting feature.","example":"2025 Subscription"},"cxInsightsSubscription":{"type":"string","description":"The [subscription](https://zoom.us/billing) ID or name for the CX Insights plan. Ignore this field if your account doesn't include the Multiple Subscription Quoting feature.","example":"2025 Subscription"},"zoomEnhancedMediaSubscription":{"type":"string","description":"The [subscription](https://zoom.us/billing) ID or name for the Zoom Enhanced Media. Ignore this field if your account doesn't include the Multiple Subscription Quoting feature.","example":"2025 Subscription"},"eduStandardStudentSubscription":{"type":"string","description":"The [subscription](https://zoom.us/billing) ID or name for the Education for Standard Student. Ignore this field if your account doesn't include the Multiple Subscription Quoting feature.","example":"2025 Subscription"},"zoomRevenueAcceleratorSegment":{"type":"string","description":"Zoom Revenue Accelerator Segment.","example":"Sales"},"zoomRevenueAcceleratorRegion":{"type":"string","description":"Zoom Revenue Accelerator Region.","example":"US"},"workforceManagementRole":{"type":"string","description":"The Zoom Workforce Management role.","example":"Workforce Management Admin (Default)"},"qualityManagementRole":{"type":"string","description":"The Zoom Quality Management role.","example":"Quality Management Admin (Default)"},"zoomAIProductivitySuite":{"type":"string","description":"The plan option for the Zoom AI Productivity Suite.\n`16777216` - Zoom AI Productivity Suite.","example":"16777216","enum":["16777216"]},"zoomAIProductivitySuiteSubscription":{"type":"string","description":"The [subscription](https://zoom.us/billing) ID or name for the Zoom AI Productivity Suite plan. Ignore this field if your account doesn't include the Multiple Subscription Quoting feature.","example":"2025 Subscription"},"zoomComplianceManagementPlan":{"type":"string","description":"The Zoom Compliance Management plan option.\n* `none` — Turn off the Zoom Compliance Management feature.\n* `zcm` — Zoom Compliance Management.\n* `zcm_plus` — Zoom Compliance Management Plus.","example":"zcm","enum":["none","zcm","zcm_plus"]},"zoomCliniciansPlan":{"type":"string","description":"The Clinicians and Clinical Note plan option.\n* `none` — Turn off the Zoom Clinical Note feature.\n* `zm_clinical_note_essentials` — Zoom Clinical Note Essentials.\n* `zm_workplace_for_clinicians_unlimited` — Zoom Workplace for Clinicians Unlimited.\n* `zm_workplace_for_clinicians_consumption` — Zoom Workplace for Clinicians Pay Per Note.","example":"zm_workplace_for_clinicians_unlimited","enum":["none","zm_clinical_note_essentials","zm_workplace_for_clinicians_unlimited","zm_workplace_for_clinicians_consumption"]},"zoomWorkplace":{"type":"string","description":"The Zoom Workplace bundle plan option:\n* `none` - Turn off the Zoom Workplace feature.\n* `zoe` - Zoom Workplace Enterprise.\n* `zoep` - Zoom Workplace Enterprise Plus.\n* `zo_ent_essentials` - Zoom Workplace Enterprise Essentials.\n* `zobp_usca` - Zoom Workplace Business Plus with US/CA Unlimited.\n* `zobp_ukir` - Zoom Workplace Business Plus with UK/IR Unlimited.\n* `zobp_aunz` - Zoom Workplace Business Plus with AU/NZ Unlimited.\n* `zobp_jp` - Zoom Workplace Business Plus with Japan Unlimited.\n* `zobp_global` - Zoom Workplace Business Plus with Global Select.\n* `zoe_prem_usca` - Zoom Workplace Enterprise Premier with US/CA Unlimited.\n* `zoe_prem_jp` - Zoom Workplace Enterprise Premier with Japan Unlimited.\n* `zoe_prem_ukir` - Zoom Workplace Enterprise Premier with UK/IR Unlimited.\n* `zoe_prem_aunz` - Zoom Workplace Enterprise Premier with AU/NZ Unlimited.\n* `zopp_usca` - Zoom Workplace Pro Plus with US/CA Unlimited.\n* `zo_edu_sch_cmp` - Zoom Workplace for Education School and Campus.\n* `zo_edu_ent_essentials` - Zoom Workplace for Education Enterprise Essentials.\n* `zo_edu_ent_plus` - Zoom Workplace for Education Enterprise Plus.\n* `zo_edu_ent_hied_stu` - Zoom Workplace for Education Enterprise Student.\n* `zo_edu_std` - Zoom Workplace for Education Standard.\n* `zo_edu_sch_cmp_plus_usca` - Zoom Workplace for Education School and Campus Plus with US/CA Unlimited.\n* `zo_edu_sch_cmp_plus_jp` - Zoom Workplace for Education School and Campus Plus with Japan Unlimited.\n* `zo_edu_sch_cmp_plus_ukir` - Zoom Workplace for Education School and Campus Plus with UK/IR Unlimited.\n* `zo_edu_sch_cmp_plus_aunz` - Zoom Workplace for Education School and Campus Plus with AU/NZ Unlimited.\n* `zo_edu_sch_cmp_plus_global` - Zoom Workplace for Education School and Campus Plus with Global Select.\n* `zo_edu_ent_prem_usca` - Zoom Workplace for Education Enterprise Premier with US/CA Unlimited.\n* `zo_edu_ent_prem_jp` - Zoom Workplace for Education Enterprise Premier with Japan Unlimited.\n* `zo_edu_ent_prem_ukir` - Zoom Workplace for Education Enterprise Premier with UK/IR Unlimited.\n* `zo_edu_ent_prem_aunz` - Zoom Workplace for Education Enterprise Premier with AU/NZ Unlimited.\n* `zo_edu_ent_prem_global` - Zoom Workplace for Education Enterprise Premier with Global Select.","example":"zobp_usca","enum":["none","zoe","zoep","zo_ent_essentials","zobp_usca","zobp_ukir","zobp_aunz","zobp_jp","zobp_global","zoe_prem_usca","zoe_prem_jp","zoe_prem_ukir","zoe_prem_aunz","zopp_usca","zo_edu_sch_cmp","zo_edu_ent_essentials","zo_edu_ent_plus","zo_edu_ent_hied_stu","zo_edu_std","zo_edu_sch_cmp_plus_usca","zo_edu_sch_cmp_plus_jp","zo_edu_sch_cmp_plus_ukir","zo_edu_sch_cmp_plus_aunz","zo_edu_sch_cmp_plus_global","zo_edu_ent_prem_usca","zo_edu_ent_prem_jp","zo_edu_ent_prem_ukir","zo_edu_ent_prem_aunz","zo_edu_ent_prem_global"]}}}}}}}},"responses":{"201":{"description":"**HTTP Status Code:** `201` <br>\n User created.\n\n ","content":{"application/json":{"schema":{"type":"object","properties":{"id":{"type":"string","description":"The user's ID.","example":"k&KdKr6TLWuxdDtk0hjSzL"},"meta":{"type":"object","properties":{"resourceType":{"type":"string","description":"The resource type. Always `User` for the User resource type.","example":"User"},"location":{"type":"string","description":"The resource's URI in `https://api.zoom.us/scim2/Users/{userId}` format.","example":"https://api.zoom.us/scim2/Users/k&KdKr6TLWuxdDtk0hjSzL"},"version":{"type":"string","description":"The resource's version number.","example":"1.0.0"},"created":{"type":"string","description":"The user's creation time.","example":"2023-11-24T05:13:15Z"},"lastModified":{"type":"string","description":"The user's last modification time.","example":"2023-11-24T05:13:15Z"}},"description":"The user's resource metadata."},"schemas":{"type":"array","description":"A list of schemas.","items":{"type":"string","example":"urn:ietf:params:scim:api:messages:2.0:ListResponse"}},"name":{"type":"object","properties":{"givenName":{"type":"string","description":"The user's first name.","example":"Jill"},"familyName":{"type":"string","description":"The user's last name.","example":"Chill"}},"description":"Information about the user's name."},"emails":{"type":"array","description":"The user's email information.","items":{"type":"object","properties":{"type":{"type":"string","description":"The type of email address.","example":"work","default":"work"},"value":{"type":"string","description":"The user's email address.","format":"email","example":"jchill@example.com"},"primary":{"type":"boolean","description":"Whether the email address is the user's primary email address.","example":true}}}},"displayName":{"type":"string","description":"The user's display name.","example":"Jill Chill"},"userName":{"type":"string","description":"The user's email address.","format":"email","example":"jchill@example.com"},"active":{"type":"boolean","description":"Whether the user is active.","example":true},"userType":{"type":"string","description":"Note: You can continue using this field, but it is planned for deprecation. No timeline has been set.\nThe user type:\n* `Collaboration` - Not supported with Microsoft Entra due to a Microsoft-specific limitation. It functions as expected with other identity providers (e.g., Okta), and through direct API calls.\n* `Basic`\n* `Licensed`\n* `On-Prem`","example":"On-Prem","deprecated":true,"enum":["Collaboration","Basic","Licensed","On-Prem"]},"title":{"type":"string","description":"The user's job title.","example":"Developer"},"locale":{"type":"string","description":"The user's location.","example":"San Jose"},"phoneNumbers":{"type":"array","description":"A list of the user's assigned phone numbers.","items":{"type":"object","properties":{"type":{"type":"string","description":"The phone number's label:\n* `mobile`\n* `office`\n* `home`\n* `fax`\n* `work`\n\nThis value defaults to `work`.","example":"work","default":"work","enum":["mobile","office","home","fax","work"]},"value":{"type":"string","description":"The phone number.","example":"+015550100"}}}},"roles":{"type":"array","description":"The user's [role](https://support.zoom.com/hc/en/article?id=zm_kb&sysparm_article=KB0064983) information.","items":{"type":"object","properties":{"display":{"type":"string","description":"The role's display name.","example":"Developer"},"value":{"type":"string","description":"The role name.","example":"Developer"},"primary":{"type":"boolean","description":"Whether the role is the user's primary role.","example":true}}}},"groups":{"type":"array","description":"The user's [groups](https://support.zoom.com/hc/en/article?id=zm_kb&sysparm_article=KB0062584) information.","items":{"type":"object","properties":{"display":{"type":"string","description":"The group's display name.","example":"Developers"},"type":{"type":"string","description":"The group type.","example":"direct","default":"direct"},"value":{"type":"string","description":"The group name.","example":"Developers"},"primary":{"type":"boolean","description":"Whether the group is the user's primary group.","example":true,"deprecated":true}}}},"urn:ietf:params:scim:schemas:extension:enterprise:2.0:User":{"type":"object","properties":{"department":{"type":"string","description":"The user's department.","example":"Development"},"organization":{"type":"string","description":"The user's organization.","example":"Example"},"costCenter":{"type":"string","description":"The user's cost center.","example":"US01"},"employeeNumber":{"type":"string","description":"The user's employee ID.","example":"ABCDE12345"},"manager":{"type":"string","description":"The email address of the user's manager.","format":"email","example":"thill@example.com"}}},"urn:ietf:params:scim:schemas:extension:zoom:1.0:User":{"type":"object","properties":{"{customAttribute}":{"maxItems":5,"type":"string","description":"A custom attribute and its value. This field returns as the custom attribute's name. For example, `currentState` and the `California` value.","example":"\"Custom attribute name\" : \"custom attribute value\""},"personalLinkName":{"type":"string","description":"The user's customized [personal link](https://support.zoom.com/hc/en/article?id=zm_kb&sysparm_article=KB0068443#h_08f381ef-1e88-417c-b014-a2b9ad4abbda).","example":"user001"},"transferee":{"type":"string","description":"The transferee is another user within the same account designated to receive the original user's data when that user is deactivated or deleted.","example":"transferee@example.com"},"pronouns":{"type":"string","description":"The user's pronouns.","example":"They/Them/Their"},"zoomUnited":{"type":"string","description":"The user's number of [Zoom United licenses](https://zoom.us/pricing/zoom-bundles).","example":"16"},"zoomOneBizPlus":{"type":"string","description":"Zoom One Business Plus.","example":"16","deprecated":true},"zoomOneEdu":{"type":"string","description":"Zoom One for Education Enterprise Student.","example":"576460752303423488","deprecated":true},"zoomOneSchoolCampusPlus":{"type":"string","description":"Zoom One for Education School and Campus Plus.","example":"137438953472","deprecated":true},"zoomOneEntPremier":{"type":"string","description":"Zoom One Enterprise Premier.","example":"13421772","deprecated":true},"zoomOneEduEntPremier":{"type":"string","description":"Zoom One for Education Enterprise Premier.","example":"4294967296","deprecated":true},"zoomIQ":{"type":"boolean","description":"Zoom IQ Plan.","example":true,"deprecated":true},"zoomRevenueAccelerator":{"type":"boolean","description":"Zoom Revenue Accelerator Plan.","example":true},"zoomCustomerManagedKey":{"type":"boolean","description":"Zoom Customer Managed Key Plan.","example":true},"zoomWhiteboard":{"type":"boolean","description":"Zoom Whiteboard Plan.","example":true},"zoomWhiteboardPlus":{"type":"boolean","description":"Zoom Whiteboard Plus Plan.","example":true},"zoomTranslatedCaptions":{"type":"boolean","description":"Zoom Translated Captions Plan.","example":true},"zoomHuddles":{"type":"boolean","description":"Zoom Huddles Plan.","example":true,"deprecated":true},"zoomWorkforceManagement":{"type":"boolean","description":"Zoom Workforce Management Plan.","example":true},"zoomQualityManagement":{"type":"boolean","description":"Zoom Quality Management Plan.","example":true},"zoomScheduler":{"type":"boolean","description":"Zoom Scheduler Plan.","example":true},"zoomClipsPlus":{"type":"boolean","description":"Zoom Clips Plus Plan.","example":true},"zoomMailAndCalendar":{"type":"boolean","description":"Zoom Mail and Calendar Plan.","example":true},"visitorManagement":{"type":"boolean","description":"Zoom Visitor Management Plan.","example":true},"zoomComplianceManagement":{"type":"boolean","description":"Zoom Compliance Management Plan.","example":true,"deprecated":true},"zoomDocs":{"type":"boolean","description":"Zoom Docs Plan.","example":true},"zoomClinicians":{"type":"boolean","description":"Zoom Workplace for Clinicians.","example":true,"deprecated":true},"zoomCustomAICompanion":{"type":"boolean","description":"Zoom Custom AI Companion.","example":true},"zoomAICompanion":{"type":"boolean","description":"Zoom AI Companion.","example":true},"zoomRevenueAcceleratorRole":{"type":"string","description":"Zoom Revenue Accelerator Role.","example":"Sales Manager"},"zoomAutoDialer":{"type":"string","description":"The plan option of Zoom Auto Dialer.\n* `1073741824` - Zoom Auto Dialer Plus US/Canada.\n* `-9223372036854775808` - Zoom Auto Dialer Plus Japan.\n* `2305843009213693952` - Zoom Auto Dialer Plus UK/IR.\n* `4611686018427387904` - Zoom Auto Dialer Plus AU/NZ.","example":"1073741824","enum":["1073741824","-9223372036854775808","2305843009213693952","4611686018427387904"]},"zoomFrontline":{"type":"string","description":"The plan option of Zoom Workplace for Frontline.\n* `2048` - Zoom Workplace for Frontline.","example":"2048","enum":["2048"]},"cxInsights":{"type":"string","description":"The plan option of CX Insights.\n* `1099511627776` - CX Insights Leader.","example":"1099511627776","enum":["1099511627776"]},"zoomEnhancedMedia":{"type":"string","description":"The plan option of Zoom Enhanced Media.\n`4503599627370496` - Zoom Enhanced Media.","example":"4503599627370496","enum":["4503599627370496"]},"aiSalesAssist":{"type":"string","description":"The plan option of AI Sales Assist.\n`128` - AI Sales Assist.","example":"128","enum":["128"]},"eduStandardStudent":{"type":"string","description":"The plan option of Education for Standard Student.\n`1152921504606846976` - Education for Standard Student.","example":"1152921504606846976","enum":["1152921504606846976"]},"zoomWorkplaceSubscription":{"type":"string","description":"The [subscription](https://zoom.us/billing) name for the Zoom Workplace license. Ignore this field if your account doesn't include the Multiple Subscription Quoting feature.","example":"2025 Subscription"},"zoomRevenueAcceleratorSubscription":{"type":"string","description":"The [subscription](https://zoom.us/billing) ID or name for the Zoom Revenue Accelerator plan. Ignore this field if your account doesn't include the Multiple Subscription Quoting feature.","example":"2025 Subscription"},"zoomCustomerManagedKeySubscription":{"type":"string","description":"The [subscription](https://zoom.us/billing) ID or name for the Zoom Customer Managed Key. Ignore this field if your account doesn't include the Multiple Subscription Quoting feature.","example":"2025 Subscription"},"zoomWhiteboardSubscription":{"type":"string","description":"The [subscription](https://zoom.us/billing) ID or name for the Zoom Whiteboard and Zoom Whiteboard Plus plan. Ignore this field if your account doesn't include the Multiple Subscription Quoting feature.","example":"2025 Subscription"},"zoomTranslatedCaptionsSubscription":{"type":"string","description":"The [subscription](https://zoom.us/billing) ID or name for the Zoom Translated Captions plan. Ignore this field if your account doesn't include the Multiple Subscription Quoting feature.","example":"2025 Subscription"},"zoomWorkforceManagementSubscription":{"type":"string","description":"The [subscription](https://zoom.us/billing) ID or name for the Zoom Workforce Management plan. Ignore this field if your account doesn't include the Multiple Subscription Quoting feature.","example":"2025 Subscription"},"zoomQualityManagementSubscription":{"type":"string","description":"The [subscription](https://zoom.us/billing) ID or name for the Zoom Quality Management plan. Ignore this field if your account doesn't include the Multiple Subscription Quoting feature.","example":"2025 Subscription"},"zoomSchedulerSubscription":{"type":"string","description":"The [subscription](https://zoom.us/billing) ID or name for the Zoom Scheduler plan. Ignore this field if your account doesn't include the Multiple Subscription Quoting feature.","example":"2025 Subscription"},"zoomClipsPlusSubscription":{"type":"string","description":"The [subscription](https://zoom.us/billing) ID or name for the Zoom Clips Plus plan. Ignore this field if your account doesn't include the Multiple Subscription Quoting feature.","example":"2025 Subscription"},"visitorManagementSubscription":{"type":"string","description":"The [subscription](https://zoom.us/billing) ID or name for the Visitor Management plan. Ignore this field if your account doesn't include the Multiple Subscription Quoting feature.","example":"2025 Subscription"},"zoomComplianceManagementSubscription":{"type":"string","description":"The [subscription](https://zoom.us/billing) ID or name for the Zoom Compliance Management plan. Ignore this field if your account doesn't include the Multiple Subscription Quoting feature.","example":"2025 Subscription"},"zoomDocsSubscription":{"type":"string","description":"The [subscription](https://zoom.us/billing) ID or name for the Zoom Docs plan. Ignore this field if your account doesn't include the Multiple Subscription Quoting feature.","example":"2025 Subscription"},"zoomAutoDialerSubscription":{"type":"string","description":"The [subscription](https://zoom.us/billing) ID or name for the Zoom Auto Dialer plan. Ignore this field if your account doesn't include the Multiple Subscription Quoting feature.","example":"2025 Subscription"},"zoomAICompanionSubscription":{"type":"string","description":"The [subscription](https://zoom.us/billing) ID or name for the Zoom AI Companion and Zoom Custom AI Companion plan. Ignore this field if your account doesn't include the Multiple Subscription Quoting feature.","example":"2025 Subscription"},"aiSalesAssistSubscription":{"type":"string","description":"The [subscription](https://zoom.us/billing) ID or name for the AI Sales Assist plan. Ignore this field if your account doesn't include the Multiple Subscription Quoting feature.","example":"2025 Subscription"},"cxInsightsSubscription":{"type":"string","description":"The [subscription](https://zoom.us/billing) ID or name for the CX Insights plan. Ignore this field if your account doesn't include the Multiple Subscription Quoting feature.","example":"2025 Subscription"},"zoomEnhancedMediaSubscription":{"type":"string","description":"The [subscription](https://zoom.us/billing) ID or name for the Zoom Enhanced Media. Ignore this field if your account doesn't include the Multiple Subscription Quoting feature.","example":"2025 Subscription"},"eduStandardStudentSubscription":{"type":"string","description":"The [subscription](https://zoom.us/billing) ID or name for the Education for Standard Student. Ignore this field if your account doesn't include the Multiple Subscription Quoting feature.","example":"2025 Subscription"},"workforceManagementRole":{"type":"string","description":"The Zoom Workforce Management role.","example":"Workforce Management Admin (Default)"},"qualityManagementRole":{"type":"string","description":"The Zoom Quality Management role.","example":"Quality Management Admin (Default)"},"zoomAIProductivitySuite":{"type":"string","description":"The plan option for the Zoom AI Productivity Suite.\n`16777216` - Zoom AI Productivity Suite.","example":"16777216","enum":["16777216"]},"zoomAIProductivitySuiteSubscription":{"type":"string","description":"The [subscription](https://zoom.us/billing) ID or name for the Zoom AI Productivity Suite plan. Ignore this field if your account doesn't include the Multiple Subscription Quoting feature.","example":"2025 Subscription"},"zoomComplianceManagementPlan":{"type":"string","description":"The Zoom Compliance Management plan option.\n* `none` — Turn off the Zoom Compliance Management feature.\n* `zcm` — Zoom Compliance Management.\n* `zcm_plus` — Zoom Compliance Management Plus.","example":"zcm","enum":["none","zcm","zcm_plus"]},"zoomCliniciansPlan":{"type":"string","description":"The Clinicians and Clinical Note plan option.\n* `none` — Turn off the Zoom Clinical Note feature.\n* `zm_clinical_note_essentials` — Zoom Clinical Note Essentials.\n* `zm_workplace_for_clinicians_unlimited` — Zoom Workplace for Clinicians Unlimited.\n* `zm_workplace_for_clinicians_consumption` — Zoom Workplace for Clinicians Pay Per Note.","example":"zm_workplace_for_clinicians_unlimited","enum":["none","zm_clinical_note_essentials","zm_workplace_for_clinicians_unlimited","zm_workplace_for_clinicians_consumption"]},"zoomWorkplace":{"type":"string","description":"The Zoom Workplace bundle plan option:\n* `none` - Turn off the Zoom Workplace feature.\n* `zoe` - Zoom Workplace Enterprise.\n* `zoep` - Zoom Workplace Enterprise Plus.\n* `zo_ent_essentials` - Zoom Workplace Enterprise Essentials.\n* `zobp_usca` - Zoom Workplace Business Plus with US/CA Unlimited.\n* `zobp_ukir` - Zoom Workplace Business Plus with UK/IR Unlimited.\n* `zobp_aunz` - Zoom Workplace Business Plus with AU/NZ Unlimited.\n* `zobp_jp` - Zoom Workplace Business Plus with Japan Unlimited.\n* `zobp_global` - Zoom Workplace Business Plus with Global Select.\n* `zoe_prem_usca` - Zoom Workplace Enterprise Premier with US/CA Unlimited.\n* `zoe_prem_jp` - Zoom Workplace Enterprise Premier with Japan Unlimited.\n* `zoe_prem_ukir` - Zoom Workplace Enterprise Premier with UK/IR Unlimited.\n* `zoe_prem_aunz` - Zoom Workplace Enterprise Premier with AU/NZ Unlimited.\n* `zopp_usca` - Zoom Workplace Pro Plus with US/CA Unlimited.\n* `zo_edu_sch_cmp` - Zoom Workplace for Education School and Campus.\n* `zo_edu_ent_essentials` - Zoom Workplace for Education Enterprise Essentials.\n* `zo_edu_ent_plus` - Zoom Workplace for Education Enterprise Plus.\n* `zo_edu_ent_hied_stu` - Zoom Workplace for Education Enterprise Student.\n* `zo_edu_std` - Zoom Workplace for Education Standard.\n* `zo_edu_sch_cmp_plus_usca` - Zoom Workplace for Education School and Campus Plus with US/CA Unlimited.\n* `zo_edu_sch_cmp_plus_jp` - Zoom Workplace for Education School and Campus Plus with Japan Unlimited.\n* `zo_edu_sch_cmp_plus_ukir` - Zoom Workplace for Education School and Campus Plus with UK/IR Unlimited.\n* `zo_edu_sch_cmp_plus_aunz` - Zoom Workplace for Education School and Campus Plus with AU/NZ Unlimited.\n* `zo_edu_sch_cmp_plus_global` - Zoom Workplace for Education School and Campus Plus with Global Select.\n* `zo_edu_ent_prem_usca` - Zoom Workplace for Education Enterprise Premier with US/CA Unlimited.\n* `zo_edu_ent_prem_jp` - Zoom Workplace for Education Enterprise Premier with Japan Unlimited.\n* `zo_edu_ent_prem_ukir` - Zoom Workplace for Education Enterprise Premier with UK/IR Unlimited.\n* `zo_edu_ent_prem_aunz` - Zoom Workplace for Education Enterprise Premier with AU/NZ Unlimited.\n* `zo_edu_ent_prem_global` - Zoom Workplace for Education Enterprise Premier with Global Select.","example":"zobp_usca","enum":["none","zoe","zoep","zo_ent_essentials","zobp_usca","zobp_ukir","zobp_aunz","zobp_jp","zobp_global","zoe_prem_usca","zoe_prem_jp","zoe_prem_ukir","zoe_prem_aunz","zopp_usca","zo_edu_sch_cmp","zo_edu_ent_essentials","zo_edu_ent_plus","zo_edu_ent_hied_stu","zo_edu_std","zo_edu_sch_cmp_plus_usca","zo_edu_sch_cmp_plus_jp","zo_edu_sch_cmp_plus_ukir","zo_edu_sch_cmp_plus_aunz","zo_edu_sch_cmp_plus_global","zo_edu_ent_prem_usca","zo_edu_ent_prem_jp","zo_edu_ent_prem_ukir","zo_edu_ent_prem_aunz","zo_edu_ent_prem_global"]}}}}}}}},"400":{"description":"**HTTP Status Code:** `400` <br>\n Bad Request  \n\n **Error Code:** `400` <br>\n Account has not enabled Single Sign-On. <br>\n**Error Code:** `400` <br>\n The request body must be in JSON format. <br>\n**Error Code:** `400` <br>\n The request JSON must not be empty. <br>\n**Error Code:** `400` <br>\n The \"userName\" of the request is invalid. <br>\n**Error Code:** `400` <br>\n The email \"{email}\" is already in use. <br>\n"},"403":{"description":"**HTTP Status Code:** `403` <br>\n Forbidden  \n\n **Error Code:** `403` <br>\n The request was denied due to insufficient permissions: \"User:Edit\". <br>\n"},"409":{"description":"**HTTP Status Code:** `409` <br>\n Conflict  \n\n **Error Code:** `409` <br>\n The email domain does not match the associated domain of the account, please contact Zoom Customer Support to set up if necessary. <br>\n**Error Code:** `409` <br>\n Cannot add paid users. <br>\n**Error Code:** `409` <br>\n The Zoom United Plan is invalid. <br>\n**Error Code:** `409` <br>\n Cannot create more users with Zoom United Plan. <br>\n**Error Code:** `409` <br>\n Cannot create more users with Zoom Workplace Business Plus. <br>\n**Error Code:** `409` <br>\n Cannot create more users with Zoom Workplace Enterprise Premier. <br>\n**Error Code:** `409` <br>\n Cannot create more users with Zoom Workplace for Education School and Campus Plus. <br>\n**Error Code:** `409` <br>\n Cannot create more users with Zoom Workplace for Education Enterprise Premier. <br>\n**Error Code:** `409` <br>\n Cannot create more users with Zoom Workplace for Education Enterprise Student. <br>\n**Error Code:** `409` <br>\n Cannot create more users with Zoom Workplace Pro Plus. <br>\n"},"429":{"description":"**HTTP Status Code:** `429` <br>\n Too Many Requests. For more information, see [rate limits](https://developers.zoom.us/docs/api/rest/rate-limits/). \n\n "}},"security":[{"openapi_oauth":["scim2","scim2:admin"],"openapi_authorization":[]}],"x-extensions":{"x-permissions":["User:Edit"],"x-macro-scopes":["scim2"],"x-granular-scopes":["scim2:admin"]}}},"/scim2/Users/{userId}":{"get":{"tags":["User"],"summary":"Get a user","description":"Returns information about a specific user.\n\n**[Scopes](https://developers.zoom.us/docs/integrations/oauth-scopes-overview/):** `scim2`\n\n**[Granular Scopes](https://developers.zoom.us/docs/integrations/oauth-scopes-overview/):** `scim2:admin`\n\n**[Rate Limit Label](https://marketplace.zoom.us/docs/api-reference/rate-limits#rate-limits):** `LIGHT`","operationId":"userSCIM2Get","parameters":[{"name":"userId","in":"path","description":"The user's Zoom ID.","required":true,"schema":{"type":"string","example":"k&KdKr6TLWuxdDtk0hjSzL"}}],"responses":{"200":{"description":"**HTTP Status Code:** `200` \n User information retrieved successfully.","content":{"application/json":{"schema":{"type":"object","properties":{"id":{"type":"string","description":"The user's unique identifier.","example":"k&KdKr6TLWuxdDtk0hjSzL"},"meta":{"type":"object","properties":{"resourceType":{"type":"string","description":"The resource type. Always `User` for user resources.","example":"User"},"location":{"type":"string","description":"The resource's URI in `https://api.zoom.us/scim2/Users/{userId}` format.","example":"https://api.zoom.us/scim2/Users/k&KdKr6TLWuxdDtk0hjSzL"},"version":{"type":"string","description":"The resource's version number.","example":"1.0.0"},"created":{"type":"string","description":"The timestamp when the user was created.","example":"2023-11-24T05:13:15Z"},"lastModified":{"type":"string","description":"The timestamp when the user was last modified.","example":"2023-11-25T06:23:17Z"}},"description":"The user's resource metadata."},"schemas":{"type":"array","description":"A list of schemas.","items":{"type":"string","example":"urn:ietf:params:scim:api:messages:2.0:ListResponse"}},"name":{"type":"object","properties":{"givenName":{"type":"string","description":"The user's first name.","example":"Jill"},"familyName":{"type":"string","description":"The user's last name.","example":"Chill"}},"description":"The user's name."},"emails":{"type":"array","description":"The user's email.","items":{"type":"object","properties":{"type":{"type":"string","description":"The email address label. For example, `work`.","example":"work","default":"work"},"value":{"type":"string","description":"The user's email address.","format":"email","example":"jchill@example.com"},"primary":{"type":"boolean","description":"Whether the email address is the user's primary email address.","example":true}}}},"displayName":{"type":"string","description":"The user's display name.","example":"Jill Chill"},"userName":{"type":"string","description":"The user's email address.","format":"email","example":"jchill@example.com"},"active":{"type":"boolean","description":"Whether the user is active.","example":true},"userType":{"type":"string","description":"Note: You can continue using this field, but it is planned for deprecation. No timeline has been set.\nThe user type: \n* `Collaboration` - Not supported with Microsoft Entra due to a Microsoft-specific limitation. It functions as expected with other identity providers (e.g., Okta), and through direct API calls.\n* `Basic` \n* `Licensed` \n* `On-Prem`","example":"On-Prem","deprecated":true,"enum":["Collaboration","Basic","Licensed","On-Prem"]},"phoneNumbers":{"type":"array","description":"A list of the user's assigned phone numbers.","items":{"type":"object","properties":{"type":{"type":"string","description":"The phone number's label: \n* `mobile` \n* `office` \n* `home` \n* `fax` \n* `work` \n\nThis value defaults to `work`.","example":"work","default":"work","enum":["mobile","office","home","fax","work"]},"value":{"type":"string","description":"The phone number.","example":"+015550100"}}}},"roles":{"type":"object","properties":{"display":{"type":"string","description":"The role's display name.","example":"Developer"},"value":{"type":"string","description":"The role name.","example":"Developer"},"primary":{"type":"boolean","description":"Whether the role is the user's primary role.","example":true}},"description":"The user's [role](https://support.zoom.com/hc/en/article?id=zm_kb&sysparm_article=KB0064983) information."},"groups":{"type":"object","properties":{"type":{"type":"string","description":"The group type.","example":"direct"},"value":{"type":"string","description":"The group name.","example":"Developers"},"display":{"type":"string","description":"The group's display name.","example":"Developers"}},"description":"The user's [groups](https://support.zoom.com/hc/en/article?id=zm_kb&sysparm_article=KB0062584) information."},"urn:ietf:params:scim:schemas:extension:enterprise:2.0:User":{"type":"object","properties":{"department":{"type":"string","description":"The user's department.","example":"Development"},"organization":{"type":"string","description":"The user's organization.","example":"Example"},"costCenter":{"type":"string","description":"The user's cost center.","example":"US01"},"employeeNumber":{"type":"string","description":"The user's employee identifier.","example":"123"},"manager":{"type":"string","description":"The email address of the user's manager.","format":"email","example":"thill@example.com"}},"description":"The user's enterprise extension attributes."},"urn:us:zoom:scim:schemas:extension:1.0:ZoomUser":{"type":"object","properties":{"loginType":{"type":"object","properties":{"workEmail":{"type":"boolean","description":"Whether login using a work email address is enabled.","example":true},"sso":{"type":"boolean","description":"Whether Single Sign-On (SSO) login is enabled.","example":true}},"description":"The user's login method information."}},"description":"The user's Zoom-specific extension attributes."},"urn:ietf:params:scim:schemas:extension:zoom:1.0:User":{"type":"object","properties":{"personalLinkName":{"type":"string","description":"The user's customized [personal link](https://support.zoom.com/hc/en/article?id=zm_kb&sysparm_article=KB0068443#h_08f381ef-1e88-417c-b014-a2b9ad4abbda).","example":"user001"},"transferee":{"type":"string","description":"The transferee is another user within the same account designated to receive the original user's data when that user is deactivated or deleted.","example":"transferee@example.com"},"pronouns":{"type":"string","description":"The user's pronouns.","example":"They/Them/Their"},"zoomUnited":{"type":"string","description":"The user's number of Zoom United licenses.","example":"16"},"zoomOneBizPlus":{"type":"string","description":"Zoom Workplace Business Plus.","example":"16","deprecated":true},"zoomOneEdu":{"type":"string","description":"Zoom One for Education Enterprise Student.","example":"576460752303423488","deprecated":true},"zoomOneSchoolCampusPlus":{"type":"string","description":"Zoom One for Education School and Campus Plus.","example":"137438953472","deprecated":true},"zoomOneEntPremier":{"type":"string","description":"Zoom Workplace Enterprise Premier.","example":"13421772","deprecated":true},"zoomOneEduEntPremier":{"type":"string","description":"Zoom One for Education Enterprise Premier.","example":"4294967296"},"zoomIQ":{"type":"boolean","description":"Whether the Zoom IQ Plan is enabled.","example":true,"deprecated":true},"zoomRevenueAccelerator":{"type":"boolean","description":"Whether the Zoom Revenue Accelerator Plan is enabled.","example":true},"zoomCustomerManagedKey":{"type":"boolean","description":"Whether the Zoom Customer Managed Key Plan is enabled.","example":true},"zoomWhiteboard":{"type":"boolean","description":"Whether the Zoom Whiteboard Plan is enabled.","example":true},"zoomWhiteboardPlus":{"type":"boolean","description":"Whether the Zoom Whiteboard Plus Plan is enabled.","example":true},"zoomTranslatedCaptions":{"type":"boolean","description":"Whether the Zoom Translated Captions Plan is enabled.","example":true},"zoomHuddles":{"type":"boolean","description":"Whether the Zoom Huddles Plan is enabled.","example":true,"deprecated":true},"zoomWorkforceManagement":{"type":"boolean","description":"Whether the Zoom Workforce Management Plan is enabled.","example":true},"zoomQualityManagement":{"type":"boolean","description":"Whether the Zoom Quality Management Plan is enabled.","example":true},"zoomScheduler":{"type":"boolean","description":"Whether the Zoom Scheduler Plan is enabled.","example":true},"zoomClipsPlus":{"type":"boolean","description":"Whether the Zoom Clips Plus Plan is enabled.","example":true},"zoomMailAndCalendar":{"type":"boolean","description":"Whether the Zoom Mail and Calendar Plan is enabled.","example":true},"visitorManagement":{"type":"boolean","description":"Whether the Zoom Visitor Management Plan is enabled.","example":true},"zoomComplianceManagement":{"type":"boolean","description":"Whether the Zoom Compliance Management Plan is enabled.","example":true,"deprecated":true},"zoomDocs":{"type":"boolean","description":"Whether the Zoom Docs Plan is enabled.","example":true},"zoomClinicians":{"type":"boolean","description":"Whether Zoom Workplace for Clinicians is enabled.","example":true,"deprecated":true},"zoomCustomAICompanion":{"type":"boolean","description":"Whether Zoom Custom AI Companion is enabled.","example":true},"zoomAICompanion":{"type":"boolean","description":"Zoom AI Companion.","example":true},"zoomAutoDialer":{"type":"string","description":"The plan option of Zoom Auto Dialer.\n* `1073741824` - Zoom Auto Dialer Plus US/Canada.\n* `-9223372036854775808` - Zoom Auto Dialer Plus Japan.\n* `2305843009213693952` - Zoom Auto Dialer Plus UK/IR.\n* `4611686018427387904` - Zoom Auto Dialer Plus AU/NZ.","example":"1073741824","enum":["1073741824","-9223372036854775808","2305843009213693952","4611686018427387904"]},"zoomFrontline":{"type":"string","description":"The plan option of Zoom Workplace for Frontline.\n`2048` - Zoom Workplace for Frontline.","example":"2048","enum":["2048"]},"cxInsights":{"type":"string","description":"The plan option of CX Insights.\n`1099511627776` - CX Insights Leader.","example":"1099511627776","enum":["1099511627776"]},"zoomEnhancedMedia":{"type":"string","description":"The plan option of Zoom Enhanced Media.\n`4503599627370496` - Zoom Enhanced Media.","example":"4503599627370496","enum":["4503599627370496"]},"aiSalesAssist":{"type":"string","description":"The plan option of AI Sales Assist.\n`128` - AI Sales Assist.","example":"128","enum":["128"]},"eduStandardStudent":{"type":"string","description":"The plan option of Education for Standard Student.\n`1152921504606846976` - Education for Standard Student.","example":"1152921504606846976","enum":["1152921504606846976"]},"zoomWorkplaceSubscription":{"type":"string","description":"The [subscription](https://zoom.us/billing) name for the Zoom Workplace license. Ignore this field if your account doesn't include the Multiple Subscription Quoting feature.","example":"2025 Subscription"},"zoomRevenueAcceleratorSubscription":{"type":"string","description":"The [subscription](https://zoom.us/billing) ID or name for the Zoom Revenue Accelerator plan. Ignore this field if your account doesn't include the Multiple Subscription Quoting feature.","example":"2025 Subscription"},"zoomCustomerManagedKeySubscription":{"type":"string","description":"The [subscription](https://zoom.us/billing) ID or name for the Zoom Customer Managed Key. Ignore this field if your account doesn't include the Multiple Subscription Quoting feature.","example":"2025 Subscription"},"zoomWhiteboardSubscription":{"type":"string","description":"The [subscription](https://zoom.us/billing) ID or name for the Zoom Whiteboard and Zoom Whiteboard Plus plan. Ignore this field if your account doesn't include the Multiple Subscription Quoting feature.","example":"2025 Subscription"},"zoomTranslatedCaptionsSubscription":{"type":"string","description":"The [subscription](https://zoom.us/billing) ID or name for the Zoom Translated Captions plan. Ignore this field if your account doesn't include the Multiple Subscription Quoting feature.","example":"2025 Subscription"},"zoomWorkforceManagementSubscription":{"type":"string","description":"The [subscription](https://zoom.us/billing) ID or name for the Zoom Workforce Management plan. Ignore this field if your account doesn't include the Multiple Subscription Quoting feature.","example":"2025 Subscription"},"zoomQualityManagementSubscription":{"type":"string","description":"The [subscription](https://zoom.us/billing) ID or name for the Zoom Quality Management plan. Ignore this field if your account doesn't include the Multiple Subscription Quoting feature.","example":"2025 Subscription"},"zoomSchedulerSubscription":{"type":"string","description":"The [subscription](https://zoom.us/billing) ID or name for the Zoom Scheduler plan. Ignore this field if your account doesn't include the Multiple Subscription Quoting feature.","example":"2025 Subscription"},"zoomClipsPlusSubscription":{"type":"string","description":"The [subscription](https://zoom.us/billing) ID or name for the Zoom Clips Plus plan. Ignore this field if your account doesn't include the Multiple Subscription Quoting feature.","example":"2025 Subscription"},"visitorManagementSubscription":{"type":"string","description":"The [subscription](https://zoom.us/billing) ID or name for the Visitor Management plan. Ignore this field if your account doesn't include the Multiple Subscription Quoting feature.","example":"2025 Subscription"},"zoomComplianceManagementSubscription":{"type":"string","description":"The [subscription](https://zoom.us/billing) ID or name for the Zoom Compliance Management plan. Ignore this field if your account doesn't include the Multiple Subscription Quoting feature.","example":"2025 Subscription"},"zoomDocsSubscription":{"type":"string","description":"The [subscription](https://zoom.us/billing) ID or name for the Zoom Docs plan. Ignore this field if your account doesn't include the Multiple Subscription Quoting feature.","example":"2025 Subscription"},"zoomAutoDialerSubscription":{"type":"string","description":"The [subscription](https://zoom.us/billing) ID or name for the Zoom Auto Dialer plan. Ignore this field if your account doesn't include the Multiple Subscription Quoting feature.","example":"2025 Subscription"},"zoomAICompanionSubscription":{"type":"string","description":"The [subscription](https://zoom.us/billing) ID or name for the Zoom AI Companion and Zoom Custom AI Companion plan. Ignore this field if your account doesn't include the Multiple Subscription Quoting feature.","example":"2025 Subscription"},"aiSalesAssistSubscription":{"type":"string","description":"The [subscription](https://zoom.us/billing) ID or name for the AI Sales Assist plan. Ignore this field if your account doesn't include the Multiple Subscription Quoting feature.","example":"2025 Subscription"},"cxInsightsSubscription":{"type":"string","description":"The [subscription](https://zoom.us/billing) ID or name for the CX Insights plan. Ignore this field if your account doesn't include the Multiple Subscription Quoting feature.","example":"2025 Subscription"},"zoomEnhancedMediaSubscription":{"type":"string","description":"The [subscription](https://zoom.us/billing) ID or name for the Zoom Enhanced Media. Ignore this field if your account doesn't include the Multiple Subscription Quoting feature.","example":"2025 Subscription"},"eduStandardStudentSubscription":{"type":"string","description":"The [subscription](https://zoom.us/billing) ID or name for the Education for Standard Student. Ignore this field if your account doesn't include the Multiple Subscription Quoting feature.","example":"2025 Subscription"},"workforceManagementRole":{"type":"string","description":"The Zoom Workforce Management role.","example":"Workforce Management Admin (Default)"},"zoomRevenueAcceleratorRole":{"type":"string","description":"The Zoom Revenue Accelerator role.","example":"Sales Manager"},"qualityManagementRole":{"type":"string","description":"The Zoom Quality Management role.","example":"Quality Management Admin (Default)"},"zoomAIProductivitySuite":{"type":"string","description":"The plan option for the Zoom AI Productivity Suite.\n`16777216` - Zoom AI Productivity Suite.","example":"16777216","enum":["16777216"]},"zoomAIProductivitySuiteSubscription":{"type":"string","description":"The [subscription](https://zoom.us/billing) ID or name for the Zoom AI Productivity Suite plan. Ignore this field if your account doesn't include the Multiple Subscription Quoting feature.","example":"2025 Subscription"},"zoomComplianceManagementPlan":{"type":"string","description":"The Zoom Compliance Management plan option.\n* `none` — Turn off the Zoom Compliance Management feature.\n* `zcm` — Zoom Compliance Management.\n* `zcm_plus` — Zoom Compliance Management Plus.","example":"zcm","enum":["none","zcm","zcm_plus"]},"zoomCliniciansPlan":{"type":"string","description":"The Clinicians and Clinical Note plan option.\n* `none` — Turn off the Zoom Clinical Note feature.\n* `zm_clinical_note_essentials` — Zoom Clinical Note Essentials.\n* `zm_workplace_for_clinicians_unlimited` — Zoom Workplace for Clinicians Unlimited.\n* `zm_workplace_for_clinicians_consumption` — Zoom Workplace for Clinicians Pay Per Note.","example":"zm_workplace_for_clinicians_unlimited","enum":["none","zm_clinical_note_essentials","zm_workplace_for_clinicians_unlimited","zm_workplace_for_clinicians_consumption"]},"zoomWorkplace":{"type":"string","description":"The Zoom Workplace bundle plan option:\n* `none` - Turn off the Zoom Workplace feature.\n* `zoe` - Zoom Workplace Enterprise.\n* `zoep` - Zoom Workplace Enterprise Plus.\n* `zo_ent_essentials` - Zoom Workplace Enterprise Essentials.\n* `zobp_usca` - Zoom Workplace Business Plus with US/CA Unlimited.\n* `zobp_ukir` - Zoom Workplace Business Plus with UK/IR Unlimited.\n* `zobp_aunz` - Zoom Workplace Business Plus with AU/NZ Unlimited.\n* `zobp_jp` - Zoom Workplace Business Plus with Japan Unlimited.\n* `zobp_global` - Zoom Workplace Business Plus with Global Select.\n* `zoe_prem_usca` - Zoom Workplace Enterprise Premier with US/CA Unlimited.\n* `zoe_prem_jp` - Zoom Workplace Enterprise Premier with Japan Unlimited.\n* `zoe_prem_ukir` - Zoom Workplace Enterprise Premier with UK/IR Unlimited.\n* `zoe_prem_aunz` - Zoom Workplace Enterprise Premier with AU/NZ Unlimited.\n* `zopp_usca` - Zoom Workplace Pro Plus with US/CA Unlimited.\n* `zo_edu_sch_cmp` - Zoom Workplace for Education School and Campus.\n* `zo_edu_ent_essentials` - Zoom Workplace for Education Enterprise Essentials.\n* `zo_edu_ent_plus` - Zoom Workplace for Education Enterprise Plus.\n* `zo_edu_ent_hied_stu` - Zoom Workplace for Education Enterprise Student.\n* `zo_edu_std` - Zoom Workplace for Education Standard.\n* `zo_edu_sch_cmp_plus_usca` - Zoom Workplace for Education School and Campus Plus with US/CA Unlimited.\n* `zo_edu_sch_cmp_plus_jp` - Zoom Workplace for Education School and Campus Plus with Japan Unlimited.\n* `zo_edu_sch_cmp_plus_ukir` - Zoom Workplace for Education School and Campus Plus with UK/IR Unlimited.\n* `zo_edu_sch_cmp_plus_aunz` - Zoom Workplace for Education School and Campus Plus with AU/NZ Unlimited.\n* `zo_edu_sch_cmp_plus_global` - Zoom Workplace for Education School and Campus Plus with Global Select.\n* `zo_edu_ent_prem_usca` - Zoom Workplace for Education Enterprise Premier with US/CA Unlimited.\n* `zo_edu_ent_prem_jp` - Zoom Workplace for Education Enterprise Premier with Japan Unlimited.\n* `zo_edu_ent_prem_ukir` - Zoom Workplace for Education Enterprise Premier with UK/IR Unlimited.\n* `zo_edu_ent_prem_aunz` - Zoom Workplace for Education Enterprise Premier with AU/NZ Unlimited.\n* `zo_edu_ent_prem_global` - Zoom Workplace for Education Enterprise Premier with Global Select.","example":"zobp_usca","enum":["none","zoe","zoep","zo_ent_essentials","zobp_usca","zobp_ukir","zobp_aunz","zobp_jp","zobp_global","zoe_prem_usca","zoe_prem_jp","zoe_prem_ukir","zoe_prem_aunz","zopp_usca","zo_edu_sch_cmp","zo_edu_ent_essentials","zo_edu_ent_plus","zo_edu_ent_hied_stu","zo_edu_std","zo_edu_sch_cmp_plus_usca","zo_edu_sch_cmp_plus_jp","zo_edu_sch_cmp_plus_ukir","zo_edu_sch_cmp_plus_aunz","zo_edu_sch_cmp_plus_global","zo_edu_ent_prem_usca","zo_edu_ent_prem_jp","zo_edu_ent_prem_ukir","zo_edu_ent_prem_aunz","zo_edu_ent_prem_global"]}},"description":"The user's Zoom extension attributes including licenses and subscription information."}}}}}},"400":{"description":"**HTTP Status Code:** `400` <br>\n Bad Request  \n\n **Error Code:** `400` <br>\n Account has not enabled Single Sign-On. <br>\n"},"403":{"description":"**HTTP Status Code:** `403` <br>\n Forbidden  \n\n **Error Code:** `403` <br>\n The request was denied due to insufficient permissions: \"User:Read\". <br>\n"},"404":{"description":"**HTTP Status Code:** `404` <br>\n Not Found  \n\n **Error Code:** `404` <br>\n User does not exist. <br>\n"},"429":{"description":"**HTTP Status Code:** `429` <br>\n Too Many Requests. For more information, see [rate limits](https://developers.zoom.us/docs/api/rate-limits/). \n\n "}},"security":[{"openapi_oauth":["scim2","scim2:admin"],"openapi_authorization":[]}],"x-extensions":{"x-permissions":["User:Read"],"x-macro-scopes":["scim2"],"x-granular-scopes":["scim2:admin"]}},"put":{"tags":["User"],"summary":"Update a user","description":"Updates a user's information.\n\n**[Scopes](https://developers.zoom.us/docs/integrations/oauth-scopes-overview/):** `scim2`\n\n**[Granular Scopes](https://developers.zoom.us/docs/integrations/oauth-scopes-overview/):** `scim2:admin`\n\n**[Rate Limit Label](https://marketplace.zoom.us/docs/api-reference/rate-limits#rate-limits):** `LIGHT`","operationId":"userSCIM2Update","parameters":[{"name":"userId","in":"path","description":"The user's Zoom ID.","required":true,"schema":{"type":"string","example":"k&KdKr6TLWuxdDtk0hjSzL"}}],"requestBody":{"description":"This schema displays a list of properties that you can update. When you make an update request, include **only** the parameters that you want to update and the `schemas` parameter in the request body.","content":{"application/json":{"schema":{"type":"object","properties":{"schemas":{"type":"array","description":"A list of schemas in `urn:ietf:params:scim:api:messages:2.0:{operation}` format.","items":{"type":"string","example":"urn:ietf:params:scim:api:messages:2.0:ListResponse"}},"active":{"type":"boolean","description":"Whether to activate the user: \n* `true` - Activate user. \n* `false` - Deactivate user.","example":true},"userType":{"type":"string","description":"Note: You can continue using this field, but it is planned for deprecation. No timeline has been set.\nThe user type: \n* `Collaboration` - Not supported with Microsoft Entra due to a Microsoft-specific limitation. It functions as expected with other identity providers (for example, Okta) and through direct API calls.\n* `Basic` \n* `Licensed` \n* `On-Prem`","example":"On-Prem","deprecated":true,"enum":["Collaboration","Basic","Licensed","On-Prem"]},"name":{"type":"object","properties":{"givenName":{"type":"string","description":"The user's first name.","example":"Jill"},"familyName":{"type":"string","description":"The user's last name.","example":"Chill"}},"description":"Information about the user's name."},"displayName":{"type":"string","description":"The user's display name. Note: Zoom does not update the display name if you update the first name or last name. You must send a new `displayName` if you change these values.","example":"Jill Chill"},"title":{"type":"string","description":"The user's job title.","example":"Developer"},"locale":{"type":"string","description":"The user's location.","example":"San Jose"},"phoneNumbers":{"type":"array","description":"A list of the user's assigned phone numbers.","items":{"type":"object","properties":{"type":{"type":"string","description":"The label of the phone number: `mobile`, `office`, `home`, or `fax`. If you do not provide a label, Zoom assigns the default label value of `work`.","example":"work","default":"work"},"value":{"type":"string","description":"The phone number.","example":"+015550100"}}}},"roles":{"type":"array","description":"The user's [role](https://support.zoom.com/hc/en/article?id=zm_kb&sysparm_article=KB0064983) information.","items":{"type":"object","properties":{"display":{"type":"string","description":"The role's display name.","example":"Developer"},"value":{"type":"string","description":"The role name.","example":"Developer"},"primary":{"type":"boolean","description":"Whether the role is the user's primary role.","example":true}}}},"groups":{"type":"array","description":"The user's [groups](https://support.zoom.com/hc/en/article?id=zm_kb&sysparm_article=KB0062584) information.","items":{"type":"object","properties":{"display":{"type":"string","description":"The group's display name.","example":"Developers"},"type":{"type":"string","description":"The group type. Defaults to `direct`.","example":"direct","default":"direct"},"value":{"type":"string","description":"The group name.","example":"Developers"},"primary":{"type":"boolean","description":"Whether the group is the user's primary group.","example":true,"deprecated":true}}}},"urn:ietf:params:scim:schemas:extension:enterprise:2.0:User":{"type":"object","properties":{"department":{"type":"string","description":"The user's department.","example":"Development"},"organization":{"type":"string","description":"The user's organization.","example":"Example"},"costCenter":{"type":"string","description":"The user's cost center.","example":"US01"},"employeeNumber":{"type":"string","description":"The user's employee ID.","example":"123"},"manager":{"type":"string","description":"The email address of the user's manager.","format":"email","example":"thill@example.com"}}},"urn:ietf:params:scim:schemas:extension:zoom:1.0:User":{"type":"object","properties":{"zoomPhoneExtNumber":{"type":"string","description":"The user's Zoom Phone extension number. To automatically assign an extension number, set this field's value to `0`.","example":"0"},"zoomPhoneNumber":{"type":"string","description":"The user's assigned Zoom Phone number. This value must be an unassigned number in the Zoom account.","example":"5550100"},"zoomPhoneSite":{"type":"string","description":"The Zoom Phone site to assign the user to. If you do not provide this value, Zoom assigns the user to the main site.","example":"main"},"zoomPhoneCallingPlan":{"type":"string","description":"The user's assigned [Zoom Phone calling plan number](/docs/api/references/billing-plans/#zoom-phone-calling-plans). To remove all calling plans, set the value of `zoomPhoneCallingPlan` to `-1`.","example":"phone_calling_usca_monthly_unlimited"},"{customAttribute}":{"maxItems":5,"type":"string","description":"A custom attribute and its value. This field returns the custom attribute's name. For example, `currentState` and the `California` value.","example":"\"Custom attribute name\" : \"custom attribute value\""},"personalLinkName":{"type":"string","description":"The user's customized [personal link](https://support.zoom.com/hc/en/article?id=zm_kb&sysparm_article=KB0068443#h_08f381ef-1e88-417c-b014-a2b9ad4abbda).","example":"customLinkName"},"transferee":{"type":"string","description":"The transferee is another user within the same account designated to receive the original user's data when that user is deactivated or deleted.","example":"transferee@example.com"},"pronouns":{"type":"string","description":"The user's pronouns.","example":"They/Them/Their"},"zoomUnited":{"type":"string","description":"The user's number of Zoom United licenses. Choose a license option: \n* `1` - Zoom United Pro-United with US/CA Unlimited. \n* `2` - Zoom United Pro-United with UK/IR Unlimited. \n* `4` - Zoom United Pro-United with AU/NZ Unlimited. \n* `8` - Zoom United Pro-United with Global Select. \n* `16` - Zoom United Pro-United with Zoom Phone Pro. \n* `32` - Zoom United Biz-United with US/CA Unlimited. \n* `64` - Zoom United Biz-United with UK/IR Unlimited. \n* `128` - Zoom United Biz-United with AU/NZ Unlimited. \n* `256` - Zoom United Biz-United with Global Select. \n* `512` - Zoom United Biz-United with Zoom Phone Pro. \n* `1024` - Zoom United Ent-United with US/CA Unlimited. \n* `2048` - Zoom United Ent-United with UK/IR Unlimited. \n* `4096` - Zoom United Ent-United with AU/NZ Unlimited. \n* `8192` - Zoom United Ent-United with Global Select. \n* `16384` - Zoom United Ent-United with Zoom Phone Pro. \n* `32768` - Zoom United Pro-United with JP Unlimited. \n* `65536` - Zoom United Biz-United with JP Unlimited. \n* `131072` - Zoom United Ent-United with JP Unlimited.","example":"16","enum":["1","2","4","8","16","32","64","128","256","512","1024","2048","4096","8192","16384","32768","65536","131072"]},"zoomOneBizPlus":{"type":"string","description":"The Zoom Workplace plan option. Choose from: \n* `16` - Zoom Workplace Business Plus with US/CA Unlimited. \n* `32` - Zoom Workplace Business Plus with UK/IR Unlimited. \n* `64` - Zoom Workplace Business Plus with AU/NZ Unlimited. \n* `128` - Zoom Workplace Business Plus with Japan Unlimited. \n* `33554432` - Zoom Workplace Business Plus with Global Select. \nThe Zoom One plan option for Gov accounts: \n* `16` - Zoom One Business Plus.","example":"16","deprecated":true,"enum":["16","32","64","128","33554432"]},"zoomOneEdu":{"type":"string","description":"Zoom One for Education Enterprise Student: \n* `576460752303423488` - Zoom One for Education Enterprise Student.","example":"576460752303423488","deprecated":true},"zoomOneSchoolCampusPlus":{"type":"string","description":"The Zoom One plan option: \n* `137438953472` - Zoom One for Education School and Campus Plus with US/CA Unlimited. \n* `274877906944` - Zoom One for Education School and Campus Plus with Japan Unlimited. \n* `549755813888` - Zoom One for Education School and Campus Plus with UK/Ireland Unlimited. \n* `1099511627776` - Zoom One for Education School and Campus Plus with AU/NZ Unlimited. \n* `2199023255552` - Zoom One for Education School and Campus Plus with Global Select.","example":"137438953472","deprecated":true,"enum":["137438953472","274877906944","549755813888","1099511627776","2199023255552"]},"zoomOneEntPremier":{"type":"string","description":"The Zoom One plan option: \n* `134217728` - Zoom One Enterprise Premier with US/CA Unlimited. \n* `268435456` - Zoom One Enterprise Premier with Japan Unlimited. \n* `536870912` - Zoom One Enterprise Premier with UK/Ireland Unlimited. \n* `1073741824` - Zoom One Enterprise Premier with AU/NZ Unlimited. \n* `2147483648` - Zoom One Enterprise Premier with Global Select.","example":"134217728","deprecated":true,"enum":["134217728","268435456","536870912","1073741824","2147483648"]},"zoomOneEduEntPremier":{"type":"string","description":"The Zoom One plan option: \n* `4294967296` - Zoom One for Education Enterprise Premier with US/CA Unlimited. \n* `8589934592` - Zoom One for Education Enterprise Premier with Japan Unlimited. \n* `17179869184` - Zoom One for Education Enterprise Premier with UK/Ireland Unlimited. \n* `34359738368` - Zoom One for Education Enterprise Premier with AU/NZ Unlimited. \n* `68719476736` - Zoom One for Education Enterprise Premier with Global Select.","example":"4294967296","deprecated":true,"enum":["4294967296","8589934592","17179869184","34359738368","68719476736"]},"zoomIQ":{"type":"boolean","description":"Zoom IQ Plan.","example":true,"deprecated":true},"zoomRevenueAccelerator":{"type":"boolean","description":"Zoom Revenue Accelerator Plan.","example":true},"zoomCustomerManagedKey":{"type":"boolean","description":"Zoom Customer Managed Key Plan.","example":true},"zoomWhiteboard":{"type":"boolean","description":"Zoom Whiteboard Plan.","example":true},"zoomWhiteboardPlus":{"type":"boolean","description":"Zoom Whiteboard Plus Plan.","example":true},"zoomTranslatedCaptions":{"type":"boolean","description":"Zoom Translated Captions Plan.","example":true},"zoomHuddles":{"type":"boolean","description":"Zoom Huddles Plan.","example":true,"deprecated":true},"zoomWorkforceManagement":{"type":"boolean","description":"Zoom Workforce Management Plan.","example":true},"zoomQualityManagement":{"type":"boolean","description":"Zoom Quality Management Plan.","example":true},"zoomScheduler":{"type":"boolean","description":"Zoom Scheduler Plan.","example":true},"zoomClipsPlus":{"type":"boolean","description":"Zoom Clips Plus Plan.","example":true},"zoomMailAndCalendar":{"type":"boolean","description":"Zoom Mail and Calendar Plan.","example":true},"visitorManagement":{"type":"boolean","description":"Zoom Visitor Management Plan.","example":true},"zoomComplianceManagement":{"type":"boolean","description":"Zoom Compliance Management Plan.","example":true,"deprecated":true},"zoomDocs":{"type":"boolean","description":"Zoom Docs Plan.","example":true},"zoomClinicians":{"type":"boolean","description":"Zoom Workplace for Clinicians.","example":true,"deprecated":true},"zoomCustomAICompanion":{"type":"boolean","description":"Zoom Custom AI Companion.","example":true},"zoomAICompanion":{"type":"boolean","description":"Zoom AI Companion.","example":true},"zoomContactCenterPackage":{"type":"string","description":"Zoom Contact Center Plan to assign to the user. An empty value will result in no changes. The package options: \n* `Essentials` - Zoom Contact Center Essentials Package. \n* `Premium` - Zoom Contact Center Premium Package. \n* `Elite` - Zoom Contact Center Elite Package.","example":"Essentials","enum":["Essentials","Premium","Elite"]},"zoomContactCenterAddonsPlan":{"type":"string","description":"Optional. The Zoom Contact Center add-on plans to assign to the user. Use a comma-separated list to assign multiple plans (e.g., `plan1,plan2`). If this field is empty, no changes will be applied. Available add-on packages:\n* `ai_expert_assist` — Zoom Contact Center AI Expert Assist package.\n* `service_cloud_voice` — Zoom Contact Center for Service Cloud Voice package.\n* `epic` — Zoom Contact Center for EPIC package.\n* `servicenow_unified_view` — Zoom Contact Center Unified View for ServiceNow package.","example":"ai_expert_assist","enum":["ai_expert_assist","service_cloud_voice","epic","servicenow_unified_view"]},"zoomContactCenterRole":{"type":"string","description":"The Zoom Contact Center role to update for the user. An empty value will result in no changes.","example":"Admin"},"zoomContactCenterRegion":{"type":"string","description":"The Zoom Contact Center region to assign to the user. An empty value will result in no changes.","example":"Main Region"},"zoomContactCenterUserTemplate":{"type":"string","description":"The Zoom Contact Center Update Template to apply to the user. You can only use update-type templates when updating users; add-type templates will be ignored. If you provide this value, leave all other fields blank to apply the settings from the template. Only the settings from the template indicated as 'override' will be applied to the user. If you specify both individual values and a template in the request, the individual values take priority over the template settings.","example":"Update Template"},"zoomRevenueAcceleratorRole":{"type":"string","description":"Zoom Revenue Accelerator role.","example":"Sales Manager"},"zoomAutoDialer":{"type":"string","description":"The plan option of Zoom Auto Dialer.\n* `1073741824` - Zoom Auto Dialer Plus US/Canada.\n* `-9223372036854775808` - Zoom Auto Dialer Plus Japan.\n* `2305843009213693952` - Zoom Auto Dialer Plus UK/IR.\n* `4611686018427387904` - Zoom Auto Dialer Plus AU/NZ.","example":"1073741824","enum":["1073741824","-9223372036854775808","2305843009213693952","4611686018427387904"]},"zoomFrontline":{"type":"string","description":"The plan option of Zoom Workplace for Frontline.\n`2048` - Zoom Workplace for Frontline.","example":"2048","enum":["2048"]},"cxInsights":{"type":"string","description":"The plan option of CX Insights.\n`1099511627776` - CX Insights Leader.","example":"1099511627776","enum":["1099511627776"]},"zoomEnhancedMedia":{"type":"string","description":"The plan option of Zoom Enhanced Media.\n`4503599627370496` - Zoom Enhanced Media.","example":"4503599627370496","enum":["4503599627370496"]},"aiSalesAssist":{"type":"string","description":"The plan option of AI Sales Assist.\n`128` - AI Sales Assist.","example":"128","enum":["128"]},"eduStandardStudent":{"type":"string","description":"The plan option of Education for Standard Student.\n`1152921504606846976` - Education for Standard Student.","example":"1152921504606846976","enum":["1152921504606846976"]},"zoomWorkplaceSubscription":{"type":"string","description":"The [subscription](https://zoom.us/billing) ID or name for the Zoom Workplace License. Ignore this field if your account doesn't enable the Multiple Subscription Quoting feature.","example":"2025 Subscription"},"zoomPhoneCallingPlanSubscription":{"type":"string","description":"The [subscription](https://zoom.us/billing) ID or name for the Zoom Phone calling plans. Ignore this field if your account doesn't enable the Multiple Subscription Quoting feature.","example":"2025 Subscription"},"zoomRevenueAcceleratorSubscription":{"type":"string","description":"The [subscription](https://zoom.us/billing) ID or name for the Zoom Revenue Accelerator plan. Ignore this field if your account doesn't include the Multiple Subscription Quoting feature.","example":"2025 Subscription"},"zoomCustomerManagedKeySubscription":{"type":"string","description":"The [subscription](https://zoom.us/billing) ID or name for the Zoom Customer Managed Key. Ignore this field if your account doesn't include the Multiple Subscription Quoting feature.","example":"2025 Subscription"},"zoomWhiteboardSubscription":{"type":"string","description":"The [subscription](https://zoom.us/billing) ID or name for the Zoom Whiteboard and Zoom Whiteboard Plus plan. Ignore this field if your account doesn't include the Multiple Subscription Quoting feature.","example":"2025 Subscription"},"zoomTranslatedCaptionsSubscription":{"type":"string","description":"The [subscription](https://zoom.us/billing) ID or name for the Zoom Translated Captions plan. Ignore this field if your account doesn't include the Multiple Subscription Quoting feature.","example":"2025 Subscription"},"zoomWorkforceManagementSubscription":{"type":"string","description":"The [subscription](https://zoom.us/billing) ID or name for the Zoom Workforce Management plan. Ignore this field if your account doesn't include the Multiple Subscription Quoting feature.","example":"2025 Subscription"},"zoomQualityManagementSubscription":{"type":"string","description":"The [subscription](https://zoom.us/billing) ID or name for the Zoom Quality Management plan. Ignore this field if your account doesn't include the Multiple Subscription Quoting feature.","example":"2025 Subscription"},"zoomSchedulerSubscription":{"type":"string","description":"The [subscription](https://zoom.us/billing) ID or name for the Zoom Scheduler plan. Ignore this field if your account doesn't include the Multiple Subscription Quoting feature.","example":"2025 Subscription"},"zoomClipsPlusSubscription":{"type":"string","description":"The [subscription](https://zoom.us/billing) ID or name for the Zoom Clips Plus plan. Ignore this field if your account doesn't include the Multiple Subscription Quoting feature.","example":"2025 Subscription"},"visitorManagementSubscription":{"type":"string","description":"The [subscription](https://zoom.us/billing) ID or name for the Visitor Management plan. Ignore this field if your account doesn't include the Multiple Subscription Quoting feature.","example":"2025 Subscription"},"zoomComplianceManagementSubscription":{"type":"string","description":"The [subscription](https://zoom.us/billing) ID or name for the Zoom Compliance Management plan. Ignore this field if your account doesn't include the Multiple Subscription Quoting feature.","example":"2025 Subscription"},"zoomDocsSubscription":{"type":"string","description":"The [subscription](https://zoom.us/billing) ID or name for the Zoom Docs plan. Ignore this field if your account doesn't include the Multiple Subscription Quoting feature.","example":"2025 Subscription"},"zoomAutoDialerSubscription":{"type":"string","description":"The [subscription](https://zoom.us/billing) ID or name for the Zoom Auto Dialer plan. Ignore this field if your account doesn't include the Multiple Subscription Quoting feature.","example":"2025 Subscription"},"zoomAICompanionSubscription":{"type":"string","description":"The [subscription](https://zoom.us/billing) ID or name for the Zoom AI Companion and Zoom Custom AI Companion plan. Ignore this field if your account doesn't include the Multiple Subscription Quoting feature.","example":"2025 Subscription"},"aiSalesAssistSubscription":{"type":"string","description":"The [subscription](https://zoom.us/billing) ID or name for the AI Sales Assist plan. Ignore this field if your account doesn't include the Multiple Subscription Quoting feature.","example":"2025 Subscription"},"cxInsightsSubscription":{"type":"string","description":"The [subscription](https://zoom.us/billing) ID or name for the CX Insights plan. Ignore this field if your account doesn't include the Multiple Subscription Quoting feature.","example":"2025 Subscription"},"zoomEnhancedMediaSubscription":{"type":"string","description":"The [subscription](https://zoom.us/billing) ID or name for the Zoom Enhanced Media. Ignore this field if your account doesn't include the Multiple Subscription Quoting feature.","example":"2025 Subscription"},"eduStandardStudentSubscription":{"type":"string","description":"The [subscription](https://zoom.us/billing) ID or name for the Education for Standard Student. Ignore this field if your account doesn't include the Multiple Subscription Quoting feature.","example":"2025 Subscription"},"zoomRevenueAcceleratorSegment":{"type":"string","description":"Zoom Revenue Accelerator Segment.","example":"Sales"},"zoomRevenueAcceleratorRegion":{"type":"string","description":"Zoom Revenue Accelerator Region.","example":"US"},"workforceManagementRole":{"type":"string","description":"The Zoom Workforce Management role.","example":"Workforce Management Admin (Default)"},"qualityManagementRole":{"type":"string","description":"The Zoom Quality Management role.","example":"Quality Management Admin (Default)"},"zoomAIProductivitySuite":{"type":"string","description":"The plan option for the Zoom AI Productivity Suite.\n`16777216` - Zoom AI Productivity Suite.","example":"16777216","enum":["16777216"]},"zoomAIProductivitySuiteSubscription":{"type":"string","description":"The [subscription](https://zoom.us/billing) ID or name for the Zoom AI Productivity Suite plan. Ignore this field if your account doesn't include the Multiple Subscription Quoting feature.","example":"2025 Subscription"},"zoomComplianceManagementPlan":{"type":"string","description":"The Zoom Compliance Management plan option.\n* `none` — Turn off the Zoom Compliance Management feature.\n* `zcm` — Zoom Compliance Management.\n* `zcm_plus` — Zoom Compliance Management Plus.","example":"zcm","enum":["none","zcm","zcm_plus"]},"zoomCliniciansPlan":{"type":"string","description":"The Clinicians and Clinical Note plan option.\n* `none` — Turn off the Zoom Clinical Note feature.\n* `zm_clinical_note_essentials` — Zoom Clinical Note Essentials.\n* `zm_workplace_for_clinicians_unlimited` — Zoom Workplace for Clinicians Unlimited.\n* `zm_workplace_for_clinicians_consumption` — Zoom Workplace for Clinicians Pay Per Note.","example":"zm_workplace_for_clinicians_unlimited","enum":["none","zm_clinical_note_essentials","zm_workplace_for_clinicians_unlimited","zm_workplace_for_clinicians_consumption"]},"zoomWorkplace":{"type":"string","description":"The Zoom Workplace bundle plan option:\n* `none` - Turn off the Zoom Workplace feature.\n* `zoe` - Zoom Workplace Enterprise.\n* `zoep` - Zoom Workplace Enterprise Plus.\n* `zo_ent_essentials` - Zoom Workplace Enterprise Essentials.\n* `zobp_usca` - Zoom Workplace Business Plus with US/CA Unlimited.\n* `zobp_ukir` - Zoom Workplace Business Plus with UK/IR Unlimited.\n* `zobp_aunz` - Zoom Workplace Business Plus with AU/NZ Unlimited.\n* `zobp_jp` - Zoom Workplace Business Plus with Japan Unlimited.\n* `zobp_global` - Zoom Workplace Business Plus with Global Select.\n* `zoe_prem_usca` - Zoom Workplace Enterprise Premier with US/CA Unlimited.\n* `zoe_prem_jp` - Zoom Workplace Enterprise Premier with Japan Unlimited.\n* `zoe_prem_ukir` - Zoom Workplace Enterprise Premier with UK/IR Unlimited.\n* `zoe_prem_aunz` - Zoom Workplace Enterprise Premier with AU/NZ Unlimited.\n* `zopp_usca` - Zoom Workplace Pro Plus with US/CA Unlimited.\n* `zo_edu_sch_cmp` - Zoom Workplace for Education School and Campus.\n* `zo_edu_ent_essentials` - Zoom Workplace for Education Enterprise Essentials.\n* `zo_edu_ent_plus` - Zoom Workplace for Education Enterprise Plus.\n* `zo_edu_ent_hied_stu` - Zoom Workplace for Education Enterprise Student.\n* `zo_edu_std` - Zoom Workplace for Education Standard.\n* `zo_edu_sch_cmp_plus_usca` - Zoom Workplace for Education School and Campus Plus with US/CA Unlimited.\n* `zo_edu_sch_cmp_plus_jp` - Zoom Workplace for Education School and Campus Plus with Japan Unlimited.\n* `zo_edu_sch_cmp_plus_ukir` - Zoom Workplace for Education School and Campus Plus with UK/IR Unlimited.\n* `zo_edu_sch_cmp_plus_aunz` - Zoom Workplace for Education School and Campus Plus with AU/NZ Unlimited.\n* `zo_edu_sch_cmp_plus_global` - Zoom Workplace for Education School and Campus Plus with Global Select.\n* `zo_edu_ent_prem_usca` - Zoom Workplace for Education Enterprise Premier with US/CA Unlimited.\n* `zo_edu_ent_prem_jp` - Zoom Workplace for Education Enterprise Premier with Japan Unlimited.\n* `zo_edu_ent_prem_ukir` - Zoom Workplace for Education Enterprise Premier with UK/IR Unlimited.\n* `zo_edu_ent_prem_aunz` - Zoom Workplace for Education Enterprise Premier with AU/NZ Unlimited.\n* `zo_edu_ent_prem_global` - Zoom Workplace for Education Enterprise Premier with Global Select.","example":"zobp_usca","enum":["none","zoe","zoep","zo_ent_essentials","zobp_usca","zobp_ukir","zobp_aunz","zobp_jp","zobp_global","zoe_prem_usca","zoe_prem_jp","zoe_prem_ukir","zoe_prem_aunz","zopp_usca","zo_edu_sch_cmp","zo_edu_ent_essentials","zo_edu_ent_plus","zo_edu_ent_hied_stu","zo_edu_std","zo_edu_sch_cmp_plus_usca","zo_edu_sch_cmp_plus_jp","zo_edu_sch_cmp_plus_ukir","zo_edu_sch_cmp_plus_aunz","zo_edu_sch_cmp_plus_global","zo_edu_ent_prem_usca","zo_edu_ent_prem_jp","zo_edu_ent_prem_ukir","zo_edu_ent_prem_aunz","zo_edu_ent_prem_global"]}}},"emails":{"maxItems":1,"type":"array","description":"The user's email information.","items":{"type":"object","properties":{"type":{"type":"string","description":"The email address label, such as `work`.","example":"work","default":"work"},"value":{"type":"string","description":"The user's email address.","format":"email","example":"jchill@example.com"},"primary":{"type":"boolean","description":"Whether the email address is the user's primary email address.","example":true}}}}}}}}},"responses":{"200":{"description":"**HTTP Status Code:** `200` \n User updated.","content":{"application/json":{"schema":{"type":"object","properties":{"id":{"type":"string","description":"The user's ID.","example":"k&KdKr6TLWuxdDtk0hjSzL"},"meta":{"type":"object","properties":{"resourceType":{"type":"string","description":"The resource type. The value is always `User` for the User resource type.","example":"User"},"location":{"type":"string","description":"The resource's URI in the `https://api.zoom.us/scim2/Users/{userId}` format.","example":"https://api.zoom.us/scim2/Users/k&KdKr6TLWuxdDtk0hjSzL"},"version":{"type":"string","description":"The resource's version number.","example":"1.0.0"},"created":{"type":"string","description":"The user's creation time.","example":"2023-11-24T05:13:15Z"},"lastModified":{"type":"string","description":"The user's last modification time.","example":"2023-11-24T05:13:15Z"}},"description":"The user's resource metadata."},"schemas":{"type":"array","description":"A list of schemas.","items":{"type":"string","example":"urn:ietf:params:scim:api:messages:2.0:ListResponse"}},"name":{"type":"object","properties":{"givenName":{"type":"string","description":"The user's first name.","example":"Jill"},"familyName":{"type":"string","description":"The user's last name.","example":"Chill"}},"description":"Information about the user's name."},"emails":{"type":"array","description":"The user's email information.","items":{"type":"object","properties":{"type":{"type":"string","description":"The email address label. For example, `work`.","example":"work"},"value":{"type":"string","description":"The user's email address.","format":"email","example":"jchill@example.com"},"primary":{"type":"boolean","description":"Whether the email address is the user's primary email address.","example":true}}}},"displayName":{"type":"string","description":"The user's display name.","example":"Jill Chill"},"userName":{"type":"string","description":"The user's email address.","format":"email","example":"jchill@example.com"},"active":{"type":"boolean","description":"Whether the user is active.","example":true},"userType":{"type":"string","description":"Note: You can continue using this field, but it is planned for deprecation. No timeline has been set.\nThe user type: \n* `Collaboration` - Not supported with Microsoft Entra due to a Microsoft-specific limitation. It functions as expected with other identity providers (e.g., Okta), and through direct API calls.\n* `Basic` \n* `Licensed` \n* `On-Prem`","example":"On-Prem","deprecated":true,"enum":["Collaboration","Basic","Licensed","On-Prem"]},"title":{"type":"string","description":"The user's job title.","example":"Developer"},"locale":{"type":"string","description":"The user's location.","example":"San Jose"},"phoneNumbers":{"type":"array","description":"A list of the user's assigned phone numbers.","items":{"type":"object","properties":{"type":{"type":"string","description":"The phone number's label: \n* `mobile` \n* `office` \n* `home` \n* `fax` \n* `work` \n\nDefaults to `work`.","example":"work","enum":["mobile","office","home","fax","work"]},"value":{"type":"string","description":"The phone number.","example":"+015550100"}}}},"roles":{"type":"array","description":"The user's [role](https://support.zoom.com/hc/en/article?id=zm_kb&sysparm_article=KB0064983) information.","items":{"type":"object","properties":{"display":{"type":"string","description":"The role's display name.","example":"Developer"},"value":{"type":"string","description":"The role name.","example":"Developer"},"primary":{"type":"boolean","description":"Whether the role is the user's primary role.","example":true}}}},"groups":{"type":"array","items":{"type":"object","properties":{"display":{"type":"string","description":"The group's display name.","example":"Developers"},"type":{"type":"string","description":"The group type.","example":"direct"},"value":{"type":"string","description":"The group name.","example":"Developers"},"primary":{"type":"boolean","description":"Whether the group is the user's primary group.","example":true,"deprecated":true}}}},"urn:ietf:params:scim:schemas:extension:enterprise:2.0:User":{"type":"object","properties":{"department":{"type":"string","description":"The user's department.","example":"Development"},"organization":{"type":"string","description":"The user's organization.","example":"Example"}}},"urn:ietf:params:scim:schemas:extension:zoom:1.0:User":{"type":"object","properties":{"{customAttribute}":{"maxItems":5,"type":"string","description":"A custom attribute and its value. This field returns the custom attribute's name. For example, `currentState` and the `California` value.","example":"\"Custom attribute name\" : \"custom attribute value\""},"personalLinkName":{"type":"string","description":"The user's customized [personal link](https://support.zoom.com/hc/en/article?id=zm_kb&sysparm_article=KB0068443#h_08f381ef-1e88-417c-b014-a2b9ad4abbda).","example":"user001"},"transferee":{"type":"string","description":"The transferee is another user within the same account designated to receive the original user's data when that user is deactivated or deleted.","example":"transferee@example.com"},"pronouns":{"type":"string","description":"The user's pronouns.","example":"They/Them/Their"},"zoomUnited":{"type":"string","description":"The user's number of [Zoom United licenses](https://zoom.us/pricing/zoom-bundles).","example":"16"},"zoomOneBizPlus":{"type":"string","description":"Zoom One Business Plus.","example":"16","deprecated":true},"zoomOneEdu":{"type":"string","description":"Zoom One for Education Enterprise Student.","example":"576460752303423488","deprecated":true},"zoomOneSchoolCampusPlus":{"type":"string","description":"Zoom One for Education School and Campus Plus.","example":"137438953472","deprecated":true},"zoomOneEntPremier":{"type":"string","description":"Zoom One Enterprise Premier.","example":"13421772","deprecated":true},"zoomOneEduEntPremier":{"type":"string","description":"Zoom One for Education Enterprise Premier.","example":"4294967296","deprecated":true},"zoomIQ":{"type":"boolean","description":"Zoom IQ Plan.","example":true,"deprecated":true},"zoomRevenueAccelerator":{"type":"boolean","description":"Zoom Revenue Accelerator Plan.","example":true},"zoomCustomerManagedKey":{"type":"boolean","description":"Zoom Customer Managed Key Plan.","example":true},"zoomWhiteboard":{"type":"boolean","description":"Zoom Whiteboard Plan.","example":true},"zoomWhiteboardPlus":{"type":"boolean","description":"Zoom Whiteboard Plus Plan.","example":true},"zoomTranslatedCaptions":{"type":"boolean","description":"Zoom Translated Captions Plan.","example":true},"zoomHuddles":{"type":"boolean","description":"Zoom Huddles Plan.","example":true,"deprecated":true},"zoomWorkforceManagement":{"type":"boolean","description":"Zoom Workforce Management Plan.","example":true},"zoomQualityManagement":{"type":"boolean","description":"Zoom Quality Management Plan.","example":true},"zoomScheduler":{"type":"boolean","description":"Zoom Scheduler Plan.","example":true},"zoomClipsPlus":{"type":"boolean","description":"Zoom Clips Plus Plan.","example":true},"zoomComplianceManagement":{"type":"boolean","description":"Zoom Compliance Management Plan.","example":true,"deprecated":true},"zoomDocs":{"type":"boolean","description":"Zoom Docs Plan.","example":true},"zoomClinicians":{"type":"boolean","description":"Zoom Workplace for Clinicians.","example":true,"deprecated":true},"zoomCustomAICompanion":{"type":"boolean","description":"Zoom Custom AI Companion.","example":true},"zoomRevenueAcceleratorRole":{"type":"string","description":"Zoom Revenue Accelerator Role.","example":"Sales Manager"},"zoomAutoDialer":{"type":"string","description":"The plan option of Zoom Auto Dialer.\n* `1073741824` - Zoom Auto Dialer Plus US/Canada.\n* `-9223372036854775808` - Zoom Auto Dialer Plus Japan.\n* `2305843009213693952` - Zoom Auto Dialer Plus UK/IR.\n* `4611686018427387904` - Zoom Auto Dialer Plus AU/NZ.","example":"1073741824","enum":["1073741824","-9223372036854775808","2305843009213693952","4611686018427387904"]},"zoomFrontline":{"type":"string","description":"The plan option of Zoom Workplace for Frontline.\n`2048` - Zoom Workplace for Frontline.","example":"2048","enum":["2048"]},"cxInsights":{"type":"string","description":"The plan option of CX Insights.\n`1099511627776` - CX Insights Leader.","example":"1099511627776","enum":["1099511627776"]},"zoomEnhancedMedia":{"type":"string","description":"The plan option of Zoom Enhanced Media.\n`4503599627370496` - Zoom Enhanced Media.","example":"4503599627370496","enum":["4503599627370496"]},"aiSalesAssist":{"type":"string","description":"The plan option of AI Sales Assist.\n`128` - AI Sales Assist.","example":"128","enum":["128"]},"eduStandardStudent":{"type":"string","description":"The plan option of Education for Standard Student.\n`1152921504606846976` - Education for Standard Student.","example":"1152921504606846976","enum":["1152921504606846976"]},"zoomWorkplaceSubscription":{"type":"string","description":"The [subscription](https://zoom.us/billing) name for the Zoom Workplace License. Ignore this field if your account doesn't enable the Multiple Subscription Quoting feature.","example":"2025 Subscription"},"zoomRevenueAcceleratorSubscription":{"type":"string","description":"The [subscription](https://zoom.us/billing) ID or name for the Zoom Revenue Accelerator plan. Ignore this field if your account doesn't include the Multiple Subscription Quoting feature.","example":"2025 Subscription"},"zoomCustomerManagedKeySubscription":{"type":"string","description":"The [subscription](https://zoom.us/billing) ID or name for the Zoom Customer Managed Key. Ignore this field if your account doesn't include the Multiple Subscription Quoting feature.","example":"2025 Subscription"},"zoomWhiteboardSubscription":{"type":"string","description":"The [subscription](https://zoom.us/billing) ID or name for the Zoom Whiteboard and Zoom Whiteboard Plus plan. Ignore this field if your account doesn't include the Multiple Subscription Quoting feature.","example":"2025 Subscription"},"zoomTranslatedCaptionsSubscription":{"type":"string","description":"The [subscription](https://zoom.us/billing) ID or name for the Zoom Translated Captions plan. Ignore this field if your account doesn't include the Multiple Subscription Quoting feature.","example":"2025 Subscription"},"zoomWorkforceManagementSubscription":{"type":"string","description":"The [subscription](https://zoom.us/billing) ID or name for the Zoom Workforce Management plan. Ignore this field if your account doesn't include the Multiple Subscription Quoting feature.","example":"2025 Subscription"},"zoomQualityManagementSubscription":{"type":"string","description":"The [subscription](https://zoom.us/billing) ID or name for the Zoom Quality Management plan. Ignore this field if your account doesn't include the Multiple Subscription Quoting feature.","example":"2025 Subscription"},"zoomSchedulerSubscription":{"type":"string","description":"The [subscription](https://zoom.us/billing) ID or name for the Zoom Scheduler plan. Ignore this field if your account doesn't include the Multiple Subscription Quoting feature.","example":"2025 Subscription"},"zoomClipsPlusSubscription":{"type":"string","description":"The [subscription](https://zoom.us/billing) ID or name for the Zoom Clips Plus plan. Ignore this field if your account doesn't include the Multiple Subscription Quoting feature.","example":"2025 Subscription"},"visitorManagementSubscription":{"type":"string","description":"The [subscription](https://zoom.us/billing) ID or name for the Visitor Management plan. Ignore this field if your account doesn't include the Multiple Subscription Quoting feature.","example":"2025 Subscription"},"zoomComplianceManagementSubscription":{"type":"string","description":"The [subscription](https://zoom.us/billing) ID or name for the Zoom Compliance Management plan. Ignore this field if your account doesn't include the Multiple Subscription Quoting feature.","example":"2025 Subscription"},"zoomDocsSubscription":{"type":"string","description":"The [subscription](https://zoom.us/billing) ID or name for the Zoom Docs plan. Ignore this field if your account doesn't include the Multiple Subscription Quoting feature.","example":"2025 Subscription"},"zoomAutoDialerSubscription":{"type":"string","description":"The [subscription](https://zoom.us/billing) ID or name for the Zoom Auto Dialer plan. Ignore this field if your account doesn't include the Multiple Subscription Quoting feature.","example":"2025 Subscription"},"zoomAICompanionSubscription":{"type":"string","description":"The [subscription](https://zoom.us/billing) ID or name for the Zoom AI Companion and Zoom Custom AI Companion plan. Ignore this field if your account doesn't include the Multiple Subscription Quoting feature.","example":"2025 Subscription"},"aiSalesAssistSubscription":{"type":"string","description":"The [subscription](https://zoom.us/billing) ID or name for the AI Sales Assist plan. Ignore this field if your account doesn't include the Multiple Subscription Quoting feature.","example":"2025 Subscription"},"cxInsightsSubscription":{"type":"string","description":"The [subscription](https://zoom.us/billing) ID or name for the CX Insights plan. Ignore this field if your account doesn't include the Multiple Subscription Quoting feature.","example":"2025 Subscription"},"zoomEnhancedMediaSubscription":{"type":"string","description":"The [subscription](https://zoom.us/billing) ID or name for the Zoom Enhanced Media. Ignore this field if your account doesn't include the Multiple Subscription Quoting feature.","example":"2025 Subscription"},"eduStandardStudentSubscription":{"type":"string","description":"The [subscription](https://zoom.us/billing) ID or name for the Education for Standard Student. Ignore this field if your account doesn't include the Multiple Subscription Quoting feature.","example":"2025 Subscription"},"workforceManagementRole":{"type":"string","description":"The Zoom Workforce Management role.","example":"Workforce Management Admin (Default)"},"qualityManagementRole":{"type":"string","description":"The Zoom Quality Management role.","example":"Quality Management Admin (Default)"},"zoomAIProductivitySuite":{"type":"string","description":"The plan option for the Zoom AI Productivity Suite.\n`16777216` - Zoom AI Productivity Suite.","example":"16777216","enum":["16777216"]},"zoomAIProductivitySuiteSubscription":{"type":"string","description":"The [subscription](https://zoom.us/billing) ID or name for the Zoom AI Productivity Suite plan. Ignore this field if your account doesn't include the Multiple Subscription Quoting feature.","example":"2025 Subscription"},"zoomComplianceManagementPlan":{"type":"string","description":"The Zoom Compliance Management plan option.\n* `none` — Turn off the Zoom Compliance Management feature.\n* `zcm` — Zoom Compliance Management.\n* `zcm_plus` — Zoom Compliance Management Plus.","example":"zcm","enum":["none","zcm","zcm_plus"]},"zoomCliniciansPlan":{"type":"string","description":"The Clinicians and Clinical Note plan option.\n* `none` — Turn off the Zoom Clinical Note feature.\n* `zm_clinical_note_essentials` — Zoom Clinical Note Essentials.\n* `zm_workplace_for_clinicians_unlimited` — Zoom Workplace for Clinicians Unlimited.\n* `zm_workplace_for_clinicians_consumption` — Zoom Workplace for Clinicians Pay Per Note.","example":"zm_workplace_for_clinicians_unlimited","enum":["none","zm_clinical_note_essentials","zm_workplace_for_clinicians_unlimited","zm_workplace_for_clinicians_consumption"]},"zoomWorkplace":{"type":"string","description":"The Zoom Workplace bundle plan option:\n* `none` - Turn off the Zoom Workplace feature.\n* `zoe` - Zoom Workplace Enterprise.\n* `zoep` - Zoom Workplace Enterprise Plus.\n* `zo_ent_essentials` - Zoom Workplace Enterprise Essentials.\n* `zobp_usca` - Zoom Workplace Business Plus with US/CA Unlimited.\n* `zobp_ukir` - Zoom Workplace Business Plus with UK/IR Unlimited.\n* `zobp_aunz` - Zoom Workplace Business Plus with AU/NZ Unlimited.\n* `zobp_jp` - Zoom Workplace Business Plus with Japan Unlimited.\n* `zobp_global` - Zoom Workplace Business Plus with Global Select.\n* `zoe_prem_usca` - Zoom Workplace Enterprise Premier with US/CA Unlimited.\n* `zoe_prem_jp` - Zoom Workplace Enterprise Premier with Japan Unlimited.\n* `zoe_prem_ukir` - Zoom Workplace Enterprise Premier with UK/IR Unlimited.\n* `zoe_prem_aunz` - Zoom Workplace Enterprise Premier with AU/NZ Unlimited.\n* `zopp_usca` - Zoom Workplace Pro Plus with US/CA Unlimited.\n* `zo_edu_sch_cmp` - Zoom Workplace for Education School and Campus.\n* `zo_edu_ent_essentials` - Zoom Workplace for Education Enterprise Essentials.\n* `zo_edu_ent_plus` - Zoom Workplace for Education Enterprise Plus.\n* `zo_edu_ent_hied_stu` - Zoom Workplace for Education Enterprise Student.\n* `zo_edu_std` - Zoom Workplace for Education Standard.\n* `zo_edu_sch_cmp_plus_usca` - Zoom Workplace for Education School and Campus Plus with US/CA Unlimited.\n* `zo_edu_sch_cmp_plus_jp` - Zoom Workplace for Education School and Campus Plus with Japan Unlimited.\n* `zo_edu_sch_cmp_plus_ukir` - Zoom Workplace for Education School and Campus Plus with UK/IR Unlimited.\n* `zo_edu_sch_cmp_plus_aunz` - Zoom Workplace for Education School and Campus Plus with AU/NZ Unlimited.\n* `zo_edu_sch_cmp_plus_global` - Zoom Workplace for Education School and Campus Plus with Global Select.\n* `zo_edu_ent_prem_usca` - Zoom Workplace for Education Enterprise Premier with US/CA Unlimited.\n* `zo_edu_ent_prem_jp` - Zoom Workplace for Education Enterprise Premier with Japan Unlimited.\n* `zo_edu_ent_prem_ukir` - Zoom Workplace for Education Enterprise Premier with UK/IR Unlimited.\n* `zo_edu_ent_prem_aunz` - Zoom Workplace for Education Enterprise Premier with AU/NZ Unlimited.\n* `zo_edu_ent_prem_global` - Zoom Workplace for Education Enterprise Premier with Global Select.","example":"zobp_usca","enum":["none","zoe","zoep","zo_ent_essentials","zobp_usca","zobp_ukir","zobp_aunz","zobp_jp","zobp_global","zoe_prem_usca","zoe_prem_jp","zoe_prem_ukir","zoe_prem_aunz","zopp_usca","zo_edu_sch_cmp","zo_edu_ent_essentials","zo_edu_ent_plus","zo_edu_ent_hied_stu","zo_edu_std","zo_edu_sch_cmp_plus_usca","zo_edu_sch_cmp_plus_jp","zo_edu_sch_cmp_plus_ukir","zo_edu_sch_cmp_plus_aunz","zo_edu_sch_cmp_plus_global","zo_edu_ent_prem_usca","zo_edu_ent_prem_jp","zo_edu_ent_prem_ukir","zo_edu_ent_prem_aunz","zo_edu_ent_prem_global"]}}}}}}}},"400":{"description":"**HTTP Status Code:** `400` <br>\n Bad Request  \n\n **Error Code:** `400` <br>\n Account has not enabled Single Sign-On.  <br>\n**Error Code:** `400` <br>\n The request body must be in JSON format. <br>\n**Error Code:** `400` <br>\n The request JSON must not be empty. <br>\n**Error Code:** `400` <br>\n User is inactive or locked. <br>\n**Error Code:** `400` <br>\n Cannot change the email of Admin user. <br>\n**Error Code:** `400` <br>\n Cannot update Zoom Room user to free <br>\n**Error Code:** `400` <br>\n Cannot assign Zoom Whiteboard and Zoom Whiteboard Plus to a user at the same time. <br>\n**Error Code:** `400` <br>\n User is inactive or locked. <br>\n"},"403":{"description":"**HTTP Status Code:** `403` <br>\n Forbidden  \n\n **Error Code:** `403` <br>\n The request was denied due to insufficient permissions: \"User:Edit\". <br>\n"},"404":{"description":"**HTTP Status Code:** `404` <br>\n Not Found  \n\n **Error Code:** `404` <br>\n User does not exist. <br>\n"},"409":{"description":"**HTTP Status Code:** `409` <br>\n Conflict  \n\n **Error Code:** `409` <br>\n Email ''{email}'' has already been used. <br>\n**Error Code:** `409` <br>\n The email domain does not match the associated domain of the account, please contact Zoom Customer Support to set up if necessary. <br>\n**Error Code:** `409` <br>\n Cannot add paid users. <br>\n**Error Code:** `409` <br>\n The Zoom United Plan is invalid. <br>\n**Error Code:** `409` <br>\n Cannot create more users with Zoom United Plan. <br>\n**Error Code:** `409` <br>\n Cannot create more users with Zoom Workplace Business Plus. <br>\n**Error Code:** `409` <br>\n Cannot create more users with Zoom Workplace Enterprise Premier. <br>\n**Error Code:** `409` <br>\n Cannot create more users with Zoom Workplace for Education School and Campus Plus. <br>\n**Error Code:** `409` <br>\n Cannot create more users with Zoom Workplace for Education Enterprise Premier. <br>\n**Error Code:** `409` <br>\n Cannot create more users with Zoom Workplace for Education Enterprise Student. <br>\n**Error Code:** `409` <br>\n Cannot create more users with Zoom Workplace Pro Plus. <br>\n"},"429":{"description":"**HTTP Status Code:** `429` <br>\n Too Many Requests. For more information, see [rate limits](/docs/api/rate-limits/). \n\n "}},"security":[{"openapi_oauth":["scim2","scim2:admin"],"openapi_authorization":[]}],"x-extensions":{"x-permissions":["User:Edit"],"x-macro-scopes":["scim2"],"x-granular-scopes":["scim2:admin"]}},"delete":{"tags":["User"],"summary":"Delete a user","description":"Delete a user.\n\n**[Scopes](https://developers.zoom.us/docs/integrations/oauth-scopes-overview/):** `scim2`\n\n**[Granular Scopes](https://developers.zoom.us/docs/integrations/oauth-scopes-overview/):** `scim2:admin`\n\n**[Rate Limit Label](https://marketplace.zoom.us/docs/api-reference/rate-limits#rate-limits):** `LIGHT`","operationId":"userSCIM2Delete","parameters":[{"name":"userId","in":"path","description":"The user's Zoom ID.","required":true,"schema":{"type":"string","example":"k&KdKr6TLWuxdDtk0hjSzL"}}],"responses":{"204":{"description":"**HTTP Status Code:** `204` <br>\nUser deleted."},"400":{"description":"**HTTP Status Code:** `400` <br>\n Bad Request  \n\n **Error Code:** `400` <br>\n Account has not enabled Single Sign-On. <br>\n**Error Code:** `400` <br>\n Cannot delete Admin user. <br>\n"},"403":{"description":"**HTTP Status Code:** `403` <br>\n Forbidden  \n\n **Error Code:** `403` <br>\n The request was denied due to insufficient permissions:\"User:Edit\". <br>\n"},"404":{"description":"**HTTP Status Code:** `404` <br>\n Not Found  \n\n **Error Code:** `404` <br>\n User does not exist. <br>\n"},"429":{"description":"**HTTP Status Code:** `429` <br>\n Too Many Requests. For more information, see [rate limits](https://developers.zoom.us/docs/api/rest/rate-limits/). \n\n "}},"security":[{"openapi_oauth":["scim2","scim2:admin"],"openapi_authorization":[]}],"x-extensions":{"x-permissions":["User:Edit"],"x-macro-scopes":["scim2"],"x-granular-scopes":["scim2:admin"]}},"patch":{"tags":["User"],"summary":"Deactivate a user","description":"Activate or deactivate a user.\n\n**[Scopes](https://developers.zoom.us/docs/integrations/oauth-scopes-overview/):** `scim2`\n\n**[Granular Scopes](https://developers.zoom.us/docs/integrations/oauth-scopes-overview/):** `scim2:admin`\n\n**[Rate Limit Label](https://marketplace.zoom.us/docs/api-reference/rate-limits#rate-limits):** `LIGHT`","operationId":"userADSCIM2Deactivate","parameters":[{"name":"userId","in":"path","description":"The user's Zoom ID.","required":true,"schema":{"type":"string","example":"k&KdKr6TLWuxdDtk0hjSzL"}}],"requestBody":{"content":{"application/json":{"schema":{"type":"object","properties":{"schemas":{"type":"array","description":"A list of schemas in `urn:ietf:params:scim:api:messages:2.0:{operation}` format.","items":{"type":"string","example":"urn:ietf:params:scim:api:messages:2.0:ListResponse"}},"Operations":{"type":"array","description":"The operations information.","items":{"type":"object","properties":{"op":{"type":"string","description":"The operation name. This value must be `replace`.","example":"replace","enum":["replace"]},"value":{"type":"object","properties":{"active":{"type":"boolean","description":"Whether the user is active. Set this value to `false` to deactivate the user.","example":false}},"description":"The operation's value information."}}}}}}}}},"responses":{"200":{"description":"**HTTP Status Code:** `200` \n User deactivated.","content":{"application/json":{"schema":{"type":"object","properties":{"id":{"type":"string","description":"The user's ID.","example":"k&KdKr6TLWuxdDtk0hjSzL"},"meta":{"type":"object","properties":{"resourceType":{"type":"string","description":"The resource type. The value is always `User` for the User resource type.","example":"User"},"location":{"type":"string","description":"The resource's URI in `https://api.zoom.us/scim2/Users/{userId}` format.","example":"https://api.zoom.us/scim2/Users/k&KdKr6TLWuxdDtk0hjSzL"},"version":{"type":"string","description":"The resource's version number.","example":"1.0.0"},"created":{"type":"string","description":"The user's creation time.","example":"2023-11-24T05:13:15Z"},"lastModified":{"type":"string","description":"The user's last modification time.","example":"2023-11-24T05:13:15Z"}},"description":"The user's resource metadata."},"schemas":{"type":"array","description":"A list of schemas.","items":{"type":"string","example":"urn:ietf:params:scim:api:messages:2.0:ListResponse"}},"name":{"type":"object","properties":{"givenName":{"type":"string","description":"The user's first name.","example":"Jill"},"familyName":{"type":"string","description":"The user's last name.","example":"Chill"}},"description":"Information about the user's name."},"emails":{"type":"array","description":"The user's email information.","items":{"type":"object","properties":{"type":{"type":"string","description":"The email address label. For example, `work`.","example":"work"},"value":{"type":"string","description":"The user's email address.","format":"email","example":"jillchill@example.com"},"primary":{"type":"boolean","description":"Whether the email address is the user's primary email address.","example":true}}}},"displayName":{"type":"string","description":"The user's display name.","example":"JillChill"},"userName":{"type":"string","description":"The user's email address.","format":"email","example":"jchill@example.com"},"active":{"type":"boolean","description":"Whether the user is active.","example":false},"userType":{"type":"string","description":"The user type: \n* `Collaboration` \n* `Basic` \n* `Licensed` \n* `On-Prem`","example":"On-Prem","enum":["Collaboration","Basic","Licensed","On-Prem"]},"title":{"type":"string","description":"The user's job title.","example":"Developer"},"locale":{"type":"string","description":"The user's location.","example":"San Jose"},"phoneNumbers":{"type":"array","description":"A list of the user's assigned phone numbers.","items":{"type":"object","properties":{"type":{"type":"string","description":"The phone number's label: \n* `mobile` \n* `office` \n* `home` \n* `fax` \n* `work` \n\nThis value defaults to `work`.","example":"work","enum":["mobile","office","home","fax","work"]},"value":{"type":"string","description":"The phone number.","example":"+015550100"}}}},"roles":{"type":"array","description":"The user's [role](https://support.zoom.com/hc/en/article?id=zm_kb&sysparm_article=KB0064983) information.","items":{"type":"object","properties":{"display":{"type":"string","description":"The role's display name.","example":"Developer"},"value":{"type":"string","description":"The role name.","example":"Developer"},"primary":{"type":"boolean","description":"Whether the role is the user's primary role.","example":true}}}},"groups":{"type":"array","items":{"type":"object","properties":{"display":{"type":"string","description":"The group's display name.","example":"Developers"},"type":{"type":"string","description":"The group type.","example":"direct"},"value":{"type":"string","description":"The group name.","example":"Developers"},"primary":{"type":"boolean","description":"Whether the group is the user's primary group.","example":true,"deprecated":true}}}},"urn:ietf:params:scim:schemas:extension:enterprise:2.0:User":{"type":"object","properties":{"department":{"type":"string","description":"The user's department.","example":"Development"},"organization":{"type":"string","description":"The user's organization.","example":"Example"}}},"urn:ietf:params:scim:schemas:extension:zoom:1.0:User":{"type":"object","properties":{"{customAttribute}":{"maxItems":5,"type":"string","description":"A custom attribute and its value. This field returns the custom attribute's name and value. For example, the `currentState` attribute name and the `California` value.","example":"\"Custom attribute name\" : \"custom attribute value\""},"personalLinkName":{"type":"string","description":"The user's customized [personal link](https://support.zoom.com/hc/en/article?id=zm_kb&sysparm_article=KB0068443#h_08f381ef-1e88-417c-b014-a2b9ad4abbda).","example":"user001"},"transferee":{"type":"string","description":"The transferee is another user within the same account designated to receive the original user's data when that user is deactivated or deleted.","example":"transferee@example.com"},"pronouns":{"type":"string","description":"The user's pronouns.","example":"They/Them/Their"},"zoomUnited":{"type":"string","description":"The user's number of [Zoom United licenses](https://zoom.us/pricing/zoom-bundles).","example":"16"},"zoomOneBizPlus":{"type":"string","description":"Zoom Workplace Business Plus.","example":"16","deprecated":true},"zoomOneEdu":{"type":"string","description":"Zoom One for Education Enterprise Student.","example":"576460752303423488","deprecated":true},"zoomOneSchoolCampusPlus":{"type":"string","description":"Zoom One for Education School and Campus Plus.","example":"137438953472","deprecated":true},"zoomOneEntPremier":{"type":"string","description":"Zoom Workplace Enterprise Premier.","example":"13421772","deprecated":true},"zoomOneEduEntPremier":{"type":"string","description":"Zoom One for Education Enterprise Premier.","example":"4294967296","deprecated":true},"zoomIQ":{"type":"boolean","description":"Zoom IQ Plan.","example":true,"deprecated":true},"zoomRevenueAccelerator":{"type":"boolean","description":"Zoom Revenue Accelerator Plan.","example":true},"zoomCustomerManagedKey":{"type":"boolean","description":"Zoom Customer Managed Key Plan.","example":true},"zoomWhiteboard":{"type":"boolean","description":"Zoom Whiteboard Plan.","example":true},"zoomWhiteboardPlus":{"type":"boolean","description":"Zoom Whiteboard Plus Plan.","example":true},"zoomTranslatedCaptions":{"type":"boolean","description":"Zoom Translated Captions Plan.","example":true},"zoomHuddles":{"type":"boolean","description":"Zoom Huddles Plan.","example":true,"deprecated":true},"zoomWorkforceManagement":{"type":"boolean","description":"Zoom Workforce Management Plan.","example":true},"zoomQualityManagement":{"type":"boolean","description":"Zoom Quality Plan.","example":true},"zoomScheduler":{"type":"boolean","description":"Zoom Scheduler Plan.","example":true},"zoomClipsPlus":{"type":"boolean","description":"Zoom Clips Plus Plan.","example":true},"zoomMailAndCalendar":{"type":"boolean","description":"Zoom Mail and Calendar Plan.","example":true},"visitorManagement":{"type":"boolean","description":"Zoom Visitor Management Plan.","example":true},"zoomComplianceManagement":{"type":"boolean","description":"Zoom Compliance Management Plan.","example":true,"deprecated":true},"zoomDocs":{"type":"boolean","description":"Zoom Docs Plan.","example":true},"zoomClinicians":{"type":"boolean","description":"Zoom Workplace for Clinicians.","example":true,"deprecated":true},"zoomCustomAICompanion":{"type":"boolean","description":"Zoom Custom AI Companion.","example":true},"zoomAICompanion":{"type":"boolean","description":"Zoom AI Companion.","example":true},"zoomAutoDialer":{"type":"string","description":"The plan option of Zoom Auto Dialer.\n* `1073741824` - Zoom Auto Dialer Plus US/Canada.\n* `-9223372036854775808` - Zoom Auto Dialer Plus Japan.\n* `2305843009213693952` - Zoom Auto Dialer Plus UK/IR.\n* `4611686018427387904` - Zoom Auto Dialer Plus AU/NZ.","example":"1073741824","enum":["1073741824","-9223372036854775808","2305843009213693952","4611686018427387904"]},"zoomFrontline":{"type":"string","description":"The plan option of Zoom Workplace for Frontline.\n`2048` - Zoom Workplace for Frontline.","example":"2048","enum":["2048"]},"cxInsights":{"type":"string","description":"The plan option of CX Insights.\n`1099511627776` - CX Insights Leader.","example":"1099511627776","enum":["1099511627776"]},"zoomEnhancedMedia":{"type":"string","description":"The plan option of Zoom Enhanced Media.\n`4503599627370496` - Zoom Enhanced Media.","example":"4503599627370496","enum":["4503599627370496"]},"aiSalesAssist":{"type":"string","description":"The plan option of AI Sales Assist.\n`128` - AI Sales Assist.","example":"128","enum":["128"]},"eduStandardStudent":{"type":"string","description":"The plan option of Education for Standard Student.\n`1152921504606846976` - Education for Standard Student.","example":"1152921504606846976","enum":["1152921504606846976"]},"zoomWorkplaceSubscription":{"type":"string","description":"The [subscription](https://zoom.us/billing) name for the Zoom Workplace license. Ignore this field if your account doesn't include the Multiple Subscription Quoting feature.","example":"2025 Subscription"},"zoomRevenueAcceleratorSubscription":{"type":"string","description":"The [subscription](https://zoom.us/billing) ID or name for the Zoom Revenue Accelerator plan. Ignore this field if your account doesn't include the Multiple Subscription Quoting feature.","example":"2025 Subscription"},"zoomCustomerManagedKeySubscription":{"type":"string","description":"The [subscription](https://zoom.us/billing) ID or name for the Zoom Customer Managed Key. Ignore this field if your account doesn't include the Multiple Subscription Quoting feature.","example":"2025 Subscription"},"zoomWhiteboardSubscription":{"type":"string","description":"The [subscription](https://zoom.us/billing) ID or name for the Zoom Whiteboard and Zoom Whiteboard Plus plan. Ignore this field if your account doesn't include the Multiple Subscription Quoting feature.","example":"2025 Subscription"},"zoomTranslatedCaptionsSubscription":{"type":"string","description":"The [subscription](https://zoom.us/billing) ID or name for the Zoom Translated Captions plan. Ignore this field if your account doesn't include the Multiple Subscription Quoting feature.","example":"2025 Subscription"},"zoomWorkforceManagementSubscription":{"type":"string","description":"The [subscription](https://zoom.us/billing) ID or name for the Zoom Workforce Management plan. Ignore this field if your account doesn't include the Multiple Subscription Quoting feature.","example":"2025 Subscription"},"zoomQualityManagementSubscription":{"type":"string","description":"The [subscription](https://zoom.us/billing) ID or name for the Zoom Quality Management plan. Ignore this field if your account doesn't include the Multiple Subscription Quoting feature.","example":"2025 Subscription"},"zoomSchedulerSubscription":{"type":"string","description":"The [subscription](https://zoom.us/billing) ID or name for the Zoom Scheduler plan. Ignore this field if your account doesn't include the Multiple Subscription Quoting feature.","example":"2025 Subscription"},"zoomClipsPlusSubscription":{"type":"string","description":"The [subscription](https://zoom.us/billing) ID or name for the Zoom Clips Plus plan. Ignore this field if your account doesn't include the Multiple Subscription Quoting feature.","example":"2025 Subscription"},"visitorManagementSubscription":{"type":"string","description":"The [subscription](https://zoom.us/billing) ID or name for the Visitor Management plan. Ignore this field if your account doesn't include the Multiple Subscription Quoting feature.","example":"2025 Subscription"},"zoomComplianceManagementSubscription":{"type":"string","description":"The [subscription](https://zoom.us/billing) ID or name for the Zoom Compliance Management plan. Ignore this field if your account doesn't include the Multiple Subscription Quoting feature.","example":"2025 Subscription"},"zoomDocsSubscription":{"type":"string","description":"The [subscription](https://zoom.us/billing) ID or name for the Zoom Docs plan. Ignore this field if your account doesn't include the Multiple Subscription Quoting feature.","example":"2025 Subscription"},"zoomAutoDialerSubscription":{"type":"string","description":"The [subscription](https://zoom.us/billing) ID or name for the Zoom Auto Dialer plan. Ignore this field if your account doesn't include the Multiple Subscription Quoting feature.","example":"2025 Subscription"},"zoomAICompanionSubscription":{"type":"string","description":"The [subscription](https://zoom.us/billing) ID or name for the Zoom AI Companion and Zoom Custom AI Companion plan. Ignore this field if your account doesn't include the Multiple Subscription Quoting feature.","example":"2025 Subscription"},"aiSalesAssistSubscription":{"type":"string","description":"The [subscription](https://zoom.us/billing) ID or name for the AI Sales Assist plan. Ignore this field if your account doesn't include the Multiple Subscription Quoting feature.","example":"2025 Subscription"},"cxInsightsSubscription":{"type":"string","description":"The [subscription](https://zoom.us/billing) ID or name for the CX Insights plan. Ignore this field if your account doesn't include the Multiple Subscription Quoting feature.","example":"2025 Subscription"},"zoomEnhancedMediaSubscription":{"type":"string","description":"The [subscription](https://zoom.us/billing) ID or name for the Zoom Enhanced Media. Ignore this field if your account doesn't include the Multiple Subscription Quoting feature.","example":"2025 Subscription"},"eduStandardStudentSubscription":{"type":"string","description":"The [subscription](https://zoom.us/billing) ID or name for the Education for Standard Student. Ignore this field if your account doesn't include the Multiple Subscription Quoting feature.","example":"2025 Subscription"},"workforceManagementRole":{"type":"string","description":"The Zoom Workforce Management role.","example":"Workforce Management Admin (Default)"},"zoomRevenueAcceleratorRole":{"type":"string","description":"The Zoom Revenue Accelerator role.","example":"Sales Manager"},"qualityManagementRole":{"type":"string","description":"The Zoom Quality Management role.","example":"Quality Management Admin (Default)"},"zoomAIProductivitySuite":{"type":"string","description":"The plan option for the Zoom AI Productivity Suite.\n`16777216` - Zoom AI Productivity Suite.","example":"16777216","enum":["16777216"]},"zoomAIProductivitySuiteSubscription":{"type":"string","description":"The [subscription](https://zoom.us/billing) ID or name for the Zoom AI Productivity Suite plan. Ignore this field if your account doesn't include the Multiple Subscription Quoting feature.","example":"2025 Subscription"},"zoomComplianceManagementPlan":{"type":"string","description":"The Zoom Compliance Management plan option.\n* `none` — Turn off the Zoom Compliance Management feature.\n* `zcm` — Zoom Compliance Management.\n* `zcm_plus` — Zoom Compliance Management Plus.","example":"zcm","enum":["none","zcm","zcm_plus"]},"zoomCliniciansPlan":{"type":"string","description":"The Clinicians and Clinical Note plan option.\n* `none` — Turn off the Zoom Clinical Note feature.\n* `zm_clinical_note_essentials` — Zoom Clinical Note Essentials.\n* `zm_workplace_for_clinicians_unlimited` — Zoom Workplace for Clinicians Unlimited.\n* `zm_workplace_for_clinicians_consumption` — Zoom Workplace for Clinicians Pay Per Note.","example":"zm_workplace_for_clinicians_unlimited","enum":["none","zm_clinical_note_essentials","zm_workplace_for_clinicians_unlimited","zm_workplace_for_clinicians_consumption"]},"zoomWorkplace":{"type":"string","description":"The Zoom Workplace bundle plan option:\n* `none` - Turn off the Zoom Workplace feature.\n* `zoe` - Zoom Workplace Enterprise.\n* `zoep` - Zoom Workplace Enterprise Plus.\n* `zo_ent_essentials` - Zoom Workplace Enterprise Essentials.\n* `zobp_usca` - Zoom Workplace Business Plus with US/CA Unlimited.\n* `zobp_ukir` - Zoom Workplace Business Plus with UK/IR Unlimited.\n* `zobp_aunz` - Zoom Workplace Business Plus with AU/NZ Unlimited.\n* `zobp_jp` - Zoom Workplace Business Plus with Japan Unlimited.\n* `zobp_global` - Zoom Workplace Business Plus with Global Select.\n* `zoe_prem_usca` - Zoom Workplace Enterprise Premier with US/CA Unlimited.\n* `zoe_prem_jp` - Zoom Workplace Enterprise Premier with Japan Unlimited.\n* `zoe_prem_ukir` - Zoom Workplace Enterprise Premier with UK/IR Unlimited.\n* `zoe_prem_aunz` - Zoom Workplace Enterprise Premier with AU/NZ Unlimited.\n* `zopp_usca` - Zoom Workplace Pro Plus with US/CA Unlimited.\n* `zo_edu_sch_cmp` - Zoom Workplace for Education School and Campus.\n* `zo_edu_ent_essentials` - Zoom Workplace for Education Enterprise Essentials.\n* `zo_edu_ent_plus` - Zoom Workplace for Education Enterprise Plus.\n* `zo_edu_ent_hied_stu` - Zoom Workplace for Education Enterprise Student.\n* `zo_edu_std` - Zoom Workplace for Education Standard.\n* `zo_edu_sch_cmp_plus_usca` - Zoom Workplace for Education School and Campus Plus with US/CA Unlimited.\n* `zo_edu_sch_cmp_plus_jp` - Zoom Workplace for Education School and Campus Plus with Japan Unlimited.\n* `zo_edu_sch_cmp_plus_ukir` - Zoom Workplace for Education School and Campus Plus with UK/IR Unlimited.\n* `zo_edu_sch_cmp_plus_aunz` - Zoom Workplace for Education School and Campus Plus with AU/NZ Unlimited.\n* `zo_edu_sch_cmp_plus_global` - Zoom Workplace for Education School and Campus Plus with Global Select.\n* `zo_edu_ent_prem_usca` - Zoom Workplace for Education Enterprise Premier with US/CA Unlimited.\n* `zo_edu_ent_prem_jp` - Zoom Workplace for Education Enterprise Premier with Japan Unlimited.\n* `zo_edu_ent_prem_ukir` - Zoom Workplace for Education Enterprise Premier with UK/IR Unlimited.\n* `zo_edu_ent_prem_aunz` - Zoom Workplace for Education Enterprise Premier with AU/NZ Unlimited.\n* `zo_edu_ent_prem_global` - Zoom Workplace for Education Enterprise Premier with Global Select.","example":"zobp_usca","enum":["none","zoe","zoep","zo_ent_essentials","zobp_usca","zobp_ukir","zobp_aunz","zobp_jp","zobp_global","zoe_prem_usca","zoe_prem_jp","zoe_prem_ukir","zoe_prem_aunz","zopp_usca","zo_edu_sch_cmp","zo_edu_ent_essentials","zo_edu_ent_plus","zo_edu_ent_hied_stu","zo_edu_std","zo_edu_sch_cmp_plus_usca","zo_edu_sch_cmp_plus_jp","zo_edu_sch_cmp_plus_ukir","zo_edu_sch_cmp_plus_aunz","zo_edu_sch_cmp_plus_global","zo_edu_ent_prem_usca","zo_edu_ent_prem_jp","zo_edu_ent_prem_ukir","zo_edu_ent_prem_aunz","zo_edu_ent_prem_global"]}}}}}}}},"400":{"description":"**HTTP Status Code:** `400` <br>\n Bad Request  \n\n **Error Code:** `400` <br>\n Account has not enabled Single Sign-On.  <br>\n**Error Code:** `400` <br>\n The request body must be in JSON format. <br>\n**Error Code:** `400` <br>\n The request JSON must not be empty. <br>\n**Error Code:** `400` <br>\n User is force inactive. <br>\n"},"403":{"description":"**HTTP Status Code:** `403` <br>\n Forbidden  \n\n **Error Code:** `403` <br>\n The request was denied due to insufficient permissions: \"User:Edit\". <br>\n"},"404":{"description":"**HTTP Status Code:** `404` <br>\n Not Found  \n\n **Error Code:** `404` <br>\n User does not exist. <br>\n"},"409":{"description":"**HTTP Status Code:** `409` <br>\n Conflict  \n\n **Error Code:** `409` <br>\n Cannot activate or deactivate Zoom Room and Admin users. <br>\n**Error Code:** `409` <br>\n User is force inactive. <br>\n**Error Code:** `409` <br>\n You cannot deactivate this user because the user has hub assets on Zoom Events. <br>\n"},"429":{"description":"**HTTP Status Code:** `429` <br>\n Too Many Requests. For more information, see [rate limits](https://developers.zoom.us/docs/api/rate-limits/). \n\n "}},"security":[{"openapi_oauth":["scim2","scim2:admin"],"openapi_authorization":[]}],"x-extensions":{"x-permissions":["User:Edit"],"x-macro-scopes":["scim2"],"x-granular-scopes":["scim2:admin"]}}}},"components":{"securitySchemes":{"openapi_authorization":{"type":"apiKey","name":"Authorization","in":"header"},"openapi_oauth":{"type":"oauth2","flows":{"authorizationCode":{"authorizationUrl":"/","tokenUrl":"","refreshUrl":"","scopes":{"scim2":"scim2","scim2:admin":"scim2:admin"}}}}}}}