Important
This feature requires enabling the feature flag Technique domain > Jetons Api label.
The API tokens menu allows you to manage API tokens for technical users of Akuiteo. API tokens are only use to access Akuiteo API resources, in replacement of the Oauth2 authentication. They allow you to identify and the authentication to third-parties app accessing the Akuiteo API resources.
Tokens configuration is defined in the Administration console > Security > API tokens.
Creating a token
| 1 | From the API tokens screen, click on Create an API token at the top right of the screen. |
| 2 | In the window displayed, specify the following fields: |
| Field | Description |
|---|---|
| User |
Select the user of the token from the drop-down list. This list only displays technical users whom are working in the company on the creation date of the token. Technical users are the users with the Technical user? box checked on their user record sheet (People > User management > User tab > General information section). |
| Token name | Specify the token name. |
| Expiration date |
Specify an expiration date for the token. If no date is specified, today's date will be automatically applied to the token. When the expiration date has passed, it is no longer possible to use this token. |
| 3 | Click on Create. |
An information window with the token linked to the API token is displayed.
| 4 | Click on: |
-
to view the token. - Copy to the clipboard to copy the token. This action leads to the closing of the window.
- Close to close the window.
Important
It is no longer possible to view the token once the window is closed.
The API token is created. It is visible in the tokens table and can be used. The Valid value is displayed in the Status column.
Regenerating a token
The regeneration of a token allows you to expand its duration without having to go through the creation mode.
| 1 | From the tokens table, click on  in the Actions column of the token to regenerate. |
| 2 | In the displayed window, specify the new Expiration date for the token. If no date is specified, a duration of a year is applied by default. |
| 3 | Click on Create. |
An information window with the token linked to the API token is displayed.
| 4 | Click on: |
-
to view the token.
- Copy to the clipboard to copy the token. This action leads to the closing of the window.
- Close to close the window.
The token is regenerated. The new expiration date is displayed in the Expiration date column and the Valid value is displayed in the Status column.
Removing a token
| 1 | From the tokens table, click on  in the Actions column of the desired line. |
| 2 | Confirm the action. |
The token is removed. The token can be seen in the table, the Removal date column is specified with today's date and the Revoked value is displayed in the Status column. It is no longer possible to use this token.
Deleting a token
| 1 | From the tokens table, click on  in the Actions column of the desired line. |
| 2 | Confirm the action. |
The token is deleted. It can no longer be seen in the table.
Setting up the API tokens expiration notifications section
| 1 | Fill in the following fields to configure the connection: |
| Field | Description |
|---|---|
| Email address to notify when API tokens expire |
Specify the email address to notify when a token is about to expire. |
| Reminder period before expiration (days) |
Specify the number of days before the token expires from which a notification is sent by email. If the field is left empty, a period of 30 days is applied by default. |
| 2 | Click on Save for each field that is filled in or modified to take into account the value specified. |
Notifications are set up.
