Rate this page:
Use this REST API to integrate your organization with an identity provider.
The User provisioning REST API integrates your organization with an identity provider. Use this API to:
To manage accounts, use the User management REST API.
To manage your organization, use the Organizations REST API.
To manage users and groups using the User Provisioning APIs, you will require an API key (distinct from your Cloud admin API key). This unique key grants you full administrative control over your organization's directory, enabling you to create and update user attributes as well as modify user group memberships. To authenticate your script and administer your directory, utilize this API key as a Bearer access token.
Furthermore, each directory is distinguished by a Unique ID, specifically the directoryId found after 'directory/' in the Directory's base URL. For instance, if the Directory base URL is https://api.atlassian.com/scim/directory/abcdeg1234, the directoryId is abcdeg1234.
Learn more about Configuring user provisioning.
To make requests to the API with the client/tool of your choice, follow these steps to create an API key and obtain the directory ID
This documentation is for version 1 of the user provisioning REST API. The URIs for resources have the following structure:
The user provisioning REST API uses pagination to conserve server resources and limit response size. If there are more results available after the current page, a link to the next page of results is included in the JSON. You can use the parameter to set a specific starting point for the results.
We follow the standard HTTP status code definition. See W3C Status Code Definitions for the detailed code definitions.
Note: If you have the improved user management experience, any references in the documentation below to “your site” or “your organization’s sites” are now “your organization”.