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
- See Branding and Branding Themes for important overview information.
For property descriptions, see Branding theme data model.
Property | Type | Required? |
---|---|---|
configuration.backgroundColor | String | Required |
configuration.backgroundType | String | Required |
configuration.backgroundImage.href | String | Required |
configuration.backgroundImage.id | String | Required |
configuration.bodyTextColor | String | Optional |
configuration.buttonColor | String | Optional |
configuration.buttonTextColor | String | Optional |
configuration.cardColor | String | Optional |
configuration.footer | String | Optional |
configuration.headingTextColor | String | Optional |
configuration.linkTextColor | String | Optional |
configuration.logo.href | String | Required |
configuration.logo.id | String | Required |
configuration.logoType | String | Required |
configuration.name | String | Optional |
default | Boolean | Required |
template | String | Required |
Prerequisites
- Create an image to get an
{{imageID}}
and{{logoID}}
. See Create Image. Alternatively, you can pass new href values that are valid images forconfiguration.logo.href
andconfiguration.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"}