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

335 lines
10 KiB
Plaintext

---
id: core-groups-add-user-create
title: "core_groups_add_user_create"
description: "Add user to group"
sidebar_label: "core_groups_add_user_create"
hide_title: true
hide_table_of_contents: true
api: eJytVU1v2zAM/SuGThuQRVnbw5DTui4oAqxb0Ta7FEEg24yt1rY0Sc4WGP7vIyU7cZC026GXRLIofjw+PjVMaTDCSVXNUzZliTKwyoyqtV2JNF3VFswqMSAcsBFLwSZGarJG28s0jeg8ciryV9BCCyNKcGAsmz42TJKdFi7HowoPcOctV3UtU/xmkxxKwaYNc1tNp9YZWWV4slamFA6/eMv2KHa0WMy/RsE8kilUTq63tHa5tNE1BRmjGwO/amkAS3OmhnY5Yk5klJuvlC2DBVj3RaVbyiNRlUNntBRaFzLx2PAnS2Gb44RV/ASJO8YmSVRduQgxxKS4gVJtKLsd2pbAMrR1Eiw51M8DtxKzyMCwth3W8EhGVIN0BVktEP0u0l0oAy+0R1UjzpDURrqtb4qoXU54YbzHZeshsBozCmmcTS7o77AcCkS1gG/FxWTyhlD9FIVM/dVoZowyR8BUqlqtJRTpCujcDlwKY8QWL0gHpT2mEWGRqBROn1BvKKwobofx2j2++9RCZh7cw+wDHudviMc1VGBkEl3ezl8AJAUnZHGiqNeqHbKoczBgUhf0H2W+xIxKuWiNLEx9JJz/XJGYaGWd1wSc/ynjNHE8aAtv9jLQ8l5oOCkCmE2vHrUp6J7Qkm/OOSOq9kS+JzADGgM67+rOndO9vNA+BmG6aaJ23O1nfvZHlLqAfgAnaCGrtfK+Omz2AUaMcguFn03OLsafxh+P+ncjnmnS+1uBBZGVFIYkiWgiEk8T5AP1keVQFOpzpnaRxlIR4sghwLn0QxDU82b+gC4CMFSknXKeSZfX8ThRJR+44PtVXKiYY6iKf5tfzb7fzzwQ1J1SVAPn1KCg5JaGPYj7afEfsP3kO9D1wcEfx3WBoakcn3bT8aFT4FF4EEgOpwdPQ08KXBJRc+ISXmqaWFhYmKJt6TP20ZCq4XIjjBQxdQypk0pLa2ThWhQWXsn+3V03GO+j/31UThbXK1JFerQRRU07XD7D9vDVa5donYNIsTZKNRhchYQ+PJCbvYMjIWlH/Q0UftDuVdvlYBhvf9wTdeLunSu9UDAjftMrib8+WaXD24QG/lvDClFltcjINvj0yllTB3fT1k3XqF9QVSfhwOZ5iwf1DBU2sEfH0Z6Aadu/TMv1PA==
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_add_user_create"}
>
</Heading>
<MethodEndpoint
method={"post"}
path={"/core/groups/{group_uuid}/add_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>