Skip to main content

admin_settings_partial_update

PATCH 
/api/v3//admin/settings/

Settings view

Request​

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​

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

Authorization: http

name: authentiktype: httpscheme: bearer

Request Collapse all
Base URL
/api/v3
Auth
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
}