Skip to main content

Azure DevOps

Connector maturity: Beta. See Connector maturity.

Description​

The Azure DevOps connector reads the names of the secret variables kept in Azure DevOps variable groups (Azure DevOps Services or Azure DevOps Server) through the Azure DevOps REST API 7.1, so credentials that live in pipeline libraries instead of your vault can be found. It does not scan Azure DevOps users or groups.

Each variable group that has at least one secret variable appears as a Non-Human account named azure-devops:<organization>/<group name> [<id>], holding its secret variables as CI/CD secret credentials. The variables are also compared with your vault on the Secrets Outside Vault page, and the credential KRIs and credential policy rules apply to them.

System Type Classification​

FieldValue
System TypeApplication
Default Scan Priority500

Version Support​

OrbisID EditionSupported
CommunityNo
ProYes
EnterpriseYes

Supported Protocol​

ProtocolPortNotes
REST API (HTTPS)443 TCPA personal access token, sent as HTTP Basic with an empty user name

What OrbisID Discovers​

DataSource
ProjectsGET {organization}/_apis/projects
Variable groups and their variablesGET {organization}/{project}/_apis/distributedtask/variablegroups

By default only the variables marked secret are reported. Turn on the system attribute Include Plain Variables (azureDevOpsIncludeAllVariables) to report every variable; a secret stored as a plain variable is otherwise missed. Variable groups linked to Azure Key Vault are always left out, because their secrets already live in a vault. A group shared with several projects is reported once.

Azure DevOps returns the value of every variable that is not marked secret. OrbisID discards the value as soon as the response is read and never stores or logs it. A variable group has a created and a modified date for the whole group, not for a variable, so OrbisID records no date for a variable: the age of the group says nothing reliable about one secret in it, and an unknown date is not treated as "never".

At most 500 projects are read. A project whose variable groups cannot be read is skipped with a warning, and variables already recorded are kept rather than removed.

Connection Requirements​

Required Permissions​

Create a personal access token for OrbisID (a dedicated user is best) with the scopes:

  • Variable Groups: Read (vso.variablegroups_read)
  • Project and Team: Read (vso.project)

The token's user needs Reader (or higher) on the variable groups and must be a member of the projects to read. A token that can see no project fails the scan with a message saying so, instead of reporting that no secrets exist. Microsoft recommends Microsoft Entra ID authentication over personal access tokens for new integrations; OrbisID uses a token.

Credential Mapping​

OrbisID FieldValue
credential.passwordThe personal access token (the username is not used)
Organization (system attribute)The organization name, as in https://dev.azure.com/<organization>
system.pamPlatformUrlOptional. The full organization URL, required for Azure DevOps Server, for example https://tfs.example.com/tfs/DefaultCollection

Network Requirements​

The OrbisID server, or the On-Premise Agent for Azure DevOps Server, must have HTTPS access to dev.azure.com (or your server) on port 443.

Configuration Steps​

  1. In Azure DevOps create the personal access token described above
  2. Create a Credential in OrbisID with the token as the Password
  3. Navigate to Systems → Add System
  4. Fill in the fields:
FieldValue
NameDescriptive name (for example Azure DevOps - acme)
OS TypeAzure DevOps
System TypeApplication
Hostnamedev.azure.com
Organization (attribute)Your organization name
CredentialThe personal access token credential
  1. Click Test Connection
  2. Click Save

Troubleshooting​

SymptomLikely CauseResolution
Authentication failed - check the Azure DevOps personal access tokenThe token is wrong or expired. Azure DevOps often answers a bad token with a sign-in pageCreate a new token and update the credential
The token can see no projectMissing scopes, or the token's user is in no projectAdd the Project and Team (read) scope, or add the user to the projects
Azure DevOps refused ... (403)Missing Variable Groups (read) scope, or no Reader role on the groupsAdd the scope or the role
Set the Azure DevOps organization on the systemNeither the Organization attribute nor the Platform URL is setSet one
Warnings that some projects were not readThe token cannot read those projects' variable groupsGrant access, or accept that they are not covered
Variables appear without datesVariable groups have no per-variable datesExpected