API DocumentationProduct Documentation

Manage Service Users

Suggest Edits

This page explains how Tetra Data Platform (TDP) Administrators can:

  • Access the Service Users page
  • Manage Service Users
  • Generate a JSON Web Token (JWT) for a Service User Account

Access the Service Users Page

To access the service users page:

  1. On the left side of the page, click Account from the expanded menu.
  2. Click Service Users to open the Service Users details page:
162

Service Users menu option

  1. From the Service Users page, you can add, edit, disable, or activate a service user.
1847

Service Users page

This table describes the fields in the Service Users page:

FieldDescription
Add Service UserClick to add a service user.
User (Filter)Allows you to filter based on the user's name. Partial matches are displayed.
User Role (Filter)Filters based on user role. Only items that match the filter are displayed.
User Status (Filter)Filters based on user status. Only items that match the filter are displayed.
Token Status (Filter)Filters based on token status. Only items that match the filter are displayed.
Token Created (Filter)Filters based on the date the token was created. Only items that match the filter are displayed.
Token Expiry(Filter)Filters based on the date the token expires. Only items that match the filter are displayed.
UserLists the user name.
User RoleDisplays the user role (Administrator, Member, or Read Only).
User StatusIndicates if the user is Active or Disabled (Inactive).
TokenDisplays a portion of the token generated for the service user. You can copy active tokens to your clipboard.
Token StatusDisplays the token status: Active, Expired, Disabled, or No Token.
Token CreatedIndicates when the token was created.
Token ExpiryIndicates the expiration date for the token (if any).

Add a Service User

To add a service user:

  1. Click Add Service User in the Service Users page.
  2. In the Add a new service user page, add the service user's name and assign an account role.
517

Add Service User

  1. Indicate whether the JSON Web Token that you want to create for the service user should expire. By default, the slider is set to "Yes". If you want a token that doesn't expire, move the slider to the left to indicate that it should not expire.
  2. Enter the number of days that the token should be active (1 to 720 days).
  3. Click Add to add the new service user.
  4. The generated token appears. Click Copy Token to copy the token to your clipboard or download the token in a TetraScience Software Development Kit (SDK) configuration file. This file is a text-based file that can be used if you want to create a Self-Service Pipeline.
  5. Click OK.

❗️

Token With No Expiration Date

If you create a JWT Token without an expiration date, then the token will remain valid until you disable the service user.

Edit a Service User

To edit a service user's role:

  1. In the Service Users screen, select the menu on the right side of the page that is next to the entry that you want to edit. Select Edit User.
192

Edit User Menu Option

  1. From the Edit Service User screen, you can edit the name and account role.
  2. Click Update to change the information.

Generate a JSON Web Token for an Existing Service User

To generate a token for an existing Service User:

  1. In the Service Users screen, select the menu on the right side of the page that is next to the entry that you want to edit. Select Generate Token.
  2. In the Generate New Token screen, indicate whether the token that you want to create for the service user should expire. By default, the slider is set to "Yes". If you want a token that doesn't expire, move the slider to the left to indicate that it should not expire.
509

Generate a New Token

  1. Enter the number of days that the token should be active (1 to 720 days).
  2. Click Add to add the new service user.

Disable a Service User

To disable a user's account for a service user:

  1. In the Service Users screen, select the menu on the right side of the page that is next to the entry that you want to edit. Select Disable User.
  2. A message displays asking you to confirm. Click Disable to disable the user's account.

Re-Enable (Activate) a Service User

To activate a user account that has been disabled (inactive):

  1. In the Service Users screen, select the menu on the right side of the page that is next to the entry that you want to edit. Select *Enable User.
178

Enable User (Activate User)

  1. A message displays asking you to confirm. Click Yes to re-enable the user's account.

Updated about 2 months ago