Authentication (On-Premises) Personal Access Token (PAT) (DEPRECATED)
Description
Instructions
**DEPRECATED:** On-premises PAT method is legacy; consider Azure App Credentials if your server supports Azure AD apps. To connect to Azure DevOps On-Premises Server using a Personal Access Token (PAT), you must first create a valid PAT:-
Start by navigating to your on-premises Azure DevOps Server URL.
NOTE: The screenshots shown below are from the cloud version, so your interface may look slightly different depending on which on-premises Azure DevOps Server version you’re using — however, the overall concepts and steps are very similar between the cloud and on-premises editions. -
Now open any project and capture Collection Name from the URL. For example if your URL is
https://tfs.mycompany.local/tfs/MyCollection/MyProject/
then your collection name is MyCollection usually after /tfs/. Copy this collection name and later we will enter on Connection UI. -
Next, click User settings icon and then click Personal access tokens:
-
Then click New Token button to create a new personal access token:
-
Continue by...
- naming your token
- selecting the right Organization
- setting token's Expiration date (it's recommended to use
Custom definedoption and make it expire after one year or later) - and setting the Scopes:
NOTE: You may be restricted from creating full-scoped PATs. If so, your Azure DevOps administrator in Azure AD has enabled a policy which limits you to a specific custom defined set of scopes.
-
Now click Copy button and save the newly created token into a file for quick access later:
- Go back to the connector screen, input the token you saved in a previous step into the Personal Access Token (PAT) field.
- Then enter the Organization host name part that you noted recorded in previous step into Organization name or Id for url field.
- Enter the name or Id of the project you want to connect to by default in the Default Project (Choose after above fields) field.
- Select the Security tab.
- Enter
https://auditservice.dev.azure.com,https://almsearch.dev.azure.com,https://analytics.dev.azure.cominto the Additional Trusted Domains field. - Select the Test Connection button at the bottom of the window to verify proper connectivity with your Azure DevOps account. After that, choose Default Project Name in connection settings. Some endpoints (for example, work items) often work more reliably when a default project is selected; otherwise, you must supply the Project value each time.
- Done!
Parameters
| Parameter | Required | Default value | Options | ||||||||||
|---|---|---|---|---|---|---|---|---|---|---|---|---|---|
|
Name:
Label: Personal Access Token (PAT) |
YES | ||||||||||||
|
Name:
Label: Collection name (e.g. MyCollection) The collection name or Id |
YES | ||||||||||||
|
Name:
Label: API Version The version of the On-Premises TFS Server API to use. |
YES |
7.0
|
|
||||||||||
|
Name:
Label: AuthScheme |
Bearer
|
||||||||||||
|
Name:
Label: AuthHeader |
Authorization
|
||||||||||||
|
Name:
Label: Default Project Name The default project name to make API calls for. |
|||||||||||||
|
Name:
Label: RetryMode |
RetryWhenStatusCodeMatch
|
|
|||||||||||
|
Name:
Label: RetryStatusCodeList |
429
|
||||||||||||
|
Name:
Label: RetryCountMax |
5
|
||||||||||||
|
Name:
Label: RetryMultiplyWaitTime |
True
|