• Manage
  • Profile
  • Email
  • Api Tokens
  • Lifecycle
Cloud
User management REST API / Reference / REST API

About the user management REST API

Postman Collection
OpenAPI

The User management REST API provides resources to administer and edit managed accounts. Use this API to:

  • Get user management permissions
  • Get and update profiles
  • Deactivate and delete accounts

To manage your organization, use the Organizations REST API.

To integrate your organization with an identity provider, use the User provisioning REST API.

Authentication and authorization

To use the user management REST API you must have a valid API key. The API key protects the API and ensures that you have permission to update and deactivate the accounts owned by your organization. You can use the same API key for the organizations REST API and the user management REST API. For more information, see Create an API key.

Once you have your API key, you can provide it as a bearer token in the Authorization part of your HTTPS header.

Version and URI

This documentation is for version 1 of the user management REST API. The URIs for resources have the following structure:

1
2
https://api.atlassian.com/users/<resource-name>

Experimental features

Methods marked as experimental may change without an earlier notice. We are looking for your feedback for these methods.

Vocabulary

There are several concepts that are common ideas with a unique meaning in Atlassian Administration. Learn more about terminology related to the cloud admin experience.