| Table of Contents | ||||||||||
|---|---|---|---|---|---|---|---|---|---|---|
|
Access tokens are necessary for user validation in external applications integrated with the XTR Platform through the Home Portal API. For successful integration, you need to generate an access token in the Home Portal and provide it in the external application.
| Info |
|---|
Access tokens can be generated only for users that have accounts on the Home Portal. |
| Note |
|---|
IMPORTANT! Anyone who knows your token will be able to use your API and operate on your XTRF instance with the user's privileges of the token's owner. Therefore, we recommend creating a dedicated user that belongs to a dedicated group with rights limited only to those required by the integration scenario you develop. To learn how to create such a user, see the Add a new user account article. |
To generate the access token, perform the following steps:
Sign in to the XTRF Home Portal.
Go to the
Configuration menu >→ User Management > → Users.From the list of all Home Portal users, select the user you want to generate an access token for and open their account in edit mode.
Go to the Access Tokens tab. If the access tokens were generated for this user account in the past, the list of generated tokens is displayed. However, to use an access token for a new integration, you need to generate a new one.
Click the Generate Access Token button. An extra section will appear.
Copy the access token full string.
| Note |
|---|
IMPORTANT! |
The full string of the access token is available only when it is generated. When you save or reload this page, the access token will be moved to the list of generated tokens. If you |
don't copy it immediately after generation, you are required to generate the token once again. |
b. (Optional) Provide the description for the newly created token.
| Panel | ||||||||
|---|---|---|---|---|---|---|---|---|
| ||||||||
To generate an access token for yourself, you can use the |
| Info |
|---|
To check the API documentation for your XTRF Platform, click the link at the top of the Access Tokens tab. |