Rate this page:
Use this REST API to integrate your organization with an identity provider.
To manage users and groups with the user provisioning REST API, you need an API key separate from your Cloud admin API key. This key gives full administrative access to your organization's directory, allowing the API client to create and update user attributes and change user group membership.
See Configure user provisioning.
Once you have your API key, you can provide it as a bearer token
in the Authorization
part of your HTTPS header.
If you need to "rotate" or regenerate an API key, use the following steps:
This documentation is for version 1 of the user provisioning REST API. The URIs for resources have the following structure:
1 2https://api.atlassian.com/admin/v1/scim/<resource-name>
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 cursor
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.
active
flag to false
.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”.
Rate this page: