YouTrack Server
 
2019.2
Get YouTrack Standalone
You are viewing the documentation for an earlier version of YouTrack Server. View this page in the current documentation
  1. Managing Your Profile
  2. Manage Permanent Tokens

Manage Permanent Tokens

Last modified: 17 December 2019

In YouTrack Standalone, permanent tokens let developers access and perform operations securely using the REST API calls in their scripts and applications without having to implement OAuth 2.0 authentication flows. A permanent token allows access to a service with the permissions that are granted to the user account.

This page covers operations with permanent tokens that are performed in the user profile. For a sample of REST API calls using the permanent token, refer to the Permanent Token Authorization page in the Resources for Developers section.

Create a Permanent Token

To access a service programmatically with the permissions that are granted to your user account, create your own permanent token.

In addition to the permissions that are listed here, you need permission to read the service that you want to access with the token. Access to connected services is managed in Hub. If you work with YouTrack InCloud or a YouTrack Standalone installation that uses the built-in Hub service, all users have access to YouTrack services.

If your YouTrack Standalone installation uses an external Hub service, permission to read the connected service is granted in two ways:

  • The Access setting for the service grants group members access to the application from the Services menu. If you are a member of a group that is granted access in this way, you can create a permanent token to access the service. Basically, if you can see the name and icon for the service in the Services menu, you can generate a token to access the service.

  • You are granted the global Read Service permission.

If you are signed in and you don't see the option to create a token, ask an administrator to grant the Read Service permission to your account or to add you to a group for whom the service is visible.

To obtain a new permanent token:

tip

Requires permissions: Update Self

  1. Open your user profile.

  2. Click the link to access your Hub account.

  3. Select the Authentication tab.

  4. Click the New token button.

  5. In the New Permanent Token dialog, specify a name for the new token and the access scope for it. The scope for the token is a list of services which you can access with this new token.

    New permanent token dialog

    For the YouTrack instance with the built-in Hub, a scope basically let you send REST API calls to the following endpoints:

    Scope

    URLs

    Description

    YouTrack

    		 /rest/...
    /api/...

    Send API requests to the end-user part of YouTrack: issues, tags, commands, agile board, dashboard and reports.

    YouTrack Administration

    		 /hub/api/...
    /hub/rest/...

    Send API requests to the administration part of YouTrack: project and access management, server settings, etc.

  6. Click the Create token button.

    • A dialog window with the new token is displayed.

    Permanent token created

  7. Copy the token and store it in a secure location. Use either of these two actions to copy the token:

    • Click the Copy token button.

    • Select the token with your pointer and use the standard keyboard shortcut for your operating system to copy the current selection to the clipboard.

    warning

    You must copy the token at this point. As soon as you close the dialog, you can't access the token again. If you close the dialog accidentally, the only way to obtain a token is to repeat the procedure and create a new one.

  8. After you copy the token, close the dialog.

    • The new token is associated with your user account and is displayed in the list in the Authentication tab.

    Permanent token list

Delete a Permanent Token

A permanent token does not have an expiration date. If you suspect that an authenticated service has been compromised, you can explicitly delete this token in your profile.

To delete a permanent token:

tip

Requires permissions: Update Self

  1. Open your user profile. Switch to your Hub account.

  2. Open the Authentication tab.

  3. In the list of tokens, select the token that you want to revoke.

  4. Click the trash button.

    Permanent token revoke

    • A confirmation dialog is displayed.

  5. Click the Delete button.

    Delete token confirm

    • Selected permanent token is deleted and removed from the list.