757 lines
30 KiB
Plaintext
757 lines
30 KiB
Plaintext
---
|
|
id: core-users-create
|
|
title: "core_users_create"
|
|
description: "User Viewset"
|
|
sidebar_label: "core_users_create"
|
|
hide_title: true
|
|
hide_table_of_contents: true
|
|
api: eJztWEtv2zgQ/isEL3uRLb/b+tRsYwQG0m2RRw8bBAYt0TYbitSSVBLX8H/fGVK25WfTILt72Yuhx3A4880331BeUJ1zw5zQapjSPk204aPCcmNHieHMcRrRlNvEiBxtwOIWXpJvgj9Z7uClY1NL+3d+Ib2PqOF/Fdy633U6p/0FPFaOK4eXLM+lSPxW8XeLvhbUJjOeMbxy85yDdz3+zhN3eNNrbgST4gc38D43GLgT3OJqjFixjFc8WWeEmoJlJtQlV1M3o/0m3LHn9V23sYzosWX7AfxmSSpsLtmc4KI6hdXCjljixGPVxVhryZlCcIST+OQsmOw6PedWTBWAbMnTjLsZ5OhmwhLMhtiZLmRKxpw4X4iUMEvCXnVyqyyXAFSwF8o6zlKiJySFxw4SAMtEF8pZH6Vk1o2kngp1KNOJNhmDEtEUtqk5kWGkqpCSjTF6ZwoOPqZGF7mtrGfGsDlYCscze9JvUYiULsEH1FrIk6bBYoPcAO8JS1PDraVb5Wt1O+CSOfAxLhy3h1gECwWCzeTXKl8wlpyhk9N0AbPwekG5KjLkuQA+A9UwRv68voSCPYqEj0rUEZXSbrT76j7a23KVLJLsBt4NcC+MEZtJGJ7ixp6n0Ybp99vrrkLfwbKtdWXxLE8KIxy05B00YgFUU048wN390veszTUwykPYajT/xcbNHyo+ELOpNwLGp1+UnIcENpkOz5HOJ7v9//5+XX9DpraAymBwB5PdrskbKULwMQL2vMDPEY5diwwIOhEA4QW6q/CNwI4ebqhtGe5JBh6J9Dghw4YhHQQ1Gx1h9HbIF9wRRsAcIk2YjKDErt0iw3MfMDAlRHsI9cN8fkkB9xlvUVkBNqcD0fym5ElIibxcewsky5kpBeFnYO1xKywdHWvFXXD31r9S5A8raFmk7agi5MGOpPra0uUL4vsn5tojc8y8WLiCeUS48DLDyMy5PMYfS26vLonGZ9D/DO6Gh2j16jmKJf9pTY/O2/90wkaBsL/c/rvEKmu1pWY7/RjRDc0CZpUxVsaxQ78wyrerjTF3Go03HNDfQChTv5QMjNH7E1ppNQJtlemI4/tf0HsMP9HpIbVaHqfUBoRNaCGyo3i03xCPC65Qk8nZ1+ERQFLuDnb7yWyrdCkdVMpdbnoiTXiUwQlC4zdarq2jq4aiMX55xV6m47JPOFYJDnqFkWjAchE/tmOKR73VQfAa4Qj5VI6D68hRONCZt8IhwkErjQ8DAb3afOQNnhlMX779EbZppN37ynkqaGn16AJnz1an1vhQa7Zvmp1+o9vvtOqNRvdPujls3NH2hL3vTnqdWvdd812t0+21auP2JKm1kg+99qTXYxPWQ3BLUfZhfeQhzHqiM7ojdmttqsjFZnp7+cHpqibaA1SWbINaRBHwUChMoP6+3tyj1Wf24E9t5apATmKFD4pGnr0AjNfBMu4Zl1J/nOr1TnWh/WEPtA6Oh743A7qfhzeoIb7aXvL7cTyFQVCMMd+44iLeXI2lHsewlYovh58Gf1wPfHWRWxlTFedIL3+EsuTwPwKV1tv7cyDg6EDHYzhXQ42XZZyLEvPyj4MghjgIsXIzJDi8WizGzPJbI5dLfAycM/gFA5ePDE54fgLDFwwsAHnGQw9w/oGDCf0UIqqh1mOBmCx80XaFYRmtVpwlCc/dSdv7Sg9+/XKNmI/Lvzky3/jUsCccFvALPRtR7RHyTeafLYDtalqwKdoGn14Ji63JWPZatLrArFaCq+aVCAEeb3GjH7gCiKIyFYf3EC44/xuU8ibv
|
|
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_users_create"}
|
|
>
|
|
</Heading>
|
|
|
|
<MethodEndpoint
|
|
method={"post"}
|
|
path={"/core/users/"}
|
|
>
|
|
|
|
</MethodEndpoint>
|
|
|
|
|
|
|
|
User 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={"username"}
|
|
required={true}
|
|
schemaName={"string"}
|
|
qualifierMessage={"**Possible values:** `non-empty` and `<= 150 characters`"}
|
|
schema={{"type":"string","minLength":1,"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={"groups"}
|
|
required={false}
|
|
schemaName={"uuid[]"}
|
|
qualifierMessage={undefined}
|
|
schema={{"type":"array","items":{"type":"string","format":"uuid"}}}
|
|
>
|
|
|
|
</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={true}
|
|
className={"schemaItem"}
|
|
>
|
|
<details
|
|
style={{}}
|
|
className={"openapi-markdown__details"}
|
|
>
|
|
<summary
|
|
style={{}}
|
|
>
|
|
<span
|
|
className={"openapi-schema__container"}
|
|
>
|
|
<strong
|
|
className={"openapi-schema__property"}
|
|
>
|
|
attributes
|
|
</strong><span
|
|
className={"openapi-schema__name"}
|
|
>
|
|
object
|
|
</span>
|
|
</span>
|
|
</summary><div
|
|
style={{"marginLeft":"1rem"}}
|
|
>
|
|
<SchemaItem
|
|
name={"property name*"}
|
|
required={false}
|
|
schemaName={"any"}
|
|
qualifierMessage={undefined}
|
|
schema={{"type":"object","additionalProperties":{}}}
|
|
collapsible={false}
|
|
discriminator={false}
|
|
>
|
|
|
|
</SchemaItem>
|
|
</div>
|
|
</details>
|
|
</SchemaItem><SchemaItem
|
|
collapsible={false}
|
|
name={"path"}
|
|
required={false}
|
|
schemaName={"string"}
|
|
qualifierMessage={"**Possible values:** `non-empty`"}
|
|
schema={{"type":"string","minLength":1}}
|
|
>
|
|
|
|
</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>
|
|
</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={"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={true}
|
|
className={"schemaItem"}
|
|
>
|
|
<details
|
|
style={{}}
|
|
className={"openapi-markdown__details"}
|
|
>
|
|
<summary
|
|
style={{}}
|
|
>
|
|
<span
|
|
className={"openapi-schema__container"}
|
|
>
|
|
<strong
|
|
className={"openapi-schema__property"}
|
|
>
|
|
attributes
|
|
</strong><span
|
|
className={"openapi-schema__name"}
|
|
>
|
|
object
|
|
</span>
|
|
</span>
|
|
</summary><div
|
|
style={{"marginLeft":"1rem"}}
|
|
>
|
|
<SchemaItem
|
|
name={"property name*"}
|
|
required={false}
|
|
schemaName={"any"}
|
|
qualifierMessage={undefined}
|
|
schema={{"type":"object","additionalProperties":{}}}
|
|
collapsible={false}
|
|
discriminator={false}
|
|
>
|
|
|
|
</SchemaItem>
|
|
</div>
|
|
</details>
|
|
</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={true}
|
|
className={"schemaItem"}
|
|
>
|
|
<details
|
|
style={{}}
|
|
className={"openapi-markdown__details"}
|
|
>
|
|
<summary
|
|
style={{}}
|
|
>
|
|
<span
|
|
className={"openapi-schema__container"}
|
|
>
|
|
<strong
|
|
className={"openapi-schema__property"}
|
|
>
|
|
attributes
|
|
</strong><span
|
|
className={"openapi-schema__name"}
|
|
>
|
|
object
|
|
</span>
|
|
</span>
|
|
</summary><div
|
|
style={{"marginLeft":"1rem"}}
|
|
>
|
|
<SchemaItem
|
|
name={"property name*"}
|
|
required={false}
|
|
schemaName={"any"}
|
|
qualifierMessage={undefined}
|
|
schema={{"type":"object","additionalProperties":{}}}
|
|
collapsible={false}
|
|
discriminator={false}
|
|
>
|
|
|
|
</SchemaItem>
|
|
</div>
|
|
</details>
|
|
</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>
|
|
</ul>
|
|
</details>
|
|
</TabItem><TabItem
|
|
label={"Example (from schema)"}
|
|
value={"Example (from schema)"}
|
|
>
|
|
<ResponseSamples
|
|
responseExample={"{\n \"pk\": 0,\n \"username\": \"string\",\n \"name\": \"string\",\n \"is_active\": true,\n \"last_login\": \"2024-09-13T14:05:42.142Z\",\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}"}
|
|
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>
|
|
|