Azure DevOps

Version Requirement: The Azure DevOps Git connection requires Apidog On-Premises image version 2.8.35 or later.

Azure DevOps Configuration

To integrate with Azure DevOps, you need to register an application in Microsoft Entra ID (formerly Azure Active Directory) to enable OAuth authentication.

Registering an Application in Microsoft Entra ID

Follow the official Microsoft documentation to register your application:

https://learn.microsoft.com/en-us/entra/identity-platform/quickstart-register-app

Configuration Steps

Sign in to Microsoft Entra Admin Center:

Navigate to Microsoft Entra admin center

Go to Identity > Applications > App registrations

Register a New Application:

Click New registration

Provide a Name for your application (e.g., "Apidog On-Premises")

Select the appropriate Supported account types based on your organization's requirements:

Single tenant: Accounts in this organizational directory only

Multitenant: Accounts in any organizational directory (recommended for most cases)

Configure Redirect URI:

Under Redirect URI, select Web as the platform

Set the redirect URI to your Apidog On-Premises API domain, followed by /api/v1/projects/git-connections/azure-callback

For example: https://your-apidog-domain.com/api/v1/projects/git-connections/azure-callback

Click Register to create the application

Note the Application Details

After registration, you will see the Application (client) ID on the Overview page

Save this value as you will need it for the AZURE_DEVOPS_CLIENT_ID environment variable

Create a Client Secret:

Under the Manage section in the left navigation, select Certificates & secrets

Click New client secret

Add a description and select an expiration period

Click Add

Important Note

Copy and securely store the client secret Value immediately. The secret is displayed only once upon creation and cannot be retrieved later. This value is required to configure the AZURE_DEVOPS_CLIENT_SECRET environment variable.

Required OAuth Scopes

The default scope configuration includes:

vso.code_full: Grants full access to source code, including commit metadata, changesets, branches, and other version control artifacts.

vso.profile: Grants read-only access to user profile, accounts, collections, projects, teams, and other top-level organizational artifacts.

Grant Admin Consent (External Tenants Only)

By default, the application is assigned the User.Read permission upon registration. For external tenants, individual users are often restricted from consenting to permissions independently. Therefore, an administrator must grant consent on behalf of the entire tenant.

Under the Manage section in the left navigation, select API permissions.

Select Grant admin consent for <Tenant Name> to authorize permission.

In the confirmation dialog, select Yes.

Select Refresh.

Ensure the Status indicator shows Granted for <Tenant Name> next to the User.Read permission.

Environment Variables

Once you have registered your application and obtained the credentials, configure the following environment variables:

Environment Variable	Description	Default Value	Notes
`GIT_CONNECTION_AZURE_DEVOPS_ENABLE`	Whether to enable Azure DevOps Git connection	`false`	Set to `true` to enable Azure DevOps integration
`AZURE_DEVOPS_AUTH_HOST`	Microsoft Entra ID authentication endpoint	`https://login.microsoftonline.com/common`	Use `/common` for multitenant or `/{tenant-id}` for single tenant
`AZURE_DEVOPS_API_HOST`	Azure DevOps API host URL	`https://dev.azure.com`	Use your Azure DevOps Server URL for on-premises installations
`AZURE_DEVOPS_VSSPS_HOST`	Azure DevOps Visual Studio Services host URL	`https://app.vssps.visualstudio.com`	Required for user profile and organization information
`AZURE_DEVOPS_CLIENT_ID`	Microsoft Entra ID application client ID	-	Required - obtained from app registration
`AZURE_DEVOPS_CLIENT_SECRET`	Microsoft Entra ID application client secret	-	Required - obtained from app registration
`AZURE_DEVOPS_REDIRECT_URI`	OAuth redirect URI	-	Must match the redirect URI configured in your Entra ID application
`AZURE_DEVOPS_SCOPE`	OAuth scope permissions	`offline_access https://app.vssps.visualstudio.com/.default`	Required scopes for repository access and user information
`GIT_CONNECTION_AZURE_DEVOPS_REJECT_UNAUTHORIZED`	SSL certificate validation for Azure DevOps	`true`	Set to `false` for self-signed certificates in Azure DevOps Server environments

Configuration Example for Azure DevOps Services (SaaS)

- name: GIT_CONNECTION_AZURE_DEVOPS_ENABLE
  value: 'true'
- name: AZURE_DEVOPS_AUTH_HOST
  value: 'https://login.microsoftonline.com/common'
- name: AZURE_DEVOPS_API_HOST
  value: 'https://dev.azure.com'
- name: AZURE_DEVOPS_VSSPS_HOST
  value: 'https://app.vssps.visualstudio.com'
- name: AZURE_DEVOPS_CLIENT_ID
  value: <your-application-client-id>
- name: AZURE_DEVOPS_CLIENT_SECRET
  value: <your-application-client-secret>
- name: AZURE_DEVOPS_REDIRECT_URI
  value: 'https://your-apidog-domain.com/api/v1/projects/git-connections/azure-callback'
- name: AZURE_DEVOPS_SCOPE
  value: 'offline_access https://app.vssps.visualstudio.com/.default'
- name: GIT_CONNECTION_AZURE_DEVOPS_REJECT_UNAUTHORIZED
  value: 'true'

Azure DevOps Configuration#

Registering an Application in Microsoft Entra ID#

Configuration Steps#

Environment Variables#

Configuration Example for Azure DevOps Services (SaaS)#

Azure DevOps Configuration

Registering an Application in Microsoft Entra ID

Configuration Steps

Environment Variables

Configuration Example for Azure DevOps Services (SaaS)