What are admin APIs?
10 min
Advanced
By the end of this lesson, you'll be able to:
- Explain Atlassian admin APIs
- Identify how to use admin APIs
- List some of the API calls
Extend your organization administration abilities
Cloud admin application programming interfaces, or APIs, enable the administration of organizations using API calls. Using cloud admin APIs, you can manage organizations, sites, and users. You can embed API calls in automated scripts or use them in webhooks, automating considerable manual administration tasks.
There are three types of cloud admin APIs:
- Organizations API
- User management API
- User provisioning API
How do admin APIs work?
Calls for the cloud admin APIs usually come from an external custom script. In order to authenticate a script, an org admin needs to generate an API key from the admin hub and provide it to the developer.
To generate an API key as an org admin:
- Go to admin.atlassian.com and select your organization.
- Under the Settings tab, go to API Keys section.
- Select Create API Key.
- Enter the name of your key and the date you want the key to expire. This can't exceed one year.
- Select Create.
- Take note of the provided information as it is not stored anywhere: The organization ID and the API Key.
- Select Done.
- Use the Org ID and API key within your script to make calls to the admin cloud APIs.
The API key is different from API token. User can generate API tokens to perform REST API calls to the products they have access to.
Org admins can revoke an API key at any moment if they notice anything wrong with how it is being used. They can do this by selecting Revoke next to the API key in the API Keys section, under the Settings tab in the admin hub.
What is the organizations API?
The organizations API provides you with information about an organization, such as the users, groups or domains that belong to it.
👇 Click the boxes below to learn more about uses of the organizations API.
What is the user management API?
Org admins can use the user management API to apply changes to managed accounts in an organization with verified domains.
👇 Click the boxes below to learn more about uses of the user management API.
What is the user provisioning API?
As an org admin, you can use the user provisioning API to automatically update users and groups in your organization when you make changes in your identity provider.
👇 Click the boxes below to learn more about the uses of the user provisioning API.
How was this lesson?
next lesson
What are application tunnels?
- What is an application tunnel?
- How does an application tunnel work?
- How to set up an application tunnel?
- Which products support application tunnels?