SailPoint IdentityIQ Credential Cycling

Implementation tutorial

Credential cycling is a feature that allows applications requiring credentials, such as username and password, to obtain that information directly from BeyondTrust Password Safe.

With credential cycling, credentials can be removed from application configurations and obtained at run time using an Application Programming Interface (API) call to Password Safe. Password Safe is then configured to rotate the credentials directly with the application target, helping to reduce the risk associated with stale credentials while eliminating the need for manual updates of credentials in a solution like SailPoint IdentityIQ.

Credentials used by SailPoint IdentityIQ are privileged credentials, since they allow access to private data. They also allow for provisioning and deprovisioning of permissions in critical systems and applications, such as Active Directory (AD).

This tutorial outlines the steps required to configure credential cycling for a Java database connectivity (JDBC) application in SailPoint IdentityIQ.

ℹ️

Note

For more information, see the IdentityIQ Privileged Account Management documentation located in the SailPoint Community Portal.

Create a service account for IdentityIQ credential cycling

Create an API registration

1. Log in to the BeyondInsight console.
2. Go to Configuration > General > API Registrations.
3. Under API Registrations, click Create API Registration, and then select API Key Policy.
4. Name the new API registration IdentityIQ Credential Cycling.
5. Click Add Authentication Rule.
6. Add the IdentityIQ server IP address (located in IP Rule) to the IP Address field to allow the connection.
7. Click Create Rule.
8. Click Create API Registration.

Create a local group

To create a local group in BeyondInsight, follow the below steps:

1. From the left sidebar, click Configuration.
2. Under Role Based Access, click User Management.
3. From the Groups tab, click + Create New Group.
4. Select Create a New Group.
5. On the next screen, provide a group name of IdentityIQ Credential Cycling and description.
6. Click Create Group.

ℹ️

Note

In addition to creating groups locally, you can import Active Directory, Entra ID, and LDAP groups into BeyondInsight.

Create an account access policy

An access policy must be available for credential cycling. This is required to be able to grant the requestor the Password Safe role for the Smart Rule.

1. In BeyondInsight, go to Configuration > Privileged Access Management Policies > Access Policies.
2. Click Create New Access Policy.
3. Type IdentityIQ Credential Cycling in the Access Policy Name field and click Create Access Policy.
4. Click the Schedule tab, and then click Create Schedule.
5. Scroll down to Policy Types and enable View Password.
6. Check the Auto Approve box.
7. Scroll down to the bottom of the scheduling form and click Create Schedule.
8. Click Make Available on the prompt that displays.
9. Click Update Access Policy.

Assign an account Smart Group

An account Smart Group must be assigned to the new local group that contains the application accounts required by IdentityIQ. To do this:

1. In BeyondInsight, go to Configuration > Role Based Access > User Management > Groups.
2. In the Filter by field, select Name from the dropdown list.
3. Type IdentityIQ Credential Cycling in the Name field.
4. Click the vertical ellipsis for the group and select View Group Details.
5. Under Group Details, select Smart Groups.
6. Locate the All Managed Accounts Smart Group in the Smart Groups Permissions grid and click the vertical ellipsis for it.
7. Select Assign Permissions Read Only.
8. Click the vertical ellipsis for the All Managed Accounts Smart Group again, and then select Edit Password Safe Roles.
9. Check the box next to Requestor.
10. Select IdentityIQ Credential Cycling from the Access Policy for Requestor dropdown.
11. Click Save Roles.

Add a user account

A user account must be added to the group. IdentityIQ uses this account as the service account for credential cycling.

1. In BeyondInsight, go to Configuration > Role Based Access > User Management > Groups.
2. In the Filter by field, select Name from the dropdown list.
3. Type IdentityIQ Credential Cycling in the Name field.
4. Click the vertical ellipsis for the group and select View Group Details.
5. Under Group Details, select Users.
6. Above the Users grid, select Users not Assigned from the Show dropdown list.
7. Locate the user and select it.
8. Click Assign User above the grid. If you select Assigned Users from the Show dropdown list, the user is now listed.

Enable credential cycling API registration for the group

