Files
authentik/website/docs/developer-docs/api/reference/core-groups-remove-user-create.api.mdx
Tana M Berry 7a6d44d0df first pass
2024-10-22 15:10:13 -05:00

334 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: eJytVd9v2jAQ/lciP20SI4j2YeJpXYcqpHWr2rKXCiEnORKXJPZshxVF+d93ZycQFNrtoS9gx+f78d13n2smFWhuhSwXCZuxWGpYp1pWyqw1FHIH68qAXscauAU2YgmYWAtFF9D8KkkCOg+sDNwttFBc8wIsaMNmTzUTZKe4zfCoxAPcOct1VYkEv5k4g4KzWc3sXtGpsVqUKZ5spC64xS/OshnEDpbLxbfAmwcigdKKzZ7WNhMmuKEgY3Sj4XclNGB1VlfQrEbM8pRyc8WylbcAY7/KZE95xLK06IyWXKlcxA6e8NlQ2HqYsIyeIbZDbOJYVqUNeJJgUqFDk7I7AG4ILE1bK8CQQ7XtuRWYRQqaNU2/hicyohqEzclqiei3ke59GXihGVSNOENcaWH3rim8shnhhfGeVo2DwCjMyKcxnVzS32k5FIhqAdeKy8nkHaH6xXORuKvBXGupB8CUslxvBOTJGujc9FxyrfkeLwgLhRnSiLCIZQLnT6g3FJbnd/14zRHfY2o+MwfuafYej4t3xOMGStAiDq7uFq8AkoDlIj9T1FvV9lnUOugxqQ36jzJfY0YpbbBBFiYuEs5/JklPlDTWaQLO/4yFNHGhl5ewPspAE/a0JiRRAL3rBKTSOV3lSoS7i5ARWzsuPxCeHpAeow+lZ9aqTmFoHwHX7UBRR+6PYz9/4YXKoZvBCVqIciOdrxaeY4ARo9x87dPJ9HL8eTwdtPCWb2nYu1ueCIERFIZUiZjCY8cUpAS1kmWQ5/JLKg+RxkIS6EgjwNF0c+AF9HbxiC48MFSkmYVhKmxWReNYFmHPRXhcRbmMQgxVht8X1/MfD3MHBDWo4GXPOfXIi7kJfFu8xJ9/AnqcP/satK2w8GJDlWN0qshlXresaHV45J8FEsXZyQPRowbuiLEZkQrv1XXEDSx13jT0GbupSd5wueNa8Ij6hgRKhKE10nHDcwNvFPDhvp2Qj8H/vi5n6+ukqSRh2vG8oh0ut7A/ff6aFVpnwBOsjVL1Btc+oU+P5OboYKAozai7gS8AKPum7ao3lXc/H4hAUfvgFU4xmOZ/CG78dclK5R8pNHDfapbzMq14Srbep5PQipp4mLl2xkbdgqo6Cwc2z1k8yi2U2MAOHUt7AqZp/gIyz/rR
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={"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>