Managing Long-Lived Access Tokens

The management of Long-Lived Access Tokens can be found in the admin section of the Synthetix Cloud Platform. If activation has already been completed, please skip to the ‘Accessing the Access Tokens Section’ of this article.

Activation Process

To utilise this feature, the following is required:

1. The add-on must be enabled on your account. 
2. A service account that will be associated with the tokens.
3. A new/current permission group that will have the permissions enabled to allow access to the ‘Access Tokens’ section in the admin area.

Step 1:

Speak to your Synthetix account manager who will enable the add-on and help you decide which permission group to use or create a new one. Once done, the permissions will be enabled in the group.

Step 2: 

Create a user that will be associated with access tokens. Access tokens can only be created for users marked as service accounts. To mark a user as a service account, please raise a support ticket, providing the username, asking for the user to be marked as one. You will be notified once this has been done.

Step 3:

Navigate to the users admin area and assign any user/s who will be responsible for managing the tokens to the chosen permission group. You do not need to assign the service account to the group.

Accessing the Access Tokens section

1. A user who is part of the chosen permission group must login to the Synthetix Cloud Platform.
2. Navigate to the admin section by clicking on the ‘admin’ option on the top navigation bar.
3. Click on the ‘API Keys’ option on the left-hand sidebar under the ‘Configuration’ heading
4. Click on the ‘Access Tokens’ tab that appears.

The Access Tokens screen with no tokens created

Creating an Access Token

1. On the ‘Access Tokens’ screen, on the top right-hand side corner of the screen, click the ‘Create Access Token’ button. 
2. The user will be navigated to the ‘Create Access Token’ screen and presented with a form.
3. Please note, the ‘resource owner’ will be your service account.
4. Once the form has been completed, click on the ‘create’ button to generate the new access token which will be available to edit via the ‘Access Tokens’ screen or click ‘cancel’ to close the form.

Editing an Access Token

1. On the ‘Access Token’ screen, click on the access token that you wish to edit.
2. On the ‘edit access token’ screen, the form will display, allowing certain fields to be changed. Elements that are greyed out cannot be modified. 
3. Click on the ‘save’ button to save any changes you have made or click ‘cancel’ to be navigated back to the listing screen.

Deleting an Access Token

1. On the ‘Access Tokens’ screen, click on the access token that you wish to delete.
2. On the ‘edit access token’ screen, click the ‘Delete Access Token’ button at the top of the form. 
3. A confirmation popup will display. 
4. Click the red ‘Delete’ button to confirm deletion or click ‘cancel’ to dismiss the popup.