Create a bearer token
To create a bearer token:
- From the left menu of any screen, click Admin.
- Under Workspace, click API Tokens.
- In the upper right of the API Tokens table, click the Generate API Token button:
- For Name enter a name for your API token, for example the system or application that will use this token.
- (Optional) For Description enter a description for your API token, for example its intended use. You can also add or change the description later.
- (Optional) For Personas select any asset-level permissions you want to give to the token. You can also add these later.
- (Optional) If you would like the token to be temporary, for Expiry choose the time after which the token should automatically become invalid.
- At the bottom right, click the Save button.
Use the bearer token
You must authenticate all requests to Atlan's APIs. You can authenticate your requests by sending the following header:
Authorization: Bearer <token>
So, for example, if the API token you copied had the value
eyJhbGciOi..., you would use the header:
Authorization: Bearer eyJhbGciOi...
Authorization header is the combination of the word
Bearer, a space, and then the token's value. The token copied from Atlan does not include this
By default, each API token will have the permissions of an admin user, without connection admin privileges. This means the token is able to:
- Call administrative API endpoints. For example, to create users and groups.
- Call governance API endpoints. For example, to create governance objects like tags, custom metadata, personas and purposes.
To provide access to any connections and assets, you need to add one or more personas to the token that have access to that connection's assets.
Once personas are assigned to the token, the token will be able to:
- Create, read, update, delete, and search glossaries (and their content) that are accessible by those assigned personas.
- Create, read, update, delete, and search any assets that are accessible by those personas.