Files
developer.sailpoint.com/docs/tools/sdk/powershell/Reference/V2024/Models/CustomPasswordInstruction.md
2025-05-07 14:37:48 +00:00

2.3 KiB

id, title, pagination_label, sidebar_label, sidebar_class_name, keywords, slug, tags
id title pagination_label sidebar_label sidebar_class_name keywords slug tags
v2024-custom-password-instruction CustomPasswordInstruction CustomPasswordInstruction CustomPasswordInstruction powershellsdk
powershell
PowerShell
sdk
CustomPasswordInstruction
V2024CustomPasswordInstruction
/tools/sdk/powershell/v2024/models/custom-password-instruction
SDK
Software Development Kit
CustomPasswordInstruction
V2024CustomPasswordInstruction

CustomPasswordInstruction

Properties

Name Type Description Notes
PageId Enum [ "change-password:enter-password", "change-password:finish", "flow-selection:select", "forget-username:user-email", "mfa:enter-code", "mfa:enter-kba", "mfa:select", "reset-password:enter-password", "reset-password:enter-username", "reset-password:finish", "unlock-account:enter-username", "unlock-account:finish" ] The page ID that represents the page for forget user name, reset password and unlock account flow. [optional]
PageContent String The custom instructions for the specified page. Allow basic HTML format and maximum length is 1000 characters. The custom instructions will be sanitized to avoid attacks. If the customization text includes a link, like <A HREF=\""URL\"">...</A> clicking on this will open the link on the current browser page. If you want your link to be redirected to a different page, please redirect it to ""_blank"" like this: <a href=\""URL"" target=\""_blank\"" >link</a>. This will open a new tab when the link is clicked. Notice we're only supporting _blank as the redirection target. [optional]
Locale String The locale for the custom instructions, a BCP47 language tag. The default value is ""default"". [optional]

Examples

  • Prepare the resource
$CustomPasswordInstruction = Initialize-V2024CustomPasswordInstruction  -PageId change-password:enter-password `
 -PageContent Please enter a new password. Your password must be at least 8 characters long and contain at least one number and one letter. `
 -Locale en
  • Convert the resource to JSON
$CustomPasswordInstruction | ConvertTo-JSON

[Back to top]