Create custom password instructions
POST/custom-password-instructions/v1
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.
This API creates the custom password instructions for the specified page ID.
The pageId determines which login and password-recovery screen your custom instructions appear on. The following table describes each supported page ID and where its text is displayed:
| Page ID | Where the custom text appears |
|---|---|
flow-selection:select | Flow-selection landing screen, under "Need help signing in?", above the navigation links. |
reset-password:enter-username | Reset-password "enter username" step, under the prompt, above the username field. |
unlock-account:enter-username | Unlock-account "enter username" step, under the prompt, above the username field. |
forget-username:user-email | Forgot-username screen, under "Enter the email address for", above the email field. |
reset-password:enter-password | Reset-password "new password" step, under the header, above the password fields. |
change-password:enter-password | Same "new password" screen, but the authenticated app/sync-group change variant. |
reset-password:finish | Reset-password success screen, under the success icon/heading, above the return button. |
change-password:finish | Success screen for the authenticated app/sync-group change, under the heading. |
mfa:select | MFA method-selection step, under the prompt, above the list of MFA options. |
mfa:enter-code | MFA code-entry step, under the option label, above the code field. |
mfa:enter-kba | KBA step, under "Please answer these security questions", above the questions form. |
unlock-account:finish | Unlock-account success screen, under the success icon/heading, above the return button. |
In every case the text shows as an info-icon + paragraph block that only appears if custom text is configured for that page ID, positioned between the screen's built-in heading and its form controls.
Request
Responses
- 200
- 400
- 403
- 500
Reference to the custom password instructions.
Client Error - Returned if the request body is invalid.
Forbidden - Returned if the user you are running as, doesn't have access to this end-point.
Internal Server Error - Returned if there is an unexpected error.