core_brands_list
GET/api/v3//core/brands/
Brand Viewset
Request
Query Parameters
brand_uuid uuid
branding_default_flow_background string
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 (auto)
Schema
pagination objectrequired
results object[]required
{
"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",
"branding_custom_css": "string",
"branding_default_flow_background": "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 (auto)
Schema
non_field_errorsstring[]
codestring
property name*any
Validation Error
{
"non_field_errors": [
"string"
],
"code": "string"
}
- application/json
- Schema
- Example (auto)
Schema
detailstringrequired
codestring
{
"detail": "string",
"code": "string"
}
Authorization: http
name: authentiktype: httpscheme: bearer
- csharp
- curl
- dart
- go
- http
- java
- javascript
- kotlin
- c
- nodejs
- objective-c
- ocaml
- php
- powershell
- python
- r
- ruby
- rust
- shell
- swift
- HTTPCLIENT
- RESTSHARP
var client = new HttpClient();
var request = new HttpRequestMessage(HttpMethod.Get, "/api/v3/core/brands/");
request.Headers.Add("Accept", "application/json");
request.Headers.Add("Authorization", "Bearer <token>");
var response = await client.SendAsync(request);
response.EnsureSuccessStatusCode();
Console.WriteLine(await response.Content.ReadAsStringAsync());