How do I create, edit, copy or revoke access tokens?

To make an access token URL, and to create a new access token

To edit an access token

To copy an access token value

To revoke an access token

RESTful API

To make an access token URL, and to create a new access token:

You can make an access token URL (that will be attached to an access token) from dashboards in the UI, and create the access tokens themselves from the same location (or via the Access Token Management page).

To make an access token URL:

1. Navigate to a dashboard.
2. Open the Overflow Menu and click Make Access Token URL.
   
   
   
   
3. The Make Access Token URL form will open on the right of the page.
   
   
   
   
4. Click the Choose Access Token field to then select the access token to embed within the URL.
   
   
   
   
   • If you have not created an access token, you can do so via the Create New Access Token field in the Make Access Token URL form, or via the Access Token Management page. Please see the section below for details on creating a new access token.
   
   Click Done to return to the 'Make Access Token URL' form.
5. Once you have a selected an access token, the Access URL field will be automatically populated, and if you wish you can copy the URL to the clipboard. Copying the URL makes it easier to create a URL with an access token.
   
   

To create a new access token via the Access Token Management page:

1. Navigate to the Access Token Management page.
2. Click Create Access Token at the top of the page (or via the Overflow Menu).
   
   
   
   
3. The Create Access Token form will open on the right of the screen
   
   
   
   
4. Specify the User account against which this access token will be created. The access token will provide access to Entuity based on the specified user's privileges. More than one access token can be associated with a specified Entuity user account.
   
   
   
   The 'admin' user will be highlighted with an icon, so that it is easier to idenfity the creation of an access token that entails full admin functionality.
   
   
   
   
5. Specify whether the access token will expire via the Expires toggle. If enabled, the URL to which the token is attached will become inactive after the specified expiry time.
6. If the Expires toggle is enabled, you can specify the Expiry Time in the field below, giving the time and date of the local Entuity server at which expiration will occur. Note, when an access token expires, any current user sessions that were created via that token will also expire within 1 minute.
7. Specify a Description for the token, if you desire. This is limited to a maximum of 256 characters.

To edit an access token:

1. Navigate to the Access Token Management page and select the access token that you want to edit.
2. Click Edit Access Token at the top of the page (or via the Overflow Menu or right-click Context Menu).
   
   
   
   
3. The Edit Access Token form will open on the right of the page.
   
   
   
   
4. This form contains the same fields as when creating a new access token (see above).
5. Once you have made the edits you desire, click Done to save your edits, otherwise click Cancel.

To copy an access token value:

You can copy an access token value or a URL-encoded token value to the clipboard, should you need it. You can use the URL-encoded token value to access Entuity URLs via the browser bar in the following manner:

[Entuity URL]&accessToken=[URL-encoded token value]

1. Navigate to the Access Token Management page and select the access token with the value that you want to copy.
2. Click Copy Token Value at the top of the page (or via the Overflow Menu or right-click Context Menu). Copy URL-encoded Token Value is also available from the Context Menu.
   
   
   
   
3. The access token URL value will then be copied to the clipboard.

You can also copy the token value from the Make Access Token URL form. Please see the section above for details on making the access token URL.

To revoke an access token:

You can revoke an access token with immediate effect. This will immediately expire any active sessions that were created via that token, and will also remove the access token from the table on the Access Token Management page.

1. Navigate to the Access Token Management page.
2. Select the access token(s) that you want to revoke, and click Revoke Access Tokens at the top of the page (or via the Overflow Menu or right-click Context Menu).
   
   
   
   
3. A dialog will open asking you to confirm the deletion.
   
   

RESTful API:

You can execute the following commands via the Entuity RESTful API functionality:

• List and create access tokens.
• List details of a specified access token, edit an access token, or delete an access token.