Access Tokens
An access token is an API token that can be used to access our APIs. It needs to be provided under the Authorization
header when making API requests. This token contains user-specific information, so it can be used to determine the user, user's account, and the user's permissions. The response from the API will respect the user and their permissions.
Generate New Tokens
Follow the steps below to create a new access token:
-
Click your profile in the top-right corner, then click Access Tokens.
-
In the Token Name field, provide a clear and descriptive name for the access token. This should describe the purpose of the token.
-
Choose an expiration date for the token. You can select a duration between 30 days and Never, depending on how long you need the token to be valid.
-
Once the details are filled, click on the Generate button to create the access token.
-
After generating, the access token will appear below. Make sure to save it, as you will not be able to view the token again.
The token will also appear in the Tokens in Use list, but the actual token value will not be displayed again.
Remember, the token is tied to your user account, so ensure it is securely stored.
Make a Request to the API Using the API Token
API tokens can be used to make API requests. To use the API token in a request, include it in the Authorization
header with the prefix Token
. See the example below (replace </API_Token>
with the actual API Token value):
curl -X 'GET' \
<CoreServices_URL>/identity/accounts/ \
-H 'accept: application/json' \
-H 'Authorization: Token </API_Token>'