OAuth 2.0 Authorization
To access YouTrack resources with the REST API using OAuth 2.0, you need to log in, authorize, and obtain an access token for YouTrack. Authorization is provided by the Hub service.
We only recommend that you use OAuth 2.0 when your application requires client-side authentication. Otherwise, you're better off using token-based authorization. For more information, see Permanent Token Authorization.
If your YouTrack Server installation is connected to an external Hub service, then you can use any OAuth 2.0 authorization flow that is supported by Hub. The built-in Hub service only supports implicit authorization grants. External Hub installations support a wider range of authorization methods. For details, refer to the Hub documentation.
The Hub service that is connected to a YouTrack Cloud instance only supports implicit authorization grants.
The built-in Hub service uses the following OAuth 2.0 endpoints:
<Hub service URL>/api/rest/oauth2/auth
<Hub service URL>/api/rest/oauth2/token
For a YouTrack Server installation, the
<Hub service URL>is the access point for the Hub service in your network environment. For YouTrack Server installations, the service is accessible from your YouTrack Base URL appended with the path
/hub. For example,
You can find the Base URL for your installation on the Global Settings page.
For a YouTrack Cloud instance, the
<Hub service URL>is the access point for the Hub service in your network environment. For YouTrack Cloud, the service is accessible when you replace the
/youtrackpath in your YouTrack Base URL with
/hub. For example,
You can find the Base URL for your instance on the Domain Settings page.
YouTrack supports OAuth 2.0 authorization with implicit authorization as specified in the OAuth 2.0 Authorization Framework.
To obtain an access token from YouTrack, you need to provide values for the following parameters:
To start authentication, redirect the browser to the authorization endpoint:
To obtain an access token from YouTrack, you need to provide values for the following parameters in your authorization requests:
Specifies the grant type in an OAuth 2.0 request. For implicit grant, use
An identifier for the current application state. For example, it can be a key for a local storage object that contains information about the location of the current user in the client application.
A URI in your client application that can handle responses from Hub.
A parameter that determines whether the user should be asked to log in. The following values are recognized:
The ID of the YouTrack service as registered in the built-in Hub service. To get the YouTrack service ID, open thepage:
The access scope in which your API requests are processed. Use the symbolic name of the YouTrack service in the built-in Hub:
The client service should be able to handle responses from Hub at the URL that is passed as the
redirect_uri. Response parameters are passed after a hash sign in the URL. As a result, these parameters are not sent to the server and cannot be intercepted by a malefactor.
If the resource owner grants the access request, Hub issues an access token and delivers it to the client by adding the following parameters to the fragment component of the redirect URI using the
The access token issued by Hub.
The type of the token that was issued by Hub. The value is case insensitive.
The lifetime of the access token, in seconds. For example,
Optional if identical to the scope requested by the client; otherwise, required. The scope of the access token in Hub is the
Required if the
Note that the authorization server (Hub) does not issue a refresh token.
For example, the Hub server redirects the user-agent by sending the following HTTP response:
OAuth 2.0 Errors
If the request fails due to a missing, invalid, or mismatching redirect URI, or if the client identifier is missing or invalid, the Hub server informs the resource owner of the error and does not automatically redirect the user-agent to the invalid redirection URI.
If the resource owner denies the access request or if the request fails for reasons other than a missing or invalid redirection URI, the authorization server informs the client by adding the following parameters to the fragment component of the redirect URI using the "
Human-readable ASCII [USASCII] text providing additional information, used to help the client developer understand what went wrong.
A URI that identifies a human-readable web page with information about the error, used to provide the client developer with additional information.
Required if a "state" parameter was present in the client authorization request. The exact value received from the client.
For example, Hub redirects the user-agent by sending the following HTTP response:
Authorization Response Errors
The following errors can be returned by a request to the authorization endpoint.
Token Response Errors
The following errors can be returned by a request to the token endpoint. For more information, read the definition of each error as defined in the RFC6749 standard.