mirror of
https://github.com/goauthentik/authentik
synced 2026-04-26 09:35:07 +02:00
739 lines
33 KiB
Plaintext
739 lines
33 KiB
Plaintext
---
|
|
id: sources-ldap-retrieve
|
|
title: "sources_ldap_retrieve"
|
|
description: "LDAP Source Viewset"
|
|
sidebar_label: "sources_ldap_retrieve"
|
|
hide_title: true
|
|
hide_table_of_contents: true
|
|
api: eJy1WG1v2zYQ/iuEMGAb5thBugFbPi1Ls85A3tAkHbYiE2iJtlhTpEpScV3D/313R0qW35IGTT9Zso53z73fcZGYSljupdHDPDlOnKltJlyqcl6lVngrxYNIekkuXGZlhXRAdf765JrdECl7J8XMCQ80Fbe8FF5Ylxy/XyQSKSvuC/ik4QNyV/UE3lxWiJInx4vEzyv6H+ToyZaYoQZmmisWUDHk0mO1EzmTmt29PXf9ZNlLrPhYSysAvre1WN73Es8niKHRJoG/nMhqK/2coPHaF0J7OYW3ezxghauMdkAKoI4OD/EnMyBee3zkVaVkRlYafHCIbbGthBl9EJl/1FY3wkqu5Gdh0VwWTe9lEFpNd9ljbGzJAUJS1zJPECfPr7SaB1VBUekVHrgelYxIlo2tn7JtQPS9Y7l0leJzdgnHyJzkpBfxTS8p+adzoScQA8e/HGKEeDwFx/97f8APPp8c/Ht48Ft6/9N3KFhoPlLoxlb2yBgluMaPjcuCF9KxMrMvMZiulUKujcHWlfgTuDBvEDabAXvWlaInTHySjh6AwIZgE9oapUog+lYYggSUqsWsIxmf0hg087SEmAQa1wHAreVzkCe9KN3TwJbAc2JNXb0008yUkEwxdR6PojfCs5A3rD0FEcV8wT2bCTbVYJwiGEjk0sMHwdpEW88GkPwg7Mg4kX5ZCrwVvrY6soNMWDv9BPe0UrXl6vlCwrknZUEd5WlpcqGep4xs0pLOsn3sKwP1bJ5CakotSA5KELousWxypeAQ13MsnJti25JDLM6IwwUyaEIUoiErgLZlC+yuxlR3GwEyxyQbS6qDUEWlSiHgp+0LfMaYQ3Zk7Pixfafvj2C7A8KLCAOxnaFcrPPrNvsLAwsCKpawHHtXCeo4JseM6/X0Z64wtcrZSHSrBJQ7YxlvUzVmr8gpZUuu+WStorVQN4tCA/0iHGGjOVt1qU3gVxRNLqQJt4KVO0712W0hXJMujugyiATEzHXO6ioPz7U34DPQRqk5HpKOjRWfMAMRAwGVk56NMN3mKzyCLQxE8gwaK7RKlF7KSZgmXJ/9Y2qiAhsqCkg5nncSGBJOcno/uR722Kj2YPCKWBdcT1Ci2ZQArYUzBXBshN/fFd2hUsLkkULRqpB82wNAJrPQyTdds8UP2AGGFOaHxwsgfMfcEkCbYWcfk+W+vkVc0QO6B+tGY8UwWBA0qCunK4GMT7jULhTL0xN2WsArms6ja6diXnFpKT4zJbGRvSjYU+LJOjzRj92UWcO3VwsCOILwS7MdXkKveG596pXbMTCs8umMhgp2g8Ts9vyGTmr56BkoHxESDDJDBvqzm8thsH0cQAgchwKe7wbHc+hW5LSUonEX2UrgSaRmWLjY68uthL+2ohI6h2wFW/4BcoGIcOGBg481IBNhSugIDs39CyW/QeJniaYTa7JJ05Dc6VgqyNKn+9YplApoB5Y1Na1pHyFaA5tYCe7aWSio9g1FkXJdWaUoRyC9kBXIE2pnTd8Y7JAMRjqZFQx3CYx5FtkwAw2GEWeSETWptQR7QgNyXyWEs8CIDds+S1Iq7tzM2DxVBrp2Gipo2owMafN5Z26si72jo6tpo206rGESZlkSxFydZULkjs2kLyjjKQvnOqPk2JXAa9+fg+xvGuNDL277SCGkbZH1GHJmMEyOeDZFfyOi2PiwX1HfgxiI+wi8A0MH1lexXIV5od+CJD8+pgVsxlhnie75FZZGaq0hQOQDbbDbK+cq66/Xtspn0jX1a/lUkce5PeOwAefN8LSGcKuHrm3p79vK2d0VNpSM7Xk1Q23PxHHV7eHuvNake81Fw8aUvWuAv1/VQvRtWIvBAstNldGZP7/ozcA7rmROR9mZtWb7TkDjoosJngr8/oy1LKxh+a65Z7k3CpYrU6ygBWR77fHqBe3xBiqflRmOg3sMAhM6rAc7G+5+bbuBFxl0nB6FPqJm2MYKg9djk3jRhRcaySBeLw3wsmywwJhbDtpIDJdgtVVIySs5eHg1oB2kuYm6QbMEvTr3Ua0GhfdVc1dGNUVAEbEER+qxIcqoQ3dRQMkB+dHh0c/9X/tHW3a+4FNseus3KlDgYFSmeZr6SEbupHUMwQilzO8Ts1oupEGrg6+FdmT4eMV3MbzFTY3URhXc8WAwgbJfj/qQ64MOi8HqaaTMaACi9OB8eHp2eXNGalbGecj+DvNocIYGZ/tuJzvxuOeiMlrYi09+AOuBpEJNkBfRt6urQ9ARhMHPcawpGDwFIEOixQIr2Z1VyyX+jbMQXjDC4wO3MpRPCIJcunizNebKbRbTLt4f3sZg/ZHtw9kUANqQH7iq8Q0eYa5vbliX90BXQAXGqQjkh08n0IQr3zm0lasYnW2ovzlDR6KPuo0tBGGveUDuOwGBZYji1kyFBus0+Dy+I8Dl8n8ekt+X
|
|
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_ldap_retrieve"}
|
|
>
|
|
</Heading>
|
|
|
|
<MethodEndpoint
|
|
method={"get"}
|
|
path={"/sources/ldap/{slug}/"}
|
|
>
|
|
|
|
</MethodEndpoint>
|
|
|
|
|
|
|
|
LDAP Source 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><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={"authentication_flow"}
|
|
required={false}
|
|
schemaName={"uuid"}
|
|
qualifierMessage={undefined}
|
|
schema={{"type":"string","format":"uuid","nullable":true,"description":"Flow to use when authenticating existing users."}}
|
|
>
|
|
|
|
</SchemaItem><SchemaItem
|
|
collapsible={false}
|
|
name={"enrollment_flow"}
|
|
required={false}
|
|
schemaName={"uuid"}
|
|
qualifierMessage={undefined}
|
|
schema={{"type":"string","format":"uuid","nullable":true,"description":"Flow to use when enrolling new users."}}
|
|
>
|
|
|
|
</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={"policy_engine_mode"}
|
|
required={false}
|
|
schemaName={"PolicyEngineMode (string)"}
|
|
qualifierMessage={"**Possible values:** [`all`, `any`]"}
|
|
schema={{"enum":["all","any"],"type":"string","title":"PolicyEngineMode"}}
|
|
>
|
|
|
|
</SchemaItem><SchemaItem
|
|
collapsible={false}
|
|
name={"user_matching_mode"}
|
|
required={false}
|
|
schemaName={"UserMatchingModeEnum (string)"}
|
|
qualifierMessage={"**Possible values:** [`identifier`, `email_link`, `email_deny`, `username_link`, `username_deny`]"}
|
|
schema={{"enum":["identifier","email_link","email_deny","username_link","username_deny"],"type":"string","title":"UserMatchingModeEnum"}}
|
|
>
|
|
|
|
</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={"icon"}
|
|
required={true}
|
|
schemaName={"string"}
|
|
qualifierMessage={undefined}
|
|
schema={{"type":"string","readOnly":true}}
|
|
>
|
|
|
|
</SchemaItem><SchemaItem
|
|
collapsible={false}
|
|
name={"server_uri"}
|
|
required={true}
|
|
schemaName={"uri"}
|
|
qualifierMessage={undefined}
|
|
schema={{"type":"string","format":"uri"}}
|
|
>
|
|
|
|
</SchemaItem><SchemaItem
|
|
collapsible={false}
|
|
name={"peer_certificate"}
|
|
required={false}
|
|
schemaName={"uuid"}
|
|
qualifierMessage={undefined}
|
|
schema={{"type":"string","format":"uuid","nullable":true,"description":"Optionally verify the LDAP Server's Certificate against the CA Chain in this keypair."}}
|
|
>
|
|
|
|
</SchemaItem><SchemaItem
|
|
collapsible={false}
|
|
name={"client_certificate"}
|
|
required={false}
|
|
schemaName={"uuid"}
|
|
qualifierMessage={undefined}
|
|
schema={{"type":"string","format":"uuid","nullable":true,"description":"Client certificate to authenticate against the LDAP Server's Certificate."}}
|
|
>
|
|
|
|
</SchemaItem><SchemaItem
|
|
collapsible={false}
|
|
name={"bind_cn"}
|
|
required={false}
|
|
schemaName={"string"}
|
|
qualifierMessage={undefined}
|
|
schema={{"type":"string"}}
|
|
>
|
|
|
|
</SchemaItem><SchemaItem
|
|
collapsible={false}
|
|
name={"start_tls"}
|
|
required={false}
|
|
schemaName={"Enable Start TLS (boolean)"}
|
|
qualifierMessage={undefined}
|
|
schema={{"type":"boolean","title":"Enable Start TLS"}}
|
|
>
|
|
|
|
</SchemaItem><SchemaItem
|
|
collapsible={false}
|
|
name={"sni"}
|
|
required={false}
|
|
schemaName={"Use Server URI for SNI verification (boolean)"}
|
|
qualifierMessage={undefined}
|
|
schema={{"type":"boolean","title":"Use Server URI for SNI verification"}}
|
|
>
|
|
|
|
</SchemaItem><SchemaItem
|
|
collapsible={false}
|
|
name={"base_dn"}
|
|
required={true}
|
|
schemaName={"string"}
|
|
qualifierMessage={undefined}
|
|
schema={{"type":"string"}}
|
|
>
|
|
|
|
</SchemaItem><SchemaItem
|
|
collapsible={false}
|
|
name={"additional_user_dn"}
|
|
required={false}
|
|
schemaName={"Addition User DN (string)"}
|
|
qualifierMessage={undefined}
|
|
schema={{"type":"string","title":"Addition User DN","description":"Prepended to Base DN for User-queries."}}
|
|
>
|
|
|
|
</SchemaItem><SchemaItem
|
|
collapsible={false}
|
|
name={"additional_group_dn"}
|
|
required={false}
|
|
schemaName={"Addition Group DN (string)"}
|
|
qualifierMessage={undefined}
|
|
schema={{"type":"string","title":"Addition Group DN","description":"Prepended to Base DN for Group-queries."}}
|
|
>
|
|
|
|
</SchemaItem><SchemaItem
|
|
collapsible={false}
|
|
name={"user_object_filter"}
|
|
required={false}
|
|
schemaName={"string"}
|
|
qualifierMessage={undefined}
|
|
schema={{"type":"string","description":"Consider Objects matching this filter to be Users."}}
|
|
>
|
|
|
|
</SchemaItem><SchemaItem
|
|
collapsible={false}
|
|
name={"group_object_filter"}
|
|
required={false}
|
|
schemaName={"string"}
|
|
qualifierMessage={undefined}
|
|
schema={{"type":"string","description":"Consider Objects matching this filter to be Groups."}}
|
|
>
|
|
|
|
</SchemaItem><SchemaItem
|
|
collapsible={false}
|
|
name={"group_membership_field"}
|
|
required={false}
|
|
schemaName={"string"}
|
|
qualifierMessage={undefined}
|
|
schema={{"type":"string","description":"Field which contains members of a group."}}
|
|
>
|
|
|
|
</SchemaItem><SchemaItem
|
|
collapsible={false}
|
|
name={"object_uniqueness_field"}
|
|
required={false}
|
|
schemaName={"string"}
|
|
qualifierMessage={undefined}
|
|
schema={{"type":"string","description":"Field which contains a unique Identifier."}}
|
|
>
|
|
|
|
</SchemaItem><SchemaItem
|
|
collapsible={false}
|
|
name={"password_login_update_internal_password"}
|
|
required={false}
|
|
schemaName={"boolean"}
|
|
qualifierMessage={undefined}
|
|
schema={{"type":"boolean","description":"Update internal authentik password when login succeeds with LDAP"}}
|
|
>
|
|
|
|
</SchemaItem><SchemaItem
|
|
collapsible={false}
|
|
name={"sync_users"}
|
|
required={false}
|
|
schemaName={"boolean"}
|
|
qualifierMessage={undefined}
|
|
schema={{"type":"boolean"}}
|
|
>
|
|
|
|
</SchemaItem><SchemaItem
|
|
collapsible={false}
|
|
name={"sync_users_password"}
|
|
required={false}
|
|
schemaName={"boolean"}
|
|
qualifierMessage={undefined}
|
|
schema={{"type":"boolean","description":"When a user changes their password, sync it back to LDAP. This can only be enabled on a single LDAP source."}}
|
|
>
|
|
|
|
</SchemaItem><SchemaItem
|
|
collapsible={false}
|
|
name={"sync_groups"}
|
|
required={false}
|
|
schemaName={"boolean"}
|
|
qualifierMessage={undefined}
|
|
schema={{"type":"boolean"}}
|
|
>
|
|
|
|
</SchemaItem><SchemaItem
|
|
collapsible={false}
|
|
name={"sync_parent_group"}
|
|
required={false}
|
|
schemaName={"uuid"}
|
|
qualifierMessage={undefined}
|
|
schema={{"type":"string","format":"uuid","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"}
|
|
>
|
|
connectivity
|
|
</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"}}
|
|
>
|
|
<div
|
|
style={{"marginTop":".5rem","marginBottom":".5rem"}}
|
|
>
|
|
|
|
|
|
Get cached source connectivity
|
|
|
|
|
|
</div><SchemaItem
|
|
collapsible={true}
|
|
className={"schemaItem"}
|
|
>
|
|
<details
|
|
style={{}}
|
|
className={"openapi-markdown__details"}
|
|
>
|
|
<summary
|
|
style={{}}
|
|
>
|
|
<span
|
|
className={"openapi-schema__container"}
|
|
>
|
|
<strong
|
|
className={"openapi-schema__property"}
|
|
>
|
|
property name*
|
|
</strong><span
|
|
className={"openapi-schema__name"}
|
|
>
|
|
object
|
|
</span><span
|
|
className={"openapi-schema__divider"}
|
|
>
|
|
|
|
</span><span
|
|
className={"openapi-schema__nullable"}
|
|
>
|
|
nullable
|
|
</span>
|
|
</span>
|
|
</summary><div
|
|
style={{"marginLeft":"1rem"}}
|
|
>
|
|
<SchemaItem
|
|
name={"property name*"}
|
|
required={false}
|
|
schemaName={"string"}
|
|
qualifierMessage={undefined}
|
|
schema={{"type":"string"}}
|
|
collapsible={false}
|
|
discriminator={false}
|
|
>
|
|
|
|
</SchemaItem>
|
|
</div>
|
|
</details>
|
|
</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 \"authentication_flow\": \"3fa85f64-5717-4562-b3fc-2c963f66afa6\",\n \"enrollment_flow\": \"3fa85f64-5717-4562-b3fc-2c963f66afa6\",\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 \"policy_engine_mode\": \"all\",\n \"user_matching_mode\": \"identifier\",\n \"managed\": \"string\",\n \"user_path_template\": \"string\",\n \"icon\": \"string\",\n \"server_uri\": \"string\",\n \"peer_certificate\": \"3fa85f64-5717-4562-b3fc-2c963f66afa6\",\n \"client_certificate\": \"3fa85f64-5717-4562-b3fc-2c963f66afa6\",\n \"bind_cn\": \"string\",\n \"start_tls\": true,\n \"sni\": true,\n \"base_dn\": \"string\",\n \"additional_user_dn\": \"string\",\n \"additional_group_dn\": \"string\",\n \"user_object_filter\": \"string\",\n \"group_object_filter\": \"string\",\n \"group_membership_field\": \"string\",\n \"object_uniqueness_field\": \"string\",\n \"password_login_update_internal_password\": true,\n \"sync_users\": true,\n \"sync_users_password\": true,\n \"sync_groups\": true,\n \"sync_parent_group\": \"3fa85f64-5717-4562-b3fc-2c963f66afa6\",\n \"connectivity\": {}\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>
|
|
|