core

Brand Viewset

get/core/brands/{brand_uuid}/

Path parameters

brand_uuidstring uuid required

A UUID string identifying this Brand.

Response

brand_uuidstring uuid required
domainstring required

Domain that activates this brand. Can be a superset, i.e. a.b for aa.b and ba.b

defaultboolean
branding_titlestring
branding_logostring
branding_faviconstring
branding_custom_cssstring
branding_default_flow_backgroundstring
branding_map_tilesstring

URL template for the vector tile source used by the events map. Supports XYZ templates with {z}, {x} and {y} placeholders, or pmtiles:// archive URLs. When empty, the frontend uses the bundled hexworld basemap. This value is part of the brand information served to unauthenticated clients; do not embed API keys or other credentials in it.

flow_authenticationstring uuid nullable
flow_user_switchstring uuid nullable
flow_invalidationstring uuid nullable
flow_recoverystring uuid nullable
flow_unenrollmentstring uuid nullable
flow_user_settingsstring uuid nullable
flow_device_codestring uuid nullable
flow_lockdownstring uuid nullable
flow_requeststring uuid nullable
default_applicationstring uuid nullable

When set, external users will be redirected to this application after authenticating.

web_certificatestring uuid nullable

Web Certificate used by the authentik Core webserver.

client_certificatesstring[]

Certificates used for client authentication.

attributesobject

Changes

No recorded changes to this endpoint across all 1 revision of this API.