Authorization tokens can be generated by users and admins to provide others with access to private/authenticated channels or with a specific set of permissions when using the Package Security Manager CLI or API.

This token can be used in place of username-based authentication, and is particularly useful (and sometimes necessary) for third-party applications or automation tools.

​
Token Types

There are two types of tokens within Package Security Manager:

​
Resource tokens

Resource tokens provide the token holder with read, write, or manage permissions for a specific set of channels.

​
Scope tokens

Scope tokens provide the token holder with a fine-grained set of custom user permissions, limiting the available actions that they are able to perform. A scope combines permission categories with specific actions users can perform into a concatenated string, like this:

category:action or category.subcategory:action

Tokens cannot contain both resources and scopes.

Some actions are also tied to permission levels. For example, if you provide the scope channel:edit, you are also providing manage level permissions over channels.

​
Generating tokens

To provide token holders with access to a channel:

  1. Log in to Package Security Manager.

  2. Select Tokens from the left-hand navigation.

  3. Click Generate Token.

  4. Enter a name for your token.

  5. Set an expiration date for your token.

  6. Open the Type dropdown menu and select Resources.

  7. Open the Channel dropdown menu and select an available channel to associate with this token.

  8. Select the level of permissions to associate with this token.

  9. If necessary, click the Add Resource button to include an additional channel with this token, repeat as needed.

  10. Provide a brief description of the token’s use.

  11. Click Create.

  12. Save your token string in a secure location.

    Generated tokens appear in the upper right corner, and will remain visible until you close the notification, or navigate away from the page.

    Save your token in a secure location! If you lose your token, there is no way to recover the token string. You must issue a new token if you lose your current token.

​
Editing a token

You can edit a token to change its name or to update its expiration date. You can choose to issue a new token while editing as well, which will invalidate the previous string associated with the token.

To edit a token:

  1. Log in to Package Security Manager.
  2. Select Tokens from the left-hand navigation.
  3. Select the token’s Edit icon.
  4. Make any necessary changes to the token.
  5. If necessary, select the Issue a new token checkbox. A warning appears at the top of the window to inform you that you will receive a new token.
  6. Click Edit.

​
Deleting a token

To delete a token:

  1. Log in to Package Security Manager.
  2. Select Tokens from the left-hand navigation.
  3. Select Delete Token beside the token you want to delete.
  4. Click Delete.

​
Setting/using a token

Once you have generated a token, you can share it with other users by any method you wish.

If you have received a resource token string from another user and you would like to use it to access packages on a channel, add the channel to your .condarc file by running the following command:

# Replace <FQDN> with the URL of your Package Security Manager fully qualified domain name
# Replace <TOKEN> with the generated/shared token string
# Replace <CHANNEL> with the channel name
conda config --add channels http(s)://<FQDN>/api/repo/t/<TOKEN>/<CHANNEL>

​
Managing tokens via the CLI

For more information on working with tokens using the CLI, see Package Security Manager CLI.

​
Managing tokens via the API

​
Listing available authorization scopes

GET /api/system/tokens

​
Listing the user authorization tokens

GET /api/account/token

​
Creating a new user authorization token

POST /api/account/tokens

​
Removing a user authorization token

DELETE /api/account/tokens/<TOKEN_ID>

Was this page helpful?

ProjectsHistory