Files
authentik/website/docs/developer-docs/api/reference/admin-settings-update.api.mdx
Tana M Berry 7a6d44d0df first pass
2024-10-22 15:10:13 -05:00

515 lines
19 KiB
Plaintext

---
id: admin-settings-update
title: "admin_settings_update"
description: "Settings view"
sidebar_label: "admin_settings_update"
hide_title: true
hide_table_of_contents: true
api: eJztV11v2zYU/SsEX7YBmpU6wVq4KLCu84oAbRE06fYwBAYlXlusKVIjKSee4f++e0kpluM6W4EM2Iq+JDI/zv3gueeSG24bcCIoa84ln3Aha2VmHkJQZuFnbSNFAJ5xCb50qqF1uOqym2crBTc4G8TC88nvaTe/zriDP1rw4Scr13yy4aU1AUygT9E0WpXRYP7RE9qG+7KCWtBXWDeA+Lb4CGU4bvYSnBJa/QkO1zSOQggKfMRfiSCcH4D54HATLkTf3oBZhIpPntyHfmXNXC1aB6yyN0y0oUJ/1ZL5yrZa0j8cTdBsbh1rPTg/4lvCmYtWhxmNzMpKmAXMjKhh4EFhrQZhDuKZGlFoYGiLiUJpFdY7bBYsS2g0rxwjzKMGMX1KP7bFCMqElA788Vjp+9+It8eNhmGFxzFzQCxSiTSfc7pT2u7ZjdKaFcAkaESSTMwDODSnPJNtKoLRt79YV4swYTcAS//i9LkUa/9i/Bx54PBn5gHJLHHku+jY3FrEmGlllpFz+3avMFIbf7CyJ5iP8ad9LO5jOB3HNJIMbqFsA2alEQtIWV/IBrNtaywcYcp/kujfkL0MYrZlxgRGTfiQslAKTK1kxZqJmOSDtLRN5xDNfuPTOOWGnFE1FhvWrbh3Dsdcea1tgQ6sO3dyqXwkwR7OHrmCXYKZ9QfyuUf9c0JhEeXuWA/xdQdwh65QohZRUGpxq+q25pPxk7OnZ89Ofzh7Gm2mwb+x2OFu0WBQQcNAtt4nUcQ5mkUitQ5LAHUTVasXHPx1vY0C6vEUfNK08cnJf0dFv+rml6WbX5XyC1bK/4028qiJ+5vJsbNHlb5fUe5k3MqmztlD3TPWzOYKtJwBzQ8FUDgn1rhBBag/IYzkfmklfHoGxUCRWaEvhvYGidi5ljw7mo/TR8zHazDYA0r28uL8SEIkhH2F7IN6KFq6/SsHkp4EHcD1LtLO6ANh4lANobL0IGlacrsRxEeexwdG3j9Pck5t1K2ADgq7aOt0XNSofHWac+qjfZe9pIx0vW3Xa++cr0JoCCyuohoF4cBFTyin73fPmemtQHmBvSY5rLdjTS24Fh7sQccX7DpFWnMg6jv7BwKYdtyTon1T91XkMJp9VTghbTNzG9PXnekupxmn40hA45Px2ejZaHzAu7diiRburguJvcwryuyIZ5Heooz07rLDK9Da/riwd5ZGyhILkfuA96RYvDFH/O35FUIkLtC5+kmeL1So2mKEmckHEPnuq0DxzdGUyd+cv5q+u5zGs2+sD7UwA/BIQNYTkH36fTyoz8OnciJcgNuQNxoNUhDR2U3H8v4ZTeTtxDHjVEAVekPTm00hPHxwerulYaSmo1skfq4E3ugKOhG8ReIGEBJZTKWxhHW6rZFb31+RE7RctzGo+xKyzfodL8sSmvDg2utBtV58oNwX3bO/jgrBnaDA6S8Wd8ZTm4+lGMc2XCPNW2ziOJ8go2S2ey2oq8is/6CgemU264GDmJ244opIixnKukgiidFbBP8L44YBUg==
sidebar_class_name: "put api-method"
info_path: docs/developer-docs/api/reference/authentik
custom_edit_url: null
hide_send_button: true
---
import ApiTabs from "@theme/ApiTabs";
import DiscriminatorTabs from "@theme/DiscriminatorTabs";
import MethodEndpoint from "@theme/ApiExplorer/MethodEndpoint";
import SecuritySchemes from "@theme/ApiExplorer/SecuritySchemes";
import MimeTabs from "@theme/MimeTabs";
import ParamsItem from "@theme/ParamsItem";
import ResponseSamples from "@theme/ResponseSamples";
import SchemaItem from "@theme/SchemaItem";
import SchemaTabs from "@theme/SchemaTabs";
import Heading from "@theme/Heading";
import OperationTabs from "@theme/OperationTabs";
import TabItem from "@theme/TabItem";
<Heading
as={"h1"}
className={"openapi__heading"}
children={"admin_settings_update"}
>
</Heading>
<MethodEndpoint
method={"put"}
path={"/admin/settings/"}
>
</MethodEndpoint>
Settings view
<Heading
id={"request"}
as={"h2"}
className={"openapi-tabs__heading"}
children={"Request"}
>
</Heading>
<MimeTabs
className={"openapi-tabs__mime"}
>
<TabItem
label={"application/json"}
value={"application/json-schema"}
>
<details
style={{}}
className={"openapi-markdown__details mime"}
data-collapsed={false}
open={true}
>
<summary
style={{}}
className={"openapi-markdown__details-summary-mime"}
>
<h3
className={"openapi-markdown__details-summary-header-body"}
>
Body
</h3>
</summary><div
style={{"textAlign":"left","marginLeft":"1rem"}}
>
</div><ul
style={{"marginLeft":"1rem"}}
>
<SchemaItem
collapsible={false}
name={"avatars"}
required={false}
schemaName={"string"}
qualifierMessage={"**Possible values:** `non-empty`"}
schema={{"type":"string","minLength":1,"description":"Configure how authentik should show avatars for users."}}
>
</SchemaItem><SchemaItem
collapsible={false}
name={"default_user_change_name"}
required={false}
schemaName={"boolean"}
qualifierMessage={undefined}
schema={{"type":"boolean","description":"Enable the ability for users to change their name."}}
>
</SchemaItem><SchemaItem
collapsible={false}
name={"default_user_change_email"}
required={false}
schemaName={"boolean"}
qualifierMessage={undefined}
schema={{"type":"boolean","description":"Enable the ability for users to change their email address."}}
>
</SchemaItem><SchemaItem
collapsible={false}
name={"default_user_change_username"}
required={false}
schemaName={"boolean"}
qualifierMessage={undefined}
schema={{"type":"boolean","description":"Enable the ability for users to change their username."}}
>
</SchemaItem><SchemaItem
collapsible={false}
name={"event_retention"}
required={false}
schemaName={"string"}
qualifierMessage={"**Possible values:** `non-empty`"}
schema={{"type":"string","minLength":1,"description":"Events will be deleted after this duration.(Format: weeks=3;days=2;hours=3,seconds=2)."}}
>
</SchemaItem><SchemaItem
collapsible={false}
name={"footer_links"}
required={false}
schemaName={""}
qualifierMessage={undefined}
schema={{"description":"The option configures the footer links on the flow executor pages."}}
>
</SchemaItem><SchemaItem
collapsible={false}
name={"gdpr_compliance"}
required={false}
schemaName={"boolean"}
qualifierMessage={undefined}
schema={{"type":"boolean","description":"When enabled, all the events caused by a user will be deleted upon the user's deletion."}}
>
</SchemaItem><SchemaItem
collapsible={false}
name={"impersonation"}
required={false}
schemaName={"boolean"}
qualifierMessage={undefined}
schema={{"type":"boolean","description":"Globally enable/disable impersonation."}}
>
</SchemaItem><SchemaItem
collapsible={false}
name={"default_token_duration"}
required={false}
schemaName={"string"}
qualifierMessage={"**Possible values:** `non-empty`"}
schema={{"type":"string","minLength":1,"description":"Default token duration"}}
>
</SchemaItem><SchemaItem
collapsible={false}
name={"default_token_length"}
required={false}
schemaName={"integer"}
qualifierMessage={"**Possible values:** `>= 1` and `<= 2147483647`"}
schema={{"type":"integer","maximum":2147483647,"minimum":1,"description":"Default token length"}}
>
</SchemaItem>
</ul>
</details>
</TabItem>
</MimeTabs><div>
<div>
<ApiTabs
label={undefined}
id={undefined}
>
<TabItem
label={"200"}
value={"200"}
>
<div>
</div><div>
<MimeTabs
className={"openapi-tabs__mime"}
schemaType={"response"}
>
<TabItem
label={"application/json"}
value={"application/json"}
>
<SchemaTabs
className={"openapi-tabs__schema"}
>
<TabItem
label={"Schema"}
value={"Schema"}
>
<details
style={{}}
className={"openapi-markdown__details response"}
data-collapsed={false}
open={true}
>
<summary
style={{}}
className={"openapi-markdown__details-summary-response"}
>
<strong>
Schema
</strong>
</summary><div
style={{"textAlign":"left","marginLeft":"1rem"}}
>
</div><ul
style={{"marginLeft":"1rem"}}
>
<SchemaItem
collapsible={false}
name={"avatars"}
required={false}
schemaName={"string"}
qualifierMessage={undefined}
schema={{"type":"string","description":"Configure how authentik should show avatars for users."}}
>
</SchemaItem><SchemaItem
collapsible={false}
name={"default_user_change_name"}
required={false}
schemaName={"boolean"}
qualifierMessage={undefined}
schema={{"type":"boolean","description":"Enable the ability for users to change their name."}}
>
</SchemaItem><SchemaItem
collapsible={false}
name={"default_user_change_email"}
required={false}
schemaName={"boolean"}
qualifierMessage={undefined}
schema={{"type":"boolean","description":"Enable the ability for users to change their email address."}}
>
</SchemaItem><SchemaItem
collapsible={false}
name={"default_user_change_username"}
required={false}
schemaName={"boolean"}
qualifierMessage={undefined}
schema={{"type":"boolean","description":"Enable the ability for users to change their username."}}
>
</SchemaItem><SchemaItem
collapsible={false}
name={"event_retention"}
required={false}
schemaName={"string"}
qualifierMessage={undefined}
schema={{"type":"string","description":"Events will be deleted after this duration.(Format: weeks=3;days=2;hours=3,seconds=2)."}}
>
</SchemaItem><SchemaItem
collapsible={false}
name={"footer_links"}
required={false}
schemaName={""}
qualifierMessage={undefined}
schema={{"description":"The option configures the footer links on the flow executor pages."}}
>
</SchemaItem><SchemaItem
collapsible={false}
name={"gdpr_compliance"}
required={false}
schemaName={"boolean"}
qualifierMessage={undefined}
schema={{"type":"boolean","description":"When enabled, all the events caused by a user will be deleted upon the user's deletion."}}
>
</SchemaItem><SchemaItem
collapsible={false}
name={"impersonation"}
required={false}
schemaName={"boolean"}
qualifierMessage={undefined}
schema={{"type":"boolean","description":"Globally enable/disable impersonation."}}
>
</SchemaItem><SchemaItem
collapsible={false}
name={"default_token_duration"}
required={false}
schemaName={"string"}
qualifierMessage={undefined}
schema={{"type":"string","description":"Default token duration"}}
>
</SchemaItem><SchemaItem
collapsible={false}
name={"default_token_length"}
required={false}
schemaName={"integer"}
qualifierMessage={"**Possible values:** `>= 1` and `<= 2147483647`"}
schema={{"type":"integer","maximum":2147483647,"minimum":1,"description":"Default token length"}}
>
</SchemaItem>
</ul>
</details>
</TabItem><TabItem
label={"Example (from schema)"}
value={"Example (from schema)"}
>
<ResponseSamples
responseExample={"{\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 \"default_token_duration\": \"string\",\n \"default_token_length\": 0\n}"}
language={"json"}
>
</ResponseSamples>
</TabItem>
</SchemaTabs>
</TabItem>
</MimeTabs>
</div>
</TabItem><TabItem
label={"400"}
value={"400"}
>
<div>
</div><div>
<MimeTabs
className={"openapi-tabs__mime"}
schemaType={"response"}
>
<TabItem
label={"application/json"}
value={"application/json"}
>
<SchemaTabs
className={"openapi-tabs__schema"}
>
<TabItem
label={"Schema"}
value={"Schema"}
>
<details
style={{}}
className={"openapi-markdown__details response"}
data-collapsed={false}
open={true}
>
<summary
style={{}}
className={"openapi-markdown__details-summary-response"}
>
<strong>
Schema
</strong>
</summary><div
style={{"textAlign":"left","marginLeft":"1rem"}}
>
</div><ul
style={{"marginLeft":"1rem"}}
>
<SchemaItem
collapsible={false}
name={"non_field_errors"}
required={false}
schemaName={"string[]"}
qualifierMessage={undefined}
schema={{"type":"array","items":{"type":"string"}}}
>
</SchemaItem><SchemaItem
collapsible={false}
name={"code"}
required={false}
schemaName={"string"}
qualifierMessage={undefined}
schema={{"type":"string"}}
>
</SchemaItem><SchemaItem
name={"property name*"}
required={false}
schemaName={"any"}
qualifierMessage={undefined}
schema={{"type":"object","description":"Validation Error","properties":{"non_field_errors":{"type":"array","items":{"type":"string"}},"code":{"type":"string"}},"additionalProperties":{},"title":"ValidationError"}}
collapsible={false}
discriminator={false}
>
</SchemaItem>
</ul>
</details>
</TabItem><TabItem
label={"Example (from schema)"}
value={"Example (from schema)"}
>
<ResponseSamples
responseExample={"{\n \"non_field_errors\": [\n \"string\"\n ],\n \"code\": \"string\"\n}"}
language={"json"}
>
</ResponseSamples>
</TabItem>
</SchemaTabs>
</TabItem>
</MimeTabs>
</div>
</TabItem><TabItem
label={"403"}
value={"403"}
>
<div>
</div><div>
<MimeTabs
className={"openapi-tabs__mime"}
schemaType={"response"}
>
<TabItem
label={"application/json"}
value={"application/json"}
>
<SchemaTabs
className={"openapi-tabs__schema"}
>
<TabItem
label={"Schema"}
value={"Schema"}
>
<details
style={{}}
className={"openapi-markdown__details response"}
data-collapsed={false}
open={true}
>
<summary
style={{}}
className={"openapi-markdown__details-summary-response"}
>
<strong>
Schema
</strong>
</summary><div
style={{"textAlign":"left","marginLeft":"1rem"}}
>
</div><ul
style={{"marginLeft":"1rem"}}
>
<SchemaItem
collapsible={false}
name={"detail"}
required={true}
schemaName={"string"}
qualifierMessage={undefined}
schema={{"type":"string"}}
>
</SchemaItem><SchemaItem
collapsible={false}
name={"code"}
required={false}
schemaName={"string"}
qualifierMessage={undefined}
schema={{"type":"string"}}
>
</SchemaItem>
</ul>
</details>
</TabItem><TabItem
label={"Example (from schema)"}
value={"Example (from schema)"}
>
<ResponseSamples
responseExample={"{\n \"detail\": \"string\",\n \"code\": \"string\"\n}"}
language={"json"}
>
</ResponseSamples>
</TabItem>
</SchemaTabs>
</TabItem>
</MimeTabs>
</div>
</TabItem>
</ApiTabs>
</div>
</div>