700 lines
30 KiB
Plaintext
700 lines
30 KiB
Plaintext
---
|
|
id: rac-endpoints-create
|
|
title: "rac_endpoints_create"
|
|
description: "Endpoint Viewset"
|
|
sidebar_label: "rac_endpoints_create"
|
|
hide_title: true
|
|
hide_table_of_contents: true
|
|
api: eJzVWG1v2zYQ/iuEvqwFbMuxXSdzMWBpmxYB+hIkbfchCwRKom3WFKmRVBLX8H/fHSlbsiM7DtC12IcEMkXe63PPHbUIVM40tVzJ8zQYBZomEZNprri0Jko0o5YFrSBlJtE8x22w6azcQL5ydmeYhQ2WTkwwusbzwU0r0Oyfghn7SqXzYLQIEiUtkxYfaZ4LnjiF4TeD4haBSaYso/hk5zkDBSr+xhK7W+8V05wK/p1p2JNrdMFyZlCCpBmrSTJWczmBXRmX75mc2GkwOlq6Q7c8hfPVVhDMJrDi31qVKIFvmSwy51mag5hbmcB/Y6bo5bYOy63AhYvy+BkeBXFTZewBNkEkLbxAN5Zrt+ZRBiErl1cSqNZ0DgK4ZZlpkjxWOqOgMygKngZLEEcLO40ylbK6T8ZCIhIfwyy3+3w6hfMf4PjKp4ze86zIIkithFxBgkxDLNf7glHvaHA8OOkPB8fOcb/YXq+eoJEIG65ZirZVBpcBbPnc1rJTS+NNZekKJZceg+D9hmSrC+aCnRSaW4Dn9cLpAnzyGfy6WTr8mhw88pDqdY9+Mojz2eNJRSNp+kmKufepBr84Iz7vrR3lcEgBuLcROOEcFuLT2IVqv3OXp68vyqMH+1dhZZdD52/2urLKnk9INBbq7pDwyUIIGqMCr23Tk7cghRSGpQTOkU0V5A5+EFgh1BiVcODIlNQwQbghNEmYwePxnFBJCtmuyYBlEK07K+uV5t+fZvwuY51lK5FwFKwEY1bp7AQ/nlgSYA4ly8LY3r5p5jtmiQcOWZ8iRoGN1JI7RmYS3JjCn1WEpdy6EK+RtokOjJwxfCJZGtVCHxlRTB635BwwpyUVG1lDgLV8GLkkXy7fm87Bane1nU21p9WJ3wxJuckFnZOPcHa/ppgms2RKgWnFr3J2lwn/ieO3TMfKsAOFXzJbaFkCBcRvnH5EepSLQlPxdCX+3KO6Mmap62Liac7wVc7cWbJL/ObIoAqbQ6eMcCQ7uKaXDWKrph6x+5zr+eN2v2FgMPR1ZlwFCwXcQwl0UINoE9RY0yFv2JgWAkhgTLokY1QaX/tY5+VW4/cCYVou3ItYKxgyNZJqIiDWaYc8e+toaASqCm3+aB+9BM2FZfDYewmdXckUHvvP0TkIH5gWWTVjMgKHAHylezWnYqUEmPPAq7+QTiGcyEiuS5AqNMSJNOSOC0FiRrwiYHYgNlJp6QQPJpudBLKP0w6txUNpo7Hz1On8IXjXE1gdaC3s5lsl21xjtRmtNicEft7aQuBPmcD/bzO3oIVMplGhG/lq/zzzquAChpTEFkAqXhCyPnmGJbaaDwi3hokxSRWUsVSWTOktdGAJuP9WGPu35DLlsBNlrG+Jzxt57xdcD2rhqe4Ksx0Xhq0Zt+H+4C8Om1HELAy63R94HfgKI3LqW/KZ1qrhQou1yZlII4bvnwBJP52lTUMzgjOFCQvUUnFR17esAlGZ5i3bGY/+D4zHOybh3pCQ04vzHQFJgZV4QwXs9bYOnVJALeWl0j1u+lY+VfiNJPdwyyle3INQ0yRcF0OI3MQ00J9x1yVXq0FIcx7e9kPHdaub5xVGxLtUu3+ujZ9ai3Tn4uZaFKMa2RIswZheVl9Yzu5plgtWff2oOKG65XXrnFpSqWfFavejZHgd9Mf05MV4OGi/OD46bg9eDHvtuD9O2r3k92F/PBzSMR1iZGvUVzFeIyl0QRWXY+VcL/NRxcN1EuOz0Ov2Bp2TTu8BZj7QGV51ti5phmNUOq6nSUt9vwcMInaCKRNC/TlRa00drhzF8gR6ej2WH84/gwifR8yJGYXhhNtpEXegV4Y1EWH1FAsVh6BKhu/PX599vDpzeUPgZFTWhAN2KiIlzZ/baqXV+OXNw8WyexvCVM0lulG2CA9R/1WuFawVwTPmyKf/OlgsYmrYFy2WS1wGXOHAdw2PtxSu8K6lXN9gFwWWRywBrmcMtgSvvWHtz2gDbheFS992/S9bqxOncC3O7d69N7VSu/h0hdGPy++IJaA0xUkF/0NpwjSSr/uLW1tAJ5CTgk5wr5e56sb1kc/XU2v1UPu4QeW8ZiGEx+34jOMehKhVuuLGPzAXhP8L1jtv/g==
|
|
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={"rac_endpoints_create"}
|
|
>
|
|
</Heading>
|
|
|
|
<MethodEndpoint
|
|
method={"post"}
|
|
path={"/rac/endpoints/"}
|
|
>
|
|
|
|
</MethodEndpoint>
|
|
|
|
|
|
|
|
Endpoint 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={"name"}
|
|
required={true}
|
|
schemaName={"string"}
|
|
qualifierMessage={"**Possible values:** `non-empty`"}
|
|
schema={{"type":"string","minLength":1}}
|
|
>
|
|
|
|
</SchemaItem><SchemaItem
|
|
collapsible={false}
|
|
name={"provider"}
|
|
required={true}
|
|
schemaName={"integer"}
|
|
qualifierMessage={undefined}
|
|
schema={{"type":"integer"}}
|
|
>
|
|
|
|
</SchemaItem><SchemaItem
|
|
collapsible={false}
|
|
name={"protocol"}
|
|
required={true}
|
|
schemaName={"ProtocolEnum (string)"}
|
|
qualifierMessage={"**Possible values:** [`rdp`, `vnc`, `ssh`]"}
|
|
schema={{"enum":["rdp","vnc","ssh"],"type":"string","title":"ProtocolEnum"}}
|
|
>
|
|
|
|
</SchemaItem><SchemaItem
|
|
collapsible={false}
|
|
name={"host"}
|
|
required={true}
|
|
schemaName={"string"}
|
|
qualifierMessage={"**Possible values:** `non-empty`"}
|
|
schema={{"type":"string","minLength":1}}
|
|
>
|
|
|
|
</SchemaItem><SchemaItem
|
|
collapsible={false}
|
|
name={"settings"}
|
|
required={false}
|
|
schemaName={""}
|
|
qualifierMessage={undefined}
|
|
schema={{}}
|
|
>
|
|
|
|
</SchemaItem><SchemaItem
|
|
collapsible={false}
|
|
name={"property_mappings"}
|
|
required={false}
|
|
schemaName={"uuid[]"}
|
|
qualifierMessage={undefined}
|
|
schema={{"type":"array","items":{"type":"string","format":"uuid"}}}
|
|
>
|
|
|
|
</SchemaItem><SchemaItem
|
|
collapsible={false}
|
|
name={"auth_mode"}
|
|
required={true}
|
|
schemaName={"AuthModeEnum (string)"}
|
|
qualifierMessage={"**Possible values:** [`static`, `prompt`]"}
|
|
schema={{"enum":["static","prompt"],"type":"string","title":"AuthModeEnum"}}
|
|
>
|
|
|
|
</SchemaItem><SchemaItem
|
|
collapsible={false}
|
|
name={"maximum_connections"}
|
|
required={false}
|
|
schemaName={"integer"}
|
|
qualifierMessage={"**Possible values:** `>= -2147483648` and `<= 2147483647`"}
|
|
schema={{"type":"integer","maximum":2147483647,"minimum":-2147483648}}
|
|
>
|
|
|
|
</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={"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"}}
|
|
>
|
|
|
|
</SchemaItem><SchemaItem
|
|
collapsible={false}
|
|
name={"provider"}
|
|
required={true}
|
|
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"}
|
|
>
|
|
provider_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"}}
|
|
>
|
|
|
|
|
|
RACProvider 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={"name"}
|
|
required={true}
|
|
schemaName={"string"}
|
|
qualifierMessage={undefined}
|
|
schema={{"type":"string"}}
|
|
>
|
|
|
|
</SchemaItem><SchemaItem
|
|
collapsible={false}
|
|
name={"authentication_flow"}
|
|
required={false}
|
|
schemaName={"uuid"}
|
|
qualifierMessage={undefined}
|
|
schema={{"type":"string","format":"uuid","nullable":true,"description":"Flow used for authentication when the associated application is accessed by an un-authenticated user."}}
|
|
>
|
|
|
|
</SchemaItem><SchemaItem
|
|
collapsible={false}
|
|
name={"authorization_flow"}
|
|
required={true}
|
|
schemaName={"uuid"}
|
|
qualifierMessage={undefined}
|
|
schema={{"type":"string","format":"uuid","description":"Flow used when authorizing this provider."}}
|
|
>
|
|
|
|
</SchemaItem><SchemaItem
|
|
collapsible={false}
|
|
name={"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={"assigned_application_slug"}
|
|
required={true}
|
|
schemaName={"string"}
|
|
qualifierMessage={undefined}
|
|
schema={{"type":"string","description":"Internal application name, used in URLs.","readOnly":true}}
|
|
>
|
|
|
|
</SchemaItem><SchemaItem
|
|
collapsible={false}
|
|
name={"assigned_application_name"}
|
|
required={true}
|
|
schemaName={"string"}
|
|
qualifierMessage={undefined}
|
|
schema={{"type":"string","description":"Application's display Name.","readOnly":true}}
|
|
>
|
|
|
|
</SchemaItem><SchemaItem
|
|
collapsible={false}
|
|
name={"assigned_backchannel_application_slug"}
|
|
required={true}
|
|
schemaName={"string"}
|
|
qualifierMessage={undefined}
|
|
schema={{"type":"string","description":"Internal application name, used in URLs.","readOnly":true}}
|
|
>
|
|
|
|
</SchemaItem><SchemaItem
|
|
collapsible={false}
|
|
name={"assigned_backchannel_application_name"}
|
|
required={true}
|
|
schemaName={"string"}
|
|
qualifierMessage={undefined}
|
|
schema={{"type":"string","description":"Application's display Name.","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={"settings"}
|
|
required={false}
|
|
schemaName={""}
|
|
qualifierMessage={undefined}
|
|
schema={{}}
|
|
>
|
|
|
|
</SchemaItem><SchemaItem
|
|
collapsible={false}
|
|
name={"outpost_set"}
|
|
required={true}
|
|
schemaName={"string[]"}
|
|
qualifierMessage={undefined}
|
|
schema={{"type":"array","readOnly":true,"items":{"type":"string"}}}
|
|
>
|
|
|
|
</SchemaItem><SchemaItem
|
|
collapsible={false}
|
|
name={"connection_expiry"}
|
|
required={false}
|
|
schemaName={"string"}
|
|
qualifierMessage={undefined}
|
|
schema={{"type":"string","description":"Determines how long a session lasts. Default of 0 means that the sessions lasts until the browser is closed. (Format: hours=-1;minutes=-2;seconds=-3)"}}
|
|
>
|
|
|
|
</SchemaItem><SchemaItem
|
|
collapsible={false}
|
|
name={"delete_token_on_disconnect"}
|
|
required={false}
|
|
schemaName={"boolean"}
|
|
qualifierMessage={undefined}
|
|
schema={{"type":"boolean","description":"When set to true, connection tokens will be deleted upon disconnect."}}
|
|
>
|
|
|
|
</SchemaItem>
|
|
</div>
|
|
</details>
|
|
</SchemaItem><SchemaItem
|
|
collapsible={false}
|
|
name={"protocol"}
|
|
required={true}
|
|
schemaName={"ProtocolEnum (string)"}
|
|
qualifierMessage={"**Possible values:** [`rdp`, `vnc`, `ssh`]"}
|
|
schema={{"enum":["rdp","vnc","ssh"],"type":"string","title":"ProtocolEnum"}}
|
|
>
|
|
|
|
</SchemaItem><SchemaItem
|
|
collapsible={false}
|
|
name={"host"}
|
|
required={true}
|
|
schemaName={"string"}
|
|
qualifierMessage={undefined}
|
|
schema={{"type":"string"}}
|
|
>
|
|
|
|
</SchemaItem><SchemaItem
|
|
collapsible={false}
|
|
name={"settings"}
|
|
required={false}
|
|
schemaName={""}
|
|
qualifierMessage={undefined}
|
|
schema={{}}
|
|
>
|
|
|
|
</SchemaItem><SchemaItem
|
|
collapsible={false}
|
|
name={"property_mappings"}
|
|
required={false}
|
|
schemaName={"uuid[]"}
|
|
qualifierMessage={undefined}
|
|
schema={{"type":"array","items":{"type":"string","format":"uuid"}}}
|
|
>
|
|
|
|
</SchemaItem><SchemaItem
|
|
collapsible={false}
|
|
name={"auth_mode"}
|
|
required={true}
|
|
schemaName={"AuthModeEnum (string)"}
|
|
qualifierMessage={"**Possible values:** [`static`, `prompt`]"}
|
|
schema={{"enum":["static","prompt"],"type":"string","title":"AuthModeEnum"}}
|
|
>
|
|
|
|
</SchemaItem><SchemaItem
|
|
collapsible={false}
|
|
name={"launch_url"}
|
|
required={true}
|
|
schemaName={"string"}
|
|
qualifierMessage={undefined}
|
|
schema={{"type":"string","nullable":true,"description":"Build actual launch URL (the provider itself does not have one, just\nindividual endpoints)","readOnly":true}}
|
|
>
|
|
|
|
</SchemaItem><SchemaItem
|
|
collapsible={false}
|
|
name={"maximum_connections"}
|
|
required={false}
|
|
schemaName={"integer"}
|
|
qualifierMessage={"**Possible values:** `>= -2147483648` and `<= 2147483647`"}
|
|
schema={{"type":"integer","maximum":2147483647,"minimum":-2147483648}}
|
|
>
|
|
|
|
</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 \"provider\": 0,\n \"provider_obj\": {\n \"pk\": 0,\n \"name\": \"string\",\n \"authentication_flow\": \"3fa85f64-5717-4562-b3fc-2c963f66afa6\",\n \"authorization_flow\": \"3fa85f64-5717-4562-b3fc-2c963f66afa6\",\n \"property_mappings\": [\n \"3fa85f64-5717-4562-b3fc-2c963f66afa6\"\n ],\n \"component\": \"string\",\n \"assigned_application_slug\": \"string\",\n \"assigned_application_name\": \"string\",\n \"assigned_backchannel_application_slug\": \"string\",\n \"assigned_backchannel_application_name\": \"string\",\n \"verbose_name\": \"string\",\n \"verbose_name_plural\": \"string\",\n \"meta_model_name\": \"string\",\n \"settings\": {},\n \"outpost_set\": [\n \"string\"\n ],\n \"connection_expiry\": \"string\",\n \"delete_token_on_disconnect\": true\n },\n \"protocol\": \"rdp\",\n \"host\": \"string\",\n \"settings\": {},\n \"property_mappings\": [\n \"3fa85f64-5717-4562-b3fc-2c963f66afa6\"\n ],\n \"auth_mode\": \"static\",\n \"launch_url\": \"string\",\n \"maximum_connections\": 0\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>
|
|
|