Skip to main content

Get the white label of the request domain

GET 
/v1/white-label

Returns the white label of the domain the request was sent to: its settings with the UI theme embedded. The white label is resolved from the request host: api.<customDomain> and api-<label>.<parent> hosts map to the white label with the matching custom domain. When no white label owns the exact domain, the closest parent domain that has one is used.

Authentication is optional:

  • Without credentials, it returns the summary (WhiteLabelSummary: page title, hidden features, the device brands its company network restricts devices to, Auth0 login configuration and UI theme), so a login page can show the right branding before anyone is authenticated. The response may be cached for 60 seconds.

  • With valid credentials of any identity, it returns the full white label (WhiteLabel): its settings with the UI theme embedded, plus the same device brands.

  • Invalid credentials fail with the same authentication error as on any other route (403).

A response to a request with credentials is never cacheable (Cache-Control: private, no-store).

The two variants are told apart by uid: WhiteLabel carries it, WhiteLabelSummary doesn't.

JWTs are verified against the Auth0 tenant of the resolved white label, so a valid token of another tenant fails with 403. A login page bootstrapping its branding should call this endpoint without credentials.

Responses​

OK

Response Headers
    Cache-Control

    public, max-age=60 without credentials, private, no-store with them.