Manage an organization with the admin APIs
Who can do this? |
API keys allow you to manage your organization through the admin APIs. You can update organization settings with the organization REST APIs, manage user accounts with the user management REST APIs, classify data in an organization with the classification REST APIs, and secure data compliance, manage authentication policies, and access to resources with the admin control REST APIs.
To make requests to the API with the client of your choice, you need to create an API key.
When you create an API key, only you know the API key value. As a security precaution, you should only share the API key value with another organization admin.
When an organization admin leaves your organization, we recommend you revoke any API keys they created.
What are API key scopes?
An API scope allows you to define the levels of access to data in your Atlassian apps. When you create an API key, you need to choose the access level for the API key. You can can create an API key with or without scopes. Scopes allow you to choose the actions an API key can perform in your Atlassian organization.
You’re only able to select scopes for some APIs. Check API documentation for available scopes.
Create API key with scopes
When you create an API key, you give it a name that describes the purpose of the key. An API key can last no longer than a year. API keys support variable length values, not fixed length values, to accommodate different integrations. An API key with scopes is secure because it can only perform specific actions in your organization.
To create an API key with scopes:
Go to admin.atlassian.com. Select your organization if you have more than one.
Select Settings > API keys.
Select API keys with scopes.
Select Create API key.
Enter a Name that makes it easy to remember the API key.
Select the expiration date for the API key. Keys can last no longer than a year.
Select API scopes to choose what the API key can do in your organization.
Review your API key scope information.
Select Create to save the API key.
Copy your API key and save it somewhere safe. You can't recover the API key later. As a security precaution, we don't store your API key value.
Create an API key without scopes
An API key without scopes can access all Atlassian Admin APIs. An API key with scopes allows you to specify the access for your API calls. This API key may present a security risk because it can access everything.
To create API key without scopes:
Go to admin.atlassian.com. Select your organization if you have more than one.
Select Settings > API keys.
Select Create API key.
Select API keys without scopes.
Select Create API key.
Review your API key scope information.
Select Create to save the API key.
Copy your API key and save it somewhere safe. You can't recover the API key later. As a security precaution, we don't store your API key value.
Revoke an API key
To revoke an API key:
Go to admin.atlassian.com. Select your organization if you have more than one.
Select Settings > API keys.
Select Revoke next to the API key.
A revoked API key is permanent. It may take up to 10 minutes for a key you revoke to stop working.
Was this helpful?