Create an API token in Tricentis User Administration

Application Programming Interfaces (APIs) are the data interface between applications and servers. To make sure that your system under test is functional, reliable, and secure, you need to test your APIs. This may require API authentication; not every API accepts calls without authentication.

If you use Tricentis User Administration, you can generate API access tokens directly in Tricentis User Administration.

What's in this topic?

This topic is for administrators and users. It has all the information you need to complete the following tasks: 

  • Generate a new token. This gives you a base64 encoded personal access token with a client ID and a client secret that you can use in your API tests.

  • Delete a token.

Generate a new token

API access tokens allow you to access the APIs you want to test. To generate a new API access token, follow these steps:

  1. Access Tricentis User Administration and go to My Account.

  2. On your account page, click on Add new.

  3. In the subsequent Generate Token dialog, enter the following information:

Entry

Description

Name

Enter a unique name for your API token.

Expiration date

Enter an expiration date for your token.

Scopes

By default, every token has access to all scopes.

If you want to limit the token's access to specific scopes, clear the Full Access checkbox and choose your scopes from the drop-down menu.

Generate a new token in Tricentis User Administration

  1. Click Generate Token.

  2. The next screen shows the generated token, client ID, and client secret. Copy the information immediately. Once you close the dialog, you can't access this information anymore.

  3. Click Close.

You can now see the information that you have a token and the token's expiration date on your account page.

Token on a user's account page

Delete an API token

If you don't need a token anymore and don't want to wait until it expires, you can delete it.

To do so, follow these steps:

  1. Access Tricentis User Administration and go to My Account.

  2. On your account page, click the icon next to the token you want to delete.

What's next

Create tests with the API Engine 3.0 to make sure that your APIs are working as expected.