--- title: Branding Themes description: Branding themes control the layout, color, and images for the authentication sign-on screens associated with a specified environment. PingOne provides several branding template themes that can be used as-is, or as a starting point for further customization. If a branding theme is not specified, the sign-on screens use Ping Identity default branding. component: pingone-api page_id: pingone-api:platform:branding/branding-themes canonical_url: https://developer.pingidentity.com/pingone-api/platform/branding/branding-themes.html section_ids: branding-template-configurations: Branding template configurations branding-themes-data-model: Branding themes data model response-codes: Response codes --- # Branding Themes Branding themes control the layout, color, and images for the authentication sign-on screens associated with a specified environment. PingOne provides several branding template themes that can be used as-is, or as a starting point for further customization. If a branding theme is not specified, the sign-on screens use Ping Identity default branding. ## Branding template configurations PingOne provides the following branding theme configurations. A branding theme template must be specified in the `template` property when creating a new branding theme resource: **default** ```json { "name": "default", "color": { "button": "#2996cc", "buttonText": "#ffffff", "bodyText": "#686f77", "headingText": "#686f77", "link": "#2996cc", "card": "#ffffff", "background": "#ededed" }, "image": { "background": "" }, "meta": { "displayName": "Ping Default" } } ``` **focus** ```json { "name": "focus", "color": { "button": "#cb0020", "buttonText": "#ffffff", "bodyText": "#4a4a4a", "headingText": "#cb0020", "link": "#2996cc", "card": "#fcfcfc", "background": "#ededed" }, "image": { "background": "" }, "meta": { "displayName": "Focus" } } ``` **mural** ```json { "name": "mural", "color": { "button": "#61b375", "buttonText": "#ffffff", "bodyText": "#000000", "headingText": "#000000", "link": "#2996cc", "card": "#fcfcfc", "background": "" }, "image": { "background": "https://assets.pingone.com/ux/branding-themes/0.1.0/mural/bg.jpg" }, "meta": { "displayName": "Mural", "cssLink": "https://assets.pingone.com/ux/branding-themes/0.1.0/mural/mural.css" } } ``` **slate** ```json { "name": "slate", "color": { "button": "#fcfcfc", "buttonText": "#4a4a4a", "bodyText": "#4a4a4a", "headingText": "#4a4a4a", "link": "#4a4a4a", "card": "#fcfcfc", "background": "" }, "image": { "background": "https://assets.pingone.com/ux/branding-themes/0.1.0/slate/bg.jpg" }, "meta": { "displayName": "Slate", "cssLink": "https://assets.pingone.com/ux/branding-themes/0.1.0/slate/slate.css" } } ``` **split** ```json { "name": "split", "color": { "button": "#263956", "buttonText": "#ffffff", "bodyText": "#263956", "headingText": "#686f77", "link": "#2996cc", "card": "#fcfcfc", "background": "#2996cc" }, "image": { "background": "" }, "meta": { "displayName": "Split" } } ``` ### Branding themes data model | Property | Type | Required? | Mutable? | Description | | -------------------------------------------------------------------- | ------- | --------- | --------- | -------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------- | | `configuration.backgroundColor` | String | Required | Mutable | The background color for the theme. It must be a valid hexadecimal color code, and it is a required property when `configuration.backgroundType` is set to `COLOR`. | | `configuration.backgroundImage.href` | String | Required | Mutable | The URL or fully qualified path to the background image file used for branding. This is a required property when `configuration.backgroundType` is set to `IMAGE`. | | `configuration.backgroundImage.id` | String | Required | Immutable | The ID of the background image. | | `configuration.backgroundOutlineColor` | String | Optional | Mutable | For PingOne Neo verification presentation screen, the outline color of background objects for the branding theme. It must be a valid hexadecimal color code. Defaults to #A5B9C5. | | `configuration.backgroundType` | String | Required | Mutable | The background type for the theme. Options are `NONE`, `COLOR`, `IMAGE`, `DEFAULT`. | | `configuration.bodyTextColor` | String | Required | Mutable | The body text color for the theme. It must be a valid hexadecimal color code. | | `configuration.buttonBorderColor` | String | Optional | Mutable | The button border color for the theme. It must be a valid hexadecimal color code. | | `configuration.buttonBorderRadius` | String | Optional | Mutable | The button border radius for the theme (range between 0-25px). | | `configuration.buttonBorderWidth` | String | Optional | Mutable | The button border width for the theme (range from 0-4px). | | `configuration.buttonColor` | String | Required | Mutable | The button color for the theme. It must be a valid hexadecimal color code. | | `configuration.buttonHoverStateBorderColor` | String | Optional | Mutable | The button hover state border color for the theme. It must be a valid hexadecimal color code. | | `configuration.buttonHoverStateFillColor` | String | Optional | Mutable | The button hover state fill color for the theme. It must be a valid hexadecimal color code. | | `configuration.buttonHoverStateTextColor` | String | Optional | Mutable | The button hover state text color for the theme. It must be a valid hexadecimal color code. | | `configuration.buttonTextColor` | String | Required | Mutable | The button text color for the branding theme. It must be a valid hexadecimal color code. | | `configuration.buttonTextSize` | String | Optional | Mutable | The button text size for the theme. | | `configuration.buttonTextWeight` | String | Optional | Mutable | The button text weight for the theme (range from 100-900). | | `configuration.cardBorderColor` | String | Optional | Mutable | The card border color for the theme. It must be a valid hexadecimal color code. | | `configuration.cardBorderWidth` | String | Optional | Mutable | The card border width for the theme (range from 0-4px). | | `configuration.cardColor` | String | Required | Mutable | The card color for the branding theme. It must be a valid hexadecimal color code. | | `configuration.cardCornerRadius` | String | Optional | Mutable | The card corner radius for the theme (range from 0-25px). | | `configuration.cardHorizontalAlignment` | String | Optional | Mutable | The card horizontal alignment for the theme. | | `configuration.cardShadow` | String | Optional | Mutable | The card shadow for the theme. | | `configuration.cardVerticalAlignment` | String | Optional | Mutable | The card vertical alignment for the theme. | | `configuration.focusRectangleColor` | String | Optional | Mutable | The focus rectangle color for the theme. It must be a valid hexadecimal color code. | | `configuration.footer` | String | Optional | Mutable | The footer of the branding theme. | | `configuration.foregroundHighlightColor` | String | Optional | Mutable | For PingOne Neo verification presentation screen, the highlight color of the foreground object for the branding theme. It must be a valid hexadecimal color code. Defaults to #C6D9FF. | | `configuration.foregroundMainColor` | String | Optional | Mutable | For PingOne Neo verification presentation screen, the outline color of the foreground object for the branding theme. It must be a valid hexadecimal color code. Defaults to #4462ED. | | `configuration.globalFont` | String | Optional | Mutable | The global font for the theme. The default value is `Helvetica Neue, Helvetica, sans-serif`. | | `configuration.header` | String | Optional | Mutable | The header for the theme. For example, `"

