YouTrack Standalone 2018.3 Help

Manage Permanent Tokens

In YouTrack Standalone, permanent tokens allows developers to access and perform operations securely via REST API calls in their scripts and applications without implementation of more complicated OAuth 2.0 authentication flows. A permanent token allows access to YouTrack instance with the permissions that are assigned to the user account with generated it.

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 Log in to YouTrack 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:

  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 keep it in a secure location.
    • A 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 the transactions with a YouTrack service using a permanent token have been compromised, you can explicitly revoke this token in your profile.

To delete a permanent token:

  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.

Last modified: 12 October 2018