mirror of
https://github.com/goauthentik/authentik
synced 2026-04-26 17:45:21 +02:00
first pass
This commit is contained in:
Tana M Berry
@@ -0,0 +1,941 @@
|
||||
---
|
||||
id: sources-scim-update
|
||||
title: "sources_scim_update"
|
||||
description: "SCIMSource Viewset"
|
||||
sidebar_label: "sources_scim_update"
|
||||
hide_title: true
|
||||
hide_table_of_contents: true
|
||||
api: eJztWW1v2zYQ/iuEMGAbZltp3trm07I2KAw0bZCXAluQCbRE21woUiOpOK7h/747UrJkWXKcLd2nfmgqW+S9PPfw7nheBCpjmlqu5DAJTgKjch0zE5mYp1GeJdSyoBckzMSaZ7gK1ly9G55fuXXkC2czwywsyaimKbNMm+DkdhFwXJhRO4VXEl6gaJFP4JOJpyylwckisPPMfW81l5MNLUMJwiQVxJtEUEqP5IYlhEtyc/nRDIJlL9Ds75xrBrZbnbPlXS+wdII2lK4Ed34RM/Y3lcxRcaxAtrT4SLNM8Nj5H/5lUPFi00I1+ovFdhsOV0xzKvhXphEKjZhaDrpBhvd+09uUy49MTgChk1cbkp3UHw1JuMkEnZNPIMS560B8prRdkAQJ9LGUcLSH8bS4C7b/edun/a+n/T/2+m+ju19+QDOYpCOBoK8sGSklGJX4EiTrqABhHqUAMdhoamup1nQOKrllqWnzZqx0SiE+QZ7zJFiCzIlWefbSQr2hQNII9gDO9slALdcYd+uDW0QFqcetYGvMuPTMA3WbXIV9LM41t3N3ZGhup8BKfg+f7paOtSZT0nga7e/t/e/Uze6fxhHNpMlnKebeqwqEi1FKPNS9zkPwX2n/neg7CY1VCkwqeLMdww/MEk8astoFeBI7pZbMGLmXakam8M8qwhJu4QUjK5atcwE0PzA9UoZFuxHgktlcy0Ic8GBt9xPSo0zkmornK/H7ntQFxY1GqUqYeJ4zvCSl20s6xVNJJ2tEW4mVuRDIwuYBO/dbyGhOqtzRtOKzc9P4+FHNSNqya0Cup8yUcTRuXQwmWlhHZUJ8I5DgBgXUgqwjxBw3cUPGgk6IAlfA0wTzESuVyRWR4HEE0gHiGaQ7SGCoPeUT33iYAfld5W6VsVw4pPh4XmMWMIFT9/n0Ytgjo9wS9pg50VMqJ6hRNTXAiacEc7ouzB+0wb5LCcDMrZSNcr0Du/D8XMJqTDdtCq26ZzICt1wKF+Lz2CX/7en6Gjd9u0ztxZe5+jsTvz0TAWaeoMNjDtFsazqqIrV/dPRUleKrpoDJPMXGBNSDbN8dgDiacRf/GO2auy+gyFBjZkonrnNp6C8jO3SSz1BqcVpq1qLaCXxTnqNnsvoG9uxM6lJXN4uH70tDOlvuCtRXR3s7tyVoZ60pkWVTwk1EY8sfWEt3UJl16pc0hb5nhk+k4+hsyoBQGlgFJEb7iZmqXCTII1tyH46CEzQgN9ASCmScW8+lsQAIUWMC5YVZcABWxiqX1l+QBDU2EmrC5dYUgbzsW+6K0/ox956aHCLTiH/l7Eaac23MS7RCpmTVE3K6Gl0OWR1PWUI+oLga3whodHBDbAtzXzateoWrFjhPow5Gb1YQSmA5WArprYcdxME+Gb53BmPqcda2od7O510CuMl4IFySAGxWeaI5pWSGWRF4uZLmSQa3/47usgnWBrf81s6eqgnuxn5IjJpDHmatbAAfODpFxUU9ssuOi1wRpHWresiD2u0O0XGx9fOHJ+yD+xhv7RtWyPgVlfwz/IzowwXQNGvBIbr8QC1tLRuticsv7xHGXZqhZGptFuIfg10KUfgdnH8Kn4ZttPqXEEMy5q1txIYCNyhq463/oiprZTMNQtjj6hHcfOAxi4q8F/RW66Lmqy2lDtG6hnerYtdh/fbj3yRWEau1bNY4j72gopnHrFbGCjsa9Av8fKAB41r0W9CETgXM2p59t9YBJwA3tFyHG37X2pvSsbJFuGt0nm3ONKRVF9iqP928kq0DuerZe+Xoseq9GxfT9ptk60DHT3LWzxlie/ii85kvUKISt5Wcaa1apopKRgCuSCKG759Raf08IGmrE8vuw1xBUZnmLevE4+AF8fjAJFZDbLo7AEmAC215dqu3dYoVAmpBL5RucdOPBaYKJ+dZ7sfgmMmCsBg+hzhHDxfIv2VYZKpyRO6uk0EIrXn4cBC6Q1DOA68QFu9XbSq48gBTdzlJd2eQQbXSzhwE9rKadp89Uuh/WDWHrk68H6lVn1eTLl/HumZbt8HBmL45Gh8f9o9ev3rdPzw63u+PDsZxfz9+e3wwPj6mY3qMMHZOsnYX0XY7r3c1cqwcLEXA6ndPhNmHaX9v/3DwZrC/Qapzeu+65WKXpyYx2DG6YQFyF5puV398EQ+mTAj160RV91WuXJMNNQba8hrO58NrzHkuxq7UnoThBApwPhpAMgtrIsLqaSTUKARVMvw4fHf26erMxTRTxkLSqwfRs4sgu0j7rzS1o9f+g03BJQt1NARouZ9o+hGHZ3H1Ewpyjafw30mRSTE4UzALFy0WI2rYjRbLJX4N3NM40IbHBwq9tqsfQHe4PhUEG1Nh2BZzf7osjuXPpMvOMtVJTHQPVOT4CR7v2Twofmla3sG6KVQV7HhBv3/1zmvpY6Gvbd3ITcteueM0jllmt669q6WBixuM+6j4pSl1qSfQdIYFCf46K5Vz2h1v990CLmlykkNVg/depMvF+VpXVJzyXvlQu2Cv4wABcStccYWglLDYotiC8H8AhpStRg==
|
||||
sidebar_class_name: "put 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_update"}
|
||||
>
|
||||
</Heading>
|
||||
|
||||
<MethodEndpoint
|
||||
method={"put"}
|
||||
path={"/sources/scim/{slug}/"}
|
||||
>
|
||||
|
||||
</MethodEndpoint>
|
||||
|
||||
|
||||
|
||||
SCIMSource Viewset
|
||||
|
||||
<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":"slug","schema":{"type":"string","description":"Internal source name, used in URLs."},"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={"name"}
|
||||
required={true}
|
||||
schemaName={"string"}
|
||||
qualifierMessage={"**Possible values:** `non-empty`"}
|
||||
schema={{"type":"string","minLength":1,"description":"Source's display Name."}}
|
||||
>
|
||||
|
||||
</SchemaItem><SchemaItem
|
||||
collapsible={false}
|
||||
name={"slug"}
|
||||
required={true}
|
||||
schemaName={"string"}
|
||||
qualifierMessage={"**Possible values:** `non-empty` and `<= 50 characters`, Value must match regular expression `^[-a-zA-Z0-9_]+$`"}
|
||||
schema={{"type":"string","minLength":1,"description":"Internal source name, used in URLs.","maxLength":50,"pattern":"^[-a-zA-Z0-9_]+$"}}
|
||||
>
|
||||
|
||||
</SchemaItem><SchemaItem
|
||||
collapsible={false}
|
||||
name={"enabled"}
|
||||
required={false}
|
||||
schemaName={"boolean"}
|
||||
qualifierMessage={undefined}
|
||||
schema={{"type":"boolean"}}
|
||||
>
|
||||
|
||||
</SchemaItem><SchemaItem
|
||||
collapsible={false}
|
||||
name={"user_property_mappings"}
|
||||
required={false}
|
||||
schemaName={"uuid[]"}
|
||||
qualifierMessage={undefined}
|
||||
schema={{"type":"array","items":{"type":"string","format":"uuid"}}}
|
||||
>
|
||||
|
||||
</SchemaItem><SchemaItem
|
||||
collapsible={false}
|
||||
name={"group_property_mappings"}
|
||||
required={false}
|
||||
schemaName={"uuid[]"}
|
||||
qualifierMessage={undefined}
|
||||
schema={{"type":"array","items":{"type":"string","format":"uuid"}}}
|
||||
>
|
||||
|
||||
</SchemaItem><SchemaItem
|
||||
collapsible={false}
|
||||
name={"user_path_template"}
|
||||
required={false}
|
||||
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={"200"}
|
||||
value={"200"}
|
||||
>
|
||||
<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={"pk"}
|
||||
required={true}
|
||||
schemaName={"uuid"}
|
||||
qualifierMessage={undefined}
|
||||
schema={{"type":"string","format":"uuid","readOnly":true,"title":"Pbm uuid"}}
|
||||
>
|
||||
|
||||
</SchemaItem><SchemaItem
|
||||
collapsible={false}
|
||||
name={"name"}
|
||||
required={true}
|
||||
schemaName={"string"}
|
||||
qualifierMessage={undefined}
|
||||
schema={{"type":"string","description":"Source's display Name."}}
|
||||
>
|
||||
|
||||
</SchemaItem><SchemaItem
|
||||
collapsible={false}
|
||||
name={"slug"}
|
||||
required={true}
|
||||
schemaName={"string"}
|
||||
qualifierMessage={"**Possible values:** `<= 50 characters`, Value must match regular expression `^[-a-zA-Z0-9_]+$`"}
|
||||
schema={{"type":"string","description":"Internal source name, used in URLs.","maxLength":50,"pattern":"^[-a-zA-Z0-9_]+$"}}
|
||||
>
|
||||
|
||||
</SchemaItem><SchemaItem
|
||||
collapsible={false}
|
||||
name={"enabled"}
|
||||
required={false}
|
||||
schemaName={"boolean"}
|
||||
qualifierMessage={undefined}
|
||||
schema={{"type":"boolean"}}
|
||||
>
|
||||
|
||||
</SchemaItem><SchemaItem
|
||||
collapsible={false}
|
||||
name={"user_property_mappings"}
|
||||
required={false}
|
||||
schemaName={"uuid[]"}
|
||||
qualifierMessage={undefined}
|
||||
schema={{"type":"array","items":{"type":"string","format":"uuid"}}}
|
||||
>
|
||||
|
||||
</SchemaItem><SchemaItem
|
||||
collapsible={false}
|
||||
name={"group_property_mappings"}
|
||||
required={false}
|
||||
schemaName={"uuid[]"}
|
||||
qualifierMessage={undefined}
|
||||
schema={{"type":"array","items":{"type":"string","format":"uuid"}}}
|
||||
>
|
||||
|
||||
</SchemaItem><SchemaItem
|
||||
collapsible={false}
|
||||
name={"component"}
|
||||
required={true}
|
||||
schemaName={"string"}
|
||||
qualifierMessage={undefined}
|
||||
schema={{"type":"string","description":"Get object component so that we know how to edit the object","readOnly":true}}
|
||||
>
|
||||
|
||||
</SchemaItem><SchemaItem
|
||||
collapsible={false}
|
||||
name={"verbose_name"}
|
||||
required={true}
|
||||
schemaName={"string"}
|
||||
qualifierMessage={undefined}
|
||||
schema={{"type":"string","description":"Return object's verbose_name","readOnly":true}}
|
||||
>
|
||||
|
||||
</SchemaItem><SchemaItem
|
||||
collapsible={false}
|
||||
name={"verbose_name_plural"}
|
||||
required={true}
|
||||
schemaName={"string"}
|
||||
qualifierMessage={undefined}
|
||||
schema={{"type":"string","description":"Return object's plural verbose_name","readOnly":true}}
|
||||
>
|
||||
|
||||
</SchemaItem><SchemaItem
|
||||
collapsible={false}
|
||||
name={"meta_model_name"}
|
||||
required={true}
|
||||
schemaName={"string"}
|
||||
qualifierMessage={undefined}
|
||||
schema={{"type":"string","description":"Return internal model name","readOnly":true}}
|
||||
>
|
||||
|
||||
</SchemaItem><SchemaItem
|
||||
collapsible={false}
|
||||
name={"managed"}
|
||||
required={true}
|
||||
schemaName={"Managed by authentik (string)"}
|
||||
qualifierMessage={undefined}
|
||||
schema={{"type":"string","nullable":true,"title":"Managed by authentik","description":"Objects that are managed by authentik. These objects are created and updated automatically. This flag only indicates that an object can be overwritten by migrations. You can still modify the objects via the API, but expect changes to be overwritten in a later update.","readOnly":true}}
|
||||
>
|
||||
|
||||
</SchemaItem><SchemaItem
|
||||
collapsible={false}
|
||||
name={"user_path_template"}
|
||||
required={false}
|
||||
schemaName={"string"}
|
||||
qualifierMessage={undefined}
|
||||
schema={{"type":"string"}}
|
||||
>
|
||||
|
||||
</SchemaItem><SchemaItem
|
||||
collapsible={false}
|
||||
name={"root_url"}
|
||||
required={true}
|
||||
schemaName={"string"}
|
||||
qualifierMessage={undefined}
|
||||
schema={{"type":"string","description":"Get Root URL","readOnly":true}}
|
||||
>
|
||||
|
||||
</SchemaItem><SchemaItem
|
||||
collapsible={true}
|
||||
className={"schemaItem"}
|
||||
>
|
||||
<details
|
||||
style={{}}
|
||||
className={"openapi-markdown__details"}
|
||||
>
|
||||
<summary
|
||||
style={{}}
|
||||
>
|
||||
<span
|
||||
className={"openapi-schema__container"}
|
||||
>
|
||||
<strong
|
||||
className={"openapi-schema__property"}
|
||||
>
|
||||
token_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"}}
|
||||
>
|
||||
|
||||
|
||||
Token Serializer
|
||||
|
||||
|
||||
</div><SchemaItem
|
||||
collapsible={false}
|
||||
name={"pk"}
|
||||
required={true}
|
||||
schemaName={"uuid"}
|
||||
qualifierMessage={undefined}
|
||||
schema={{"type":"string","format":"uuid","readOnly":true,"title":"Token uuid"}}
|
||||
>
|
||||
|
||||
</SchemaItem><SchemaItem
|
||||
collapsible={false}
|
||||
name={"managed"}
|
||||
required={false}
|
||||
schemaName={"Managed by authentik (string)"}
|
||||
qualifierMessage={undefined}
|
||||
schema={{"type":"string","nullable":true,"title":"Managed by authentik","description":"Objects that are managed by authentik. These objects are created and updated automatically. This flag only indicates that an object can be overwritten by migrations. You can still modify the objects via the API, but expect changes to be overwritten in a later update."}}
|
||||
>
|
||||
|
||||
</SchemaItem><SchemaItem
|
||||
collapsible={false}
|
||||
name={"identifier"}
|
||||
required={true}
|
||||
schemaName={"string"}
|
||||
qualifierMessage={"**Possible values:** `<= 255 characters`, Value must match regular expression `^[-a-zA-Z0-9_]+$`"}
|
||||
schema={{"type":"string","maxLength":255,"pattern":"^[-a-zA-Z0-9_]+$"}}
|
||||
>
|
||||
|
||||
</SchemaItem><SchemaItem
|
||||
collapsible={false}
|
||||
name={"intent"}
|
||||
required={false}
|
||||
schemaName={"IntentEnum (string)"}
|
||||
qualifierMessage={"**Possible values:** [`verification`, `api`, `recovery`, `app_password`]"}
|
||||
schema={{"enum":["verification","api","recovery","app_password"],"type":"string","title":"IntentEnum"}}
|
||||
>
|
||||
|
||||
</SchemaItem><SchemaItem
|
||||
collapsible={false}
|
||||
name={"user"}
|
||||
required={false}
|
||||
schemaName={"integer"}
|
||||
qualifierMessage={undefined}
|
||||
schema={{"type":"integer"}}
|
||||
>
|
||||
|
||||
</SchemaItem><SchemaItem
|
||||
collapsible={true}
|
||||
className={"schemaItem"}
|
||||
>
|
||||
<details
|
||||
style={{}}
|
||||
className={"openapi-markdown__details"}
|
||||
>
|
||||
<summary
|
||||
style={{}}
|
||||
>
|
||||
<span
|
||||
className={"openapi-schema__container"}
|
||||
>
|
||||
<strong
|
||||
className={"openapi-schema__property"}
|
||||
>
|
||||
user_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"}}
|
||||
>
|
||||
|
||||
|
||||
User Serializer
|
||||
|
||||
|
||||
</div><SchemaItem
|
||||
collapsible={false}
|
||||
name={"pk"}
|
||||
required={true}
|
||||
schemaName={"ID (integer)"}
|
||||
qualifierMessage={undefined}
|
||||
schema={{"type":"integer","readOnly":true,"title":"ID"}}
|
||||
>
|
||||
|
||||
</SchemaItem><SchemaItem
|
||||
collapsible={false}
|
||||
name={"username"}
|
||||
required={true}
|
||||
schemaName={"string"}
|
||||
qualifierMessage={"**Possible values:** `<= 150 characters`"}
|
||||
schema={{"type":"string","maxLength":150}}
|
||||
>
|
||||
|
||||
</SchemaItem><SchemaItem
|
||||
collapsible={false}
|
||||
name={"name"}
|
||||
required={true}
|
||||
schemaName={"string"}
|
||||
qualifierMessage={undefined}
|
||||
schema={{"type":"string","description":"User's display name."}}
|
||||
>
|
||||
|
||||
</SchemaItem><SchemaItem
|
||||
collapsible={false}
|
||||
name={"is_active"}
|
||||
required={false}
|
||||
schemaName={"Active (boolean)"}
|
||||
qualifierMessage={undefined}
|
||||
schema={{"type":"boolean","title":"Active","description":"Designates whether this user should be treated as active. Unselect this instead of deleting accounts."}}
|
||||
>
|
||||
|
||||
</SchemaItem><SchemaItem
|
||||
collapsible={false}
|
||||
name={"last_login"}
|
||||
required={false}
|
||||
schemaName={"date-time"}
|
||||
qualifierMessage={undefined}
|
||||
schema={{"type":"string","format":"date-time","nullable":true}}
|
||||
>
|
||||
|
||||
</SchemaItem><SchemaItem
|
||||
collapsible={false}
|
||||
name={"is_superuser"}
|
||||
required={true}
|
||||
schemaName={"boolean"}
|
||||
qualifierMessage={undefined}
|
||||
schema={{"type":"boolean","readOnly":true}}
|
||||
>
|
||||
|
||||
</SchemaItem><SchemaItem
|
||||
collapsible={false}
|
||||
name={"groups"}
|
||||
required={false}
|
||||
schemaName={"uuid[]"}
|
||||
qualifierMessage={undefined}
|
||||
schema={{"type":"array","items":{"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"}
|
||||
>
|
||||
groups_obj
|
||||
</strong><span
|
||||
className={"openapi-schema__name"}
|
||||
>
|
||||
object[]
|
||||
</span><span
|
||||
className={"openapi-schema__divider"}
|
||||
>
|
||||
|
||||
</span><span
|
||||
className={"openapi-schema__nullable"}
|
||||
>
|
||||
nullable
|
||||
</span><span
|
||||
className={"openapi-schema__required"}
|
||||
>
|
||||
required
|
||||
</span>
|
||||
</span>
|
||||
</summary><div
|
||||
style={{"marginLeft":"1rem"}}
|
||||
>
|
||||
<li>
|
||||
<div
|
||||
style={{"fontSize":"var(--ifm-code-font-size)","opacity":"0.6","marginLeft":"-.5rem","paddingBottom":".5rem"}}
|
||||
>
|
||||
Array [
|
||||
</div>
|
||||
</li><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><li>
|
||||
<div
|
||||
style={{"fontSize":"var(--ifm-code-font-size)","opacity":"0.6","marginLeft":"-.5rem"}}
|
||||
>
|
||||
]
|
||||
</div>
|
||||
</li>
|
||||
</div>
|
||||
</details>
|
||||
</SchemaItem><SchemaItem
|
||||
collapsible={false}
|
||||
name={"email"}
|
||||
required={false}
|
||||
schemaName={"email"}
|
||||
qualifierMessage={"**Possible values:** `<= 254 characters`"}
|
||||
schema={{"type":"string","format":"email","title":"Email address","maxLength":254}}
|
||||
>
|
||||
|
||||
</SchemaItem><SchemaItem
|
||||
collapsible={false}
|
||||
name={"avatar"}
|
||||
required={true}
|
||||
schemaName={"string"}
|
||||
qualifierMessage={undefined}
|
||||
schema={{"type":"string","description":"User's avatar, either a http/https URL or a data URI","readOnly":true}}
|
||||
>
|
||||
|
||||
</SchemaItem><SchemaItem
|
||||
collapsible={false}
|
||||
name={"attributes"}
|
||||
required={false}
|
||||
schemaName={"object"}
|
||||
qualifierMessage={undefined}
|
||||
schema={{"type":"object"}}
|
||||
>
|
||||
|
||||
</SchemaItem><SchemaItem
|
||||
collapsible={false}
|
||||
name={"uid"}
|
||||
required={true}
|
||||
schemaName={"string"}
|
||||
qualifierMessage={undefined}
|
||||
schema={{"type":"string","readOnly":true}}
|
||||
>
|
||||
|
||||
</SchemaItem><SchemaItem
|
||||
collapsible={false}
|
||||
name={"path"}
|
||||
required={false}
|
||||
schemaName={"string"}
|
||||
qualifierMessage={undefined}
|
||||
schema={{"type":"string"}}
|
||||
>
|
||||
|
||||
</SchemaItem><SchemaItem
|
||||
collapsible={false}
|
||||
name={"type"}
|
||||
required={false}
|
||||
schemaName={"UserTypeEnum (string)"}
|
||||
qualifierMessage={"**Possible values:** [`internal`, `external`, `service_account`, `internal_service_account`]"}
|
||||
schema={{"enum":["internal","external","service_account","internal_service_account"],"type":"string","title":"UserTypeEnum"}}
|
||||
>
|
||||
|
||||
</SchemaItem><SchemaItem
|
||||
collapsible={false}
|
||||
name={"uuid"}
|
||||
required={true}
|
||||
schemaName={"uuid"}
|
||||
qualifierMessage={undefined}
|
||||
schema={{"type":"string","format":"uuid","readOnly":true}}
|
||||
>
|
||||
|
||||
</SchemaItem>
|
||||
</div>
|
||||
</details>
|
||||
</SchemaItem><SchemaItem
|
||||
collapsible={false}
|
||||
name={"description"}
|
||||
required={false}
|
||||
schemaName={"string"}
|
||||
qualifierMessage={undefined}
|
||||
schema={{"type":"string"}}
|
||||
>
|
||||
|
||||
</SchemaItem><SchemaItem
|
||||
collapsible={false}
|
||||
name={"expires"}
|
||||
required={false}
|
||||
schemaName={"date-time"}
|
||||
qualifierMessage={undefined}
|
||||
schema={{"type":"string","format":"date-time","nullable":true}}
|
||||
>
|
||||
|
||||
</SchemaItem><SchemaItem
|
||||
collapsible={false}
|
||||
name={"expiring"}
|
||||
required={false}
|
||||
schemaName={"boolean"}
|
||||
qualifierMessage={undefined}
|
||||
schema={{"type":"boolean"}}
|
||||
>
|
||||
|
||||
</SchemaItem>
|
||||
</div>
|
||||
</details>
|
||||
</SchemaItem>
|
||||
</ul>
|
||||
</details>
|
||||
</TabItem><TabItem
|
||||
label={"Example (from schema)"}
|
||||
value={"Example (from schema)"}
|
||||
>
|
||||
<ResponseSamples
|
||||
responseExample={"{\n \"pk\": \"3fa85f64-5717-4562-b3fc-2c963f66afa6\",\n \"name\": \"string\",\n \"slug\": \"string\",\n \"enabled\": true,\n \"user_property_mappings\": [\n \"3fa85f64-5717-4562-b3fc-2c963f66afa6\"\n ],\n \"group_property_mappings\": [\n \"3fa85f64-5717-4562-b3fc-2c963f66afa6\"\n ],\n \"component\": \"string\",\n \"verbose_name\": \"string\",\n \"verbose_name_plural\": \"string\",\n \"meta_model_name\": \"string\",\n \"managed\": \"string\",\n \"user_path_template\": \"string\",\n \"root_url\": \"string\",\n \"token_obj\": {\n \"pk\": \"3fa85f64-5717-4562-b3fc-2c963f66afa6\",\n \"managed\": \"string\",\n \"identifier\": \"string\",\n \"intent\": \"verification\",\n \"user\": 0,\n \"user_obj\": {\n \"pk\": 0,\n \"username\": \"string\",\n \"name\": \"string\",\n \"is_active\": true,\n \"last_login\": \"2024-07-29T15:51:28.071Z\",\n \"is_superuser\": true,\n \"groups\": [\n \"3fa85f64-5717-4562-b3fc-2c963f66afa6\"\n ],\n \"groups_obj\": [\n {\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 ],\n \"email\": \"user@example.com\",\n \"avatar\": \"string\",\n \"attributes\": {},\n \"uid\": \"string\",\n \"path\": \"string\",\n \"type\": \"internal\",\n \"uuid\": \"3fa85f64-5717-4562-b3fc-2c963f66afa6\"\n },\n \"description\": \"string\",\n \"expires\": \"2024-07-29T15:51:28.071Z\",\n \"expiring\": true\n }\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