developer.sailpoint.com/docs/tools/sdk/powershell/Reference/Beta/Methods/BetaCustomPasswordInstructionsApi.md

id, title, pagination_label, sidebar_label, sidebar_class_name, keywords, slug, tags

id	title	pagination_label	sidebar_label	sidebar_class_name	keywords	slug	tags
beta-custom-password-instructions	CustomPasswordInstructions	CustomPasswordInstructions	CustomPasswordInstructions	powershellsdk	powershell PowerShell sdk CustomPasswordInstructions BetaCustomPasswordInstructions	/tools/sdk/powershell/beta/methods/custom-password-instructions	SDK Software Development Kit CustomPasswordInstructions BetaCustomPasswordInstructions

CustomPasswordInstructions

Use this API to implement custom password instruction functionality. With this functionality in place, administrators can create custom password instructions to help users reset their passwords, change them, unlock their accounts, or recover their usernames. This allows administrators to emphasize password policies or provide organization-specific instructions.

Administrators must first use Update Password Org Config to set `customInstructionsEnabled` to `true`.

Once they have enabled custom instructions, they can use Create Custom Password Instructions to create custom page content for the specific pageId they select.

For example, an administrator can use the pageId forget-username:user-email to set the custom text for the case when users forget their usernames and must enter their emails.

Refer to Creating Custom Instruction Text for more information about creating custom password instructions.

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

Method	HTTP request	Description
New-BetaCustomPasswordInstructions	POST /custom-password-instructions	Create custom password instructions
Remove-BetaCustomPasswordInstructions	DELETE /custom-password-instructions/{pageId}	Delete custom password instructions by page id
Get-BetaCustomPasswordInstructions	GET /custom-password-instructions/{pageId}	Get custom password instructions by page id

create-custom-password-instructions

This API creates the custom password instructions for the specified page ID. A token with ORG_ADMIN authority is required to call this API.

API Spec

Parameters

Param Type	Name	Data Type	Required	Description
Body	CustomPasswordInstruction	CustomPasswordInstruction	True

Return type

CustomPasswordInstruction

Responses

Code	Description	Data Type
200	Reference to the custom password instructions.	CustomPasswordInstruction
400	Client Error - Returned if the request body is invalid.	ErrorResponseDto
403	Forbidden - Returned if the user you are running as, doesn't have access to this end-point.	ErrorResponseDto
500	Internal Server Error - Returned if there is an unexpected error.	ErrorResponseDto

HTTP request headers

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

Example

$CustomPasswordInstruction = @"{
  "pageContent" : "Please enter a new password. Your password must be at least 8 characters long and contain at least one number and one letter.",
  "pageId" : "change-password:enter-password",
  "locale" : "en"
}"@

# Create custom password instructions

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

[Back to top]

delete-custom-password-instructions

This API delete the custom password instructions for the specified page ID. A token with ORG_ADMIN authority is required to call this API.

API Spec

Parameters

Param Type	Name	Data Type	Required	Description
Path	PageId	String	True	The page ID of custom password instructions to delete.
Query	Locale	String	(optional)	The locale for the custom instructions, a BCP47 language tag. The default value is ""default"".

Return type

(empty response body)

Responses

Code	Description	Data Type
204	No content - indicates the request was successful but there is no content to be returned in the response.
400	Client Error - Returned if the request body is invalid.	ErrorResponseDto
403	Forbidden - Returned if the user you are running as, doesn't have access to this end-point.	ErrorResponseDto
404	Not Found - returned if the request URL refers to a resource or object that does not exist	ErrorResponseDto
500	Internal Server Error - Returned if there is an unexpected error.	ErrorResponseDto

HTTP request headers

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

Example

$PageId = "change-password:enter-password" # String | The page ID of custom password instructions to delete.
$Locale = "MyLocale" # String | The locale for the custom instructions, a BCP47 language tag. The default value is \""default\"". (optional)

# Delete custom password instructions by page id

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

[Back to top]

get-custom-password-instructions

This API returns the custom password instructions for the specified page ID. A token with ORG_ADMIN authority is required to call this API.

API Spec

Parameters

Param Type	Name	Data Type	Required	Description
Path	PageId	String	True	The page ID of custom password instructions to query.
Query	Locale	String	(optional)	The locale for the custom instructions, a BCP47 language tag. The default value is ""default"".

Return type

CustomPasswordInstruction

Responses

Code	Description	Data Type
200	Reference to the custom password instructions.	CustomPasswordInstruction
400	Client Error - Returned if the request body is invalid.	ErrorResponseDto
403	Forbidden - Returned if the user you are running as, doesn't have access to this end-point.	ErrorResponseDto
404	Not Found - returned if the request URL refers to a resource or object that does not exist	ErrorResponseDto
500	Internal Server Error - Returned if there is an unexpected error.	ErrorResponseDto

HTTP request headers

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

Example

$PageId = "change-password:enter-password" # String | The page ID of custom password instructions to query.
$Locale = "MyLocale" # String | The locale for the custom instructions, a BCP47 language tag. The default value is \""default\"". (optional)

# Get custom password instructions by page id

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

[Back to top]