You are here: Learning the Basics > Security > Access Tokens

Access Tokens

Access Tokens are mechanisms to create a security token to access specific TDS REST services. For example, you could have an external service or process that needs to:

  • kick off an SA template
  • get a report
  • or any other TDS API request

The Access token tool provides the ability to generate a token and then pass the token as a parameter when the service is called without the need for additional authentication. Authentication is provided by the token.

Usage

ClosedAdd New

To add a new access token:

  1. Click + Add New to expand the new Access Token form.
  2. Fill in the Description, Behavior and Expiration Date.
    Behavior Options include:
    • Token expires on specified data - this is the default setting and will auto set the token to expire in 24 hours
    • Delete on first use (one time use only) - token can only be used once and will expire itself immediately after use
    • Token never expires (valid until manually deleted - token must be manually deleted to expire

    Tip: Deleting a token also expires it.

  3. Select the privileges in the Available Privileges table that you wish the token to provide authorization for. Available privileges are based on your user role.
  4. Click Save. Once saved the token will display under the list of privileges.
  5. To use the token, suffix your endpoint URL with the token provided.
ClosedUpdating Existing

To update an existing access token:

  1. Locate the row for the token you wish to edit and click Edit (pencil icon).
  2. Make desired changes to the form.
  3. Click Save.
ClosedDelete Existing

To delete an existing access token:

  1. Locate the row for the token you wish to delete and click Delete.
  2. Click Delete in the confirmation popup.