Branding

Update the branding settings

PATCH/branding
branding:writeupdate_brandingIdempotent

Changes the fields sent in access_pages and sign_up_page and returns both groups, which are tenant-wide. Only a super admin can write, else 403 missing_permission; a service identity cannot. dry_run shows the result without saving it. Emits branding.updated once, listing the changed groups in changed_fields, not individual fields, and only when something changed; no email. Sending the earlier values undoes it, though a removed image's file stays in storage.

Query parameters

  • dry_runboolean#

    Validate and run the call without committing it, returning what the real call would return with meta.dry_run set.

Request body

application/json, required · BrandingUpdate

{
  "access_pages": {
    "login_title": "Welcome back",
    "align": "MIDDLE"
  },
  "sign_up_page": {
    "header": "Join the platform"
  }
}

Responses

200

The branding settings after the change.

Branding
{
  "data": {
    "access_pages": {
      "align": "LEFT",
      "password_visibility_enabled": true,
      "display_sign_up_link": true,
      "login_title": "string",
      "login_description": "string",
      "terms_and_conditions_title": "string",
      "terms_and_conditions": "string",
      "privacy_policy_title": "string",
      "privacy_policy": "string",
      "logo": "string",
      "background_image": "string",
      "mobile_light_logo": "string",
      "mobile_dark_logo": "string"
    },
    "sign_up_page": {
      "header": "string",
      "sub_header": "string",
      "find_out_label": "string",
      "find_out_placeholder": "string",
      "find_out_mandatory": true,
      "confirmation_header": "string",
      "confirmation_message": "string",
      "logo": "string",
      "background_image": "string",
      "display_phone_number": true
    }
  }
}
401

Authentication failed. error.code is one of invalid_token, expired, revoked.

Error
403

Authorization failed. error.code is one of org_disabled, ip_blocked, missing_scope, scope_disabled, user_disabled.

Error
422

The request can't be processed (HTTP 422): validation_failed with one ErrorDetail per problem, or a code documented on the operation.

Error
429

Rate limit exceeded (error.code = rate_limited).

Error

Examples

curl -X PATCH https://your-org-domain/kong/core/api/v2/branding\
  -H "Authorization: Bearer $HELM_API_KEY"\
  -H "Content-Type: application/json"\
  -d '{
  "access_pages": {
    "login_title": "Welcome back",
    "align": "MIDDLE"
  },
  "sign_up_page": {
    "header": "Join the platform"
  }
}'