This integration requires a license of Stoplight. If you are not currently a Stoplight customer and would like to use this functionality, please contact our Sales team for a demo.
This article reviews how to configure Stoplight's integration with Azure DevOps Server (also known as TFS).
Stoplight uses TFS 2018 Update 3 (version 16.131.28106.2) for internal testing and verification. If you plan on using Stoplight with a different version of TFS, please let us know.
Before continuing, be sure to:
- Have the full URL to your Azure DevOps Server available, including the collection you would like to integrate with Stoplight. For example:
https://tfs.example.com/tfs/DefaultCollection- Note that an integration must be created in Stoplight for each collection that you would like to connect with.
- Generate a Personal Access Token (discussed in more detail below)
- Be logged in to Stoplight as an Administrator
Generating Personal Access Tokens (PATs)
Stoplight requires Personal Access Tokens (or PATs) in order to connect to Azure DevOps Server. This means that you will need to manually generate a PAT for your integration when connecting your Stoplight account to your Azure DevOps account.
To generate a PAT, when logged into Azure DevOps Server navigate to your user menu and select the "Security" option.
Under the Security settings there is a section dedicated to "Personal access tokens".
When creating the token, be sure to select "All scopes".
From the Stoplight Landing Screen
From the Admin Settings
From the External Services Screen
Registering the Azure DevOps Server
Stoplight requires the use of PATs instead of passwords when connecting accounts. When connecting your Stoplight account with a Azure DevOps Server/TFS account, please be sure to use your PAT in place of a password.
Next Steps
Now that you've configured Azure DevOps, continue on to Connecting Your Accounts or Getting Started with Studio to start creating APIs.