Skip to main content

Client Settings

The client-settings allows you to provide customized connection pages for your users. You can customize :

  • logo: The url of the logo you want to display
  • favicon: The url of the logo you want to display on the browser
  • displayName: Your name that will be displayed on the connection page.
  • primaryColor: The color you want to use for the connection page elements (buttons, text).
note

If one of the previous is not configured, we will replace it by our default value.

note

You must ensure you are using HTTPS links ONLY for images.

The primary_color has to be of Hexadecimal color format (eg: #FFFFFF)

You can configure your settings with the endpoint:

PATCH /api/v6/client-settings

{
  "logo": "https://my-logo-url.com/logo.jpg",
  "favicon": "https://my-favicon-url.com/favicon.jpg",
  "display_name": "My display name",
  "primary_color": "#2F2F2F"
}

You also check them with the endpoint :

GET /api/v6/client-settings

{
  "logo": "https://my-logo-url.com/logo.jpg",
  "favicon": "https://my-favicon-url.com/favicon.jpg",
  "display_name": "My display name",
  "primary_color": "#2F2F2F"
}