Last updatedJul 22, 2019

About the cloud admin REST APIs

The cloud admin REST APIs let you administer Atlassian cloud products. To allow administrators to manage multiple Atlassian cloud products and sites centrally, we’ve created a global administration layer called an organization that is a centralized place for managing your products and users. With an organization, you can manage the Atlassian accounts of all registered users at your company, based on the domains that you have verified. Managing a user's account allows you to change account and profile details, view product access and admin permissions, and deactivate or permanently delete a user.

For more details about how organizations work, see Get more security and control across your organization.

Once you've created an organization and verified a domain, all the Atlassian accounts with email addresses from that domain become managed accounts. With managed accounts, you can apply Atlassian Access security policies across the users and sites in your organization.

Organizations REST API

The organizations REST API lets you get information about your organizations, including:

  • A list of organizations
  • Information about an organization
  • Users or domains associated with an organization
  • An audit log of events from an organization

User management REST API

The user management REST API lets you manage users (managed accounts) in an organization. Only an organization admin can edit the details of a managed account. As an organization admin with verified domains, you can use the user management REST API to perform operations including:

  • Get a list of your permissions to manage a user
  • Get information about a user
  • Update a user profile or set a user's email address
  • Enable or disable a user

User provisioning REST API

User provisioning integrates an external user directory with your Atlassian cloud products. This integration allows you to automatically update the users and groups in your Atlassian organization when you make updates in your identity provider (IdP). For example, with user provisioning, you can create, link, and deactivate managed Atlassian user accounts from your IdP. We support user provisioning using the System for Cross-domain Identity Management (SCIM) protocol version 2.0.