255 lines
7.4 KiB
Plaintext
255 lines
7.4 KiB
Plaintext
---
|
|
id: tenants-tenants-create-admin-group-create
|
|
title: "tenants_tenants_create_admin_group_create"
|
|
description: "Create admin group and add user to it."
|
|
sidebar_label: "tenants_tenants_create_admin_group_create"
|
|
hide_title: true
|
|
hide_table_of_contents: true
|
|
api: eJytVcFu2zAM/RVBpw3I4iztYchpaRcUAdqtaJtTEQSyzdhqbcmT5K6Z4X8fKduJUwdFD8shliWKfHx8pCuuCzDCSa2WMZ9xB0ooZzfdMzIgHGxEnEu1SYwui3aLj3gMNjKyoLt489JvM2/JvCUTKsb3mJUWDHOaSTfGa4UwIgcHxvLZY8UlXS6ES/FI4cEexKYsZYybNkohF3xWcbcr6Ng6I1WCJ1ttcuFwx1vWbxHN2Wq1/MEacyZjUE5ud7R2qbTswUchRAZ+l9IA5u9MCfV6xJ1ICF1HB183RmDdhY53hCXSCg8dLUVRZDLyHAZPlkJXQ9A6fILIDVhrQByx5vnFU9ZGZMieFJn8C4bYM1QwJ8GSc2L2FDPo7RpUgqTOvtZ1P8PH5g7lKF0GewhzQnBFAO6asO2D18f3PUO0YQutbINiOjmnx3FmV4dkIGa2jCKwdltm2W5MpTqfTIZ3LkTcZd3YnP1Hqq9AIZERm98u2cIYPWQzBidkNuQToUQ6hhMHb6htHfTIbYM28TyVx6CaNE/Qt6KeUdqxrS5V7CNh06SamrTQ1vlGovryoBXp/ln1+qcOhh0cUFOBeek6sDQZuRGFDF7OAk76txCVRrrdPXHbkCNKl1IHPfdoSJ0rug6l9xCEAePBUnXuDi2zeBV5kcFBsz1updpq77Tl7BBpxAlkQ8h0Mj0ffxtPB3W9Ec/U092tRh3MSopH3U3yEZGXD+qE6stTyDL9PdH7SGOpCQlqC1DUZNqOopvlA7poGKJs7SwIEunSMhxHOg96LoLDKsx0GGAoFVwvLxc/7xeeEapaLlTPeVsw1j2j4Qg9PWx7PfHxudvWzMGrC4oM0VHGPrOqldJh3o16q9nxOB7qCTdJ8impEn1UVSgsrExW17SNEjA4MR9x+SJwkIVUY1RdLC2tUc9bkVl4J8NPd22LfWYfHuknk203hdqRskRW0hsun2H35qtTr9E8BRGTVBFsY3HZQPryQH4OHgZDqR51N+Y49Qr3ru2619i3v+5JbmH7jcn90OFG/KGPFP57tNpT5HvS71U8EyopRUK2jU/6/QMLFbp0
|
|
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 Heading from "@theme/Heading";
|
|
import OperationTabs from "@theme/OperationTabs";
|
|
import TabItem from "@theme/TabItem";
|
|
|
|
<Heading
|
|
as={"h1"}
|
|
className={"openapi__heading"}
|
|
children={"tenants_tenants_create_admin_group_create"}
|
|
>
|
|
</Heading>
|
|
|
|
<MethodEndpoint
|
|
method={"post"}
|
|
path={"/tenants/tenants/{tenant_uuid}/create_admin_group/"}
|
|
>
|
|
|
|
</MethodEndpoint>
|
|
|
|
|
|
|
|
Create admin group and add user to it.
|
|
|
|
<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>
|
|
</ul>
|
|
</details>
|
|
</TabItem>
|
|
</MimeTabs><div>
|
|
<div>
|
|
<ApiTabs
|
|
label={undefined}
|
|
id={undefined}
|
|
>
|
|
<TabItem
|
|
label={"204"}
|
|
value={"204"}
|
|
>
|
|
<div>
|
|
|
|
|
|
Group created successfully.
|
|
|
|
|
|
</div><div>
|
|
|
|
</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>
|
|
|