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,674 @@
|
||||
---
|
||||
id: providers-google-workspace-list
|
||||
title: "providers_google_workspace_list"
|
||||
description: "GoogleWorkspaceProvider Viewset"
|
||||
sidebar_label: "providers_google_workspace_list"
|
||||
hide_title: true
|
||||
hide_table_of_contents: true
|
||||
api: eJy9WEtv2zgQ/iuELnsxoiDtAoucNtgGRYA0DZo+DkEg0NJYYk2TKh9JvIb/+86Qki3bkh/ZxR4S2xJn5uM8vhlykegaDHdCq5siuUxqo59FAcZmpdalhOxFm6mteQ6ZFNYlo6QAmxtRkwSu/xhW/WgX3Tfi7LuAFwu0vuaGz8ChyuTycZEIkvrlwczxncI3+LMACSV3UGTWj39CTmI2r2DGk8tF4uY1LbLOCFUmy+WoXwm85tIXkHlL6PHfs0DQPM+1V70Kx1pL4GpY40RIhJ2VRvt6D6JRMtFmxh0+8V4Uw/rCx4GdNUu1QSdG5QZ+eWEAgzPh0sJoU/VmNH5UIq/YRIAsmNMMXcFeKlCsVcdcBcyA9dLZsyOh1LyEE2FcMRJiys/GmAovwlVCBdP4WCgKdAOCYYr04hDKQQlmB0hmxd+normLMPSk3Tm5xoDzRjHM/YD1aBAWuMmrk/0RxRim02y/359GieMllcq6FBN8aCH3Rrh5qCHu0ZnKiSn+eiIR3FitlQVLKi/Oz+kj1wgfMx+/8rqWIg9Fnv60BGmxC0G3lYd20S1ORG1NyESU2r9WwavrrIrxT5a0DJ6F9rb3ZSzQ3jfeGBh457TjMqPY9Wu1jhuXCVXAa+97UMXg22U3vI9xW51NtJDXADfhbBrvmqLoCifJ1v3ar8FcyMwOFm4Mp0wSDma2z/XH8fAD1j2XWDRmN7LTnlwnKLz4rCRmmjMe1oBvPhDQWAY7ebvSPc9mmG347Ji9DBPorrqGht+udNtj940F1loguiwYSrFgiuXoiVAyvi7wiyrPYrbOsNQ2s3Jlcism4FgMF1tJMauRCbljL8CmSr+wCv+Qj6AQLlDkKr6bcUDL3FpRKmySY55P84orBTLrlHZmpS8Po7rBSBvFJeuIMgrrKDoAqfrbl9vQHk6H0J8eO3y4lvjNskLYWvI5u0PZXqvPYMbawpHKv0Rmj35E9RvSB7RntfSGy9ONRLmDtnAO4tlM47xz2mZEG7Mgy4bU785R+8oC6V9IfDDjr7egSlcllxe/v6cUR96j9oJ9DRUQl+ZYKj01RjS6d+rqGbZGm2PVwbpFyvFS8jFxULNNspXRXh1ZalsTIHsTWxc6U5omjuhNWkWM7G2NPBwYeMteS3CfvSs1PnqYq/xDkLvKW34OYP9nmwVMODaF6KgsRCsrNH6onkhstazjCvVYTumy3mZ67EXZl5C7NTBq52LsR1u13l+cnSY60PXQHVv+6Ewx62a7242hGNB4S2efoHWzPilO7//lvLWp8Tt26yKS8rUxerdtK4xKmPAzoPcn9NllaF9FX/8mbi+wBaFZLu+79pZrJ62hRWSD/nj3H/rjIygcYXJ2dX8z4JACE0r0cPbe3XaTo1HQzatodM82I5lXms7MZXPOJQZN0tXYnm6foFPiBGTI9ijsjSQBXov0+V2aLDtj/gN5J26vM+yvNlI5tzqRBnbF40UzuAo10WFls5W1eKgmGzdwcX7x/uyPs4sdd3/iUzontlLNeGDFrJahOVNUeWwssX8gGJBS/1nqlaUzocn5GHLAM0nI2Xh4+nTzFVXEbdMW7GWalng69OMzJJi0oyJdfxtLPU6JT9Lbm7+u7x6u43yorZtx1VG+8juLfmcrv7O+m4tOgh5xidH43eFJIMVhRQSCDhtZNIHvntewX2yFHh9RflWImpYuFmNu4ZuRyyU9jqdGSgmchajVrU+VU5gPXJA8c+khltyg3KE7kWN0bN2CHCPSkvfepYPROPUSozc2EUjnGuWNYE6+ytiDprlJeSOSY68xDgBob1De7I+tq4w95lZ3JWtbT/QDT6RhnHt8wqUVDrFIXZT8Ueoqz6HuJudO9yAtK/L9eE2cQnTRnTYjH47aL6S97ZFq3tGNhRhWfNVTUFiMLXRHv9EQcv8/bPZpkA==
|
||||
sidebar_class_name: "get 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={"providers_google_workspace_list"}
|
||||
>
|
||||
</Heading>
|
||||
|
||||
<MethodEndpoint
|
||||
method={"get"}
|
||||
path={"/providers/google_workspace/"}
|
||||
>
|
||||
|
||||
</MethodEndpoint>
|
||||
|
||||
|
||||
|
||||
GoogleWorkspaceProvider 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"}
|
||||
>
|
||||
Query Parameters
|
||||
</h3>
|
||||
</summary><div>
|
||||
<ul>
|
||||
<ParamsItem
|
||||
className={"paramsItem"}
|
||||
param={{"in":"query","name":"delegated_subject","schema":{"type":"string"}}}
|
||||
>
|
||||
|
||||
</ParamsItem><ParamsItem
|
||||
className={"paramsItem"}
|
||||
param={{"in":"query","name":"exclude_users_service_account","schema":{"type":"boolean"}}}
|
||||
>
|
||||
|
||||
</ParamsItem><ParamsItem
|
||||
className={"paramsItem"}
|
||||
param={{"in":"query","name":"filter_group","schema":{"type":"string","format":"uuid"}}}
|
||||
>
|
||||
|
||||
</ParamsItem><ParamsItem
|
||||
className={"paramsItem"}
|
||||
param={{"in":"query","name":"name","schema":{"type":"string"}}}
|
||||
>
|
||||
|
||||
</ParamsItem><ParamsItem
|
||||
className={"paramsItem"}
|
||||
param={{"name":"ordering","required":false,"in":"query","description":"Which field to use when ordering the results.","schema":{"type":"string"}}}
|
||||
>
|
||||
|
||||
</ParamsItem><ParamsItem
|
||||
className={"paramsItem"}
|
||||
param={{"name":"page","required":false,"in":"query","description":"A page number within the paginated result set.","schema":{"type":"integer"}}}
|
||||
>
|
||||
|
||||
</ParamsItem><ParamsItem
|
||||
className={"paramsItem"}
|
||||
param={{"name":"page_size","required":false,"in":"query","description":"Number of results to return per page.","schema":{"type":"integer"}}}
|
||||
>
|
||||
|
||||
</ParamsItem><ParamsItem
|
||||
className={"paramsItem"}
|
||||
param={{"name":"search","required":false,"in":"query","description":"A search term.","schema":{"type":"string"}}}
|
||||
>
|
||||
|
||||
</ParamsItem>
|
||||
</ul>
|
||||
</div>
|
||||
</details><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={true}
|
||||
className={"schemaItem"}
|
||||
>
|
||||
<details
|
||||
style={{}}
|
||||
className={"openapi-markdown__details"}
|
||||
>
|
||||
<summary
|
||||
style={{}}
|
||||
>
|
||||
<span
|
||||
className={"openapi-schema__container"}
|
||||
>
|
||||
<strong
|
||||
className={"openapi-schema__property"}
|
||||
>
|
||||
pagination
|
||||
</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"}}
|
||||
>
|
||||
<SchemaItem
|
||||
collapsible={false}
|
||||
name={"next"}
|
||||
required={true}
|
||||
schemaName={"number"}
|
||||
qualifierMessage={undefined}
|
||||
schema={{"type":"number"}}
|
||||
>
|
||||
|
||||
</SchemaItem><SchemaItem
|
||||
collapsible={false}
|
||||
name={"previous"}
|
||||
required={true}
|
||||
schemaName={"number"}
|
||||
qualifierMessage={undefined}
|
||||
schema={{"type":"number"}}
|
||||
>
|
||||
|
||||
</SchemaItem><SchemaItem
|
||||
collapsible={false}
|
||||
name={"count"}
|
||||
required={true}
|
||||
schemaName={"number"}
|
||||
qualifierMessage={undefined}
|
||||
schema={{"type":"number"}}
|
||||
>
|
||||
|
||||
</SchemaItem><SchemaItem
|
||||
collapsible={false}
|
||||
name={"current"}
|
||||
required={true}
|
||||
schemaName={"number"}
|
||||
qualifierMessage={undefined}
|
||||
schema={{"type":"number"}}
|
||||
>
|
||||
|
||||
</SchemaItem><SchemaItem
|
||||
collapsible={false}
|
||||
name={"total_pages"}
|
||||
required={true}
|
||||
schemaName={"number"}
|
||||
qualifierMessage={undefined}
|
||||
schema={{"type":"number"}}
|
||||
>
|
||||
|
||||
</SchemaItem><SchemaItem
|
||||
collapsible={false}
|
||||
name={"start_index"}
|
||||
required={true}
|
||||
schemaName={"number"}
|
||||
qualifierMessage={undefined}
|
||||
schema={{"type":"number"}}
|
||||
>
|
||||
|
||||
</SchemaItem><SchemaItem
|
||||
collapsible={false}
|
||||
name={"end_index"}
|
||||
required={true}
|
||||
schemaName={"number"}
|
||||
qualifierMessage={undefined}
|
||||
schema={{"type":"number"}}
|
||||
>
|
||||
|
||||
</SchemaItem>
|
||||
</div>
|
||||
</details>
|
||||
</SchemaItem><SchemaItem
|
||||
collapsible={true}
|
||||
className={"schemaItem"}
|
||||
>
|
||||
<details
|
||||
style={{}}
|
||||
className={"openapi-markdown__details"}
|
||||
>
|
||||
<summary
|
||||
style={{}}
|
||||
>
|
||||
<span
|
||||
className={"openapi-schema__container"}
|
||||
>
|
||||
<strong
|
||||
className={"openapi-schema__property"}
|
||||
>
|
||||
results
|
||||
</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"}}
|
||||
>
|
||||
<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={"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={"property_mappings"}
|
||||
required={false}
|
||||
schemaName={"uuid[]"}
|
||||
qualifierMessage={undefined}
|
||||
schema={{"type":"array","items":{"type":"string","format":"uuid"}}}
|
||||
>
|
||||
|
||||
</SchemaItem><SchemaItem
|
||||
collapsible={false}
|
||||
name={"property_mappings_group"}
|
||||
required={false}
|
||||
schemaName={"uuid[]"}
|
||||
qualifierMessage={undefined}
|
||||
schema={{"type":"array","items":{"type":"string","format":"uuid"},"description":"Property mappings used for group creation/updating."}}
|
||||
>
|
||||
|
||||
</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_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={"delegated_subject"}
|
||||
required={true}
|
||||
schemaName={"email"}
|
||||
qualifierMessage={"**Possible values:** `<= 254 characters`"}
|
||||
schema={{"type":"string","format":"email","maxLength":254}}
|
||||
>
|
||||
|
||||
</SchemaItem><SchemaItem
|
||||
collapsible={false}
|
||||
name={"credentials"}
|
||||
required={true}
|
||||
schemaName={""}
|
||||
qualifierMessage={undefined}
|
||||
schema={{}}
|
||||
>
|
||||
|
||||
</SchemaItem><SchemaItem
|
||||
collapsible={false}
|
||||
name={"scopes"}
|
||||
required={false}
|
||||
schemaName={"string"}
|
||||
qualifierMessage={undefined}
|
||||
schema={{"type":"string"}}
|
||||
>
|
||||
|
||||
</SchemaItem><SchemaItem
|
||||
collapsible={false}
|
||||
name={"exclude_users_service_account"}
|
||||
required={false}
|
||||
schemaName={"boolean"}
|
||||
qualifierMessage={undefined}
|
||||
schema={{"type":"boolean"}}
|
||||
>
|
||||
|
||||
</SchemaItem><SchemaItem
|
||||
collapsible={false}
|
||||
name={"filter_group"}
|
||||
required={false}
|
||||
schemaName={"uuid"}
|
||||
qualifierMessage={undefined}
|
||||
schema={{"type":"string","format":"uuid","nullable":true}}
|
||||
>
|
||||
|
||||
</SchemaItem><SchemaItem
|
||||
collapsible={false}
|
||||
name={"user_delete_action"}
|
||||
required={false}
|
||||
schemaName={"OutgoingSyncDeleteAction (string)"}
|
||||
qualifierMessage={"**Possible values:** [`do_nothing`, `delete`, `suspend`]"}
|
||||
schema={{"enum":["do_nothing","delete","suspend"],"type":"string","title":"OutgoingSyncDeleteAction"}}
|
||||
>
|
||||
|
||||
</SchemaItem><SchemaItem
|
||||
collapsible={false}
|
||||
name={"group_delete_action"}
|
||||
required={false}
|
||||
schemaName={"OutgoingSyncDeleteAction (string)"}
|
||||
qualifierMessage={"**Possible values:** [`do_nothing`, `delete`, `suspend`]"}
|
||||
schema={{"enum":["do_nothing","delete","suspend"],"type":"string","title":"OutgoingSyncDeleteAction"}}
|
||||
>
|
||||
|
||||
</SchemaItem><SchemaItem
|
||||
collapsible={false}
|
||||
name={"default_group_email_domain"}
|
||||
required={true}
|
||||
schemaName={"string"}
|
||||
qualifierMessage={undefined}
|
||||
schema={{"type":"string"}}
|
||||
>
|
||||
|
||||
</SchemaItem><li>
|
||||
<div
|
||||
style={{"fontSize":"var(--ifm-code-font-size)","opacity":"0.6","marginLeft":"-.5rem"}}
|
||||
>
|
||||
]
|
||||
</div>
|
||||
</li>
|
||||
</div>
|
||||
</details>
|
||||
</SchemaItem>
|
||||
</ul>
|
||||
</details>
|
||||
</TabItem><TabItem
|
||||
label={"Example (from schema)"}
|
||||
value={"Example (from schema)"}
|
||||
>
|
||||
<ResponseSamples
|
||||
responseExample={"{\n \"pagination\": {\n \"next\": 0,\n \"previous\": 0,\n \"count\": 0,\n \"current\": 0,\n \"total_pages\": 0,\n \"start_index\": 0,\n \"end_index\": 0\n },\n \"results\": [\n {\n \"pk\": 0,\n \"name\": \"string\",\n \"property_mappings\": [\n \"3fa85f64-5717-4562-b3fc-2c963f66afa6\"\n ],\n \"property_mappings_group\": [\n \"3fa85f64-5717-4562-b3fc-2c963f66afa6\"\n ],\n \"component\": \"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 \"delegated_subject\": \"user@example.com\",\n \"credentials\": {},\n \"scopes\": \"string\",\n \"exclude_users_service_account\": true,\n \"filter_group\": \"3fa85f64-5717-4562-b3fc-2c963f66afa6\",\n \"user_delete_action\": \"do_nothing\",\n \"group_delete_action\": \"do_nothing\",\n \"default_group_email_domain\": \"string\"\n }\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