# SailPoint Microsoft Dynamics 365 CRM Connector Documentation > Microsoft Dynamics 365 Customer Relationship Management Connector Documentation # Documentation # Connecting SailPoint and Microsoft Dynamics 365 CRM To connect SailPoint with Microsoft Dynamics 365 CRM, 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 **Actions**. 5. In the **Actions** dropdown list, select the setup method: - [**Express Setup**](<#configuring-a-source-using-express-setup>) - Quickly create a read-only connection to your target system by providing minimal configurations and authentication. On completion, aggregation is automatically started. > **Note** > > Express Setup supports Credential Providers. For information on supported credential providers and configuration, refer to [Credential Providers](). For more information, contact your SailPoint Customer Service Manager. - [**Standard Setup**](<#configuring-a-source-using-standard-setup>) - Provide detailed basic configuration to create the source. Once the source is created, continue with source setup. ### Configuring a Source Using Express Setup Express Setup minimizes the initial configuration process so you can quickly connect the application and immediately begin aggregating user account and entitlement data. 1. Review the directions and select **Start Express Setup**. 2. Review the pre-populated **Source Name**, **Source Owner**, and **Description**. To update, select **Edit**. > **Note** > > The source name must be unique. You can change these settings later in the source configuration. 3. Select **Virtual Appliance**. A virtual appliance is a Linux-based virtual machine that connects to your sources and apps using SailPoint APIs, connectors, and integrations. For more information about configuring and deploying virtual appliances, refer to [SailPoint Virtual Appliances](). 4. (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 in SailPoint, go to **Admin \> Connections \> Credential Providers**. For more information about credential providers, refer to [Credential Providers](). 5. Configure the authentication to allow SailPoint to connect to the source. For more information, refer to the **Connection Settings** section. 6. Select **Finish**. After a successful test connection, the system creates your source and prompts you to run an aggregation. - If you want to aggregate now, select **Aggregate**. - To see the latest account aggregation history, go to **Account Management \> Account Aggregation**. - To see the list of aggregated source accounts, go to **Account Management \> Accounts**. - If you want to aggregate later, select **Exit**. This returns you to the **Sources** page. Your new source is listed, but contains no accounts or aggregation history yet. ### Configuring a Source Using Standard Setup Use Standard Setup to configure the connector for full feature support. 1. In the **Source Name** field, enter a unique and descriptive name for your source. Source names cannot exceed 128 characters. 2. 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. 3. 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](). 4. Under **Connection Type**, select **Direct Connection** or **Flat File**. - **Direct Connection** - A direct connection fetches data from the **Virtual Appliance Cluster** you choose as the application connector for the source. A direct connection configuration allows for real-time updates. For more information about configuring and deploying virtual appliances, refer to the [Virtual Appliance Reference Guide](). - **Flat File** - Select the flat file if no connector is available, or if another system restricts the connection. This option allows only reading and aggregating data as a generic/delimited application. Provisioning activity is unsupported, and additional configuration pages like connection settings and aggregation settings are unavailable. 5. If you selected **Direct Connection**, in **Virtual Appliance Cluster**, select the virtual appliance cluster that will be used as the application connector for the source. 6. (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](). 7. 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](). 8. 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. In the **Virtual Appliance Cluster** dropdown list, select the virtual appliance to use when communicating with your organization's systems. For more information, refer to [SailPoint Virtual Appliances](). 4. (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](). 5. Configure the authentication to allow SailPoint to connect to the source. Refer to [Connection Settings](<#connection-settings>) for more information. 6. (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](). 7. (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. 8. Select **Save**. ## Connection Settings This section contains the information that the source uses to authenticate with the Dynamics 365 CRM managed system. After you select **Connection Settings** the following UI page is displayed. > [!NOTE] > > **Screenshot** > > [![Connection Settings for Client Credentials grant type]()]() 1. In the **Base URL** field, enter the base URL for the Dynamics 365 CRM portal. The URL format is `https://.crm.dynamics.com`. 2. In the **Microsoft Entra ID Tenant ID** field, enter the valid Tenant ID of the Microsoft Entra ID tenant to be managed by the source. 3. In the **Grant Type** dropdown list, select the OAuth 2.0 grant type supported by the managed system: - Client Credentials - JWT Certificate Credentials 4. In the **Client ID** field, enter the Entra ID application Client ID for OAuth 2.0 authentication. 5. In the **Page Size** field, enter the number of objects to fetch in a single page when iterating over large data sets. The range of the Page Size value is 1 to 1000. By default, the page size value is 500. 6. Select **Save**. ### Client Credentials Grant Type If you select **Client Credentials** as a Grant Type, *in addition* to the fields mentioned before, in the **Client Secret** field enter the Entra ID application Client Secret for OAuth 2.0 authentication. ### JWT Certificate Credentials Grant Type > [!NOTE] > > **Screenshot** > > [![Connection Settings for JWT Certificate Credentials grant type]()]() > > [![JWT Certificate Credentials connection fields]()]() If you select **JWT Certificate Credentials** as a Grant Type, *in addition* to the fields mentioned before: 1. In the **Certificate** field, enter the content of the certificate file that is uploaded on the Microsoft Entra ID application. 2. In the **Private Key** field, enter text of the private key used for signing the JWT assertion. 3. In the **Private Key Password** field, enter the password for decrypting the private key. 4. Select **Save**. ## 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 Dynamics 365 CRM Microsoft Dynamics CRM (Customer Relationship Management) is a customer relationship management software package developed by Microsoft focused on enhancing the customer relationship for any organization. Out of the box, the product focuses mainly on the Sales, Marketing, and Customer Service sectors. CRM Online is a cloud-based offering of Microsoft Dynamics CRM where all the backend processes (such as application servers, setups, deployments, databases, licensing, and so on) are managed on Microsoft servers. It is a subscription-based offering which is preferred for organizations who may not want to manage all the technicalities involved in a CRM implementation. Connecting SailPoint to your Dynamics 365 CRM allows you to manage identity and access management use cases related to read and provision various Dynamics 365 CRM Native IAM Objects as follows: - **Users**: Licensed Users in Dynamics 365 CRM are synchronized from Entra ID. Other types of users such as Application Users and Stub Users can be created in CRM itself. - **Teams**: Teams provide an easy way to share business objects and let you collaborate with other people across business units. While a team belongs to one business unit, it can include users from other business units. A user can be associated with more than one team. - **Security Roles**: Security roles define access level on different records. These roles can be assigned to users or teams. > [!NOTE] > > To view the latest features, enhancements, and fixes for all SaaS connectors, refer to the [SaaS Release Notes]() page. ## Supported Features The Microsoft Dynamics 365 CRM connector supports the following features: - Account Management - Account-Group Management ### Account Management The following table describes the supported operations on various objects for the Microsoft Dynamics 365 CRM connector: | Operations | Licensed User | Application User | Stub User | | --- | --- | --- | --- | | Aggregation | Yes | Yes | Yes | | Get Account | Yes | Yes | Yes | | Enable/Disable Users | Yes | Yes | N/A | | Add/Remove Entitlements
\- Add/Remove Access Teams
\- Add/Remove Owner Teams
\- Add/Remove Security Roles | Yes | Yes | N/A | > [!IMPORTANT] > > The Dynamics 365 Customer Relationship Management connector does not directly support Create users. Instead, licensed users are synchronized from the Entra ID source, so they must be created in that managed system, then imported into the Dynamics 365 Customer Relationship Management source. > [!NOTE] > > Licensed Users are synchronized from Entra ID. ### Entitlement Management | Operations | Owner Team | Access Team | Entra ID Office Group | Entra ID Security Group | Security Role | | --- | --- | --- | --- | --- | --- | | Aggregation | Yes | Yes | Yes | Yes | Yes | ## Privilege Classification SailPoint Privilege Classification helps organizations systematically categorize and manage the privilege levels of entitlements within their sources. By classifying entitlements as high, medium, or low, administrators can better understand the potential risk and impact associated with specific access rights. This allows automatic assignment of privilege levels based on system recommendations, custom-defined criteria, or a same level across all entitlements. | Privilege Level | Description | | --- | --- | | High | Administrative level access to accounts | | Medium | Administrative level access for a specific role or function | | Low | Only basic access of data | > [!NOTE] > > To manage Privilege Classification, users must have administrative roles such as Org Admin, Source Admin or Source Sub-Admin. For more information, refer to [Managing Privilege Classification](). > [!NOTE] > > **Example** > > [![Privilege Classification example]()]() ## Prerequisites - Configure at least one virtual appliance cluster and successfully test the connection. For more information, refer to the [Virtual Appliance Reference Guide](). The Microsoft Dynamics 365 CRM connector supports OAuth 2.0 authentication with the following grant types: - Client Credentials - JWT Certificate Credentials The following sections describe the configurations that must be performed for the above grant types. ### Registering an Application on Entra ID Registering the application generates the Tenant ID, Client ID, and Client Secret required for authentication. These are required for later processes. Perform the following: 1. Use either of the following methods to access the Entra Management Portal to perform the configuration: - [Microsoft Azure]() - [Microsoft Entra admin center]() 2. Select **Entra ID** in the left pane. 3. Select **App registrations**. 4. Select **New** registration. 5. On the **Register an application** page, in the **Name** field, enter the name of the application that you want to set up. 6. Select **Register**. An Application is created. On the Application page the **Application ID** (Client ID) and **Tenant ID** are displayed. 7. On the left-hand panel, select **Certificates & secrets**. On the **Certificates & secrets** page, in the **Client secrets** section, select **New client secret**. 8. On the **Add a client secret** page, enter the **Description** to generate a secret, and select the validity duration in the **Expires** list. Select **Add**. 9. Note the value of the client secret that you have just created. ### Client Credentials For the default **Client Credentials** grant type based authentication, following are the required configurations: - Obtain the Tenant ID, Client ID, and Client Secret from Entra ID by registering the application (steps mentioned in [Registering an Application on Entra ID](<#registering-an-application-on-entra-id>)). ### JWT Certificate Credentials JWT Certificate Credentials supports Authentication based on JWT assertion prepared from Certificate and Private Key. 1. Obtain the Tenant ID and Client ID from Entra ID by registering the application (up to step 6 mentioned in [Registering an Application on Entra ID](<#registering-an-application-on-entra-id>)). 2. To create a self-signed or CA-signed type X.509 certificate and private key, perform the following steps to register the certificate with the Microsoft identity platform: > **Important** > > The private key must be encrypted with the RSA algorithm and registered at the Entra portal. 1. Log in to the Entra Portal. 2. Select the client application. In the Entra app registration for the client application, select **Certificates & secrets**. 3. Select **Upload certificate** and select the certificate file to upload. 4. Select **Add**. 5. Obtain values for the following configurations: - **Certificate**: Obtain the text file of the same certificate which was uploaded on the Entra portal. - **Private Key**: Obtain the private key text file. - **Private Key Password** ### Creating an Application User on CRM Perform the following: 1. Open the Dynamics 365 CRM portal. 2. Select **Settings** on top right and go to **Advanced Settings**. A new tab opens. 3. Go to **Settings** on the new tab, then go to the **Security** option under **System**. 4. In **Features**, select **Users**. From the dropdown menu select **Application Users** and then select **New**. A form to create a new user opens. 5. Select the user type as **Application User** again and provide **User Name** and **Application ID**. The Application ID is the Client ID of the Application registered in Entra ID previously. 6. Save the form. ## Required Permissions Assign one of the following security roles to the application user based on the operation to be performed: - Custom Security Role - System Administrator (built-in) ### Custom Security Role A Custom Security Role must be created with minimum read privileges (as shown in the following figure) for the following purposes: - Account Aggregation of Users - Get Object for Users, Security Roles, and Teams - Group Aggregation for Roles and Teams In the **Business Management** section (as shown in the following figure), for the following entities, select the **Read** option: - Security Role - Team - User - User Settings [![Required Permissions - Custom Security Role]()]() ### System Administrator Assign the System Administrator (built-in) security role for the following purposes: - Add Security Roles and Teams to Users - Remove Security Roles and Teams from Users - Enable/Disable Users > [!NOTE] > > All connector operations can be managed with the System Administrator role. # 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 Dynamics 365 CRM connector uses the following default correlation and object configurations. ## 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 | | --- | --- | | systemUserId | Account | | teamId | teamId | | roleId | securityRole | ### Default Account Attributes The following lists the account attributes: | Attribute Name | Description | | --- | --- | | accessMode | Type of user (Read-Write, Administrative, Read, Support User, Non-interactive, Delegated Admin). | | azureActiveDirectoryObjectId | Object ID from Entra ID. | | businessunitName | Name of the business unit to which the user belongs. | | domainName | Domain of which the user is a member. | | displayName | Combination of business unit name and user name. | | employeeId | Employee identifier for the user. | | firstName | First name of the user. | | fullName | Full name of the user. | | internalEmailAddress | Internal email address for the user. | | jobTitle | Job title of the user. | | lastName | Last name of the user. | | middleName | Middle name of the user. | | mobilePhone | Mobile phone number for the user. | | nickName | Nickname of the user. | | parentSystemUserId | Unique identifier of the manager of the user. | | positionName | User's position in hierarchical security model. | | securityRoles | Security Roles assigned to the user. | | systemUserId | Unique identifier for the user. This is an Account ID which must not be changed. | | teams | Team memberships of user. | | territoryName | Name of the territory to which the user is assigned. | | title | Title of the user. | ## Group Attributes This section describes the group attributes for the following Native Object types: - team - securityRole ### Native Object Type = team | Attribute Name | Description | | --- | --- | | administratorName | Full name of the primary user responsible for the team. | | azureActiveDirectoryObjectId | Object ID from Entra ID. | | businessUnitName | Name of the business unit to which the team belongs. | | description | Description of the team. | | isDefault | Information about whether the team is a default business unit team. | | membershipType | Information about team membership type (Members and guests, Members, Owners, Guests). | | name | Name of the team. | | securityRoles | Security Roles assigned to the team. | | systemManaged | Select whether the team will be managed by the system. | | teamId | Unique identifier for the team. This is an Account ID which must not be changed. | | teamType | The team type (Owner, Access, Entra ID Security Group, Entra ID Office Group). | ### Native Object Type = securityRole | Attribute Name | Description | | --- | --- | | businessUnitName | Name of the business unit to which the team belongs. | | componentState | State of the role (Published, Unpublished, Deleted Unpublished). | | displayName | Combination of business unit name and role name. | | isInherited | Role is inherited by users from team membership, if role associated with team. | | name | Name of the role. | | organizationId | Unique identifier of the organization associated with the role. | | parentRoleName | Name of the parent role. | | roleId | Unique identifier of the role. This is an Account ID which must not be changed. | # Migrate VA-based Source to a SaaS Source Some sources that are connected to virtual appliance (VA) clusters can be migrated to SaaS connections. This ensures data (users and entitlements) remain intact and can maintains your source configurations like access profiles, roles, password settings, and correlation configurations when switching from a VA cluster to a SaaS connection. To migrate a source from a VA-based source to a SaaS source, you will provide configuration details on a draft version of the source before publishing the source. > [!NOTE] > > - You must have an Admin or Source Admin user level to migrate a source. A draft version of the source is created. As your migration process is in progress the live source will continue to work as it is. For more information on the Microsoft Dynamics 365 CRM SaaS connector, refer to the [Microsoft Dynamics 365 CRM SaaS Supported Features](). ## Important Considerations Before Migrating - You do not need to edit additional configurations (other than connection credentials) to migrate the source. - If your source migration is in progress, please do not make any configuration changes to your live source as those can be overwritten once you apply the migration your draft version. - Once you've gone ahead with your migration, it can't be rolled back. Your source is permanently migrated to a SaaS source. - Any preview operations or configuration changes on the draft source will not impact the live source until you apply the migration. ## Migrating Sources To migrate your source, complete the following: 1. Go to **Admin \> Connections \> Sources**. 2. Select or edit the VA-based source you want to migrate. 3. Open the source configuration, and select **Migrate to SaaS**. 4. When prompted, select **Continue**. A draft version of the source is created. The live source will continue to work. 5. Select **Connection Settings**. 6. Re-enter encrypted configuration details. For example, you might need to re-enter the Client Secret, Password, Refresh Token, Personal Access Token (PAT), or Certificates to migrate from the VA cluster to the SaaS connection. > **Important** > > Avoid editing the other configuration options in the draft source. 7. Select **Review and Test**. 8. Select **Test Connection**. 9. (Optional) Select **Accounts**. If you successfully tested your connection in **Review and Test**, you can select **Preview** to display a subset of accounts from the application that will be mapped to SailPoint identities. This can help ensure you are accurately connecting identity data from the application with SailPoint identities. 10. (Optional) Select **Entitlements**. If you successfully tested your connection in **Review and Test** and your source type supports entitlement type configuration, you can select **Preview** to view a preview of entitlements using the current configuration settings. 11. When you've finished reviewing your changes and successfully tested your connection, select **Apply Migration**. Your changes will be applied to the live source and the draft source will be deleted. ## Viewing Source Migration Status You can view the status and creation date of draft sources. 1. Go to **Admin \> Connections \> Sources \> Source Migration Status**. 2. Select **Source Migration Status**. 3. To view or edit the draft source, select **Actions** ![]() **\> Preview** on the draft source. 4. To delete the draft source, select **Actions** ![]() **\> Delete** on the draft source. # Enable Connector Logging This topic provides the steps needed to enable logging on SailPoint using REST APIs. > [!NOTE] > > This topic only applies to VA-based integrations. > [!NOTE] > > The examples provided might not match your configuration. Use the logging levels and logging classes reference at the bottom of the topic to configure your API responses to match your connector. This process is broken up into four steps: 1. Identify the Virtual Appliance (VA) cluster on which you want to enable logging. 2. Get the logging configuration for the existing VA cluster. 3. Update the VA cluster to enable logging levels. 4. Observe logging changes to the logging levels. ### Identify the Virtual Appliance Cluster Select the VA on which you need to enable logging using REST API. If you already know the VA application's `id`, proceed to [Get the Logging Configuration](<#get-the-logging-configuration>). 1. Make the following call to the REST API to return a list of available VA clusters: GET /v3/managed-clusters The REST API returns a response that looks similar to the following: ```json [ { "id": "2c9180866166b5b0016167c32ef31a66", "name": "Development Cluster", "description": "Development Cluster", "clientType": "CCG", "ccgVersion": "373_535_70.2.0", "pinnedConfig": true, "logConfiguration": null }, { "id": "2c9180846a93ce60016ab29f039944de", "name": "Cloud Cluster", "description": "Cloud Cluster", "clientType": "CCG", "ccgVersion": "373_535_70.2.0", "pinnedConfig": true, "logConfiguration": { "clientId": null, "durationMinutes": 60, "expiration": "2020-12-15T19:13:36.079Z", "rootLevel": "DEBUG", "logLevels": { "sailpoint.connector.ADLDAPConnector": "DEBUG" } } } ] ``` > **Note** > > The previous example code shows two VA clusters. One VA cluster has a log configuration and the other does not (refer to the `logConfiguration` value in each returned VA cluster). This is because one of the clusters already has logging enabled. This is just an example configuration, and your environment may not have logging enabled on a cluster. 2. Identify the VA cluster that you want to enable logging on by its name or description and record its `id` attribute. ### Get the Logging Configuration Get your selected VA's cluster logging configuration and identify the values you need to update. 1. Make the following call to the REST API to return the VA cluster's logging configuration. Replace `{id}` with the VA cluster's `id` attribute value recorded earlier. GET /v3/managed-clusters/{id}/log-config - If the VA doesn't have a logging configuration currently set, it returns `204 No Content` as a response. - If the VA has an existing logging configuration, it returns something similar to the following: ```json { "clientId": null, "durationMinutes": 60, "expiration": "2020-12-15T19:13:36.079Z", "rootLevel": "DEBUG", "logLevels": { "sailpoint.connector.ADLDAPConnector": "DEBUG" } } ``` You'll need to configure the following information in the response: - `durationMinutes` is the number of minutes logging should remain enabled. - `rootLevel` is the default level for all logs. For more information, refer to [Logging Levels](<#logging-levels>). - `logLevels` is a map object with logging classes as keys and logging levels as values. - For keys, refer to [Logging Classes](<#logging-classes>) for commonly used logging classes. - For a list of available values, refer to [Logging Levels](<#logging-levels>). ### Update Logging Configuration Update the VA cluster configuration returned by the REST API to update the logging settings as needed. 1. Make the following call to the REST API to update the VA cluster's logging configuration. Replace `{id}` with the VA cluster's `id` attribute value recorded earlier. PUT /v3/managed-clusters/{id}/log-config 2. Submit your configuration changes to the REST API in a JSON body. - If the VA cluster did not already have a logging configuration and you received a `204 No Content` response, you can create a new one. - If the VA returned a configuration, you can edit it to include the changes. The JSON body should be as follows: ```json { "durationMinutes": 60, "rootLevel": "DEBUG", "logLevels": { "sailpoint.connector.ADLDAPConnector": "DEBUG" } } ``` Consider the following as you edit the JSON: - `durationMinutes` is the number of minutes logging should remain enabled. - `rootLevel` is the default level for all logs. For more information, refer to [Logging Levels](<#logging-levels>). - `logLevels` is a map object with logging classes as keys and logging levels as values. - For keys, refer to [Logging Classes](<#logging-classes>) for commonly used logging classes. - For a list of available values, refer to [Logging Levels](<#logging-levels>). If the update was successful, the REST API should return a response similar to the following: ```json { "clientId": null, "durationMinutes": 60, "expiration": "2020-12-15T19:13:36.079Z", "rootLevel": "DEBUG", "logLevels": { "sailpoint.connector.ADLDAPConnector": "DEBUG" } } ``` ### Observe Logging Changes Approximately five minutes after you update the configuration, the VA cluster starts generating log files you can review. You can view the log files in **ccg.log**. ### References The tables in this reference section list information that can be helpful when creating the JSON body you'll use to configure the VA cluster's configuration file. #### Logging Levels | Logging Level | Description | | --- | --- | | ERROR | Designates error events that might still allow the connector to continue. | | WARN | Designates potentially harmful situations. | | INFO | Designates information messages that highlight process at a coarse-grain level. | | DEBUG | Very verbose. Fine grain logging levels used for development and debugging. | | TRACE | Most verbose. Finer grain logging levels than debugging. | #### Logging Classes | Connector | Logging Class | | --- | --- | | Active Directory | sailpoint.connector.ADLDAPConnector sailpoint.connector.LDAPConnector | | AIX | openconnector.connector.unix.AIXConnector openconnector.connector.unix.UnixConnector | | Amazon Web Services | logger.aws.name=openconnector.connector.aws logger.aws.level=trace logger.aws.additivity = false logger.aws.appenderRef.rolling.ref = STDOUT | | Atlassian Suite Cloud | sailpoint.connector.OpenConnectorAdapter openconnector.connector.atlassian.AtlassianConnector | | Atlassian Data Center | sailpoint.connector.OpenConnectorAdapter openconnector.connector.atlassian.AtlassianDataCenterConnector | | Microsoft Entra ID | sailpoint.connector.AzureADConnector | | Box | openconnector.connector.BoxNetConnector sailpoint.connector.OpenConnectorAdapter | | Cerner | openconnector.connector.CernerConnector sailpoint.connector.OpenConnectorAdapter | | Delimited File | logger.DelimitedFileConnector.name = sailpoint.connector.DelimitedFileConnector logger.DelimitedFileConnector.level = debug logger.DelimitedFileConnector.additivity = false logger.DelimitedFileConnector.appenderRef.rolling.ref = STDOUT | | Dropbox | openconnector.connector.DropBoxConnector sailpoint.connector.OpenConnectorAdapter | | Epic | openconnector.connector.EPICConnector sailpoint.connector.OpenConnectorAdapter | | GE Centricity | openconnector.connector.GECentricity sailpoint.connector.OpenConnectorAdapter | | Google Apps / G Suite | openconnector.connector.GoogleAppsDirect sailpoint.connector.OpenConnectorAdapter | | IBM i | openconnector.connector.IBMiConnector | | Lotus Domino | sailpoint.connector.LotusDomino | | JDBC | sailpoint.connector.JDBCConnector | | Sun One LDAP | sailpoint.connector.LDAPConnector | | Linux | openconnector.connector.unix.LinuxConnector sailpoint.connector.OpenConnectorAdapter sailpoint.connector.UnixConnector | | Microsoft Office365 | sailpoint.connector.Office365Connector | | Microsoft SQL Server | sailpoint.connector.mssql.serviceimpl.MSSQLServerConnectorV2 | | Okta | logger.openconnector.name = openconnector.connector.okta.OktaConnector logger.openconnector.level = debug logger.openconnector.additivity = false logger.openconnector.appenderRef.rolling.ref = STDOUT | | Oracle Database | sailpoint.connector.OracleDBConnector sailpoint.connector.JDBCConnector | | Oracle E-Business | sailpoint.connector.OracleEBSConnector sailpoint.connector.JDBCConnector | | Oracle Fusion HCM | openconnector.connector.oraclefusionhcm.OracleFusionHCMConnector sailpoint.connector.OpenConnectorAdapter | | Oracle HCM Cloud | sailpoint.connector.oraclehcmcloud.OracleHCMCloudConnector | | Oracle HRMS | sailpoint.connector.OracleAppsHRMSConnector sailpoint.connector.JDBCConnector | | Oracle Netsuite | openconnector.connector.netsuite.NetsuiteConnector | | PeopleSoft ERP | openconnector.connector.PeopleSoftConnector sailpoint.connector.OpenConnectorAdapter | | PeopleSoft HRMS | sailpoint.connector.PeopleSoftHRMSConnector | | RemedyForce | sailpoint.connector.ForceConnector | | RSA Authentication Manager | openconnector.connector.RSAConnector openconnector.connector.rsa.RSAHTTPClient sailpoint.connector.OpenConnectorAdapter | | Salesforce | sailpoint.connector.ForceConnector | | SAP Concur | openconnector.connector.sapconcur.SAPConcurConnector | | SAP - Direct | sailpoint.connector.SAPConnector sailpoint.connector.SAPInternalConnector | | SAP GRC | logger.SAPGRCConnector.name = sailpoint.connector.sapgrc logger.SAPGRCConnector.level = debug logger.SAPGRCConnector.additivity = false logger.SAPGRCConnector.appenderRef.rolling.ref = STDOUT | | SAP HR/HCM | sailpoint.connector.SAPHRInternalConnector | | SCIM 1.1 | openconnector.connector.SCIMConnector sailpoint.connector.OpenConnectorAdapter | | SCIM 2.0 | openconnector.connector.scim2.SCIM2Connector sailpoint.connector.OpenConnectorAdapter | | ServiceNow | openconnector.connector.servicenow.ServiceNowConnector openconnector.connector.servicenow.ServiceNowRestClient sailpoint.connector.OpenConnectorAdapter | | ServiceNow Service Desk Integration | openconnector.connector.servicedesk.ServiceNowServiceDeskConnector sailpoint.connector.OpenConnectorAdapter | | Siebel | openconnector.connector.SiebelConnector sailpoint.connector.OpenConnectorAdapter | | Snowflake | openconnector.connector.snowflake.SnowflakeConnector sailpoint.connector.OpenConnectorAdapter | | Solaris | openconnector.connector.unix.SolarisConnector openconnector.connector.unix.UnixConnector sailpoint.connector.OpenConnectorAdapter | | SuccessFactors | sailpoint.connector.SuccessFactorsConnector | | Sybase | sailpoint.connector.SybaseDirectConnector sailpoint.connector.JDBCConnector | | Webex | openconnector.connector.Webex sailpoint.connector.OpenConnectorAdapter | | Workday | openconnector.connector.WorkDay sailpoint.connector.OpenConnectorAdapter | | Workday Accounts | openconnector.connector.workdayaccounts openconnector.connector.workdayaccounts.WorkdayAccountsConnector sailpoint.connector.OpenConnectorAdapter | | Web Services | sailpoint.connector.WebServices | | XML | openconnector.connector.XMLConnector sailpoint.connector.OpenConnectorAdapter | | Yammer | openconnector.connector.YammerConnector sailpoint.connector.OpenConnectorAdapter | | Zoom | openconnector.connector.zoom.ZoomConnector sailpoint.connector.OpenConnectorAdapter | # 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]() ## The Dynamics 365 CRM Source Did Not Properly Link Security Group After Aggregation **Issue**: After performing an entitlement aggregation or full aggregation the Dynamics 365 CRM source is not able to link groups for the user. If a single account aggregation (getObject) is performed for the same user, then it brings the entitlements. **Resolution**: Change the page size from 500 (default) to 1 and retry an entitlement aggregation or full aggregation. ## The Dynamics 365 CRM Source Did Not Pull All Entitlements After Aggregation **Issue**: After performing an entitlement aggregation or full aggregation the Dynamics 365 CRM source is not able to pull entitlements for the user. If a single account aggregation (getObject) is performed for the same user, then it brings the entitlements. **Resolution**: Change the page size from 500 (default) to 100 and retry an entitlement aggregation or full aggregation. ## Failing Test Connection / Account Aggregation Test connections and account aggregation processes fail with the following error message: ```text [ TimeoutException ] [ Possible suggestions ] Tune the parameter . [ Error details ] Timeout occurred while reading command response. ``` > [!NOTE] > > Add a portion of the error message to your `retryableErrors` list, as shown in the following examples. **Resolution**: Update the following attributes in the source and retry the operation: ```json [ { "op": "add", "path": "/connectorAttributes/maxRetryCount", "value": 5 }, { "op": "add", "path": "/connectorAttributes/retryWaitTime", "value": 60000 }, { "op": "add", "path": "/connectorAttributes/retryableErrors", "value": [ "Service Unavailable", "ConnectorError", "RuntimeException", "Timeout occurred" ] } ] ``` # Timeout Errors and Settings Timeout errors might occur when SailPoint is waiting for a response from the Virtual Appliance (VA). These errors are applicable to all connectors and tend to occur during the setup of sources or when sources are down. This document is designed to give specific information that can be used to resolve these errors. Each timeout attribute has a default time value that is listed in seconds or minutes. Increasing the time value may resolve the error as it will allow for longer communication time between the two systems, thus avoiding the timeout error. > [!IMPORTANT] > > Add the necessary attributes or values before performing the "replace" operation, as missing attributes will cause the operation to fail. To increase the communication time, increase the value of the appropriate timeout attribute. Then submit the change to the VA using the SailPoint REST API. > [!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. ### aggregateTimeout **Description:** This parameter is set for the aggregation timeout, measured in seconds. **Resolution:** Increase the `aggregateTimeout` value gradually to optimize aggregation. Start with 180, then increase to 600, 900, and finally 1800. The maximum value is 3600 seconds. For example: If your current time value is 180 seconds, update the `aggregateTimeout` attribute as follows: ```json [ { "op": "replace", "path": "/connectorAttributes/aggregateTimeout", "value": 600 } ] ``` ### healthCheckTimeout **Description:** This parameter is set for the test connection and health check timeout. **Resolution:** The default value is 30 seconds. If the timeout error continues, increase the value in 15 second increments and try again. For example: If your current time value is 30 seconds, update the `healthCheckTimeout` attribute as follows: ```json [ { "op": "replace", "path": "/connectorAttributes/healthCheckTimeout", "value": 45 } ] ``` ### provisioningTimeout **Description:** This parameter is set for provisioning timeout. **Resolution:** Increase the `provisioningTimeout` value gradually to optimize provisioning. Start with 180, then increase to 360, and finally 600. The maximum value is 600 seconds. For example: If your current time value is 180 seconds, update the `provisioningTimeout` attribute as follows: ```json [ { "op": "replace", "path": "/connectorAttributes/provisioningTimeout", "value": 360 } ] ``` ### timeout **Description:** This parameter is set for pass-through authentication timeout. **Resolution:** The default value is 15 seconds. If the timeout error continues, increase this value in 15 second increments and try again. For example: If your current time value is 15 seconds, update the `timeout` attribute as follows: ```json [ { "op": "replace", "path": "/connectorAttributes/timeout", "value": 30 } ] ``` ### apiTimeout **Description:** This parameter is set for API time tracking; customers can check it using an external tool. **Resolution:** The default value is 60 seconds. If the error continues, increase the value by 15 second increments and try again. For example: If your current time value is 60 seconds, update the `apiTimeout` attribute as follows: ```json [ { "op": "replace", "path": "/connectorAttributes/apiTimeout", "value": "75" } ] ``` ### timeoutInSeconds **Description:** This parameter helps prevent the VA from waiting indefinitely for an API response, ensuring efficient handling of API requests. For example: If your current time value is 30 seconds, update the `timeoutInSeconds` attribute as follows: ```json [ { "op": "replace", "path": "/connectorAttributes/timeoutInSeconds", "value": "15" } ] ```