core_brands_partial_update

PATCH 
/api/v3//core/brands/:brand_uuid/

Brand Viewset

Request

Path Parameters

brand_uuid uuidrequired

A UUID string identifying this Brand.

application/json

Body

domainstring

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

Possible values: non-empty

defaultboolean
branding_titlestring

Possible values: non-empty

branding_logostring

Possible values: non-empty

branding_faviconstring

Possible values: non-empty

branding_custom_cssstring
branding_default_flow_backgroundstring

Possible values: non-empty

flow_authenticationuuidnullable
flow_invalidationuuidnullable
flow_recoveryuuidnullable
flow_unenrollmentuuidnullable
flow_user_settingsuuidnullable
flow_device_codeuuidnullable
default_applicationuuidnullable

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

web_certificateuuidnullable

Web Certificate used by the authentik Core webserver.

client_certificatesuuid[]

Certificates used for client authentication.

attributes

Responses

200

application/json

Schema

Schema

brand_uuiduuidrequired
domainstringrequired

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
flow_authenticationuuidnullable
flow_invalidationuuidnullable
flow_recoveryuuidnullable
flow_unenrollmentuuidnullable
flow_user_settingsuuidnullable
flow_device_codeuuidnullable
default_applicationuuidnullable

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

web_certificateuuidnullable

Web Certificate used by the authentik Core webserver.

client_certificatesuuid[]

Certificates used for client authentication.

attributes

Example (auto)

{
  "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",
  "client_certificates": [
    "3fa85f64-5717-4562-b3fc-2c963f66afa6"
  ],
  "attributes": {}
}

400

application/json

Schema

Schema

non_field_errorsstring[]
codestring
property name*any

Validation Error

Example (auto)

{
  "non_field_errors": [
    "string"
  ],
  "code": "string"
}

403

application/json

Schema

Schema

detailstringrequired
codestring

Example (auto)

{
  "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

Request Collapse all

Base URL

/api/v3

Auth

Bearer Token

Parameters

brand_uuid — pathrequired

Body

{
  "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",
  "client_certificates": [
    "3fa85f64-5717-4562-b3fc-2c963f66afa6"
  ],
  "attributes": {}
}