Azure DevOps Connector
Documentation
Version: 2
Documentation

Authentication OAuth


Description

No description available

Instructions

Connecting to your Azure DevOps data requires you to authenticate your REST API access. Follow the instructions below:
  1. Go to https://app.vsaex.visualstudio.com/app/register to register your app.
  2. Fill in your application and company's information as required, and then select the scopes that your application needs. This should typically be Project and team (read and write) and Work items (read and write).
    Your selected scopes when registering your app must match the scopes you enter here on the connector screen. If they don't match, the connector will not be able to work with your Azure DevOps account!
    If you need further information about the scopes used in Azure DevOps, or need to see what to enter into the connector screen to match up with your selected scopes, visit https://learn.microsoft.com/en-us/azure/devops/integrate/get-started/authentication/oauth?view=azure-devops.
    Create OAuth application in Azure DevOps

    NOTE: For Authorization callback URL use your company's OAuth Redirect URL (if IT administrator provides you one) or you can use https://zappysys.com/oauth (it's safe).

  3. Select Create Application and then the Application Settings page will be displayed.
  4. Record the App ID for us to use later: Copy App ID in Azure DevOps
  5. And do the same with Client Secret: Use Client Secret to read Azure DevOps REST API data
  6. Then go to https://aex.dev.azure.com and select relevant organization on the left.
  7. Then copy Organization's host name part (e.g. acmeinc, if full host name is acmeinc.visualstudio.com), save it to a file, and click it: Copy Organization Host in Azure DevOps
  8. Back at the connector screen, enter the App ID into the Client Id (App ID) field that was recorded in the previous step.
  9. Enter the Client Secret that was recorded in the previous step into the Client Secret field. In order to edit the text in this field, select the ellipses (...) button that appears when the textbox is clicked, and edit the Client Secret with the dialog box that appears.
  10. Enter the organization that was recorded in step 5 into the Organization name or Id for url field.
  11. Click Generate Token. If proper authentication occurs, you will see a notice saying so. You can click Yes to save a backup file of your generated tokens.
  12. Select the project you want to connect to by default from the Default Project (Choose after Generating Token) field.
  13. Select the Security tab.
  14. Enter https://auditservice.dev.azure.com,https://almsearch.dev.azure.com into the Additional Trusted Domains field.
  15. Select the Test Connection button at the bottom of the window to verify proper connectivity with your Azure DevOps account.
  16. If the connection test succeeds, select OK.
  17. To edit previously created app you can visit https://app.vsaex.visualstudio.com/me and see Applications and services section. Click on your desired app name.

Parameters

Parameter Label Required Default value Options Description
ClientId Client Id (App ID) YES The App ID obtained from the Azure Portal.
ClientSecret Client Secret YES The Client Secret obtained from the Azure Portal https://app.vsaex.visualstudio.com/ Click on your APP and View Client Secret. NOTE: Client Secret expires every five years. Regenerate your app secret to continue to create and use access tokens and refresh tokens. To do so, go to your app page, select [Regenerate secret], which then confirms that you want to complete this action.
Organization Organization name or Id for url (e.g. mycompany) YES The organization name or Id obtained from the Azure Portal.
ReturnUrl Return URL YES https://zappysys.com/oauth
Name Value
https://zappysys.com/oauth https://zappysys.com/oauth
The URL to send the authentication token back to.
Scope Scopes (Must match with App Registration) YES vso.project~vso.work_full
Name Value
Project and team (read) vso.project
Project and team (read and write) vso.project_write
Project and team (read, write and manage) vso.project_manage
Work items (read) vso.work
Work items (read and write) vso.work_write
Work items (full) vso.work_full
The scopes of access needed for the Azure DevOps API connection.
ApiVersion API Version YES 7.0
Name Value
6.0 6.0
7.0 7.0
7.1-preview.2 7.1-preview.2
The version of the Azure DevOps API to use.
Project Default Project Name (Choose after Generating Token) The default project name to make API calls for.
RetryMode RetryMode RetryWhenStatusCodeMatch
Name Value
None None
RetryAny RetryAny
RetryWhenStatusCodeMatch RetryWhenStatusCodeMatch
RetryStatusCodeList RetryStatusCodeList 429
RetryCountMax RetryCountMax 5
RetryMultiplyWaitTime RetryMultiplyWaitTime True