📘

Note:

This feature applies only to legacy access tokens created by version 3.0 users. Existing customers connected to Vertex O Series Cloud may still need this feature to legacy API authentication.

All other users should obtain an access token as described in Authentication and Access.

The API Access Tokens feature enables administrators to create, view, and manage access tokens used to authenticate API requests. Existing access tokens appear in the Tokens section, which displays each access token's description, creation date, and token identifier.

Use Create Token to generate a new access token for authentication.

Authenticate an access token

The service generates a unique token identifier and token value. The token identifier isn't the same as the token value and can't authenticate API requests. Use the token value for authentication.

Never share the token identifier. The service displays the token identifier only once. You must either copy the token identifier to your clipboard or manually record it. After you exit the page, you can't retrieve the token identifier. If you lose the token identifer, you must create a new access token with a new token identifier.

📘

Note:

A new access token can take several minutes to become active. During this activation period, an API request may return an HTTP 401 Unauthorized response.

Create an access token

To create a new access token, follow these steps:

1. Select Settings > API Access Tokens.
2. Click Create Token.
3. Copy the token identifier to your clipboard or manually record it.
4. Click OK to save your changes.

Field descriptions

The following table describes the available fields: