admin_settings_update

PUT 
/api/v3//admin/settings/

Settings view

Request

application/json

Body

avatars string

Possible values: non-empty

Configure how authentik should show avatars for users.

default_user_change_name boolean

Enable the ability for users to change their name.

default_user_change_email boolean

Enable the ability for users to change their email address.

default_user_change_username boolean

Enable the ability for users to change their username.

event_retention string

Possible values: non-empty

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_compliance boolean

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

impersonation boolean

Globally enable/disable impersonation.

default_token_duration string

Possible values: non-empty

Default token duration

default_token_length integer

Possible values: >= 1 and <= 2147483647

Default token length

Responses

200

application/json

Schema

Schema

avatars string

Configure how authentik should show avatars for users.

default_user_change_name boolean

Enable the ability for users to change their name.

default_user_change_email boolean

Enable the ability for users to change their email address.

default_user_change_username boolean

Enable the ability for users to change their username.

event_retention string

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_compliance boolean

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

impersonation boolean

Globally enable/disable impersonation.

default_token_duration string

Default token duration

default_token_length integer

Possible values: >= 1 and <= 2147483647

Default token length

Example (from schema)

{
  "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,
  "default_token_duration": "string",
  "default_token_length": 0
}

400

application/json

Schema

Schema

non_field_errors string[]
code string

Example (from schema)

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

403

application/json

Schema

Schema

detail stringrequired
code string

Example (from schema)

{
  "detail": "string",
  "code": "string"
}

• curl
• python
• go
• nodejs
• ruby
• csharp
• php
• java
• powershell

• CURL

curl -L -X PUT '/api/v3/admin/settings/' \
-H 'Content-Type: application/json' \
-H 'Accept: application/json' \
-H 'Authorization: Bearer <TOKEN>' \
--data-raw '{
  "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,
  "default_token_duration": "string",
  "default_token_length": 0
}'

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,
  "default_token_duration": "string",
  "default_token_length": 0
}