core_brands_create
POST/api/v3//core/brands/
Brand Viewset
Request
- application/json
Body
required
domain stringrequired
Domain that activates this brand. Can be a superset, i.e. a.b for aa.b and ba.b
Possible values: non-empty
default boolean
branding_title string
Possible values: non-empty
branding_logo string
Possible values: non-empty
branding_favicon string
Possible values: non-empty
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
Responses
- 201
- 400
- 403
- application/json
- Schema
- Example (from schema)
Schema
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
{
"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"
}
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.Post, "/api/v3/core/brands/");
request.Headers.Add("Accept", "application/json");
request.Headers.Add("Authorization", "Bearer <TOKEN>");
var content = new StringContent("{\n \"domain\": \"string\",\n \"default\": true,\n \"branding_title\": \"string\",\n \"branding_logo\": \"string\",\n \"branding_favicon\": \"string\",\n \"flow_authentication\": \"3fa85f64-5717-4562-b3fc-2c963f66afa6\",\n \"flow_invalidation\": \"3fa85f64-5717-4562-b3fc-2c963f66afa6\",\n \"flow_recovery\": \"3fa85f64-5717-4562-b3fc-2c963f66afa6\",\n \"flow_unenrollment\": \"3fa85f64-5717-4562-b3fc-2c963f66afa6\",\n \"flow_user_settings\": \"3fa85f64-5717-4562-b3fc-2c963f66afa6\",\n \"flow_device_code\": \"3fa85f64-5717-4562-b3fc-2c963f66afa6\",\n \"default_application\": \"3fa85f64-5717-4562-b3fc-2c963f66afa6\",\n \"web_certificate\": \"3fa85f64-5717-4562-b3fc-2c963f66afa6\",\n \"attributes\": {}\n}", null, "application/json");
request.Content = content;
var response = await client.SendAsync(request);
response.EnsureSuccessStatusCode();
Console.WriteLine(await response.Content.ReadAsStringAsync());