# SailPoint SCIM 1.1 Connector Documentation > SCIM 1.1 Connector Documentation # Documentation # Connecting SailPoint and SCIM 1.1 To connect SailPoint with SCIM 1.1, 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. 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. 9. 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. 10. (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](). 11. 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](). 12. 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 Set up the connection and authentication parameters. > [!NOTE] > > **Screenshot** > > [![Connection Settings]()]() 1. Enter the value of **Connection Timeout** in minutes to hold the connection. By default, it is one minute. 2. Enter the **Host URL** of the SCIM 1.1-compliant managed system. For other parameters, refer to the following sections: - [Basic Authentication](<#basic-authentication>) - [OAuth 2.0 Authentication](<#oauth-20-authentication>) - [API Token](<#api-token>) ### Basic Authentication Configure basic authentication as an authentication type. > [!NOTE] > > **Screenshot** > > [![Basic Authentication]()]() 1. Enter the **Username** for basic authentication. 2. Enter the corresponding **Password**. 3. Select **Save**. ### OAuth 2.0 Authentication Select **OAuth 2.0 Authentication** and configure a grant type. Access tokens are generated based on your configured grant type. #### Client Credentials > [!NOTE] > > **Screenshot** > > [![OAuth 2.0 Client Credentials]()]() [![OAuth 2.0 Client Credentials]()]() 1. Enter the **OAuth 2.0 Token URL**. For example: `https://{your SCIM 1.1 Domain}/Services/oauth2/token` 2. Enter the **Client ID**. The client ID is issued to the source during the registration process for OAuth 2.0 on the SCIM server. 3. Enter the **Client Secret**. 4. Add the **Key** and **Value** pairs for the additional **OAuth Request Parameters** 5. You can set the attributes that you want to exclude from the request in the **Attributes Exclude Request** field. 6. Select **Save**. #### JWT > [!NOTE] > > **Screenshot** > > [![OAuth 2.0 JWT]()]() [![OAuth 2.0 JWT]()]() [![OAuth 2.0 JWT]()]() 1. Enter the **OAuth 2.0 Token URL**. For example: `https://{your SCIM 1.1 Domain}/Services/oauth2/token` 2. Enter the **Client ID** for JWT. 3. Enter the corresponding **Client Secret**. 4. Enter the **Private Key** and the corresponding **Private Key Password** used to sign the JWT. 5. The **JWT Header** contains the algorithm used for signing the JWT assertion. It must be the same algorithm used for generating the private key. The format of the JWT header is as follows: `Key = alg` If required, the additional header attributes can be provided in this key-value pair. Enter value of the JWT headers key. For example: `Value=RS256` 6. The **JWT Payload** is the key to have information on the JWT Claim. For JWT, it is mandatory to have the payload key for a successful Test Connection and other operations. The mandatory attributes are: - `aud` - Audience - `exp` - Expiry of the JWT assertion - `iss` - Issuer - `sub` - Subject If required, additional payload attributes can be provided in this key-value pair based on the target system. 7. Add the **Key** and **Value** pairs for the additional **OAuth Request Parameters**. 8. (*Optional*) Set the attributes that you want to exclude from the request in the **Attributes Exclude Request** field. 9. Select **Save**. #### Refresh Token > [!NOTE] > > **Screenshot** > > [![OAuth 2.0 Refresh Token]()]() [![OAuth 2.0 Refresh Token]()]() 1. Enter the **OAuth 2.0 Token URL**. For example: `https://{your SCIM 1.1 Domain}/Services/oauth2/token` 2. Enter the **Client ID** for Refresh Token. 3. Enter the corresponding **Client Secret**. 4. Enter the **Refresh Token**. 5. Select **Save**. 6. Add the **Key** and **Value** pairs for the additional **OAuth Request Parameters**. 7. (*Optional*) Set the attributes that you want to exclude from the request in the **Attributes Exclude Request** field. 8. Select **Save**. ### API Token Configure API token as an authentication type. Only the bearer tokens are supported. These bearer tokens either come with a long validity period or they do not expire. > [!NOTE] > > **Screenshot** > > [![API Token]()]() 1. Select **API Token** as an Authentication Type. You can use an **API Token** for authentication on the SCIM 1.1 source. 2. Select **Save**. ## Aggregation Settings Configure the aggregation settings for the SCIM 1.1 connector. For more information about aggregation, refer to [Loading Account Data](). > [!NOTE] > > **Screenshot** > > [![Aggregation Settings]()]() 1. Enter the **Filter Condition For Accounts** to aggregate the SCIM User resources. For example: `username sw "S"` 2. Enter the **Filter Condition For Groups** to aggregate the SCIM Group resources. For example: `DisplayName sw "S"` 3. Select a **Content-type** for the SCIM data format. The data format is either **JSON** or **XML**. By default the content type is **JSON**. 4. Select **Enable Complex Attribute Support** if you want to configure the complex attributes. For more information refer to [Complex Schema Attributes](). 5. To specify and limit the attributes during account aggregation, configure the **Account Attributes Query**. To specify and limit the attributes during entitlement aggregation, configure the **Group Attributes Query**. For either of the queries, specify the fully qualified extended attributes with the associated Resource URN. For example, the `manager` attribute defined in `urn:scim:schemas:extension:enterprise` is fully encoded as `urn:scim:schemas:extension:enterprise:manager`. 6. Set the **Page Size**. This is the maximum number of records to include in one request. Specify the page size if the target system supports pagination. By default, the value of the page size is 50. 7. Select **Save**. ## Advanced Settings The Advanced Settings tab includes configuration options for provisioning and HTTP settings. > [!NOTE] > > **Screenshot** > > [![Advanced Settings]()]() 1. Enter a list of attributes that the connector can ignore while provisioning an account in the **Provisioning Attributes to Skip** field. 2. Enter the default schema attribute extensions or additional attributes in the **Extension Schema Attributes** field. Ensure that you enter a list of fully qualified extended attributes with their associated Resource URNs. 3. Select either **PATCH** or **PUT** operation for SCIM 1.1 compliant servers. 4. Choose whether to use **HTTPS** or **HTTP**. 5. 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 SCIM 1.1 The SCIM (System for Cross-Domain Identity Management) standard defines a schema and API to create, read, and update the identity and identity-related information on other systems. This standard creates a common language, by which a client system can communicate with many different servers in the same way. SaaS providers (such as Salesforce) and other software vendors are beginning to adopt this standard, and are exposing their identity management interfaces through SCIM. This guide is designed to give specific information about the requirements and field definitions needed to get a working instance of an SCIM 1.1 source. SCIM 1.1 source can be used to connect to any target system supporting the SCIM 1.1 interface. > [!NOTE] > > To view the latest features, enhancements, and fixes for all SaaS connectors, refer to the [SaaS Release Notes]() page. ## Supported Features The SailPoint SCIM 1.1 connector supports the following features: > [!NOTE] > > Before you can use any item above marked with an asterisk (\*), SailPoint must activate the feature for your site. - Load accounts - \*Provision accounts - \*Password management - \*Access certifications (certification of entitlements connected to accounts) - Discover schemas - Delete accounts For more information on features, refer to [Source Features](). > [!NOTE] > > The Discover Schema feature in the source will work if the target system supports discover schema. With this feature, you can get the account schema defined in the target system. Go to **Import Data \> Account Schema** and select **Discover** on the source UI. ### Supporting Facebook Workplace The SCIM 1.1 source supports the Facebook Workplace managed system. For Facebook Workplace, the default source profile for SCIM 1.1 source must be updated with following two attributes: - `formattedName` (Type string, Enabled, Mapped to any name attribute) - `active` (Type boolean, Enabled, default value - true) ### Supporting Group Hierarchy The SCIM 1.1 source supports group hierarchy for the managed systems which support the SCIM 1.1 interface. ### Supporting Group Entitlements Group Entitlements enable SailPoint to aggregate additional details of these entitlement types from the managed system. These objects have separate schema-defining attribute list. The aggregation task fetches these objects as additional details when they're run for that Group Entitlement type. | Feature | Groups | | --- | --- | | Aggregation | ✔ | | Read group hierarchy | ✔ | ### Password Management Purchase of the Password Management feature and Services engagement to implement the feature for your environment. If Password Management is enabled for your organization, you can change the password for a user of the source. After enabling password management on the source, be aware of the following: - The password policy defined in SailPoint applies to accounts on this source. - If you change the password for an application connected to this source, the change will automatically be made to the source itself. For more information on configuring password management, refer to [Password Management Overview](). ## Prerequisites - Configure at least one virtual appliance cluster and successfully test the connection. For instructions, refer to the [Virtual Appliance Reference Guide](). ## Administrator Permissions The service account used for SCIM 1.1 source must have the permissions for the following operations: - get all users - add user - modify user - delete user # Provisioning The SCIM 1.1 connector supports provisioning, allowing you to create and manage accounts and entitlements in SCIM 1.1 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 | Account Attribute | Generator | Description | | --- | --- | --- | | userName | Identity Attribute | Name of the user to create | | givenName | Identity Attribute | First name of the user | | familyName | Identity Attribute | Family name of the user | | email\_type | Static | Email type of the user. The default email type is work email | | email | Identity Attribute | Email address of user | | email\_primary | Static | Primary email address of user | # Retry Configurations > [!IMPORTANT] > > Add a list of retryable error messages to the attributes map of the source configuration. The value must be specified as a list or array even when only a single error string is provided. ## Provisioning Retry Errors > [!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. SailPoint connectors that support provisioning operations have the ability to retry a failed operation based on configurable error messages. The `retryableErrors` entry in the connector configuration is a list of strings that the connector searches for in the error message received from the managed source. If any of the configured error strings are found in the error message, the connector will attempt to retry the provisioning operation. Add a list of retryable error messages to the attributes map of the source configuration. The value must be specified as a list or array even when only a single error string is provided. If the error message contains one of the specified strings, the connector will initiate a retry attempt. However, if the configured error string is not present in the error message, the connector will consider the operation as failed and will not attempt a retry. Add the following entry in the source XML using the SailPoint REST APIs: For example, Use the SailPoint API by sending a PATCH request to the /v3/sources/{id} endpoint: `PATCH https://{orgName}.api.identitynow.com/v3/sources/:id` In the body of the PATCH, enter the retryable errors as follows: ```json [ { "op": "add", "path": "/connectorAttributes/retryableErrors", "value": [ "", "" ] } ] ``` > [!NOTE] > > Error messages containing very specific information about date/time, sequence ID and so on must be avoided. Error codes or error message substrings would be good candidates for inclusion. # 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 SCIM 1.1 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 | | --- | --- | | id | Account | | id | Group | ### Default Account Attributes The SCIM 1.1 connector supports the following default account schema attributes and customer configurable attributes. The attributes must be defined as strings if not specified. | Attribute Name | Description | | --- | --- | | id | A unique identifier for a SCIM resource. This is an Account ID which must not be changed. | | userName | Name of the user | | externalId | A String that is an identifier for the resource | | displayName | The name of the user | | nickName | The casual way to address the user in real life | | profileUrl | A fully qualified URL to a page representing the user's Online profile | | title | The user's title, such as Vice President | | userType | Used to identify the organization to user relationship. Values can be:
\- Contractor
\- Employee
\- Intern
\- Temp
\- External
\- Unknown | | preferredLanguage | Indicates the user's preferred written or spoken language | | locale | Used to indicate the user's default location for purposes of localizing items such as currency, date time format, numerical representations, etc. | | timezone | The user's time zone in the Olson timezone database format | | formattedName | The full name, including all middle names, titles, and suffixes as appropriate, formatted for display | | familyName | The family name of the user, or last name in most Western languages | | givenName | The given name of the user, or first name in most Western languages | | middleName | The middle name(s) of the user | | honorificPrefix | The honorific prefix(es) of the user, or Title in most Western languages. For example, Ms. given the full name Ms. Barbara Jane Jensen, III | | honorificSuffix | The honorific suffix(es) of the user, or Suffix in most Western languages. For example, III given the full name Ms. Barbara Jane Jensen, III | | employeeNumber | Numeric or alphanumeric identifier assigned to a person, typically based on order of hire or association with an organization | | costCenter | Identifies the name of a cost center | | organization | Identifies the name of an organization | | division | Identifies the name of a division | | department | Identifies the name of a department | | managerId | The ID of the SCIM resource representing the user's manager | | managerName | Name of the manager | | emails | Email addresses for the user. The value must be canonicalized by the Service Provider. For example, `bjensen@example.com` instead of `bjensen@EXAMPLE.COM` | | emails.home.primary.value | Primary home email address for the user | | emails.home.secondary.value | Secondary home email addresses for the user | | emails.work.primary.value | Primary work email address for the user | | emails.work.secondary.value | Secondary work email addresses for the user | | emails.other.primary.value | Primary other email address for the user | | emails.other.secondary.value | Secondary other email addresses for the user | | emails\_objects | A list of all of the user's email addresses, including their type (for example, home, work) and whether it is their primary address | | emails\_primary | The user's primary email address | | phoneNumbers | Phone numbers for the user. The value must be Canonicalized by the Service Provider | | phoneNumbers.home.primary.value | Primary home phone number for the user | | phoneNumbers.home.secondary.value | Secondary home phone numbers for the user | | phoneNumbers.work.primary.value | Primary work phone number for the user | | phoneNumbers.work.secondary.value | Secondary work phone numbers for the user | | phoneNumbers.mobile.primary.value | Primary mobile phone number for the user | | phoneNumbers.mobile.secondary.value | Secondary mobile phone numbers for the user | | phoneNumbers.other.primary.value | Primary other phone number for the user | | phoneNumbers.other.secondary.value | Secondary other phone numbers for the user | | phoneNumbers.fax.primary.value | Primary fax number for the user | | phoneNumbers.fax.secondary.value | Secondary fax numbers for the user | | phoneNumbers.pager.primary.value | Primary pager number for the user | | phoneNumbers.pager.secondary.value | Secondary pager numbers for the user | | phoneNumbers\_objects | A list of all of the user's phone numbers, including their type (for example, home, work) and whether it is their primary phone number | | phoneNumbers\_primary | The user's primary phone number | | ims | Instant messaging address for the user | | ims.aim.value | AIM instant messaging address for the user | | ims.gtalk.value | Gtalk instant messaging address for the user | | ims.icq.value | ICQ instant messaging address for the user | | ims.xmpp.value | XMPP instant messaging address for the user | | ims.msn.value | MSN instant messaging address for the user | | ims.skype.value | Skype instant messaging address for the user | | ims.qq.value | QQ instant messaging address for the user | | ims.yahoo.value | Yahoo instant messaging address for the user | | ims\_objects | A list of all of the instant messaging usernames, including their type (for example, aim, gtalk) and whether it is their primary messaging username | | ims\_primary | The user's primary instant messaging username | | photos | URL of a photo of the user | | photos.photo.value | URL of a photo of the user | | photos.thumbnail.value | URL of a thumbnail photo of the user | | photos\_objects | A list of URLs of all of the user's photos, including the photo type (for example, photo, thumbnail) and whether it is their primary photo | | photos\_primary | The URL of the user's primary photo | | addresses | A physical mailing address for this user | | addresses.home.formatted | Formatted home address for this user | | addresses.home.streetAddress | Home Street address for this user | | addresses.home.locality | Home address locality address for this user | | addresses.home.region | Home address region for this user | | addresses.home.postalCode | Home address postal code for this user | | addresses.home.country | Home address country for this user | | addresses.work.formatted | Formatted work address for this user | | addresses.work.streetAddress | Work Street address for this user | | addresses.work.locality | Work address locality address for this user | | addresses.work.region | Work address region for this user | | addresses.work.postalCode | Work address postal code for this user | | addresses.work.country | Work address country for this user | | addresses.other.formatted | Formatted other address for this user | | addresses.other.streetAddress | Other Street address for this user | | addresses.other.locality | Other address locality address for this user | | addresses.other.region | Other address region for this user | | addresses.other.postalCode | Other address postal code for this user | | addresses.other.country | Other address country for this user | | addresses\_objects | A list of all of the user's physical mailing addresses, including their type (home or work) and whether it is their primary address | | addresses\_primary | The user's primary physical mailing address | | groups | A list of groups that the user belongs to, either thorough direct membership, nested groups, or dynamically calculated | | groups\_objects | A list of all of the user's group memberships, including how they are assigned to the group. For example:
\- direct - If assigned directly
\- indirect - If assigned indirectly through another group and whether it is their primary group | | groups\_primary | The user's primary group membership | | entitlements | A list of entitlements for the user that represent a thing the user has | | entitlements.primary.value | Primary entitlement for the user that represent a thing the user has | | entitlements.secondary.value | A list of secondary entitlements for the user that represent a thing the user has | | entitlements.primary.display | Primary entitlement for the user that represent a thing the user has | | entitlements.secondary.display | A list of secondary entitlements for the user that represent a thing the user has | | entitlements\_objects | A list of all of the user's entitlements, including whether it is their primary entitlement | | entitlements\_primary | The user's primary entitlement | | roles | A list of roles for the user that collectively represent who the user is. For example, Student, Faculty | | roles.primary.value | User's primary role | | roles.secondary.value | User's secondary roles | | roles\_objects | A list of all of the user's roles, including whether it is their primary role | | roles\_primary | The user's primary role | | created | The date and time the Resource was added to the Service Provider | | lastModified | The most recent date and time the details of this Resource were updated at the Service Provider | | location | The URL of the Resource being returned. This value MUST be the same as the Location HTTP response header | | version | The version of the Resource being returned | ## 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 SCIM 1.1 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 | Description | | --- | --- | | id | A unique identifier for a SCIM resource | | externalId | A String that is an identifier for the resource | | displayName | The name for the group | | members | A list of members in the group | | memberGroups | A list of the group's sub-groups | | created | The DateTime the resource was added to the Service Provider | | lastModified | The most recent DateTime the details of this resource were updated at the Service Provider | | location | The URI of the resource being returned. This value MUST be the same as the Location HTTP response header | | version | The version of the resource being returned | ## Complex Schema Attributes When **Enable Complex Attribute Support** is selected on [Aggregation Settings](), the following complex, multi-valued attributes are available: | Attribute Name | Description | | --- | --- | | emails.home.primary.value | Primary home email address for the user | | emails.home.secondary.value | Secondary home email addresses for the user | | emails.work.primary.value | Primary work email address for the user | | emails.work.secondary.value | Secondary work email addresses for the user | | emails.other.primary.value | Primary other email address for the user | | emails.other.secondary.value | Secondary other email addresses for the user | | phoneNumbers.home.primary.value | Primary home phone number for the user | | phoneNumbers.home.secondary.value | Secondary home phone numbers for the user | | phoneNumbers.work.primary.value | Primary work phone number for the user | | phoneNumbers.work.secondary.value | Secondary work phone numbers for the user | | phoneNumbers.mobile.primary.value | Primary mobile phone number for the user | | phoneNumbers.mobile.secondary.value | Secondary mobile phone numbers for the user | | phoneNumbers.other.primary.value | Primary other phone number for the user | | phoneNumbers.other.secondary.value | Secondary other phone numbers for the user | | phoneNumbers.fax.primary.value | Primary fax number for the user | | phoneNumbers.fax.secondary.value | Secondary fax numbers for the user | | phoneNumbers.pager.primary.value | Primary pager number for the user | | phoneNumbers.pager.secondary.value | Secondary pager numbers for the user | | ims.aim.value | AIM instant messaging address for the user | | ims.gtalk.value | Gtalk instant messaging address for the user | | ims.icq.value | ICQ instant messaging address for the user | | ims.xmpp.value | XMPP instant messaging address for the user | | ims.msn.value | MSN instant messaging address for the user | | ims.skype.value | Skype instant messaging address for the user | | ims.qq.value | QQ instant messaging address for the user | | ims.yahoo.value | Yahoo instant messaging address for the user | | photos.photo.value | URL of a photo of the user | | photos.thumbnail.value | URL of a thumbnail photo of the user | | addresses.home.formatted | Formatted home address for this user | | addresses.home.streetAddress | Home Street address for this user | | addresses.home.locality | Home address locality address for this user | | addresses.home.region | Home address region for this user | | addresses.home.postalCode | Home address postal code for this user | | addresses.home.country | Home address country for this user | | addresses.work.formatted | Formatted work address for this user | | addresses.work.streetAddress | Work Street address for this user | | addresses.work.locality | Work address locality address for this user | | addresses.work.region | Work address region for this user | | addresses.work.postalCode | Work address postal code for this user | | addresses.work.country | Work address country for this user | | addresses.other.formatted | Formatted other address for this user | | addresses.other.streetAddress | Other Street address for this user | | addresses.other.locality | Other address locality address for this user | | addresses.other.region | Other address region for this user | | addresses.other.postalCode | Other address postal code for this user | | addresses.other.country | Other address country for this user | | roles.primary.value | User's primary role | | roles.secondary.value | User's secondary roles | # 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]() ## Provisioning Failed with an Error Message Provisioning fails with the following error message: ```text Resource 'User' is malformed - Attribute urn:scim:schemas:core:1.0:alias is not defined for resource User ``` **Resolution**: Add alias attribute in the `skipSchemaAttributes` list, which is not supported by SCIM server. ## Create Account Fails for Salesforce SCIM Server with an Error Message Create account fails for Salesforce SCIM server with the following error message: ```text REQUIRED_FIELD_MISSING:user_must_have_one_entitlement_which_must_be_a_profileid; ``` **Resolution**: While performing create any new account with **Manage User Access**, select at least one valid entitlement. ## Create Account Operation Fails While Using Recommended Mappings in the Account Policy The create account operation fails even though the recommended attribute mappings are used in the Account Policy. **Resolution**: Ensure that the managed system is enabled to set the account attributes used by the Account Policy, then try the Create account operation again. ## Test Connection Fails for Salesforce SCIM Server with an Error Message Test Connection fails for Salesforce SCIM server with the following error message: ```text com.unboundid.scim.sdk.UnauthorizedException: Unauthorized ``` Test Connection fails due to the OAuth 2.0 bearer token generated from other machine. **Resolution**: For OAuth 2.0 authentication, use the OAuth2 bearer token generated on the machine where IdentityIQ is hosted. ## Aggregation Error Account and entitlement aggregation failed with following exception: ```text Exception during aggregation. Reason: javax.ws.rs.ProcessingException: Error closing message content input stream ``` **Resolution**: Add the `connector_enableDefaultConnectorProvider` key in the source XML using APIs. > [!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. # 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" } ] ```