# SailPoint RSA Authentication Manager Connector Documentation > RSA Authentication Manager Connector Documentation # Documentation # Connecting SailPoint and RSA Authentication Manager To connect SailPoint with RSA Authentication Manager, 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**. > [!NOTE] > > Ensure that the name and description of each source is unique. ## Connection Settings Provide the information required for SailPoint to connect and interact with RSA Authentication Manager. > [!NOTE] > > On installation of RSA Authentication Manager, the system creates a command client user name and password for secure connections to the command server. This user name and password are randomly generated on creation, and are unique to each deployment. > [!NOTE] > > **Screenshot** > > [![Connection Settings]()]() 1. In the **Service Account** field, enter the name of the service account used by the administrator to connect to RSA Authentication Manager server. 2. Enter the **Password** for the service account. 3. Enter the unique **Command Client User** and **Command Client Password**. This information is created when you install RSA Authentication Manager. To obtain this information, refer to [Obtaining the Command Client User and Password](). 4. Enter the **Hostname or IP Address**. You can validate the host name of the RSA authentication manager provided in source configuration during TLS communication using the REST API. To validate the hostname, set the `enableHostNameVerification` attribute to true. > **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. 5. Enter the **Port** number. 6. Select **Save**. ## Account Settings Specify the Accounts' scope that will be managed by the configured source. > [!NOTE] > > **Screenshot** > > [![Account settings]()]() > > [![Account settings]()]() > > [![Account settings]()]() > > [![Delta Aggregation]()]() 1. Specify the name of the **Realm**. A realm is an organizational unit that includes all of the objects managed within a single deployment, such as users and user groups, tokens, passwords, and agents. 2. Specify the **Identity Source** for the realm. An identity source is a repository that contains user and user group data. Each user and user group in a deployment is associated with an identity source. For the most up-to-date information, refer to [RSA Authentication Manager Identity Sources]() in the RSA documentation. 3. (*Optional*) Specify the **Security Domain** to manage. Security domains are used to organize and manage users and enforce system policies. The default is `SystemDomain`. 4. (*Optional*) Select **Search Sub Domains** to turn this setting on or off. Turn this setting on if child domains also need to be managed. When this is turned off, you see a black X. If it is turned on, you see a blue ✔. The default is off. 5. Enter the **Page Size** to specify the number of accounts or groups to fetch per iteration through RSA Authentication Manager. The default is 500. 6. (*Optional*) Select **Enable Partition** to turn this setting on or off. When you enable partitioning, account aggregation can be split into paritions and aggregation is performed with the filters specified in the **Partition Filter Values** field. Only accounts that match the filter are aggregated. When this is turned off, you see a black X. If it is turned on, you see a blue ✔. The default is off. 7. (*Optional*) Enter the **Partition Thread Count**. This specifies the number of items in each partition group. 8. (*Optional*) Select a **Partition Filter Attribute** from the drop-down. This is the user attribute to partition users across multiple threads during account aggregation. 9. (*Optional*) Enter the **Partition Filter Values** to filter the account aggregation. To add multiple entries, enter the filter and then press the Enter key. 10. (*Optional*) Select **Delta Aggregation** to enable Delta Aggregation setting on or off. > **Note** > > Delta aggregation is not supported for radius profile and group account attributes. 11. 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 RSA Authentication Manager SailPoint's RSA Authentication Manager connector offers a single point of access management for Users, Groups, and RSA Access Tokens in your RSA Authentication Manager environment. > [!NOTE] > > To view the latest features, enhancements, and fixes for all SaaS connectors, refer to the [SaaS Release Notes]() page. ## Supported Features > [!NOTE] > > Before you can use any item marked with an asterisk (\*), SailPoint must activate the feature for your site. For more information on opening a support ticket, refer to [Working With Services](). SailPoint's RSA Authentication Manager connector supports the following features: - Load and \*provision RSA Accounts - \*Access Certifications (certification of entitlements connected to accounts) - \*Password management - \*Partitioned account aggregation - PIN reset of token in the new pin mode - Delta Aggregation - Delete Account For more information on features, refer to [Source Features](). The RSA Authentication Manager source supports multiple group objects. | Feature | Users | | --- | --- | | Aggregate | ✔ | | Create | ✔ | | Authentication | ✔ | | Password Management | ✔ | | Enable/Disable | ✔ | | Group Entitlements (Read, Request, Revoke) | Groups, Tokens, Profile | ### Group Entitlements Group Entitlements are the entitlement types for which SailPoint provides ability to aggregate additional details of these entitlement types from the managed system. These objects have separate schema defining list of attributes that aggregation task fetches as additional details when aggregation is run for that Group Entitlement type. | Feature | Groups | Tokens | Profiles | | --- | --- | --- | --- | | Aggregation | ✔ | ✔ | ✔ | ### 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](). ## Supported Managed Systems The RSA Authentication Manager connector supports versions 8.6, 8.7, and 8.8 along with their respective patches. ## Prerequisites Ensure that you perform the following: - Configure at least one virtual appliance cluster and successfully test the connection. For more information, refer to the [Virtual Appliance Reference Guide](). - Meet the requirements necessary to support [TLS communication]() in the virtual appliance you plan to use with this source. - Ensure that a valid TLS certificate is present in the correct directory. For example: `/home/sailpoint/certificates` - [Obtain the Command Client User and Password](<#obtaining-the-command-client-user-and-password>). - [Import the Server Root Certificate (Java)](<#importing-the-server-root-certificate-java>). > **Note** > > SailPoint Support may require access to your RSA Authentication Manager test or development environment for assistance. ### Obtaining the Command Client User and Password RSA Authentication Manager creates a user name and password during installation. This information is used to secure API connections to the command server. To obtain the command client user name and password: 1. Open a command prompt on your RSA Authentication Manager host. 2. Change directories to: `RSA_AM_HOME/utils` 3. Enter the following command: `rsautil manage-secrets --action list` 4. When prompted, type your Operations Console user name and password. *The system displays the list of your internal system passwords.* 5. Locate the values for your command client user name and password. For example: ```text Command Client User Name .................: CmdClient_ys0x7d41 Command Client User Password .............: e9SHbK0W4i ``` ### Importing the Server Root Certificate (Java) When RSA Authentication Manager is installed, the system creates a self-signed root certificate and stores it in the `RSA_AM_HOME/server/security/server_name.jks` directory. This certificate must be exported from the server, and imported into the keystore for remote API clients. Use the Java keytool, as described in the following sections to export and import the certificate into Java clients. #### To Export the Server Root Certificate 1. Change directories to `RSA_AM_HOME/appserver/` and enter the following: `jdk/jre/bin/keytool -export -keystore RSA_AM_HOME/server/security/server_name.jks -file am_root.cer -alias rsa_am_ca` Where: - `RSA_AM_HOME` directory is a generic placeholder for `/opt/rsa/am` path - `- server_name.jks` is a placeholder for `caStore.jks` keystore 2. At the prompt for **keystore\_password**, press **Enter** without the password. > **Note** > > Ignore the warning message that appears as the server root certificate will still be exported. #### To Import the Server Root Certificate (Java) 1. Locate the server root certificate file that you exported from Authentication Manager. Copy it to the VA location. ## Required Permissions The RSA Authentication Manager connector administrator must have enough rights to execute the requested operation. To assign the rights to the administrator: - Assign the default administrative roles present on the RSA. For most of the operations the **Auth Mgr Realm Admin** administrative role must be assigned. - Create new administrative roles with the relevant permissions, assign the role a scope, and then assign it to the administrator. The scope of an administrative role determines in what security domains an administrator may manage objects and from what identity sources an administrator may manage users. The following lists the permissions that can be assigned to the administrative role: - **All** grants an administrator permission to perform any administrative action on the object. - **Delete** grants an administrator permission to delete an object. - **Add** grants an administrator permission to add an object. - **Edit** grants an administrator permission to view and edit an object, but not the ability to add or delete. - **View** grants an administrator permission to view an object, but not to add, edit, or delete. ### Minimum Permissions This section describes the minimum permissions required for roles and custom roles. > [!NOTE] > > By selecting any one of the permission which is mentioned as YES, the respective operations would be Successful. | Administrative Roles / Operations | Test Connection | Account Aggregation | Group Aggregation | Provisioning (Create Account from IdentityIQ and Change Password) | PIN Reset | | --- | --- | --- | --- | --- | --- | | Authentication Manager Agent Administrator | YES | YES | YES | YES | NO | | Authentication Manager (Help Desk) | YES | YES | YES | YES | NO | | Authentication Manager Privileged Help Desk | YES | YES | YES | NO | NO | | Authentication Manager Radius Administrator | NO | NO | NO | NO | NO | | Authentication Manager Root Domain Administrator | YES | YES | YES | NO | NO | | Authentication Manager Security Domain Administrator | YES | YES | YES | YES | YES | | Authentication Manager Token Administrator | YES | YES | NO | NO | YES | | Authentication Manager Trust Administrator | NO | NO | NO | NO | NO | | Authentication Manager User Administrator | YES | YES | YES | YES | NO | | Request Approver | NO | NO | NO | NO | NO | | Super Administrator Role | YES | YES | YES | YES | YES | | Token Distributor | NO | NO | NO | NO | YES | | Trusted Realm Administrator Role | NO | NO | NO | NO | NO | ### Permissions for Custom Roles If you do not want to use existing roles, create a custom role and provide the required permissions as described in the table in this topic. To create custom role: 1. Go to **RSA managed system \> Administration \> Administrative Role \> Manage Existing**. 2. Select **Add Administrative Role Name**. 3. In **Administrative scope**, select **Security Domain scope**. 4. Create a custom role. Assign the following minimum permissions for a custom role:
Operations Permissions Category Permission Name Permission Scope Notes
Test Connection Authentication Permission Authentication Agents View Before an authentication agent can communicate with authentication manager an agent record must exist in the authentication manager data store.
General Permissions Identity Attribute Definition View Data element and directory mappings for user and user group.
Security Domains View Security domain defines area of administrative responsibility. Administrator who can add security domains can create administrative hierarchy with their scope.
Account Aggregation with Group, Role
Group Aggregation		 General Permissions Manage User Group View With VIEW permission, groups would be aggregated.
Manage Users View With VIEW permission, only accounts would be aggregate.
Account Provisioning with Group Membership General Permissions Manage Users Delete, Add, Edit, View With all permissions account would be created and Enable/Disable/Unlock, Reset Password, Terminate session and Users: User Attribute and Mobile Number attributes would be selected.
Users Groups: Assign Membership Yes With this permission user group membership is assigned during account creation.
Users: User Attribute -Mobile Number Modify
Note: For Account - Role assignment operation, Application User requires 'SuperAdmin Role' privileges.
Group Provisioning General Permissions Manage User Group Delete, Add, Edit, View Groups can be Created/Added/Deleted
Token Assignment Authentication Permission SecureID Tokens Delete, Add, Edit, View Select the permission you want to grant to administrators to manage secured ID tokens. Along with this Enable/Disable Tokens, Manage Token Offline Emergency Access, Manage Token Online Emergency Access,RSA SecureID PINs and Resynchronize Tokens would be selected.
SecureID Tokens: Assign Token Yes With this permission Token would be assigned.
SecureID Tokens: Replace Tokens Yes With this permission Token would be replaced.
Token Aggregation Authentication Permission SecureID Tokens View With View permission only Token would be aggregated.
# Machine Account Attributes Machine account attributes are used in provisioning configurations for machine accounts. After you have [created the required machine account subtypes](), you can use the machine account attributes to provision machine accounts in your SailPoint tenant. Refer to [Machine Identity Security Overview]() for more information. > [!NOTE] > > Attributes marked with an asterisk (\*) are mandatory. ## Machine Account Provisioning Attributes | Create Account Attribute | Description | | --- | --- | | userID\* | The User ID for the account. | | password | The password for the account. | | firstName | The first name for the account. | | lastName | The last name for the account. | # Using Multiple Group Entitlements with a Pre-existing Source For the pre-existing RSA Authentication Manager sources perform the following steps to start using the Multiple Group Entitlements with your current source. ## To Add RADIUS Profiles to an Existing Source 1. Use the [createSchema]() API to create new group schema for your source. > **Example of API body content for adding RADIUS profiles to an existing source** > > Body of the REST API call to add Radius profile schema in existing source for RSA Authentication Manager connector: > > ```json > { > "displayAttribute": "name", > "identityAttribute": "guid", > "nativeObjectType": "profile", > "objectType": "profile", > "hierarchyAttribute": null, > "includePermissions": false, > "features": [], > "configuration": {}, > "name": "profile" > "attributes": [ > { > "name": "checkLists", > "type": "string", > "description": "List of attributes to be received to validate the access", > "isMulti": true, > "isEntitlement": false, > "isGroup": false > }, > { > "name": "description", > "type": "string", > "description": "description for the RADIUS profile", > "isMulti": false, > "isEntitlement": false, > "isGroup": false > }, > { > "name": "guid", > "type": "string", > "description": "Guid of the RADIUS profile", > "isMulti": false, > "isEntitlement": false, > "isGroup": false > }, > { > "name": "isDangling", > "type": "string", > "description": "Dangling status of RADIUS profile", > "isMulti": false, > "isEntitlement": false, > "isGroup": false > }, > { > "name": "lastUpdatedBy", > "type": "string", > "description": "User ID of the user who updated the RADIUS profile recently", > "isMulti": false, > "isEntitlement": false, > "isGroup": false > }, > { > "name": "lastUpdatedOn", > "type": "string", > "description": "Time when the RADIUS profile was last updated on", > "isMulti": false, > "isEntitlement": false, > "isGroup": false > }, > { > "name": "name", > "type": "string", > "description": "Name by which the RADIUS profile is known", > "isMulti": false, > "isEntitlement": false, > "isGroup": false > }, > { > "name": "returnLists", > "type": "string", > "description": "List of attributes to be returned in case of successful validation", > "isMulti": true, > "isEntitlement": false, > "isGroup": false > }, > { > "name": "securityDomain", > "type": "string", > "description": "Security Domain to which RADIUS profile belongs", > "isMulti": false, > "isEntitlement": false, > "isGroup": false > } > ] > } > ``` 2. Navigate to the Account Schema of your source in SailPoint. Locate the attribute corresponding to the group entitlement and change the type from 'string' to the appropriate group entitlement type. ## To Add a Token to an Existing Source 1. Use the [createSchema]() API to create new group schema for your source to add Tokens to an existing source. > **Example of API body content for adding Tokens to existing source** > > ```json > { > "displayAttribute": "serialNumber", > "identityAttribute": "serialNumber", > "nativeObjectType": "token", > "objectType": "token", > "hierarchyAttribute": null, > "includePermissions": false, > "features": [], > "configuration": {}, > "name": "token" > "attributes": [ > { > "name": "enable", > "type": "boolean", > "description": "Token's enabled status", > "isMulti": false, > "isEntitlement": false, > "isGroup": false > }, > { > "name": "expirationDate", > "type": "string", > "description": "Expiration Date of the token", > "isMulti": false, > "isEntitlement": false, > "isGroup": false > }, > { > "name": "guid", > "type": "string", > "description": "Guid of the token", > "isMulti": false, > "isEntitlement": false, > "isGroup": false > }, > { > "name": "lastLoginDate", > "type": "string", > "description": "Last time when user logged in using the assigned token", > "isMulti": false, > "isEntitlement": false, > "isGroup": false > }, > { > "name": "newPinMode", > "type": "boolean", > "description": "Status indicating whether or not the token is in new PIN mode", > "isMulti": false, > "isEntitlement": false, > "isGroup": false > }, > { > "name": "nextTokenMode", > "type": "boolean", > "description": "Status indicating whether or not the token is in next token mode", > "isMulti": false, > "isEntitlement": false, > "isGroup": false > }, > { > "name": "replacementMode", > "type": "string", > "description": "Token's replacement mode", > "isMulti": false, > "isEntitlement": false, > "isGroup": false > }, > { > "name": "serialNumber", > "type": "string", > "description": "Serial number of token", > "isMulti": false, > "isEntitlement": false, > "isGroup": false > } > ] > } > ``` 2. Update Account Schema with the following steps: 1. Get account schema using [getSchema]() API. 2. Copy the schema to a file and search for attribute corresponding to the group schema that is added in step 1. 3. Add/update below two properties for the attribute found in previous step (2.b.) ```json "isGroup": true, "schema": {"type": "CONNECTOR_SCHEMA","id": "","name": " "} ``` 4. Add the schema modified in step 2.c. to the payload to update account schema in source using [replaceSchema]() API. # Provisioning The RSA Authentication Manager connector supports provisioning, allowing you to create and manage accounts and entitlements in RSA Authentication Manager 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. > [!NOTE] > > Attributes marked with an asterisk (\*) are mandatory. ## Default Create Account Attributes | Create Account Attributes | Description | | --- | --- | | userID\* | Create Unique Account ID - This generator uses the value in the **Pattern Used** field to generate a unique ID for the new account. | | password\* | Create Password - This generator creates an initial password for the new account that matches the password policy assigned to the associated RSA Authentication Manager source in SailPoint. | | lastName\* | Identity Attribute - Last Name of the user. | | firstName | Identity Attribute - First name of the user. | | email | Identity Attribute - Work email of the user. | | forceChangePassword | Static - Indicates whether or not the user needs to change the password during next logon. | | nextAvailableToken | Static - Select to assign the next available SecureID token to the user. | | identitySource | Identity Source Name to which group belongs (Read only attribute). | # 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 RSA Authentication Manager 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 | | --- | --- | | guid | Account | | guid | Group | | serialNumber | token | | guid | profile | ### Default Account Attributes The RSA Authentication Manager 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 | | --- | --- | | guid | Guid of the entity. This is an Account ID which must not be changed. | | userID | Unique name by which the entity is known by. (Display Attribute). | | firstName | First name of the entity. | | middleName | Middle name of the entity. | | lastName | Last name for which the entity is known by. | | notes | Notes or description for the entity. | | email | Email of the entity. | | certificateDN | Certificate DN of the entity. | | securityDomain | Security Domain Name to which entity belongs. | | identitySource | Identity Source Name to which entity belongs. | | lastModifiedBy | Administrator or user who modified the entity last time. | | groups | Multivalued string. Groups Membership (marked as "groupAttribute"). | | roles | Administrative roles assigned to the entity. | | lastModifiedOn | Last time when the entity was modified. | | accountStartDate | Time when the entity was created. | | accountExpireDate | Time when the entity will get expired. | | lastLogin | Last time when the entity was logged in. | | forceChangePassword | Whether or not user needs to change the password during next logon. | | tokens | Token. Tokens assigned. | | Roles | Role membership. | | Groups | Group membership. | | Mobile Number | Mobile number of the user. | | Profile | Assigned RADIUS Profile. Managed,Entitlements | ## 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 RSA Authentication Manager 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 | | --- | --- | | guid | Guid of the entity. This is an Account ID which must not be changed. | | groupName | Name by which the entity is known by (Display Attribute). | | Notes | Notes or description for the entity. | | securityDomain | Security Domain Name to which entity belongs. | | identitySource | Identity Source Name to which entity belongs. | #### Token Attributes | Attribute Name | Description | | --- | --- | | enable | Token's enabled status. | | expirationDate | Expiration Date of the token. | | guid | Guid of the token. | | lastLoginDate | Last time when user logged in using the assigned token. | | newPinMode | Status indicating whether or not the token is in new PIN mode. | | nextTokenMode | Status indicating whether or not the token is in next token mode. | | replacementMode | Token's replacement mode. | | serialNumber | Serial number of token. This is an Account ID which must not be changed. | ### Default RADIUS Profile Attributes The following lists the RADIUS profile attributes: | Attribute Name | Description | | --- | --- | | checkLists | List of attributes to be received to validate the access. | | description | Description for the RADIUS profile. | | guid | Guid of the RADIUS profile. This is an Account ID which must not be changed. | | isDangling | Dangling status of RADIUS profile. | | lastUpdatedBy | User ID of the user who updated the RADIUS profile recently. | | lastUpdatedOn | Time when the RADIUS profile was last updated on. | | name | Name by which the RADIUS profile is known. | | returnLists | List of attributes to be returned in case of successful validation. | | securityDomain | Security Domain to which RADIUS profile belongs. | # 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]() ## Test Connection Errors **Error**: The following error displays when testing the connection: ```text Test Connection failed: ; nested exception is: javax.net.ssl.SSLHandshakeException: sun.security.validator.ValidatorException: PKIX path building failed: sun.security.provider.certpath.SunCertPathBuilderException: unable to find valid certification path to requested target ``` **Resolution**: Ensure that a valid TLS certificate is present in the correct directory. **Error**: The following error displays when the test connection fails: ```text Test Connection failed: ; nested exception is: javax.net.ssl.SSLHandshakeException: sun.security.validator.ValidatorException: PKIX path building failed: sun.security.provider.certpath.SunCertPathBuilderException: unable to find valid certification path to requested target ``` **Resolution**: Ensure that a valid TLS certificate is present in the correct directory. **Error**: The following error displays when the test connection fails: ```text Test Connection failed: Could not access HTTP invoker remote service; nested exception is javax.net.ssl.SSLPeerUnverifiedException: Host name does not match the certificate subject provided by the peer ``` If the source is configured with IP, the `enableHostNameVerification` is enabled, and certificate subject has FQDN, then test connection fails with this error. **Resolution**: If `enableHostNameVerification` is enabled, FQDN/IP that is configured in the source must be present in the Certificate subject name **Error**: The following error displays when testing the connection fails: ```text Test Connection failed: Could not found the realm ``` **Resolution**: Ensure that relevant permissions are assigned to the service account. Refer to [Required Permissions](). ## Aggregation Errors **Error**: Account aggregation does not retrieve all accounts from the configured Active Directory identity source. **Resolution**: Verify if the load balancer is configured between RSA and Active Directory, if it is there, it must be removed. **Error**: The following error displays during aggregation: ```text Session not found exception ``` **Resolution**: Set the following values in RSA Authentication Manager: - Time out idle sessions: 90min - Limit session lifetime: 12hrs ## Provisioning Errors **Error**: The following error displays during provisioning: ```text Create user failed: Identity Source ' is read-only. Failed to create account! ``` **Resolution**: You may be trying to provision to an external data source. The RSA source only supports provisioning to an internal source. # 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" } ] ```