Access Tokens

Last modified on 2023/11/07 16:25

Service Manager: 2023.1 - Build 2022.1.133.0+

Access to the Service Manager REST API is secured and performed using Token authentication using an access token.

     Open url.png See the authentication methods supported by Service Manager

Each access token:

  • Is defined for a given user.
  • Enables access to a given Service Manager REST API resource.

Notes

Caution

  • The value of the access token is only available when you generate the token. If you lose it, you must generate a new access token.

Best Practice

  • If you want to prohibit a previously authorized user from accessing Service Manager data from the resource associated with the access token, you should revoke the token.
  • You can also manage the expiry date of the access token if you want to keep it.

Menu access

Administration > Access Management > Access Tokens

Screen description

          Access token.png

Name: Name of the access token.

User: Name of the user authorized to use the access token.

Expiry Date: Date after which the access token can no longer be used.

  • The expiry date will take effect at twelve midnight of the selected date or of the selected period.
  • If no expiry date is specified, the validity of the access token will be unlimited.

Date of last use: Date on which the access token was last used for a Service Manager REST API resource.

Revoke: Used to invalidate the use of the access token.

  • All of the resources associated with this token will no longer be available. To make them available again, you must generate a new access token.

Procedures

How to create an access token

CreateAccessToken_Procedure

Best Practice icon.png  We recommend that you use the authentication method Service Manager (Access Token) with a higher level of security than the Basic method which uses a login and password.

Step 1: Create an access token

   Your profile must be authorized to access the Administration > Access Management > Access Tokens menu. Open url.png See User profiles

1. Select Administration > Access Management > Access Tokens in the menu.

2. Click + New.

3. Enter the name of the new access token and select the user authorized to use the token.

4. Click Generate.

The value of the access token will automatically be copied to the clipboard.

   You should paste the value of the access token in your text editor to store it temporarily as it will no longer be available once you close the dialog box.

          Token added.png

EndCreateAccessToken_Procedure

 

How to revoke an access token

   Your profile must be authorized to access the Administration > Access Management > Access Tokens menu. Open url.png See User profiles

1. Select Administration > Access Management > Access Tokens in the menu.

2. Click Revoke next to the access token you want.

How to define access authorization for the Service Manager REST API

     Open url.png See the procedure

Tags:
Created on 2023/01/23 12:56
Powered by XWiki © EasyVista 2022