PasswordManagementApi

Use this API to implement password management functionality.
With this functionality in place, users can manage their identity passwords for all their applications.

In Identity Security Cloud, users can select their names in the upper right corner of the page and use the drop-down menu to select Password Manager. Password Manager lists the user's identity's applications, possibly grouped to share passwords. Users can then select 'Change Password' to update their passwords.

Grouping passwords allows users to update their passwords more broadly, rather than requiring them to update each password individually. Password Manager may list the applications and sources in the following groups:

• Password Group: This refers to a group of applications that share a password. For example, a user can use the same password for Google Drive, Google Mail, and YouTube. Updating the password for the password group updates the password for all its included applications.

• Multi-Application Source: This refers to a source with multiple applications that share a password. For example, a user can have a source, G Suite, that includes the Google Calendar, Google Drive, and Google Mail applications. Updating the password for the multi-application source updates the password for all its included applications.

• Applications: These are applications that do not share passwords with other applications.

An organization may require some authentication for users to update their passwords. Users may be required to answer security questions or use a third-party authenticator before they can confirm their updates.

Refer to Managing Passwords for more information about password management.

All URIs are relative to https://sailpoint.api.identitynow.com

Method	HTTP request	Description
create-digit-token-v1	POST /generate-password-reset-token/v1/digit	Generate a digit token
get-password-change-status-v1	GET /password-change-status/v1/{id}	Get password change request status
query-password-info-v1	POST /query-password-info/v1	Query password info
set-password-v1	POST /set-password/v1	Set identity's password

create-digit-token-v1

experimental

This API is currently in an experimental state. The API is subject to change based on feedback and further testing. You must include the X-SailPoint-Experimental header and set it to true to use this endpoint.

Generate a digit token This API is used to generate a digit token for password management. Requires authorization scope of "idn:password-digit-token:create".

API Spec

Parameters

Name	Type	Description	Notes
passworddigittokenreset	Passworddigittokenreset
xSailPointExperimental	string	Use this header to enable this experimental API.	[optional] [default to 'true']

Return type

Passworddigittoken

HTTP request headers

• Content-Type: application/json
• Accept: application/json

Example

import { PasswordManagementApi } from 'sailpoint-api-client';
import { Configuration } from 'sailpoint-api-client';
import { Passworddigittokenreset } from 'sailpoint-api-client/dist/password_management/api';

const configuration = new Configuration();
const apiInstance = new PasswordManagementApi(configuration);
const passworddigittokenreset: Passworddigittokenreset = {"userId":"Abby.Smith","length":8,"durationMinutes":5}; // 
const xSailPointExperimental: string = true; // Use this header to enable this experimental API. (optional)
const result = await apiInstance.createDigitTokenV1({ passworddigittokenreset: passworddigittokenreset });
console.log(result);

[Back to top]

get-password-change-status-v1

Get password change request status This API returns the status of a password change request.

API Spec

Parameters

Name	Type	Description	Notes
id	string	Password change request ID	[default to undefined]

Return type

Passwordstatus

HTTP request headers

• Content-Type: Not defined
• Accept: application/json

Example

import { PasswordManagementApi } from 'sailpoint-api-client';
import { Configuration } from 'sailpoint-api-client';

const configuration = new Configuration();
const apiInstance = new PasswordManagementApi(configuration);
const id: string = 089899f13a8f4da7824996191587bab9; // Password change request ID
const result = await apiInstance.getPasswordChangeStatusV1({ id: id });
console.log(result);

[Back to top]

query-password-info-v1

Query password info This API is used to query password related information.

API Spec

Parameters

Name	Type	Description	Notes
passwordinfoquerydto	Passwordinfoquerydto

Return type

Passwordinfo

HTTP request headers

• Content-Type: application/json
• Accept: application/json

Example

import { PasswordManagementApi } from 'sailpoint-api-client';
import { Configuration } from 'sailpoint-api-client';
import { Passwordinfoquerydto } from 'sailpoint-api-client/dist/password_management/api';

const configuration = new Configuration();
const apiInstance = new PasswordManagementApi(configuration);
const passwordinfoquerydto: Passwordinfoquerydto = ; // 
const result = await apiInstance.queryPasswordInfoV1({ passwordinfoquerydto: passwordinfoquerydto });
console.log(result);

[Back to top]

set-password-v1

Set identity's password This API is used to set a password for an identity.

An identity can change their own password (as well as any of their accounts' passwords) if they use a token generated by their ISC user, such as a personal access token or "authorization_code" derived OAuth token.

Note: If you want to set an identity's source account password, you must enable PASSWORD as one of the source's features. You can use the PATCH Source endpoint to add the PASSWORD feature.

To generate the encryptedPassword (RSA encrypted using publicKey) for the request body, run the following command:

echo -n "myPassword" | openssl pkeyutl -encrypt -inkey public_key.pem -pubin | base64

In this example, myPassword is the plain text password being set and encrypted, and public_key.pem is the path to the public key file. You can retrieve the required publicKey, along with other information like identityId, sourceId, publicKeyId, accounts, and policies, using the Query Password Info endpoint.

To successfully run this command, you must have OpenSSL installed on your machine. If OpenSSL is unavailable, consider using the Virtual Appliance (VA), which has OpenSSL pre-installed and configured.

If you are using a Windows machine, refer to this guide for instructions on installing OpenSSL.

You can then use Get Password Change Request Status to check the password change request status. To do so, you must provide the requestId from your earlier request to set the password.

API Spec

Parameters

Name	Type	Description	Notes
passwordchangerequest	Passwordchangerequest

Return type

Passwordchangeresponse

HTTP request headers

• Content-Type: application/json
• Accept: application/json

Example

import { PasswordManagementApi } from 'sailpoint-api-client';
import { Configuration } from 'sailpoint-api-client';
import { Passwordchangerequest } from 'sailpoint-api-client/dist/password_management/api';

const configuration = new Configuration();
const apiInstance = new PasswordManagementApi(configuration);
const passwordchangerequest: Passwordchangerequest = ; // 
const result = await apiInstance.setPasswordV1({ passwordchangerequest: passwordchangerequest });
console.log(result);

[Back to top]