1. In BeyondInsight, go to Configuration > Role Based Access > User Management > Groups.
2. In the Filter by field, select Name from the dropdown list.
3. Type IdentityIQ Credential Cycling in the Name field.
4. Click the vertical ellipsis for the group and select View Group Details.
5. Under Group Details, select API Registrations.
6. Check the box next to the IdentityIQ Credential Cycling API registration created earlier in this tutorial to enable it.

Identify managed system and managed account

A managed system and a managed account must be identified in order for IdentityIQ to determine the password for that account. SailPoint Connector requires the correct username/password credentials to connect to the account.

1. In BeyondInsight, go to Managed Systems.
2. Check the box next to a managed system to select it, and then click the corresponding ellipsis to the right of the system. Select Go to Advanced Details.
3. Under Advanced Details, select Managed Accounts.
4. Check the box next to a managed account to select it.
5. The managed account must have an API enabled. Click the corresponding ellipsis to the right of the group.
6. Under Account Settings, click the toggle button next to API Enabled.

Update managed account password to JSON format

To allow IdentityIQ to retrieve credentials, the password for the managed account in Password Safe must use the JSON format.

1. In BeyondInsight, go to Managed Systems.
2. Check the box next to a managed system to select it, and then click the corresponding ellipsis to the right of the system. Select Go to Advanced Details.
3. Under Advanced Details, select Managed Accounts.
4. Check the box next to a managed account to select it, and then click the corresponding ellipsis to the right of the account. Select Edit Account.
5. Under Credentials, type the user (account name) and password for that account in the Password field using the following format:

✅

Example

{"bt_user":"MyUserName","bt_password":"MyPasswordValue"}

6. Click Update Account.

Use IdentityIQ to complete credential cycling process

Customize the credentialConfigurationTemplate.xml file

In order to continue with the credential cycling process, the credentialConfigurationTemplate.xml file must be customized.  It is recommended that you create a copy locally.

1. On your local drive, navigate to Program Files > Apache Software Foundation > Tomcat 9.0 > webapps > identityiq > WEB-INF > config.
2. Select the credentialConfigurationTemplate.xml file.
3. Right-click on the file and save a copy to edit it.
4. Open the copied file in a text editor of your choice. Change the following:
   • url, runas, and apikey to match your environment.
   • Replace managedAccountName and managedSystemName with the correct values.
   • Specify the name of the application that uses credential cycling.
   • Identify application attributes.

Populate user and password with credential cycling

In IdentityIQ, you must populate the connection user and connection password in the application using credential cycling.

To view connection user and connection password:

1. Log in to SailPoint IdentityIQ.
2. Under Applications, select Application Definition.
3. Click the desired application.
4. Click Configuration > Settings to view Connection User and Connection Password.

ℹ️

Note

If the application is enabled for credential cycling, and note is displayed on the screen.

Application attributes differ from the label used on the Application Configuration page. In order to identify the application attributes, use the /debug interface.

1. Go to https://identityiq_server:8443/identityiq/debug.

2. Select Application.

3. Click the desired application to open the Object Editor.

4. Locate key=”password” and key=”user” and identify the values. These 2 values are required for application attributes.

5. Manually update the following values in the template file for the desired application:

   • <CredentialAssociation applicationName="Application Name"

     attributeName="user"

     credentialAttributeName="bt_user">

   • <CredentialAssociation applicationName="Application Name"

     attributeName="password"

     credentialAttributeName="bt_password"/>

6. Click Save.

7. Import the template file to IdentityIQ. This applies the template to the application:

• Click the gear icon on the upper right side of the screen.
• Select Global Settings.
• Select Import From File.
• Click Choose File and navigate to the template file.
• Click Import.

Test integration

At this point, you should be able to test the application successfully, preview the application via schema, and aggregate. Once an application is configured for credential cycling, credentials in Settings are ignored. To test the application:

1. Log in to SailPoint IdentityIQ.
2. Under Applications, select Application Definition.
3. Click the desired application.
4. Click Configuration > Settings.
5. At the bottom of the page, click Test Connection. If successful, a Test Successful message is displayed.