PUT /api/v1/brands/{brandId}/pages/sign-in/customized

Replaces the customized sign-in page. The customized sign-in page appears in your live environment.

Servers

https://{yourOktaDomain}

Path parameters

Name	Type	Required	Description
`brandId`	String	Yes	The ID of the brand

Request headers

Name	Type	Required	Description
`Content-Type`	String	Yes	The media type of the request body. Default value: "application/json"

Request body fields

Name	Type	Required	Description
`widgetVersion`	String	No	The version specified as a Semantic Version. This value can be a wildcard (`*`), a major version range (for example, `^2`), a major-only version (for example, `7`), or a specific `Major.Minor` version (for example, `5.15`).
`widgetCustomizations`	Object	No
`widgetCustomizations.unlockAccountLabel`	String	No	The label for the unlock account link
`widgetCustomizations.customLink2Label`	String	No	The label for the second custom link
`widgetCustomizations.helpUrl`	String	No	The help link URL
`widgetCustomizations.forgotPasswordUrl`	String	No	The forgot password URL
`widgetCustomizations.usernameLabel`	String	No	The label for the username field
`widgetCustomizations.helpLabel`	String	No	The label for the help link
`widgetCustomizations.postAuthKeepMeSignedInPrompt`	Object	No
`widgetCustomizations.postAuthKeepMeSignedInPrompt.rejectButtonText`	String	No	The label on the reject button when prompting for Stay signed in
`widgetCustomizations.postAuthKeepMeSignedInPrompt.subtitle`	String	No	The subtitle on the Sign-In Widget when prompting for Stay signed in
`widgetCustomizations.postAuthKeepMeSignedInPrompt.acceptButtonText`	String	No	The label on the accept button when prompting for Stay signed in
`widgetCustomizations.postAuthKeepMeSignedInPrompt.title`	String	No	The title on the Sign-In Widget when prompting for Stay signed in
`widgetCustomizations.showPasswordVisibilityToggle`	Boolean	No	Allows users to see their passwords as they type
`widgetCustomizations.customLink1Label`	String	No	The label for the first custom link
`widgetCustomizations.passwordInfoTip`	String	No	The label for the password information tip
`widgetCustomizations.customLink2Url`	String	No	The URL for the second custom link
`widgetCustomizations.showUserIdentifier`	Boolean	No	Allows the user's identifier to appear on authentication and enrollment pages
`widgetCustomizations.customLink1Url`	String	No	The URL for the first custom link
`widgetCustomizations.unlockAccountUrl`	String	No	The unlock account URL
`widgetCustomizations.passwordLabel`	String	No	The label for the password field
`widgetCustomizations.signInLabel`	String	No	The label for the sign in widget
`widgetCustomizations.authenticatorPageCustomLinkUrl`	String	No	The URL for the authenticator page custom link
`widgetCustomizations.widgetGeneration`	String	No	The generation of the Sign-in Widget Valid values: `"G3"` `"G2"`
`widgetCustomizations.classicFooterHelpTitle`	String	No	The title of the footer link on the sign-in page. Only applicable for Classic Engine orgs.
`widgetCustomizations.usernameInfoTip`	String	No	The label for the username information tip
`widgetCustomizations.forgotPasswordLabel`	String	No	The label for the forgot password page
`widgetCustomizations.authenticatorPageCustomLinkLabel`	String	No	The label for the authenticator page custom link
`widgetCustomizations.classicRecoveryFlowEmailOrUsernameLabel`	String	No	The label for the username field in the classic recovery flow
`contentSecurityPolicySetting`	Object	No
`contentSecurityPolicySetting.mode`	String	No	Valid values: `"enforced"` `"report_only"`
`contentSecurityPolicySetting.srcList[]`	Array	No
`contentSecurityPolicySetting.reportUri`	String	No
`pageContent`	String	No	The HTML for the page

How to start integrating

Add HTTP Task to your workflow definition.
Search for the API you want to integrate with and click on the name.
- This loads the API reference documentation and prepares the Http request settings.
Click Test request to test run your request to the API and see the API's response.