About

The Admin API for Atlassian Cloud is a RESTful API that allows you to administer your organization’s managed accounts. You’ll also be able to deactivate the account so the user will no longer be able to login with their account. For more details on administering the managed accounts for your organization, see Administer managed accounts.

Getting started with the Admin API

Before you start using the admin API, familiarize yourself with how the operations will affect the managed accounts in your organization.

To use the admin API, you must have a valid admin API key. The API key protects the admin API, and ensures that you have permission to update and disable the accounts owned by your organization.

Authentication

Obtaining an API key

To get the API key, navigate to your organization at admin.atlassian.com. You’ll see the API keys under the Developers section. Choose API keys and click create API key. Choose a API key name that will allow you to remember the key.

An API key will be generated and displayed on screen. Remember to immediately store this key securely as it will not be visible again on the page. You’ll only have the ability to revoke existing API keys from the page.

API keys currently expire 7 days after creation.

Using the API key

Once you have generated your API key, you can use it as a bearer token to make requests to the API with the client of your choice.

Orgs

Get Page of Orgs

GET /admin/v1/orgs

Get Page of Orgs where the user is an Administrator

Request

Query parameters
cursor

string

Parameter for Next Page of results.

page[cursor] Deprecated

string

Parameter for Next Page of results. Use the cursor parameter. This parameter will be removed on Nov 1 2019.

Example

1
2
3
4
curl --request GET \
  --url 'https://api.atlassian.com/admin/v1/orgs' \
  --header 'Authorization: Bearer <access_token>' \
  --header 'Accept: application/json'

Responses

Successful operation

Content typeValue
application/json

OrgPage

Get Org by ID

GET /admin/v1/orgs/{orgId}

Get single Org where the user is an Administrator by Id

Request

Path parameters
orgId Required

string

ID of Org to return

Example

1
2
3
4
curl --request GET \
  --url 'https://api.atlassian.com/admin/v1/orgs/{orgId}' \
  --header 'Authorization: Bearer <access_token>' \
  --header 'Accept: application/json'

Responses

Successful operation

Content typeValue
application/json

Org

Get Page of Users in Org

GET /admin/v1/orgs/{orgId}/users

Get Page of Users in an Org where the user is an Administrator.

Request

Path parameters
orgId Required

string

ID of Org to fetch Users

Query parameters
cursor

string

Parameter for Next Page of results.

page[cursor] Deprecated

string

Parameter for Next Page of results. Use the cursor parameter. This parameter will be removed on Nov 1 2019.

Example

1
2
3
4
curl --request GET \
  --url 'https://api.atlassian.com/admin/v1/orgs/{orgId}/users' \
  --header 'Authorization: Bearer <access_token>' \
  --header 'Accept: application/json'

Responses

Successful operation

Content typeValue
application/json

UserPage

Get Page of Domains in Org

GET /admin/v1/orgs/{orgId}/domains

Get Page of Domains in an Org where the user is an Administrator.

Request

Path parameters
orgId Required

string

ID of Org to fetch Domains

Query parameters
cursor

string

Parameter for Next Page of results.

page[cursor] Deprecated

string

Parameter for Next Page of results. Use the cursor parameter. This parameter will be removed on Nov 1 2019.

Example

1
2
3
4
curl --request GET \
  --url 'https://api.atlassian.com/admin/v1/orgs/{orgId}/domains' \
  --header 'Authorization: Bearer <access_token>' \
  --header 'Accept: application/json'

Responses

Successful operation

Content typeValue
application/json

DomainPage

Get Domain in an Org by Id

GET /admin/v1/orgs/{orgId}/domains/{domainId}

Request

Path parameters
orgId Required

string

ID of Org with the User

domainId Required

string

ID of Domain to return

Example

1
2
3
4
curl --request GET \
  --url 'https://api.atlassian.com/admin/v1/orgs/{orgId}/domains/{domainId}' \
  --header 'Authorization: Bearer <access_token>' \
  --header 'Accept: application/json'

Responses

Successful operation

Content typeValue
application/json

Domain