Create Branding Theme

POST {{apiPath}}/environments/{{envID}}/themes

The POST /environments/{{envID}}/themes endpoint creates a new branding configuration theme associated with the specified environment resource.

Prerequisites

For property descriptions, see Branding theme data model.

PropertyTypeRequired?
configuration.backgroundColorStringRequired
configuration.backgroundTypeStringRequired
configuration.backgroundImage.hrefStringRequired
configuration.backgroundImage.idStringRequired
configuration.bodyTextColorStringOptional
configuration.buttonColorStringOptional
configuration.buttonTextColorStringOptional
configuration.cardColorStringOptional
configuration.footerStringOptional
configuration.headingTextColorStringOptional
configuration.linkTextColorStringOptional
configuration.logo.hrefStringRequired
configuration.logo.idStringRequired
configuration.logoTypeStringRequired
configuration.nameStringOptional
defaultBooleanRequired
templateStringRequired

Prerequisites

  • Create an image to get an {{imageID}} and {{logoID}}. See Create Image. Alternatively, you can pass new href values that are valid images for configuration.logo.href and configuration.backgroundImage.href, and use new {{logoID}} and {{imageID}} values if they are in the correct format: 00000000-0000-0000-0000-000000000000.

Request Body

{"template"=>"default", "configuration"=>{"logoType"=>"IMAGE", "logo"=>{"href"=>"https://logo.com", "id"=>"{{logoID}}"}, "backgroundColor"=>"#333333", "backgroundType"=>"COLOR", "backgroundImage"=>{"href"=>"https://bg.com", "id"=>"{{imageID}}"}, "cardColor"=>"#333333", "headingTextColor"=>"#333333", "linkTextColor"=>"#333333", "bodyTextColor"=>"#444444", "buttonTextColor"=>"#333333", "buttonColor"=>"#333333", "name"=>"ACME test theme", "footer"=>"some footer"}}

RESPONSES

status: OK

{"_links":{"self":{"href":"https://api.pingone.com/v1/environments/abfba8f6-49eb-49f5-a5d9-80ad5c98f9f6/themes/38c14492-efd0-43a2-8212-181d9dfc7dbb"},"environment":{"href":"https://api.pingone.com/v1/environments/abfba8f6-49eb-49f5-a5d9-80ad5c98f9f6"}},"environment":{"id":"abfba8f6-49eb-49f5-a5d9-80ad5c98f9f6"},"id":"38c14492-efd0-43a2-8212-181d9dfc7dbb","template":"default","default":false,"configuration":{"logoType":"IMAGE","logo":{"href":"https://logo.com","id":"00000000-0000-0000-0000-000000000000"},"backgroundColor":"#333333","backgroundType":"COLOR","backgroundImage":{"href":"https://bg.com","id":"e8ad78dd-d45c-49b4-974d-8d5e443d4531"},"bodyTextColor":"#444444","cardColor":"#333333","headingTextColor":"#333333","linkTextColor":"#333333","buttonColor":"#333333","buttonTextColor":"#333333","name":"ACME test theme","footer":"some footer"},"modified":"2020-09-22T15:49:46.210Z"}