Creating or Generating an API Token

To create or generate an API token:

Note: Before using API tokens, confirm that the BindUser and BindPassword parameters are defined in the clientmanager.props configuration file.

  1. Click Administration > API Tokens in the Navigation pane to display the API Tokens pane. All existing API token records display.

    Note: You can view API token records if you have the appropriate permissions and the tokens are still valid.

  2. Click Add on the TA toolbar.

    Note: If the API Token pane contains any records, you can add a new token by right-clicking anywhere in the pane and selecting Add API Token.

  3. Type a unique name for the API token in the Name field. The Name field is required.

    Note: If storage of API Tokens is enabled in the Password Vault (see System Configuration – Vault Tab), the input in the Name field carries a special significance. If the name input is in the <prefix>/<postfix> format (for example, “apitokens/mytoken”), then the token will be stored in the location “<mount path in the master.props>/apitokens” in the Password Vault, provided that the folder specified in the <prefix> exists in the Password Vault. Otherwise, if the storage of API Tokens in the Password Vault is enabled and the name is not in the <prefix>/<postfix> format (for example, “mytoken”), the token will be stored in the default location “<mount path in the master.props>/tokens” in the Password Vault.

  4. Select the owner of the API token from the drop-down list. The Owner field is required.

  5. Select the appropriate user from the drop-down list to generate their API token for. The User field is required.

  1. Enter the description for the API token in the Description field.

  2. Select the date you want the API token to expire in the Expiration Date field.

  1. Select the desired number of uses for the API token from the Remaining Logins drop-down list.

    Note: The Unlimited checkbox next to the Remaining Logins field lets you control how many times the API token can be used. It's checked by default for unlimited logins. To restrict the number of logins, clear this checkbox and enter the desired limit.

    Note: Unchecking the Unlimited checkbox enables the Auto Delete Token option. To automatically delete the API token when the remaining logins reach "0", check Auto Delete Token.

  2. Use the Max. API Calls/CM/Minute drop-down list to set the maximum number of API calls per every Client Manager instance per minute.

    Note: The Unlimited checkbox next to Max. API Calls/CM/Minute field allows unlimited API calls per every Client Manager instance per minute. To select the maximum number of API calls allowed in every Client Manager instance per minute, clear this checkbox and enter the desired limit.

  3. Use the Max. Concurrent Logins/CM drop-down list to set the maximum concurrent client login limit per every Client Manager instance.

    Note: The Unlimited checkbox next to Max. Concurrent Logins/CM field allows unlimited concurrent client logins per every Client Manager instance.

  1. Click the Session Token Time to Live field and do one of these actions:

    • Set the maximum number of seconds the session token will be active. The default value is 600 seconds. The session token expires when the Session Token Time to Live value exceeds. Select Auto Refresh Session Token, to automatically refresh or regenerate a new session token when it expires.

    • Select the Unlimited (Seconds) checkbox to keep the session token active without a time limit. If you select the Unlimited (Seconds) checkbox, the Auto Refresh Session Token checkbox disables.

Note: By default, the Public checkbox is selected, making the API token record available to all TA users with the appropriate permissions to view the API token record. To restrict access to the API token record, clear this checkbox.

Note: The Enabled checkbox is selected by default, making the API token active and available for use. To deactivate the API token, clear this checkbox.

  1. Click OK to create or generate the API token. A success message appears when the API token is created.

Enable API Tokens in Tidal Automation

These steps will take you through the process of activating API tokens to ensure seamless integration.

To enable API Tokens:

  1. Stop the Tidal Automation services.

  2. Go to C:\Program Files\TIDAL\ClientManager\script and open the cmd promt from this directory.

  3. Run this command:

    cm.cmd setbindpwd "password"

    Note: Avoid using quotation marks (") in the passwords, and remember to enclose the password itself in double quotes ("your password").

    The encrypted password has now been added to the props file.

  4. Go to C:\Program Files\TIDAL\ClientManager\config.

  5. Open clientmgr.props file and add this line:

    ActiveDirectory.BindUser=dv\\tes

  6. Add this line:

    ActiveDirectory.BindPassword

  7. Save the file.

  8. Run the Tidal Automation instance.