Get the branding settings

GET/branding

Returns the login page and sign-up page settings as access_pages and sign_up_page. Both are tenant-wide: one set for the whole platform, the same whichever organisation the token is for. An image field is the address of the stored image, or null when there is none. The colours of an organisation's host are separate: use GET /branding/host-brand. Changes nothing.

Responses

200

The branding settings.

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

429

Rate limit exceeded (error.code = rate_limited).

Error

Examples

curl https://your-org-domain/kong/core/api/v2/branding\
  -H "Authorization: Bearer $HELM_API_KEY"\
  -H "Content-Type: application/json"