1026 lines
53 KiB
Plaintext
1026 lines
53 KiB
Plaintext
---
|
|
id: sources-scim-list
|
|
title: "sources_scim_list"
|
|
description: "SCIMSource Viewset"
|
|
sidebar_label: "sources_scim_list"
|
|
hide_title: true
|
|
hide_table_of_contents: true
|
|
api: eJztWd1v2zYQ/1cIYcAe5thZ2gBbnha0QWAgaYsm6bAFmUBLjMWGJlWSSuIG/t93d5QsWZIdO0vf9tBGlnjH+/jdF/kUmVxY7qXR4zQ6ipwpbCJc7BI5i5V0PhpEqXCJlTmugRUX78bnF7SKfZHiwQlcknPLZ8IL66Kj66dI4sJvhbBz+KbhC/ykP4PIJZmY8ejoKfLzHN87b6WeRovF4Klaamwq6OUgsuJbIa0A0W65cmKwynpVsj8zmWTsVgqVMm9Y4QR7yIRmFTvmM8GscIXybrilKDmfih3FOGZIxHQxmwjLHqTPpKat4bXU3Iu0FIKB7XrlkNqLqbAdQWInv+8qzYcghrmtNEfTWOELqxl4nmTdWggnuE2yne0RyBjAY/as3fug41Qx3Uh3M4g8nyL2KgBH8MqJpLDSzwmSvAAXaC/v4NcNEoA5cqMdLAWGB/v7+CcxoLT2+MjzXMmEAmP01aEiT10BzOSrSAj/FsPIy8CtdLQMVJvXavHoG6sCaqIFLhP30hSu92NiCt1PBipbseabN56rGD3ez9V5bn0sdSoee78Lna79umiC4jqo1VCiErkWcFWc1c2bW6FvpVe416farrQd4bkhC7eWI2ykFzPXZ/q1mewCEgRXEF2268y7LuIG0a2xMw5WjopCphQQPP2oFWDN20I0RJ7MGC1ZVGju8mpJRRL97FgqXa74nH0AsiG5B8PgWfoxQNhqrliIBIa7DjAZpgzy0NXnM8p9M/54JvTUZ9HR4T7mb49UQP7P9R7f+3689/f+3u/xzS8/Bb/ziUK/LveeGKMEJzcAZxuXJpvHM4gbkGobr6yxJSJpak2RvzbTxMwg4FdjY40NT4VnATRsSQX2hCzOPXsQ7E6bB5bBP8ilIpWe0vsSZatYgJ3vhZ0YJ+LtAPA5JOfADnCwQv0M9zhXheVq900C3bN7QY3n8cykQu2mjKxASbRsLXuuIRukfWx1oRSisB1g54GETeasTvFtKT6Smi74j1vBZj1UQ3aZCVf50dG6BETEgs11yoo8Dc+FNwAtKA5KzZFIOnar+JQZUAU0TbFsiGozvQQSPE6AO5j4AaoS1BncfSanoftyQ/aXKWiV81KRpeTtvIEsQILk9Pv403jAJoVn4jEn1hnXU0GVvbUDRDxnCsSxpfjDPrOHEOY+iyGaclzeU2SBzhgfF3YLdGH8fIbVmG76NvTmTugY1KJKq9THW6rRm9P1JRL9uEwd2Fe5+n8k/ngkgplligpDy277LN0oUgeHh89VKbns3QQ0JdiEwPbAOzRxwI7nkvyfoFxzegFFhjv3ABMC9Rmt/SvPjonzCXIto6WvTy7jaEdUXwHN1qCu9lqP4vH7SpB1+blh1F8P97duS1DORlOiq6ZEupgnXt6Lnu6gFus4LGkzfS+cnGrCKExqACgLqAIQo/zMZaaASQ5w5CvsQygQoyG7gs5dIeJovdTOg0FwyoHyIjwOezyhjtORlIo7HyszlXpjikBc7nlJxWk1zIOmrgDPtPxfK9tJc9TGvEYr5CpUvbDRlZDVMcpSdorsGnhjsCOZG3xbivu6aTVsuGyBi1m8BtHdCsJxhgZJIb0NsIN4c8DG70lgTD0kbZ/V+/G8jQO7iAfApamg4wQCGm0KMz1kRcDlklsAWc7tmu6ybawOtgLp2p6qbdwOPSRGKyEPi140gA4SleLqU9Ozi87Qxkvkk5NWpRogDhqzGFqHfBtGsWfkg7FZ9vYNS8uEFTX/E/yN1ocxz7VrwVtU+Z7DxLh14grLB0xISjOcZd7nI/zPYZfCDL6D+Ofwa9wHqxeaGJKx7G0jOhtgA9aL2/CiLmtVM41j8uPyEdS8l4mIy7wXDZbr4vanDaUOrXUJ35bFbo30m8O/DazSVyvZrBWPg6iGWbBZo4yVcrTgF4VjnJYZV7zfY03oVECszdl3Yx0gBkjQMw639G60N5ViVYtw0+o8+5RpcasH2Lo/7Y5kq4Zc9uyD6hSt7r1bg2n/JNmQsz4viTqpo3HkVZ/MdI9uRFozOcPTZWK0GrDopLf/8TxuleMXqHUpkbITa023ydJGx3RuHAv8vkPJDgcLaV/BWazPCrVdatGCZGvt8eYV7XEqNJZV7N7XGCQFUPUl7I3aNvFQMmggoNx0g5rhfCEzeA8xLa8VMCVGo/JQd4S3EqMy11V3DTSQRiNo7kf3b0YURtXB7wXaIyjUOP5dio7JvzpWpigWUO/CUabUt4ZWlsI3BzrcOYh8sH/wdvjb8KBj4HN+Ry1oSRXcxBy2YTSBox+hk6WkHipjlAmlzB9TUw+B0lDnCokbel1CaTgNPx9fYiIhtal+HY1GU6hqxWQIGWLUYDGqnybKTEawlR6djd+dfLg4ITVz4zxkkgbz0tIMLc367n8aIOy/CiqN66E0jWBUkOGQMJwaBH/Wh/RofDmDPwiUDITBj09PE+7ElVWLBb4OdwHoaZg9ynPI8tLhTsyj5cXSPVeFCOHSs3StDrteGvWqFwRpXFu9UJidr442SFPeXL1Qkm2vjZ4RoLqxerE9WldHG7Zb3k1t3qtcHGphvfQGf8BQRIX++ga4ZlCLcU4A4AWa4yQRuW9QdVIwcllmsNMTDFOMwGajEFLMoHponA9wPW/whiCgFdQbQCBUgvuyV4AE+i895kwp
|
|
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={"sources_scim_list"}
|
|
>
|
|
</Heading>
|
|
|
|
<MethodEndpoint
|
|
method={"get"}
|
|
path={"/sources/scim/"}
|
|
>
|
|
|
|
</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"}
|
|
>
|
|
Query Parameters
|
|
</h3>
|
|
</summary><div>
|
|
<ul>
|
|
<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><ParamsItem
|
|
className={"paramsItem"}
|
|
param={{"in":"query","name":"slug","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={"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><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\": \"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 }\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>
|
|
|