Skip to main content

core_brands_list

GET 
/core/brands/

Brand Viewset

Request​

Query Parameters

    brand_uuid uuid
    branding_favicon string
    branding_logo string
    branding_title string
    default boolean
    domain string
    flow_authentication uuid
    flow_device_code uuid
    flow_invalidation uuid
    flow_recovery uuid
    flow_unenrollment uuid
    flow_user_settings uuid
    ordering string

    Which field to use when ordering the results.

    page integer

    A page number within the paginated result set.

    page_size integer

    Number of results to return per page.

    search string

    A search term.

    web_certificate uuid

Responses​

Schema

    pagination

    object

    required

    next numberrequired
    previous numberrequired
    count numberrequired
    current numberrequired
    total_pages numberrequired
    start_index numberrequired
    end_index numberrequired

    results

    object[]

    required

  • Array [

    • brand_uuid uuidrequired
    domain stringrequired

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

    default boolean
    branding_title string
    branding_logo string
    branding_favicon string
    flow_authentication uuidnullable
    flow_invalidation uuidnullable
    flow_recovery uuidnullable
    flow_unenrollment uuidnullable
    flow_user_settings uuidnullable
    flow_device_code uuidnullable
    default_application uuidnullable

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

    web_certificate uuidnullable

    Web Certificate used by the authentik Core webserver.

    attributes

  • ]

Loading...