Welcome to PingOne

"`. | | `configuration.headingTextColor` | String | Required | Mutable | The heading text color for the branding theme. It must be a valid hexadecimal color code. | | `configuration.inputBorderWidth` | String | Optional | Mutable | The input border width for the theme (range from 0-4px). | | `configuration.inputBoxBorderColor` | String | Optional | Mutable | The input box border color for the theme. It must be a valid hexadecimal color code. | | `configuration.inputCornerRadius` | String | Optional | Mutable | The input corner radius for the theme (range from 0-25px). | | `configuration.inputLabelPosition` | String | Optional | Mutable | The input label position for the theme. | | `configuration.inputLabelTextColor` | String | Optional | Mutable | The input label text color for the theme. It must be a valid hexadecimal color code. | | `configuration.inputLabelTextSize` | String | Optional | Mutable | The input label text size for the theme. | | `configuration.inputLabelTextWeight` | String | Optional | Mutable | The input label text weight for the theme (range from 100-900). | | `configuration.inputValueTextColor` | String | Optional | Mutable | The input value text color for the theme. It must be a valid hexadecimal color code. | | `configuration.inputValueTextSize` | String | Optional | Mutable | The input value text size for the theme. | | `configuration.inputValueTextWeight` | String | Optional | Mutable | The input value text weight for the theme (range from 100-900). | | `configuration.linkTextColor` | String | Required | Mutable | The hyperlink text color for the branding theme. It must be a valid hexadecimal color code. | | `configuration.linkTextHoverColor` | String | Optional | Mutable | The link text hover color for the theme. It must be a valid hexadecimal color code. | | `configuration.linkTextSize` | String | Optional | Mutable | The link text size for the theme. | | `configuration.linkTextWeight` | String | Optional | Mutable | The link text weight for the theme (range from 100-900). | | `configuration.logo.href` | String | Required | Mutable | The URL or fully qualified path to the logo file used for branding. This is a required property when `configuration.logoType` is set to `IMAGE`. | | `configuration.logo.id` | String | Required | Immutable | The ID of the logo image. | | `configuration.logoHeight` | String | Optional | Mutable | The logo height assigned to the image (range from 0-100px). | | `configuration.logoType` | String | Required | Mutable | The type of format used for the image. Options are `IMAGE` and `NONE`. | | `configuration.name` | String | Required | Mutable | The name of the branding theme. | | `configuration.schemaVersion` | Integer | Read only | N/A | The schema version number for the theme. | | `configuration.subtitleTextColor` | String | Optional | Mutable | The subtitle text color for the theme. It must be a valid hexadecimal color code. | | `configuration.subTitleTextSize` | String | Optional | Mutable | The subtitle text size for the theme. | | `configuration.subTitleTextWeight` | String | Optional | Mutable | The subtitle text weight for the theme (range from 100-900). | | `configuration.titleTextSize` | String | Optional | Mutable | The title text size for the theme. | | `configuration.TitleTextWeight` | String | Optional | Mutable | The title text width for the theme (range from 100-900). | | `configuration.applicationBackgroundColor` | String | Optional | Mutable | The application background color for the theme. It must be a valid hexadecimal color code. Note that this property is not used by DaVinci forms. | | `configuration.headerBackgroundColor` | String | Optional | Mutable | The header background color for the theme. It must be a valid hexadecimal color code. Note that this property is not used by DaVinci forms. | | `configuration.headerLocalized` | Object | Optional | Mutable | The localization object to specify language translations for the form header. | | `configuration.headerLocalized.defaultLanguage` | String | Optional | Mutable | The localization language code for the header's default language (for example, `"defaultLanguage": "en"`). | | `configuration.headerLocalized.content` | Object | Optional | Mutable | The localization language object that specifies the localized text and content type for the language options. | | `configuration.headerLocalized.content.{{languageCode}}` | Object | Optional | Mutable | The localization language object that specifies the localized text and content type for the specific language. | | `configuration.headerLocalized.content.{{languageCode}}.inputText` | String | Optional | Mutable | The header text in the specified language. | | `configuration.headerLocalized.content.{{languageCode}}.contentType` | String | Optional | Mutable | The content type for the header text in the specified language. Options are `RichText` and `HTML`. | | `configuration.footerLocalized` | Object | Optional | Mutable | The localization object to specify language translations for the form footer. | | `configuration.footerLocalized.defaultLanguage` | String | Optional | Mutable | The localization language code for the footer's default language (for example, `"defaultLanguage": "en"`). | | `configuration.footerLocalized.content` | Object | Optional | Mutable | The localization language object that specifies the localized text and content type for the language options. | | `configuration.footerLocalized.content.{{languageCode}}` | Object | Optional | Mutable | The localization language object that specifies the localized text and content type for the specific language. | | `configuration.footerLocalized.content.{{languageCode}}.inputText` | String | Optional | Mutable | The footer text in the specified language. | | `configuration.footerLocalized.content.{{languageCode}}.contentType` | String | Optional | Mutable | The content type for the footer text in the specified language. Options are `RichText` and `HTML`. | | `default` | Boolean | Required | Mutable | Specifies whether this theme is the environment's default branding configuration. | | `environment.id` | String | Required | Immutable | The environment resource's unique identifier associated with the branding theme. | | `id` | String | Required | Immutable | The ID of the branding configuration resource. | | `template` | String | Required | Mutable | The template name of the branding theme associated with the environment. Options are `default`, `focus`, `mural`, `slate`, and `split`. | Locations of `configuration` attributes `backgroundOutlineColor`, `foregroundMainColor`, and `foregroundHighlightColor` in the PingOne Neo Verify application. ![PingOne Neo verification theme color locations](../../_images/BrandingTheme-VerifyScreenColorLocations-reduced.png) ## Response codes | Code | Message | | ---- | --------------------------------------------------------------------- | | 200 | Successful operation. | | 201 | Successfully created. | | 400 | The request could not be completed. | | 401 | You do not have access to this resource. | | 403 | You do not have permissions or are not licensed to make this request. | | 404 | The requested resource was not found. | | 500 | Unexpected server error. |