Reference

Authentication (On-Premises) Personal Access Token (PAT)


Description

No description available

Instructions

To connect to Azure DevOps On-Premises Server using a Personal Access Token (PAT), you must first create a valid PAT:
  1. 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.
  2. 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.
  3. Next, click User settings icon and then click Personal access tokens: Click User Settings icon in Azure DevOps
  4. Then click New Token button to create a new personal access token: Create new token in Azure DevOps
  5. Continue by...
    • naming your token
    • selecting the right Organization
    • setting token's Expiration date (it's recommended to use Custom defined option and make it expire after one year or later)
    • and setting the Scopes:
    Finish creating token in Azure DevOps

    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.

  6. Now click Copy button and save the newly created token into a file for quick access later: Use Azure DevOps token to read REST API data
  7. Go back to the connector screen, input the token you saved in a previous step into the Personal Access Token (PAT) field.
  8. Then enter the Organization host name part that you noted recorded in previous step into Organization name or Id for url field.
  9. Enter the name or Id of the project you want to connect to by default in the Default Project (Choose after above fields) field.
  10. Select the Security tab.
  11. Enter https://auditservice.dev.azure.com,https://almsearch.dev.azure.com,https://analytics.dev.azure.com into the Additional Trusted Domains field.
  12. Select the Test Connection button at the bottom of the window to verify proper connectivity with your Azure DevOps account.
  13. Done!

Parameters

Parameter Required Default value Options
Name: Password

Label: Personal Access Token (PAT)

YES
Name: Organization

Label: Collection name (e.g. MyCollection)

The collection name or Id
YES
Name: ApiVersion

Label: API Version

The version of the On-Premises TFS Server API to use.
YES 7.0
Name Value
4.1 4.1
5.0 5.0
6.0 6.0
7.0 7.0
Name: AuthScheme

Label: AuthScheme

Bearer
Name: AuthHeader

Label: AuthHeader

Authorization
Name: Project

Label: Default Project Name

The default project name to make API calls for.
Name: RetryMode

Label: RetryMode

RetryWhenStatusCodeMatch
Name Value
None None
RetryAny RetryAny
RetryWhenStatusCodeMatch RetryWhenStatusCodeMatch
Name: RetryStatusCodeList

Label: RetryStatusCodeList

429
Name: RetryCountMax

Label: RetryCountMax

5
Name: RetryMultiplyWaitTime

Label: RetryMultiplyWaitTime

True