Tokens (meshIQ Platform v11 and XRay v1.6)

This article pertains to tokens in the Track user interface in the meshIQ Platform version 11 and XRay 1.6.

You can access token setup in the following ways in v11.2:

• On the left toolbar, select Administrator Settings > Tokens > Streaming
• On the left toolbar, select Administrator Settings > Tokens > Access
• On the left toolbar, select Administrator Settings > Tokens > Repositories; click the Setup icon in the Streaming Tokens column.
• On the left toolbar, select User Settings > Personal Tokens.

You can access token setup in the following ways until v11.1:

• From Admin Settings:
  > Admin Settings > Tokens > Streaming
  or 
  > Admin Settings > Tokens > Access
  or 
  > Admin Settings > Tokens > Repositories; click the Setup icon in the Streaming Tokens column.
• From User Settings:
  > User Settings > Personal Tokens

This article covers two token types:

Streaming tokens. Streaming tokens allow an administrator to provide users with access to stream data to a specific repository. These tokens define the objects that may be streamed and may include limits on data, retention, and the length of time for which the token is valid (expiration date).

Access tokens. Access tokens allow a user to share access to one or more repositories. The user can specify the privileges that the recipient of the token will have for the repository, such as Query (for getting data), Modify for adding and updating non-administrative items, or Delete for deleting non-administrative data. Users who are granted Admin or Execute privileges will have more advanced capabilities, as described below.

Streaming Tokens (Admin Settings)

An administrator defines and configures streaming tokens for the following scenarios and shares these tokens with all team members as required:

• Streaming data to XRay

• Set up an AWS CloudWatch metrics HTTP endpoint 

• Streaming AutoPilot data to XRay

To set up a streaming token:

1. Click Create.
2. (Optional.) Enter a Token prefix to identify the type of token, if needed.
3. Select the Repository to which the token provides access.
4. Indicate which types of objects you want to stream. By default, all objects are streamed (the Select all checkbox is selected). You can clear the checkbox to choose individual items, one at a time. Options are Activity, Dataset, Event, and Snapshot. (To remove a selection, click the X provided for that object.)
5. (Optional.) To set up the token to expire, use the Expire Time field to select a specific date and time.
6. Update the Token Quotas as needed. See Token Quotas fields below for details.
7. Click Create.

Token Quotas fields

When you set organization or repository quotas, the values you set must not exceed the values specified the max limits defined by your license. 

From the list of streaming tokens, you can view the quotas for a particular token in the list by clicking the View quotas icon: in the Quotas column.

Access Tokens (Admin Settings or User Settings)

All tokens except streaming tokens can be used for the REST API. 

Users define and generate their own access tokens, or personal tokens, for the following scenarios:

• For yourself:
  • Generate a token to be able to import data into a repository
• For others:
  • Give someone else the right to stream data to your repository. This might be a 3rd party that you want to collect data from. Once they have provided the required data, you can set an Expire Time or remove the token to discontinue streaming access.

To set up an access token:

1. Click Create.
2. (Optional.) Enter a Token prefix to identify the type of token, if needed.
3. Select the Repositories to which the token provides access. You can choose individual repositories, one at a time. (To remove a selection, click the X provided for that repository.)
4. (Optional.) To set up the token to expire, use the Expire Time field to select a specific date and time.
5. Update the Token Options as needed. By default, all objects are selected (the Select all checkbox is selected). You can clear the checkbox to choose individual items, one at a time. See Token Options below for a list of objects.
   • Query (for getting data). Allows a user to access the repository data (for example, from the mobile application)
   • Modify Allows users to modify non-administrative data in the repository. This includes the ability to both add and update items.
   • Delete Allows users to delete non-administrative data in the repository
   • Admin allows users to manipulate administrative data only (that is, the following items): Users, Organizations, Teams, Repositories, and Tokens (listed as "AccessTokens").
   • Execute allows users to use Invoke commands (to invoke scripts, actions, or external actions).
6. Click Create.

Token Options

Items marked with asterisks below are administrative items. These are controlled by the Admin token option. 

Edit a token

1. Click the edit icon for the token.
2. Make your changes.
3. Click Save.
   
   

Clone a token

To create a new token based on an existing token, use the clone function.

1. Click the clone icon for the token you want to copy. By default the name of the new token is the name of the cloned token followed by "Copy."
2. Enter a new name for the new token.
3. Make any other desired changes.
4. Click Create..
   
   

Delete a token

1. Click the delete icon for the token you want to remove.
2. Click Yes at the confirmation message. The token is removed.