admin_settings_update

PUT 
/api/v3//admin/settings/

Settings view

Request

application/json

Body

avatarsstring

Configure how authentik should show avatars for users.

Possible values: non-empty

default_user_change_nameboolean

Enable the ability for users to change their name.

default_user_change_emailboolean

Enable the ability for users to change their email address.

default_user_change_usernameboolean

Enable the ability for users to change their username.

event_retentionstring

Events will be deleted after this duration.(Format: weeks=3;days=2;hours=3,seconds=2).

Possible values: non-empty

footer_links

The option configures the footer links on the flow executor pages.

gdpr_complianceboolean

When enabled, all the events caused by a user will be deleted upon the user's deletion.

impersonationboolean

Globally enable/disable impersonation.

impersonation_require_reasonboolean

Require administrators to provide a reason for impersonating a user.

default_token_durationstring

Default token duration

Possible values: non-empty

default_token_lengthinteger

Default token length

Possible values: >= 1 and <= 2147483647

Responses

200

application/json

Schema

Schema

avatarsstring

Configure how authentik should show avatars for users.

default_user_change_nameboolean

Enable the ability for users to change their name.

default_user_change_emailboolean

Enable the ability for users to change their email address.

default_user_change_usernameboolean

Enable the ability for users to change their username.

event_retentionstring

Events will be deleted after this duration.(Format: weeks=3;days=2;hours=3,seconds=2).

footer_links

The option configures the footer links on the flow executor pages.

gdpr_complianceboolean

When enabled, all the events caused by a user will be deleted upon the user's deletion.

impersonationboolean

Globally enable/disable impersonation.

impersonation_require_reasonboolean

Require administrators to provide a reason for impersonating a user.

default_token_durationstring

Default token duration

default_token_lengthinteger

Default token length

Possible values: >= 1 and <= 2147483647

Example (auto)

{
  "avatars": "string",
  "default_user_change_name": true,
  "default_user_change_email": true,
  "default_user_change_username": true,
  "event_retention": "string",
  "gdpr_compliance": true,
  "impersonation": true,
  "impersonation_require_reason": true,
  "default_token_duration": "string",
  "default_token_length": 0
}

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

var client = new HttpClient();
var request = new HttpRequestMessage(HttpMethod.Put, "/api/v3/admin/settings/");
request.Headers.Add("Accept", "application/json");
request.Headers.Add("Authorization", "Bearer <token>");
var content = new StringContent("{\n  \"avatars\": \"string\",\n  \"default_user_change_name\": true,\n  \"default_user_change_email\": true,\n  \"default_user_change_username\": true,\n  \"event_retention\": \"string\",\n  \"gdpr_compliance\": true,\n  \"impersonation\": true,\n  \"impersonation_require_reason\": true,\n  \"default_token_duration\": \"string\",\n  \"default_token_length\": 0\n}", null, "application/json");
request.Content = content;
var response = await client.SendAsync(request);
response.EnsureSuccessStatusCode();
Console.WriteLine(await response.Content.ReadAsStringAsync());

Request Collapse all

Base URL

/api/v3

Auth

Bearer Token

Body

{
  "avatars": "string",
  "default_user_change_name": true,
  "default_user_change_email": true,
  "default_user_change_username": true,
  "event_retention": "string",
  "gdpr_compliance": true,
  "impersonation": true,
  "impersonation_require_reason": true,
  "default_token_duration": "string",
  "default_token_length": 0
}