Files
authentik/website/docs/developer-docs/api/reference/tenants-tenants-create-recovery-key-create.api.mdx
2024-09-13 12:17:54 -05:00

334 lines
10 KiB
Plaintext

---
id: tenants-tenants-create-recovery-key-create
title: "tenants_tenants_create_recovery_key_create"
description: "Create recovery key for user."
sidebar_label: "tenants_tenants_create_recovery_key_create"
hide_title: true
hide_table_of_contents: true
api: eJy9VU1v2zAM/SuGThuQxunHYchpbRcMwdptSJtTEQSyzcRqbcmT5Kxe4P8+0pIT52PpDsN6qBWJIqnHx8c1UwVoboWS44QNmQXJpTXz9htr4BbmGmK1Al3NX6Dye6zHEjCxFgVdxqu3zXbQmgZoGiyUDkoDuo/WBdc8BwvasOHTmgm6U3Cb4pHEg03weVmKBDdNnELO2XDNbFXQsbFayCWeoNecW9xpLOv9RK6D6XT8KXDmgUhAWrGoaG1TYYLHJgplpOFHKTTgu60uoZ71mOVLyq6Fgc2cERh7o5KKcomVxENLS14UmYgb7MJnQ6HXh0mr6BliewCWS2IXrAZXPA58yACBEzwTv0ATfJoqZQUY8k6gHoMmF/IO5BJRHZ4TMKWr7TzhlenYC3zEEj3UdReFpz37ngtDuAibwSbtic/6C1QTl6r/oL/6AFbaMIWSxmV+MRj8Pxxd3FNAwmshdHWSZQnS+swKpCi+pdTZofE+jN6psz4Nn8vQAbf7NIp25cDaPbjhSUsRZ3P5DwH9DBLBioPr7+NgpLU6RCwBy8UxEHqYQwJvo+MddHDxQV28P0JxdQjFFCsbSGVRaEqZNJFQYlJFUlYoYxvZoWZgoW/pzXfdUZs6PKJzIWkQ6FUrWE3lWcgLEa4uQ0ZyYSAutbDVA4Hr0OGlTUlwXjo4pNYWraDR7wi49s1H5ZlsFWb0yvMig22Hb+m418oDvCzkQjVhPIzb2D1GaTuMLgYXV/0P/fODUt/zFxLF9pYjTGAEZUDySIziccMopA6VnKWQZerjUm0i9YWi4iDdgGiMpl7L78ePnv/u/WYYhkth0zLqxyoPOy7C7SrKVBRiKBnejW9HXx9GDUZUyJzLjnNfw6D9xkdGz/Ep1emTNweWr56FVxsWGWbV6X/Hqu2g6HVWw905doRauEv0T4mh6GS9jriBqc7qmraRDaRIT7hccRSuiIqLBEyEoTVye8EzAyde9m7i2+198NfD8Ohr/SaXlPKKZyX9wiW9YXde1zM0T4EnxFpM1lncupTOHsnP1sOBQNW99sZ1HENhT9rOOk3+/dsD8Szy0zlvBIhp/pPGO/5vslUNRE17NntrlnG5LPmSbJ1P+vsN7KQo/g==
sidebar_class_name: "post 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 Markdown from "@theme/Markdown";
import Heading from "@theme/Heading";
import OperationTabs from "@theme/OperationTabs";
import TabItem from "@theme/TabItem";
<Heading
as={"h1"}
className={"openapi__heading"}
children={"tenants_tenants_create_recovery_key_create"}
>
</Heading>
<MethodEndpoint
method={"post"}
path={"/tenants/tenants/{tenant_uuid}/create_recovery_key/"}
>
</MethodEndpoint>
Create recovery key for user.
<Heading
id={"request"}
as={"h2"}
className={"openapi-tabs__heading"}
children={"Request"}
>
</Heading>
<details
style={{"marginBottom":"1rem"}}
className={"openapi-markdown__details"}
data-collapsed={false}
open={true}
>
<summary
style={{}}
>
<h3
className={"openapi-markdown__details-summary-header-params"}
>
Path Parameters
</h3>
</summary><div>
<ul>
<ParamsItem
className={"paramsItem"}
param={{"in":"path","name":"tenant_uuid","schema":{"type":"string","format":"uuid"},"description":"A UUID string identifying this Tenant.","required":true}}
>
</ParamsItem>
</ul>
</div>
</details><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><strong
className={"openapi-schema__required"}
>
required
</strong>
</summary><div
style={{"textAlign":"left","marginLeft":"1rem"}}
>
</div><ul
style={{"marginLeft":"1rem"}}
>
<SchemaItem
collapsible={false}
name={"user"}
required={true}
schemaName={"string"}
qualifierMessage={"**Possible values:** `non-empty`"}
schema={{"type":"string","minLength":1}}
>
</SchemaItem><SchemaItem
collapsible={false}
name={"duration_days"}
required={true}
schemaName={"integer"}
qualifierMessage={undefined}
schema={{"type":"integer"}}
>
</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={"expiry"}
required={true}
schemaName={"date-time"}
qualifierMessage={undefined}
schema={{"type":"string","format":"date-time"}}
>
</SchemaItem><SchemaItem
collapsible={false}
name={"url"}
required={true}
schemaName={"string"}
qualifierMessage={undefined}
schema={{"type":"string"}}
>
</SchemaItem>
</ul>
</details>
</TabItem><TabItem
label={"Example (from schema)"}
value={"Example (from schema)"}
>
<ResponseSamples
responseExample={"{\n \"expiry\": \"2024-09-13T14:05:42.775Z\",\n \"url\": \"string\"\n}"}
language={"json"}
>
</ResponseSamples>
</TabItem>
</SchemaTabs>
</TabItem>
</MimeTabs>
</div>
</TabItem><TabItem
label={"400"}
value={"400"}
>
<div>
Bad request
</div><div>
</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><TabItem
label={"404"}
value={"404"}
>
<div>
User not found
</div><div>
</div>
</TabItem>
</ApiTabs>
</div>
</div>