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.

Branding settings errors

In addition to the general error codes, branding settings operations can return the following errors:

HTTP status Top‑level code Detail code When it happens and what the response contains

400

INVALID_DATA

EMPTY_VALUE or INVALID_VALUE

Message: Validation Error : [<property> <message>]

When and details

When: A PUT /brandingSettings request supplies a logo object without href or id, an href that is not a URL with an http or https scheme, or a companyName that does not match the description character rules

Details: Describes the failing property, such as must not be null for an omitted logo.href or logo.id, must be a valid URL with http/https scheme for an invalid logo.href, or must contain only Unicode letters, marks, numbers, spaces, or punctuation (except $, +, <, =, >, ^, `, |, ~) for an invalid companyName, for example Validation Error : [logo.href must be a valid URL with http/https scheme]

400

INVALID_REQUEST

None

Message: The request could not be completed. The request was malformed or invalid.

When and details

When: A path identifier cannot be parsed as a UUID, or the request body cannot be deserialized

Details: For a JSON field conversion error, the target is the field path. Otherwise no detail is returned.

403

ACCESS_FAILED

LICENSE_EXCEEDED

Message: This service is no longer active.

When and details

When: The environment is disabled for platform usage (applies to all branding settings operations)

Details: Environment is disabled: <environmentId>

403

ACCESS_FAILED

None

Message: The actor attempting to perform the request is not authorized.

When and details

When: The actor lacks the branding:read:brandingSettings permission (GET), or the branding:update:brandingSettings permission (PUT)

Details: None.

500

UNEXPECTED_ERROR

None

Message: There was an unexpected error with the service. Please try again later.

When and details

When: A PUT /brandingSettings request cannot publish the updated default theme to storage after the settings are saved. The saved settings are reverted before the error is returned

Details: None.