PingOne Platform APIs

Branding Settings

Branding settings control the default branding configuration applied to the environment, specifying the company name and default logo associated with an environment ID. If a branding configuration is not specified, the authentication sign-on screens use Ping Identity branding.

Branding settings data model

Property Type Required Mutable Description

companyName

String

Optional

Mutable

The company name associated with the specified environment. This is used only when your organization has enabled the p14c-33204-flow-ui-accessibility feature flag for PingOne. The companyName value is then added to the Flow UI for the PingOne admin console.

logo

Object

Optional

Mutable

Contains the logo references.

logo.href

String

Required

Mutable

The URL or fully qualified path to the logo file used for branding. Required when logo is specified. This sets the initial configuration.logo.href field for Branding Themes, and is used only when creating a new branding theme using the PingOne admin console.

logo.id

String

Required

Mutable

The ID of the logo image. Required when logo is specified. This sets the initial configuration.logo.id field for Branding Themes, and is used only when creating a new theme using the PingOne admin console.

Response codes

Code Message

200

Successful operation.

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.