PUT /api/v1/brands/{brandId}/themes/{themeId}

Replaces a theme for a brand

Servers

Path parameters

Name Type Required Description
brandId String Yes

The ID of the brand

themeId String Yes

The ID of the theme

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
_links Object No

Specifies link relations (see Web Linking) available using the JSON Hypertext Application Language specification. This object is used for dynamic discovery of related resources and lifecycle operations.

endUserDashboardTouchPointVariant String Yes

Variant for the Okta End-User Dashboard. You can publish a theme for end-user dashboard with different combinations of assets. Variants are preset combinations of those assets.

Possible values:

  • "OKTA_DEFAULT"
  • "LOGO_ON_FULL_WHITE_BACKGROUND"
  • "WHITE_LOGO_BACKGROUND"
  • "FULL_THEME"

Default value: "OKTA_DEFAULT"

errorPageTouchPointVariant String Yes

Variant for the error page. You can publish a theme for error page with different combinations of assets. Variants are preset combinations of those assets.

Possible values:

  • "BACKGROUND_IMAGE"
  • "OKTA_DEFAULT"
  • "BACKGROUND_SECONDARY_COLOR"

Default value: "OKTA_DEFAULT"

loadingPageTouchPointVariant String No

Variant for the Okta loading page. You can publish a theme for Okta loading page with different combinations of assets. Variants are preset combinations of those assets.

Possible values:

  • "OKTA_DEFAULT"
  • "NONE"

Default value: "OKTA_DEFAULT"

secondaryColorHex String Yes

Secondary color hex code

primaryColorContrastHex String No

Primary color contrast hex code

primaryColorHex String Yes

Primary color hex code

signInPageTouchPointVariant String Yes

Variant for the Okta sign-in page. You can publish a theme for sign-in page with different combinations of assets. Variants are preset combinations of those assets.

Note: For a non-OKTA_DEFAULT variant, primaryColorHex is used for button background color and primaryColorContrastHex is used to optimize the opacity for button text.

Possible values:

  • "BACKGROUND_IMAGE"
  • "OKTA_DEFAULT"
  • "BACKGROUND_SECONDARY_COLOR"
emailTemplateTouchPointVariant String Yes

Variant for email templates. You can publish a theme for email templates with different combinations of assets. Variants are preset combinations of those assets.

Possible values:

  • "OKTA_DEFAULT"
  • "FULL_THEME"

Default value: "OKTA_DEFAULT"

secondaryColorContrastHex String No

Secondary color contrast hex code

How to start integrating

  1. Add HTTP Task to your workflow definition.
  2. 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.
  3. Click Test request to test run your request to the API and see the API's response.