Skip to main content

Get Custom Password Instructions by Page ID

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

Path Parameters
  • pageId string required

    Possible values: [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 of custom password instructions to query.

    Example: mfa:select
Query Parameters
  • locale string

    The locale for the custom instructions, a BCP47 language tag. The default value is "default".

Responses

Reference to the custom password instructions.


Schema
  • pageId string

    Possible values: [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.

  • 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">... 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. This will open a new tab when the link is clicked. Notice we're only supporting _blank as the redirection target.

  • locale string

    The locale for the custom instructions, a BCP47 language tag. The default value is "default".

Loading...