PasswordConfiguration

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/v3

Method	HTTP request	Description
New-PasswordOrgConfig	POST /password-org-config	Create Password Org Config
Get-PasswordOrgConfig	GET /password-org-config	Get Password Org Config
Send-PasswordOrgConfig	PUT /password-org-config	Update Password Org Config

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

Param Type	Name	Data Type	Required	Description
Body	PasswordOrgConfig	PasswordOrgConfig	True

Return type

PasswordOrgConfig

Responses

Code	Description	Data Type
200	Reference to the password org config.	PasswordOrgConfig
400	Client Error - Returned if the request body is invalid.	ErrorResponseDto
401	Unauthorized - Returned if there is no authorization header, or if the JWT token is expired.	ListAccessProfiles401Response
403	Forbidden - Returned if the user you are running as, doesn't have access to this end-point.	ErrorResponseDto
429	Too Many Requests - Returned in response to too many requests in a given period of time - rate limited. The Retry-After header in the response includes how long to wait before trying again.	ListAccessProfiles429Response
500	Internal Server Error - Returned if there is an unexpected error.	ErrorResponseDto

HTTP request headers

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

Example

$PasswordOrgConfig = @"{
  "digitTokenLength" : 9,
  "digitTokenEnabled" : true,
  "digitTokenDurationMinutes" : 10,
  "customInstructionsEnabled" : true
}"@

# Create Password Org Config

try {
    $Result = ConvertFrom-JsonToPasswordOrgConfig -Json $PasswordOrgConfig
    New-PasswordOrgConfig -PasswordOrgConfig $Result 
    
    # Below is a request that includes all optional parameters
    # New-PasswordOrgConfig -PasswordOrgConfig $Result  
} catch {
    Write-Host $_.Exception.Response.StatusCode.value__ "Exception occurred when calling New-PasswordOrgConfig"
    Write-Host $_.ErrorDetails
}

[Back to top]

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

Param Type	Name	Data Type	Required	Description

Return type

PasswordOrgConfig

Responses

Code	Description	Data Type
200	Reference to the password org config.	PasswordOrgConfig
400	Client Error - Returned if the request body is invalid.	ErrorResponseDto
401	Unauthorized - Returned if there is no authorization header, or if the JWT token is expired.	ListAccessProfiles401Response
403	Forbidden - Returned if the user you are running as, doesn't have access to this end-point.	ErrorResponseDto
429	Too Many Requests - Returned in response to too many requests in a given period of time - rate limited. The Retry-After header in the response includes how long to wait before trying again.	ListAccessProfiles429Response
500	Internal Server Error - Returned if there is an unexpected error.	ErrorResponseDto

HTTP request headers

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

Example

# Get Password Org Config

try {
    Get-PasswordOrgConfig 
    
    # Below is a request that includes all optional parameters
    # Get-PasswordOrgConfig  
} catch {
    Write-Host $_.Exception.Response.StatusCode.value__ "Exception occurred when calling Get-PasswordOrgConfig"
    Write-Host $_.ErrorDetails
}

[Back to top]

put-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

Param Type	Name	Data Type	Required	Description
Body	PasswordOrgConfig	PasswordOrgConfig	True

Return type

PasswordOrgConfig

Responses

Code	Description	Data Type
200	Reference to the password org config.	PasswordOrgConfig
400	Client Error - Returned if the request body is invalid.	ErrorResponseDto
401	Unauthorized - Returned if there is no authorization header, or if the JWT token is expired.	ListAccessProfiles401Response
403	Forbidden - Returned if the user you are running as, doesn't have access to this end-point.	ErrorResponseDto
429	Too Many Requests - Returned in response to too many requests in a given period of time - rate limited. The Retry-After header in the response includes how long to wait before trying again.	ListAccessProfiles429Response
500	Internal Server Error - Returned if there is an unexpected error.	ErrorResponseDto

HTTP request headers

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

Example

$PasswordOrgConfig = @"{
  "digitTokenLength" : 9,
  "digitTokenEnabled" : true,
  "digitTokenDurationMinutes" : 10,
  "customInstructionsEnabled" : true
}"@

# Update Password Org Config

try {
    $Result = ConvertFrom-JsonToPasswordOrgConfig -Json $PasswordOrgConfig
    Send-PasswordOrgConfig -PasswordOrgConfig $Result 
    
    # Below is a request that includes all optional parameters
    # Send-PasswordOrgConfig -PasswordOrgConfig $Result  
} catch {
    Write-Host $_.Exception.Response.StatusCode.value__ "Exception occurred when calling Send-PasswordOrgConfig"
    Write-Host $_.ErrorDetails
}

[Back to top]