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
- 200
- 400
- 403
- application/json
- Schema
- Example (from schema)
Schema
Array [
]
pagination
object
required
next numberrequired
previous numberrequired
count numberrequired
current numberrequired
total_pages numberrequired
start_index numberrequired
end_index numberrequired
results
object[]
required
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
{
"pagination": {
"next": 0,
"previous": 0,
"count": 0,
"current": 0,
"total_pages": 0,
"start_index": 0,
"end_index": 0
},
"results": [
{
"brand_uuid": "3fa85f64-5717-4562-b3fc-2c963f66afa6",
"domain": "string",
"default": true,
"branding_title": "string",
"branding_logo": "string",
"branding_favicon": "string",
"flow_authentication": "3fa85f64-5717-4562-b3fc-2c963f66afa6",
"flow_invalidation": "3fa85f64-5717-4562-b3fc-2c963f66afa6",
"flow_recovery": "3fa85f64-5717-4562-b3fc-2c963f66afa6",
"flow_unenrollment": "3fa85f64-5717-4562-b3fc-2c963f66afa6",
"flow_user_settings": "3fa85f64-5717-4562-b3fc-2c963f66afa6",
"flow_device_code": "3fa85f64-5717-4562-b3fc-2c963f66afa6",
"default_application": "3fa85f64-5717-4562-b3fc-2c963f66afa6",
"web_certificate": "3fa85f64-5717-4562-b3fc-2c963f66afa6",
"attributes": {}
}
]
}
- application/json
- Schema
- Example (from schema)
Schema
non_field_errors string[]
code string
property name* any
Validation Error
{
"non_field_errors": [
"string"
],
"code": "string"
}
- application/json
- Schema
- Example (from schema)
Schema
detail stringrequired
code string
{
"detail": "string",
"code": "string"
}
Loading...