Files
authentik/website/docs/developer-docs/api/reference/core-groups-remove-user-create.api.mdx
2024-09-13 12:17:54 -05:00

335 lines
10 KiB
Plaintext

---
id: core-groups-remove-user-create
title: "core_groups_remove_user_create"
description: "Add user to group"
sidebar_label: "core_groups_remove_user_create"
hide_title: true
hide_table_of_contents: true
api: eJytVU1v2zAM/SuGThuQRVnbw5DTui4oAqxb0Ta7FEEg24yt1rY0Sc4WGP7vIyU7cZC026GXRLIofjw+PjVMaTDCSVXNUzZliTKwyoyqtV0ZKNUGVrUFs0oMCAdsxFKwiZGaLqD5ZZpGdB45FflbaKGFESU4MJZNHxsmyU4Ll+NRhQe485arupYpfrNJDqVg04a5raZT64ysMjxZK1MKh1+8ZXsUO1os5l+jYB7JFCon11tau1za6JqCjNGNgV+1NIDVOVNDuxwxJzLKzRfLlsECrPui0i3lkajKoTNaCq0LmXh4+JOlsM1xwip+gsQdY5Mkqq5cJNIUk+IeTcpuB7glsAxtnQRLDvXzwK3ELDIwrG2HNTySEdUgXUFWC0S/i3QXysAL7VHViDMktZFu65siapcTXhjvcdl6CKzGjEIaZ5ML+jsshwJRLeBbcTGZvCFUP0UhU381mhmjzBEwlapWawlFugI6twOXwhixxQvSQWmPaURYJCqF0yfUGworitthvHaP7z61kJkH9zD7gMf5G+JxDRUYmUSXt/MXAEnBCVmcKOq1aocs6hwMmNQF/UeZLzGjUi5aIwtTHwnnP1ekJ1pZ5zUB53/KOE0cD/LCm70MtHygNZxEAcymF5DaFHRVaMk355wRW3su3xOeAZABo3el587pXmFoH4Mw3UBRR+72Yz/7I0pdQD+DE7SQ1Vp5Xx08+wAjRrmF2s8mZxfjT+OPRy28Ec807P2tQITISgpDqkRMEYlnClKCWslyKAr1OVO7SGOpCHSkEeBo+jkIAnozf0AXARgq0k45z6TL63icqJIPXPD9Ki5UzDFUxb/Nr2bf72ceCGpQKaqBc+pREHMbhbYEiT/9BAw4f/I16Frh4I/jusDoVJHPvOlY0enwKDwLJIrTgwdiQA3cEWNzIhXea5pYWFiYom3pM3bTkLzhciOMFDH1DQmUSktrpONaFBZeKeDdXTch76P/fV1O1tdLU0XCtBFFTTtcPsP28Plrl2idg0ixNko1GFyFhD48kJu9gyNFaUf9DXwBQLtXbZeDqbz9cU8EirsHr/SKwYz4TXDjr09W6fBIoYH/1rBCVFktMrINPr2E1tTE3cx1MzbqF1TVSTiwed7iQT1DhQ3s0XG0J2Da9i8vefrQ
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={"core_groups_remove_user_create"}
>
</Heading>
<MethodEndpoint
method={"post"}
path={"/core/groups/{group_uuid}/remove_user/"}
>
</MethodEndpoint>
Add user to group
<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":"group_uuid","schema":{"type":"string","format":"uuid"},"description":"A UUID string identifying this Group.","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={"pk"}
required={true}
schemaName={"integer"}
qualifierMessage={undefined}
schema={{"type":"integer"}}
>
</SchemaItem>
</ul>
</details>
</TabItem>
</MimeTabs><div>
<div>
<ApiTabs
label={undefined}
id={undefined}
>
<TabItem
label={"204"}
value={"204"}
>
<div>
User added
</div><div>
</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><TabItem
label={"404"}
value={"404"}
>
<div>
User not found
</div><div>
</div>
</TabItem>
</ApiTabs>
</div>
</div>