Branding


Branding

The branding endpoints support operations to read, update, and delete the branding configuration details associated with the specified environment. You can manage the following branding details:

  • Company logo

    You can specify the URL to an image file to add a company logo to the environment.

  • Background color

You can specify a Hex, RGB, or HSL value to define the background color.

Branding API operations

The branding endpoints support the following operations:

For hands-on experience with the branding API endpoints, click the Run in Postman button below to download a Postman collection that you can import and open in your local Postman application.

Branding data model

Property Description
backgroundColor A string that specifies the hexadecimal color code of the background.
logo.href A string that specifies the URL or fully qualified path to the logo file used for branding.
logo.id A string that specifies the ID of the logo image.

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.

Endpoint examples

Get the branding configuration

The GET /environments/{environmentId}/branding endpoint returns the branding configuration details for the specified environment resource.

curl -X "GET" "https://api.pingone.com/v1/environments/{environmentId}/branding" \
-H 'Authorization: Bearer jwtToken'

The response data looks like this:

{
    "_links": {
        "self": {
            "href": "https://api.pingone.com/v1/environments/000c2764-3489-4d34-a707-b23dd488049c/branding"
        },
        "environment": {
            "href": "https://api.pingone.com/v1/environments/000c2764-3489-4d34-a707-b23dd488049c"
        },
        "logo": {
            "href": "https://api.pingone.com/v1/environments/000c2764-3489-4d34-a707-b23dd488049c/images/b59a55f1-c870-408b-97d0-efff0d226631"
        }
    },
    "environment": {
        "id": "000c2764-3489-4d34-a707-b23dd488049c"
    },
    "logo": {
        "href": "https://assets.pingone.com/environments/000c2764-3489-4d34-a707-b23dd488049c/images/b59a55f1-c870-408b-97d0-efff0d226631_11d00865-d5e1-469a-a880-1e626153a13e_original.png",
        "id": "b59a55f1-c870-408b-97d0-efff0d226631"
    },
    "backgroundColor": "#0082C4"
}

Update the branding configuration

The PUT /environments/{environmentId}/branding endpoint returns the branding configuration details for the specified environment resource.

curl -X "PUT" "https://api.pingone.com/v1/environments/{environmentId}/branding" \
-H 'Content-type: application/json' \
-H 'Authorization: Bearer jwtToken'
-d $'{
  "backgroundColor": "#000000",
  "logo": {
    "href": "https://assets.pingone.com/environments/000c2764-3489-4d34-a707-b23dd488049c/images/b59a55f1-c870-408b-97d0-efff0d226631_11d00865-d5e1-469a-a880-1e626153a13e_original.png",
    "id": "b59a55f1-c870-408b-97d0-efff0d226631"
  }
}'

Delete the branding configuration

The DELETE /environments/{environmentId}/branding operation deletes the branding configuration for the specified environment resource. When the branding configuration is deleted, branding for the environment reverts back to the default.

curl -X "DELETE" "https://api.pingone.com/v1/environments/{environmentId}/branding" \
-H 'Authorization: Bearer jwtToken'

For successful delete operations, a 204 NO CONTENT message is returned by the request.