# Microsoft Azure DevOps Connector > SailPoint Microsoft Azure DevOps Connector Documentation # Documentation # Connecting SailPoint and Microsoft Azure DevOps To connect SailPoint with Azure DevOps, perform the following tasks: ## Adding the Source in SailPoint To connect to SailPoint, perform the following steps. Once the connection is made, you can configure it to meet your company's needs. > [!IMPORTANT] > > By default, the provisioning feature is **disabled**, and the connector only supports read-only operations. To support provisioning operations, you must manually enable the feature in the source configuration. **To configure a new source:** 1. Sign in to SailPoint. 2. Go to **Admin \> Connections \> Sources**. 3. Select **Create New**. 4. Search for the connector by entering the name in the search box, and then select **Configure**. 5. In the **Source Name** field, enter a unique and descriptive name for your source. Source names cannot exceed 128 characters. 6. In the **Description** field, provide additional details about the source to help distinguish it from similar sources. This field allows a maximum of 2,000 characters. 7. In the **Source Owner** field, begin typing the name of an owner. Matches appear after you type two or more letters. For more information, refer to [Assigning a Source Owner](). 8. (Optional) Select a governance group to grant its members [source]() or [role]() sub-admin level oversight of the source and its access. For more information, refer to [Creating and Managing Governance Groups](). 9. If this source represents a primary system containing your organization's personnel records, select the **Authoritative Source** checkbox. For more information, refer to [Creating Identity Profiles](). 10. Select **Continue**. The source is created, and you are navigated to the **Source Setup \> Base Configuration** page. Continue to configure your connected source there. ## Base Configuration Provide the base configuration parameters. Information you entered in the Create New Source dialog is automatically entered into the fields in the Base Configuration page. You can edit this information if necessary. 1. Enter a unique name and description for the source. 2. In the **Source Owner** dropdown list, select the identity that owns this source. - To find a source owner, begin entering their name. 3. (Optional) If enabled for your organization, select the **Use a Credential Provider** checkbox to manage the source's authentication using a credential provider. > **Note** > > To add a credential provider, go to **Admin \> Connections \> Credential Providers**. For more information about credential providers, refer to [Credential Providers](). 4. Configure the authentication to allow SailPoint to connect to the source. Refer to [Connection Settings](<#connection-settings>) for more information. 5. (Optional) In the **Governance Group for Source Management** dropdown list, select a governance group to associate with this source. For more information about governance groups, refer to [Associating Governance Groups with a Source](). 6. (Optional) Choose whether to enable or disable provisioning for the source. Provisioning is disabled by default. - **Enable Provisioning** - Set the toggle to **Enabled** to allow the source to create, update, and deactivate accounts in the connected source system. - **Disable Provisioning** - Set the toggle to **Disabled** to disable provisioning for the source. Disabling provisioning will prevent the creation, updating, or deactivating of accounts on this source. 7. Select **Save**. ## Connection Settings Configure a secured, direct connection to the Azure DevOps source based on the selected **Grant Type**. > [!NOTE] > > For existing sources, with added Grant Type field in UI, please select the correct one and save the configuration whether you wish to continue to existing or switch to new Grant Type. Select one of the following **Grant Types** based on your requirements: - **Personal Access Token** - for PAT-based authentication - **Client Credentials** - for client-secret-based authentication - **JWT Certificate Credentials** - for JWT client certificate assertion-based authentication > [!NOTE] > > **Personal Access Token** > > > **Screenshot** > > > > [![Connection Settings - Personal Access Token]()]() > > 1. In the **Grant Type** dropdown list, select **Personal Access Token**. > 2. Enter the **Base URL** for the Azure DevOps system. SailPoint recommends using HTTPS for a secured connection. > 3. Enter the **Organization Name** of the Azure DevOps organization. > 4. Enter the **Personal Access Token** (PAT) generated in the source. For more information, refer to [Prerequisites](). > 5. Select **Save**. > [!NOTE] > > **Client Credentials** > > > **Screenshot** > > > > [![Connection Settings - Client Credentials]()]() > > 1. In the **Grant Type** dropdown list, select **Client Credentials**. > 2. Enter the **Base URL** for the Azure DevOps system. SailPoint recommends using HTTPS for a secured connection. > 3. Enter the **Organization Name** of the Azure DevOps organization. > 4. In the **Client ID** field, enter the Microsoft Entra ID application Client ID that has access to the Azure DevOps organization. > 5. In the **Client Secret** field, enter the Microsoft Entra ID application Client Secret value that has access to the Azure DevOps organization. > 6. In the **Domain Name** field, enter the name of the Microsoft Entra ID domain to be managed. For example, `contoso.onmicrosoft.com`. > 7. Select **Save**. > [!NOTE] > > **JWT Certificate Credentials** > > > **Screenshot** > > > > [![Connection Settings - JWT Certificate Credentials]()]() > > 1. In the **Grant Type** dropdown list, select **JWT Certificate Credentials**. > 2. Enter the **Base URL** for the Azure DevOps system. SailPoint recommends using HTTPS for a secured connection. > 3. Enter the **Organization Name** of the Azure DevOps organization. > 4. In the **Client ID** field, enter the Microsoft Entra ID application Client ID that has access to the Azure DevOps organization. > 5. In the **Certificate** field, provide the contents of the certificate file used to sign the JWT assertion and uploaded in the Microsoft Entra ID application. > 6. Enter the contents of the **Private Key** file used for encrypting the JWT assertion. > > > **Important** > > > > Generate and use an RSA encrypted private key. Unencrypted private keys are not supported. > 7. Enter the **Private Key Password** used to decrypt the private key. > 8. In the **Domain Name** field, enter the name of the Microsoft Entra ID domain to be managed. For example, `contoso.onmicrosoft.com`. > 9. Select **Save**. ## Aggregation Settings Change settings related to aggregation processes. ### Manage Service Principals as Accounts By default, the connector only aggregates User data, and ignores Service Principals and Managed Identities during account aggregation. You can include Service Principles and Managed Identities in account aggregation processes, and enable the connector to manage these as well. To include Service Principals and Managed Identities in account aggregation: 1. Select **Manage Service Principals as Accounts**. 2. Select **Save**. ## Azure DevOps REST API Version Configuration You can configure the connector to use a specific version of Azure DevOps Service REST API using the `apiVersion` parameter. > [!NOTE] > > **apiVersion** > > This parameter sets a specific Azure DevOps REST API version to use with the source. > > string To configure a specific version in the source, set the `apiVersion` parameter to the required REST API version. Upload the change using SailPoint's REST API. For example: `` > [!NOTE] > > For more information on SailPoint's REST APIs, refer to [Best Practices: REST API Authentication]() and [REST API - Update Source (Partial)]() in the SailPoint Developer Community. ## Review and Test Perform a test to confirm the connection to SailPoint. 1. Go to **Review and Test**. 2. Confirm that the entries in each field are correct. If you note any mistakes, return to the section and make corrections. 3. Select **Test Connection**. ## SailPoint Application Onboarding SailPoint application onboarding enables you to easily onboard new applications and create sources following the successful onboarding of a discovery source. To use this feature, continue to **Discovered Applications** in the SailPoint user interface. For more information, refer to [Application Onboarding]() in the SailPoint SaaS documentation. # Integrating SailPoint with Microsoft Azure DevOps The Microsoft Azure DevOps connector provides governance capabilities for users of Azure DevOps systems. It supports aggregation, provisioning, and adding or removing entitlements at the account level. This document is designed to give specific information about the requirements and field definitions needed to get a working instance of a Microsoft Azure DevOps connector. > [!NOTE] > > To view the latest features, enhancements, and fixes for all SaaS connectors, refer to the [SaaS Release Notes]() page. ## Supported Features The Microsoft Azure DevOps connector supports the following features. Account Management - Manage Azure DevOps users as accounts. - Aggregate and refresh accounts. - Create account (User and Service Principal). - Add or remove entitlements. Entitlement Management - Manage Azure DevOps groups as entitlements. - Aggregate and refresh entitlements. ## Prerequisites The prerequisites on this page are required to use the Microsoft Azure DevOps connector. Prerequisites depend on the **Grant Type** you configure on the [Connection Settings]() page. ### Personal Access Token The following prerequisites apply when you use the **Personal Access Token** grant type: - Create a personal access token (PAT) in the source with the proper permissions. For more information, refer to the following excerpts from the Microsoft Azure DevOps documentation: - [Prerequisites]() - [Create a PAT]() > **Note** > > The linked document is not maintained by SailPoint and is subject to change without notice. #### Required Permissions When you generate the PAT, ensure it has the following scopes: - `vso.graph` - Grants the ability to read user, group, scope and group membership information. - `vso.graph_manage` - Grants the ability to read user, group, scope and group membership information, and to add users, groups and manage group memberships. ### Client Credentials and JWT Certificate Credentials The following prerequisites apply when you use the **Client Credentials** or **JWT Certificate Credentials** grant type: - Create an OAuth credential (client secret or certificate) for a service principal in Microsoft Entra ID. For more information, refer to the following excerpts from the Microsoft documentation: - [Use service principals and managed identities in Azure DevOps]() - [OAuth 2.0 client credentials flow]() - for client secret authentication - [Certificate credentials for application authentication]() - for JWT certificate authentication > **Note** > > The linked document is not maintained by SailPoint and is subject to change without notice. #### Registering a Microsoft Entra ID Application 1. Register an application in Microsoft Entra ID and note the **Client ID**. 2. For **Client Credentials**, create a client secret for the application. 3. For **JWT Certificate Credentials**, create or obtain an X.509 certificate, upload the certificate to the Microsoft Entra ID application, and prepare the matching encrypted private key and its passphrase. > **Important** > > Generate and use an RSA encrypted private key. Unencrypted private keys are not supported. 4. Record the Microsoft Entra ID domain name for the tenant. For example, `contoso.onmicrosoft.com`. For more information, refer to [Authenticate to Azure DevOps with Microsoft Entra ID]() in the Microsoft Azure DevOps documentation. > [!NOTE] > > The linked document is not maintained by SailPoint and is subject to change without notice. #### Adding the Service Principal to Azure DevOps The Microsoft Entra ID application service principal must be added as a user to the Azure DevOps organization and granted the permissions required for aggregation and provisioning. For more information, refer to [Use service principals and managed identities in Azure DevOps]() in the Microsoft Azure DevOps documentation. > [!NOTE] > > The linked document is not maintained by SailPoint and is subject to change without notice. > [!NOTE] > > Grant access at the organization level in Azure DevOps. Project-scoped roles are not sufficient for connector operations. #### Required Permissions for Service Principals While generating and configuring OAuth credentials, ensure the service principal is added in Azure DevOps as a user with the appropriate access level. Add the service principal to the projects and resources you want to access or manage. To access and manage Azure DevOps resources, Project Collection Administrator level access is usually required. Verify and grant the access required to perform aggregation and provisioning. Grant the service principal the minimum Azure DevOps organization permissions required for the operations you plan to use: | Operation | Minimum Permission | | --- | --- | | Test connection and user and group aggregation | Organization-level member (Basic access) | | Membership aggregation | Organization-level read (Graph API access) | | Provisioning - add or remove group members | Project Collection Administrators | # Machine Account Attributes ## Machine Account Provisioning Attributes Use the following table to map each machine account attribute to its display name, data type, requirement status, and usage notes. | Field (name) | Type | Required | Notes | | --- | --- | --- | --- | | accountType | string | Yes | The account type. Set this value to **Service Principal** to create a Microsoft Entra ID Service Principal in Azure DevOps. | | originId | string | Yes | Object ID of the Microsoft Entra ID Service Principal. | | groups | string | Yes | The descriptor of the Azure DevOps Group. | For additional details about machine account implementation, refer to the [Machine Identity Security Overview](). # Provisioning The Microsoft Azure DevOps connector supports provisioning, allowing you to create and manage accounts and entitlements in Azure DevOps directly from SailPoint. **Prerequisite:** Your system is configured for provisioning. When SailPoint provisions new accounts to the source, it uses the attributes on the **Create Account** page as instructions or a template for what to include in the account. This page is also referred to as the *provisioning policy*. When new access is granted on a source where a user does not already have an account, SailPoint automatically includes account creation in the provisioning. This applies whether provisioning is started from an access request or from an automated role or lifecycle state assignment. For direct-connect sources, SailPoint automatically creates the account from this configuration. If the source is not configured as a direct-connect source, SailPoint creates and assigns a provisioning task to the source owner and includes the values for the source owner to use in manually creating the account. > [!IMPORTANT] > > This section describes the default **Create Account** configuration. SailPoint recommends that you work with Services to define a provisioning configuration specific to your company's needs. Be sure to verify large changes to the provisioning policy before implementation. Failure to do so might cause provisioning to fail. ## Default Create Account Attributes > [!IMPORTANT] > > Account attributes marked with an asterisk (\*) are mandatory attributes for account creation. | Account Attribute | Type | Description | | --- | --- | --- | | accountType | Radio button | Default is **User**
To create a Microsoft Entra ID Service Principal in Azure DevOps, set this value to **Service Principal**.
To create a Microsoft Entra ID Managed Identity in Azure DevOps, set this value to **Service Principal**. | | principalName | String | The Principal name (UPN) of the user within Microsoft Entra ID.
For example: [jeff@contoso.onmicrosoft.com]()
Important - You must ensure the UPN is the same as that on Microsoft Entra ID. | | originId | String | The unique identifier from the system of origin. Typically a `sid`, `object id` or `Guid`.
Provide the ObjectID of the Microsoft Entra ID Service Principal (Enterprise Application )/ Managed Identity.
For example, the Object ID for TestApp/TestMI is 0a835e3a-1c4d-4f53-82ee-8bf1faa55862 | # Schema Reference The application schema is used to configure the objects returned from a connector. > [!NOTE] > > - The **Account Schema** tab is used to define the attributes for each object type in the application being configured. The schema attributes can be defined as **Entitlement** or **Multi-Valued**. Refer to [Managing Source Account Schemas]() for more information. > - The schema attributes that are not present by [default](<#default-account-schema>) must be defined as strings if not specified. The Microsoft Azure DevOps connector uses the following default correlation and object configurations. ## Default Correlation Configuration Before you aggregate accounts from this source, you can map account attributes with their corresponding identity attributes based on your requirements. You can customize the correlation configuration. Refer to [Assigning Source Accounts to Identities]() for more information. When you first create the Microsoft Azure DevOps source, the default correlation mapping is: | Account Attribute | Operation | Identity Attribute | | --- | --- | --- | | principalName | Equals | Work Email | ## Default Account Schema Each source supports a variety of details, or attributes, about each user who has an account, such as their name, email address, manager name, and location. The set of account attributes each source stores and how they're organized is known as the account's *schema*. To best represent your data, you can configure sources to use an account schema matching the one you use in the external connector. Refer to [Managing Source Account Schemas]() for more information. ### Default Account ID SailPoint requires that certain attributes remain in your configuration. These attributes are referred to as *account IDs*. > [!CAUTION] > > Changing the attribute marked as the account ID after aggregating accounts can result in duplicate accounts being created. To avoid this, either reset the accounts on this source before editing the account ID attribute or edit the account ID attribute before aggregating accounts. > > To resolve issues caused by changing account IDs, reconfigure them to their default values. The following table lists the default account IDs for this connector: | Account ID | Schema Object Type | | --- | --- | | descriptor | Account | | descriptor | Group | ### Default Account Attributes The Microsoft Azure DevOps connector supports the following default account schema attributes and customer configurable attributes. The attributes must be defined as strings if not specified. | Attribute Name | Type | Description | | --- | --- | --- | | descriptor | string | The descriptor is the primary way to reference the graph subject while the system is running. This field will uniquely identify the same graph subject across both Accounts and Organizations. | | links | | This field contains zero or more interesting links about the graph subject. These links may be invoked to obtain additional relationships or more detailed information about this graph subject.
For more information, refer to [Users - List]() in the Microsoft documentation.
The linked document is not maintained by SailPoint and is subject to change without notice. | | directoryAlias | string | The short, generally unique name for the user in the backing directory.
For Azure DevOps users, this corresponds to the mail nickname, which is often but not necessarily similar to the part of the user's mail address before the @ sign.
For GitHub users, this corresponds to the GitHub user handle. | | displayName | string | This is the non-unique display name of the graph subject.
To change this field, you must alter its value in the source provider.
Account Name | | domain | string | This represents the name of the container of origin for a graph member. | | mailAddress | string | The email address of record for a given graph member. This may be different than the principal name. | | metaType | string | The meta type of the user in the origin, such as member, guest etc. | | origin | string | The type of source provider for the origin identifier
For example: `AD`, `AAD`, `MSA` | | originId | string | The unique identifier from the system of origin. Typically a `sid`, `object id` or `Guid`.
Linking and unlinking operations can cause this value to change for a user because the user is not backed by a different provider and has a different unique ID in the new provider. | | principalName | string | This is the principal name of this graph member from the source provider.
The source provider may change this field over time and it is not guaranteed to be immutable for the life of the graph member by VSTS. | | subjectKind | string | This field identifies the type of the graph subject
For example: `Group`, `Scope`, `User` | | url | string | This URL is the full route to the source resource of this graph subject. | | groups | group | List of groups associated with the user
Entitlement
Multi-Valued | ## Default Entitlement Attributes Entitlement attributes define the entitlements, such as groups or roles, that can be assigned to the managed system's user accounts. Refer to [Managing Entitlements]() for more information. > [!CAUTION] > > Changing the attribute marked as the Entitlement ID after aggregating accounts or entitlements can result in duplicate entitlements being created, or access profiles and roles breaking. To avoid this, edit the entitlement schema before performing any aggregations. ### Default Group Attributes The Microsoft Azure DevOps connector also supports groups. The following attributes must be configured on the managed system and in the SailPoint source schema to manage groups. | Attribute Name | Type | Description | | --- | --- | --- | | descriptor | string | The descriptor is the primary way to reference the graph subject while the system is running. This field will uniquely identify the same graph subject across both Accounts and Organizations. | | links | | This field contains zero or more interesting links about the graph subject. These links may be invoked to obtain additional relationships or more detailed information about this graph subject.
For more information, refer to [Groups - Get]() in the Microsoft documentation.
The linked document is not maintained by SailPoint and is subject to change without notice. | | description | string | A short phrase to help human readers disambiguate groups with similar names | | displayName | string | This is the non-unique display name of the graph subject. To change this field, you must alter its value in the source provider. | | domain | string | This represents the name of the container of origin for a graph member. | | mailAddress | string | The email address of record for a given graph member. This may be different than the principal name. | | origin | string | The type of source provider for the origin identifier
For example: `AD`, `AAD`, `MSA` | | originId | string | The unique identifier from the system of origin. Typically a `sid` ,`object id` or `Guid`.
Linking and unlinking operations can cause this value to change for a user because the group is not backed by a different provider and has a different unique ID in the new provider. | | principalName | string | This is the PrincipalName of this graph member from the source provider. The source provider may change this field over time and it is not guaranteed to be immutable for the life of the graph member by VSTS.
Entitlement Name | | subjectKind | string | This field identifies the type of the graph subject
For example: `Group`, `Scope`, `User` | | url | string | This URL is the full route to the source resource of this graph subject. | # Troubleshooting If you encounter any of the following issues or errors, SailPoint recommends that you follow the guidance provided below to resolve the error before contacting SailPoint Support. For issues or errors that are not addressed in this connector guide, refer to the following resources for troubleshooting information: - [SailPoint Identity Services Documentation]() - [SailPoint Support Knowledge Base]() - [SailPoint Developer Community]() ## Debug Logs For information about managing additional source settings, including debug logging and downloading connector logs, refer to [Managing Additional Settings]().