Logo
Zoom Public API Documentation

Zoom SCIM2 API

Number of APIs: 11


SCIM2 (System for Cross-domain Identity Management) is a specification designed to automate the provisioning of user/group identities across various cloud-based applications and services using SSO services and Identity Providers. The Zoom SCIM2 API provides support for user/group provisioning through the User/Group resource. Each SCIM2 API endpoint has a rate limit of 1 request/second per account.

SCIM uses HTTP methods that is compatible to REST architecture style. The payloads require schema definitions, attributes, and values for request. Also using the SCIM API, you can use additional features such as attribute filters and search criteria.

While using the SCIM APIs, set the value of the Accept header as application/scim+json.

Prerequisites

  • Zoom Owner or Admin privileges.
  • Business or Education account with approved Vanity URL.
  • Single sign-on enabled

Authentication

The SCIM2 API supports OAuth authentication. To use Oauth 2.0, create an OAuth app or a Server-to-Server OAuth app on the Zoom App Marketplace and select SCIM2 as the scope for your app. Next, generate an OAuth token for your app and start making SCIM2 API calls.

Contact Support:
Name: Zoom Developers


1. scim2-Users-{userId} - Get a user

GET {{baseUrl}}/scim2/Users/:userId

Use this API to return information about a specific user.

OAuth Scope: scim2
Rate Limit Label: Light



2. scim2-Users-{userId} - Update a user

PUT {{baseUrl}}/scim2/Users/:userId

Use this API to update a user's information.

OAuth Scope: scim2
Rate Limit Label: Light



3. scim2-Users-{userId} - Delete a user

DELETE {{baseUrl}}/scim2/Users/:userId

Use this API to delete a user.

OAuth Scope: scim2
Rate Limit Label: Light



4. scim2-Users-{userId} - Deactivate a user

PATCH {{baseUrl}}/scim2/Users/:userId

Use this API to activate or deactivate a user.

OAuth Scope: scim2
Rate Limit Label: Light



5. scim2-Users - List users

GET {{baseUrl}}/scim2/Users?startIndex=1&count=1&filter=<string>

Use this API to list all users. You can include additional query parameters to filter the response.

OAuth Scope: scim2
Rate Limit Label: Medium



6. scim2-Users - Create a user

POST {{baseUrl}}/scim2/Users

Use this API to create a new user.

OAuth Scope: scim2
Rate Limit Label: Light



7. scim2-Groups-{groupId} - Get a group

GET {{baseUrl}}/scim2/Groups/:groupId

Use this API to return information about a specific group.

OAuth Scope: scim2
Rate Limit Label: Light



8. scim2-Groups-{groupId} - Update a group

PATCH {{baseUrl}}/scim2/Groups/:groupId

Use this API to update a group's information.

OAuth Scope: scim2
Rate Limit Label: Medium



9. scim2-Groups-{groupId} - Delete a group

DELETE {{baseUrl}}/scim2/Groups/:groupId

Use this API to delete a group.

OAuth Scope: scim2
Rate Limit Label: Medium



10. scim2-Groups - List groups

GET {{baseUrl}}/scim2/Groups?startIndex=1&count=1&filter=<string>

Use this API to list all groups. You can include additional query parameters to filter the response.

OAuth Scope: scim2
Rate Limit Label: Medium



11. scim2-Groups - Create a group

POST {{baseUrl}}/scim2/Groups

Use this API to create a new group.

OAuth Scope: scim2
Rate Limit Label: Medium



ENDPOINTS