PasswordConfigurationApi

Use this API to implement organization password configuration functionality. With this functionality in place, organization administrators can create organization-specific password configurations.

These configurations include details like custom password instructions, as well as digit token length and duration.

Refer to Configuring User Authentication for Password Resets for more information about organization password configuration functionality.

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

Method	HTTP request	Description
create-password-org-config-v1	POST /password-org-config/v1	Create password org config
get-password-org-config-v1	GET /password-org-config/v1	Get password org config
put-password-org-config-v1	PUT /password-org-config/v1	Update password org config

create-password-org-config-v1

Create password org config This API creates the password org config. Unspecified fields will use default value. To be able to use the custom password instructions, you must set the customInstructionsEnabled field to "true". Requires ORG_ADMIN, API role or authorization scope of 'idn:password-org-config:write'

API Spec

Parameters

Name	Type	Description	Notes
passwordOrgConfig	PasswordOrgConfig

Return type

PasswordOrgConfig

HTTP request headers

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

Example

import { PasswordConfigurationApi } from 'sailpoint-api-client';
import { Configuration } from 'sailpoint-api-client';
import { PasswordOrgConfig } from 'sailpoint-api-client/dist/password_configuration/api';

const configuration = new Configuration();
const apiInstance = new PasswordConfigurationApi(configuration);
const passwordOrgConfig: PasswordOrgConfig = {
  "digitTokenLength" : 9,
  "digitTokenEnabled" : true,
  "digitTokenDurationMinutes" : 10,
  "customInstructionsEnabled" : true
}; // 
const result = await apiInstance.createPasswordOrgConfigV1({ passwordOrgConfig: passwordOrgConfig });
console.log(result);

[Back to top]

get-password-org-config-v1

Get password org config This API returns the password org config . Requires ORG_ADMIN, API role or authorization scope of 'idn:password-org-config:read'

API Spec

Parameters

This endpoint does not need any parameter.

Return type

PasswordOrgConfig

HTTP request headers

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

Example

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

const configuration = new Configuration();
const apiInstance = new PasswordConfigurationApi(configuration);
const result = await apiInstance.getPasswordOrgConfigV1({  });
console.log(result);

[Back to top]

put-password-org-config-v1

Update password org config This API updates the password org config for specified fields. Other fields will keep original value. You must set the customInstructionsEnabled field to "true" to be able to use custom password instructions. Requires ORG_ADMIN, API role or authorization scope of 'idn:password-org-config:write'

API Spec

Parameters

Name	Type	Description	Notes
passwordOrgConfig	PasswordOrgConfig

Return type

PasswordOrgConfig

HTTP request headers

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

Example

import { PasswordConfigurationApi } from 'sailpoint-api-client';
import { Configuration } from 'sailpoint-api-client';
import { PasswordOrgConfig } from 'sailpoint-api-client/dist/password_configuration/api';

const configuration = new Configuration();
const apiInstance = new PasswordConfigurationApi(configuration);
const passwordOrgConfig: PasswordOrgConfig = {
  "digitTokenLength" : 9,
  "digitTokenEnabled" : true,
  "digitTokenDurationMinutes" : 10,
  "customInstructionsEnabled" : true
}; // 
const result = await apiInstance.putPasswordOrgConfigV1({ passwordOrgConfig: passwordOrgConfig });
console.log(result);

[Back to top]