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

{
    "name": "default",
    "color": {
      "button": "#2996cc",
      "buttonText": "#ffffff",
      "bodyText": "#686f77",
      "headingText": "#686f77",
      "link": "#2996cc",
      "card": "#ffffff",
      "background": "#ededed"
    },
    "image": {
      "background": ""
    },
    "meta": {
      "displayName": "Ping Default"
    }
  }

focus

{
    "name": "focus",
    "color": {
      "button": "#cb0020",
      "buttonText": "#ffffff",
      "bodyText": "#4a4a4a",
      "headingText": "#cb0020",
      "link": "#2996cc",
      "card": "#fcfcfc",
      "background": "#ededed"
    },
    "image": {
      "background": ""
    },
    "meta": {
      "displayName": "Focus"
    }
  }

mural

{
    "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

{
    "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

{
    "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 Description
configuration.backgroundColor A string that specifies 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.backgroundType A string that specifies the background type for the theme. Options are NONE, COLOR, IMAGE, DEFAULT.
configuration.backgroundImage.href A string that specifies 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 A string that specifies the ID of the background image.
configuration.bodyTextColor A string that specifies the body text color for the theme. It must be a valid hexadecimal color code.
configuration.buttonColor A string that specifies the button color for the theme. It must be a valid hexadecimal color code.
configuration.buttonTextColor A string that specifies the button text color for the branding theme. It must be a valid hexadecimal color code.
configuration.cardColor A string that specifies the card color for the branding theme. It must be a valid hexadecimal color code.
configuration.footer A string that specifies the footer of the branding theme.
configuration.headingTextColor A string that specifies the heading text color for the branding theme. It must be a valid hexadecimal color code.
configuration.linkTextColor A string that specifies the hyperlink text color for the branding theme. It must be a valid hexadecimal color code.
configuration.logo.href A string that specifies 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 A string that specifies the ID of the logo image.
configuration.logoType A string that specifies the type of format used for the image. Options are IMAGE and NONE.
configuration.name A string that specifies the name of the branding theme.
default A boolean that specifies whether this theme is the environment’s default branding configuration.
environment.id A string that specifies the environment resource’s unique identifier associated with the branding theme.
id A string that specifies the ID of the branding configuration resource.
template A string that specifies the template name of the branding theme associated with the environment. Options are default, focus, mural, slate, and split.

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.