mirror of
https://github.com/goauthentik/authentik
synced 2026-04-26 09:35:07 +02:00
first pass
This commit is contained in:
Tana M Berry
@@ -0,0 +1,520 @@
|
||||
---
|
||||
id: sources-scim-groups-create
|
||||
title: "sources_scim_groups_create"
|
||||
description: "SCIMSourceGroup Viewset"
|
||||
sidebar_label: "sources_scim_groups_create"
|
||||
hide_title: true
|
||||
hide_table_of_contents: true
|
||||
api: eJzNVk1v2zgQ/SsEL3uRrcRO3K5P280GgYFmE9RpL0VgUNLYZk2JWpJK6hr67ztDypYcOx8L5LAXQ5Yeh2/evOFww3UJRjipi0nGx9zqyqRgZzaV+WxhdFXaWWpAOOARz8CmRpYERuj0YnI99fArwrFvEh4tOMQ5sbB8/H0bjN9H3MA/FVj3p87WfLzhqS4cFI4eRVkqmXoG8Q9LkTfcpkvIBT25dQm4l05+QOpepTAFI4WSv8AgtDSUmpNIAAPJrBPOOiOLBWJyWXyGYuGWfHxaR9wnfAw31yYXSJdXFQZCZEjtTVDh8FNSOc+jroMW0kBGEoUdI6K3C4pyOekUHCb4JajI6/0wzlRAnCCtjHQo8HeUtXJLVFiu8N997StgS13YoMbg5PT/U4b/JLxHzpCIJ63Uzdyn+wpBmWN2cwkZe8qQ4Q6ssmB+syz4/YBzuXqdGekrsptCrUM52hKGDbf0iyqf7cWTWIGFF2qf8hU4JhjCkWkqVMQQOBywyV+eMNaWba2zvzHtIfIjzsQPEvu6wsQo3Q4g0VqBKA4ofEWYZSLLUDancU/ZSMQepVIsAbaLZvsUvxSmcdNrYhWVUiIhfRrOYensOPVDcQ/W7zXZgRswB0lJCXXbrWz9tBv99rsi7bOKyAed1iR1fG156K4nRXjvA6L1/VsPi3BK7JeUtjs7OXnH3v+GbZT5pezSGH3Y8YUuZth5KpsBfe/WRxgj1pSPg9wecSySTXV2zMv18zVt9WipBWbP6jF8Rz2uoKCOZZ9uJ88IkoETUh1t0Oez7VqiCdCpfLPpC2niqxzcUtOML7V13tw09njcTOm4M/Jj8heYB6By4elaGUVIUcr4YRh7w2+HzZR0CYl1Rs4uhaVz5F6vnj9rAFvKeD6k7Jf2WnD5U+AhDdsh0fZLMxv4cC4+ns9HZ73zD6cfemfno0EvGc7T3iD9fTScj0ZiLkZtX7wZf9B9sphrn0EjbptWxEmRIOngZHDW/9gfHBjgWqyQN9uuCjZiliYQ9HnkfSZS7zM0FBmBL0Ep/cdC73bqS012QBMCTmzfRf5g5NeTOwwRykHS2nEcL6RbVkk/1XncCRG3T4nSSYxbFfHnycXl39NLLz+5IBdFJ3hjBEZGaGYhO37363TLS9fAYAEHP11cKtyfcvLcN4352isiWWRnP/xH7l6STxGz2STCwlej6ppeo2MM3XHw8UHgGPdjAO84uAAPYZps6NgVIIRfBJa9O2JCcFX5ij7t7zrarviUplC6F7H3nVa6vZlSQZLmWpv7/uVGPNLMwl9svQhv2LTat4h/t+FKFItKLAgbYvoDrSJJ2qkcOiXaPnRuOaJYdxiiPB5xp1dQoERRk4qj/0gXg/8LB9cYkg==
|
||||
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={"sources_scim_groups_create"}
|
||||
>
|
||||
</Heading>
|
||||
|
||||
<MethodEndpoint
|
||||
method={"post"}
|
||||
path={"/sources/scim_groups/"}
|
||||
>
|
||||
|
||||
</MethodEndpoint>
|
||||
|
||||
|
||||
|
||||
SCIMSourceGroup Viewset
|
||||
|
||||
<Heading
|
||||
id={"request"}
|
||||
as={"h2"}
|
||||
className={"openapi-tabs__heading"}
|
||||
children={"Request"}
|
||||
>
|
||||
</Heading>
|
||||
|
||||
<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={"id"}
|
||||
required={true}
|
||||
schemaName={"string"}
|
||||
qualifierMessage={"**Possible values:** `non-empty`"}
|
||||
schema={{"type":"string","minLength":1}}
|
||||
>
|
||||
|
||||
</SchemaItem><SchemaItem
|
||||
collapsible={false}
|
||||
name={"group"}
|
||||
required={true}
|
||||
schemaName={"uuid"}
|
||||
qualifierMessage={undefined}
|
||||
schema={{"type":"string","format":"uuid"}}
|
||||
>
|
||||
|
||||
</SchemaItem><SchemaItem
|
||||
collapsible={false}
|
||||
name={"source"}
|
||||
required={true}
|
||||
schemaName={"uuid"}
|
||||
qualifierMessage={undefined}
|
||||
schema={{"type":"string","format":"uuid"}}
|
||||
>
|
||||
|
||||
</SchemaItem><SchemaItem
|
||||
collapsible={false}
|
||||
name={"attributes"}
|
||||
required={false}
|
||||
schemaName={""}
|
||||
qualifierMessage={undefined}
|
||||
schema={{}}
|
||||
>
|
||||
|
||||
</SchemaItem>
|
||||
</ul>
|
||||
</details>
|
||||
</TabItem>
|
||||
</MimeTabs><div>
|
||||
<div>
|
||||
<ApiTabs
|
||||
label={undefined}
|
||||
id={undefined}
|
||||
>
|
||||
<TabItem
|
||||
label={"201"}
|
||||
value={"201"}
|
||||
>
|
||||
<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={"id"}
|
||||
required={true}
|
||||
schemaName={"string"}
|
||||
qualifierMessage={undefined}
|
||||
schema={{"type":"string"}}
|
||||
>
|
||||
|
||||
</SchemaItem><SchemaItem
|
||||
collapsible={false}
|
||||
name={"group"}
|
||||
required={true}
|
||||
schemaName={"uuid"}
|
||||
qualifierMessage={undefined}
|
||||
schema={{"type":"string","format":"uuid"}}
|
||||
>
|
||||
|
||||
</SchemaItem><SchemaItem
|
||||
collapsible={true}
|
||||
className={"schemaItem"}
|
||||
>
|
||||
<details
|
||||
style={{}}
|
||||
className={"openapi-markdown__details"}
|
||||
>
|
||||
<summary
|
||||
style={{}}
|
||||
>
|
||||
<span
|
||||
className={"openapi-schema__container"}
|
||||
>
|
||||
<strong
|
||||
className={"openapi-schema__property"}
|
||||
>
|
||||
group_obj
|
||||
</strong><span
|
||||
className={"openapi-schema__name"}
|
||||
>
|
||||
object
|
||||
</span><span
|
||||
className={"openapi-schema__divider"}
|
||||
>
|
||||
|
||||
</span><span
|
||||
className={"openapi-schema__required"}
|
||||
>
|
||||
required
|
||||
</span>
|
||||
</span>
|
||||
</summary><div
|
||||
style={{"marginLeft":"1rem"}}
|
||||
>
|
||||
<div
|
||||
style={{"marginTop":".5rem","marginBottom":".5rem"}}
|
||||
>
|
||||
|
||||
|
||||
Simplified Group Serializer for user's groups
|
||||
|
||||
|
||||
</div><SchemaItem
|
||||
collapsible={false}
|
||||
name={"pk"}
|
||||
required={true}
|
||||
schemaName={"uuid"}
|
||||
qualifierMessage={undefined}
|
||||
schema={{"type":"string","format":"uuid","readOnly":true,"title":"Group uuid"}}
|
||||
>
|
||||
|
||||
</SchemaItem><SchemaItem
|
||||
collapsible={false}
|
||||
name={"num_pk"}
|
||||
required={true}
|
||||
schemaName={"integer"}
|
||||
qualifierMessage={undefined}
|
||||
schema={{"type":"integer","description":"Get a numerical, int32 ID for the group","readOnly":true}}
|
||||
>
|
||||
|
||||
</SchemaItem><SchemaItem
|
||||
collapsible={false}
|
||||
name={"name"}
|
||||
required={true}
|
||||
schemaName={"string"}
|
||||
qualifierMessage={undefined}
|
||||
schema={{"type":"string"}}
|
||||
>
|
||||
|
||||
</SchemaItem><SchemaItem
|
||||
collapsible={false}
|
||||
name={"is_superuser"}
|
||||
required={false}
|
||||
schemaName={"boolean"}
|
||||
qualifierMessage={undefined}
|
||||
schema={{"type":"boolean","description":"Users added to this group will be superusers."}}
|
||||
>
|
||||
|
||||
</SchemaItem><SchemaItem
|
||||
collapsible={false}
|
||||
name={"parent"}
|
||||
required={false}
|
||||
schemaName={"uuid"}
|
||||
qualifierMessage={undefined}
|
||||
schema={{"type":"string","format":"uuid","nullable":true}}
|
||||
>
|
||||
|
||||
</SchemaItem><SchemaItem
|
||||
collapsible={false}
|
||||
name={"parent_name"}
|
||||
required={true}
|
||||
schemaName={"string"}
|
||||
qualifierMessage={undefined}
|
||||
schema={{"type":"string","readOnly":true,"nullable":true}}
|
||||
>
|
||||
|
||||
</SchemaItem><SchemaItem
|
||||
collapsible={false}
|
||||
name={"attributes"}
|
||||
required={false}
|
||||
schemaName={"object"}
|
||||
qualifierMessage={undefined}
|
||||
schema={{"type":"object"}}
|
||||
>
|
||||
|
||||
</SchemaItem>
|
||||
</div>
|
||||
</details>
|
||||
</SchemaItem><SchemaItem
|
||||
collapsible={false}
|
||||
name={"source"}
|
||||
required={true}
|
||||
schemaName={"uuid"}
|
||||
qualifierMessage={undefined}
|
||||
schema={{"type":"string","format":"uuid"}}
|
||||
>
|
||||
|
||||
</SchemaItem><SchemaItem
|
||||
collapsible={false}
|
||||
name={"attributes"}
|
||||
required={false}
|
||||
schemaName={""}
|
||||
qualifierMessage={undefined}
|
||||
schema={{}}
|
||||
>
|
||||
|
||||
</SchemaItem>
|
||||
</ul>
|
||||
</details>
|
||||
</TabItem><TabItem
|
||||
label={"Example (from schema)"}
|
||||
value={"Example (from schema)"}
|
||||
>
|
||||
<ResponseSamples
|
||||
responseExample={"{\n \"id\": \"string\",\n \"group\": \"3fa85f64-5717-4562-b3fc-2c963f66afa6\",\n \"group_obj\": {\n \"pk\": \"3fa85f64-5717-4562-b3fc-2c963f66afa6\",\n \"num_pk\": 0,\n \"name\": \"string\",\n \"is_superuser\": true,\n \"parent\": \"3fa85f64-5717-4562-b3fc-2c963f66afa6\",\n \"parent_name\": \"string\",\n \"attributes\": {}\n },\n \"source\": \"3fa85f64-5717-4562-b3fc-2c963f66afa6\",\n \"attributes\": {}\n}"}
|
||||
language={"json"}
|
||||
>
|
||||
|
||||
</ResponseSamples>
|
||||
</TabItem>
|
||||
</SchemaTabs>
|
||||
</TabItem>
|
||||
</MimeTabs>
|
||||
</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>
|
||||
</ApiTabs>
|
||||
</div>
|
||||
</div>
|
||||
|
||||
Reference in New Issue
Block a user