mirror of
https://github.com/goauthentik/authentik
synced 2026-04-26 09:35:07 +02:00
1020 lines
48 KiB
Plaintext
1020 lines
48 KiB
Plaintext
---
|
|
id: sources-ldap-list
|
|
title: "sources_ldap_list"
|
|
description: "LDAP Source Viewset"
|
|
sidebar_label: "sources_ldap_list"
|
|
hide_title: true
|
|
hide_table_of_contents: true
|
|
api: eJzFGWtv4zbyrxDGAfehjh1se8A1ny6XpnsBkmzQbFrcLVKBlmiLDU2pJJXEDfLfb2ZIvWzJlu0t+ilWyHly3vM2ynJhuJOZvkpGZyObFSYWNlIJzyMlrRuNR4mwsZE53oEb1z+c37F7usZ+luLFCryTc8OXwgljR2df3kYSb/5eCLOCMw0n8MmTRCIOrqKFyYo8SjQc2jgVSz46exu5VY7XrDNSL0bv7+OdaAorzIFYZtyKQ0GlTqL4INBYSaFdFAvj5FzG3IktWMajeWaW3MF/ikIm/ViF5jMlki5UsyxTgut+WP8SS7GcwdOlMo/mUqhOVLtk85iy2W8idoBFgS0cjiY3aJZuFS15nsN924WKG8MRUjqxtIP0NxKvucoSuORMIQClWymEwIujPo7ozwGSBFUUWsKBFtYO020JbRIRxDDi90IaeOCzOVcW2G5Ra3vnL6mMU0aEmMsYeAh7SYVmJTrmUsGMsIVydjKQlZwvxJ5snDMEYrpAu2Iv0qVSE2n4t9Rg90lggkH46ORDaicWYELrjERW/rEvN7eejWxeSo6qMcIVRjMwM+J1NxNdb5xza19At5HKQK6oyBOQLUIwgwGqPD7INXMB0e2IUBHQWMFNnO79fh6MgSDLnXbSxT2E5mfgvzDyIGhVLA6C053kduraOm5c5FRnnNkNvdKxz2lHwEMGxdxAaL5GViCkmCGP4InAj7NiytFHZwXC8pckhcfxyPEFVjVlbTSCf1kRg2W7FRU7vIDIpp18gq9HBIAok2faCqL/4fQU/8QZBAXt8Cdwr9CjwdWmv1n0t7dNObzKsLLyUkuPLcRP6aG239Xi1TVu+WAMaQ6uiWeZFbbzMM4K3Q0GIhvRc+YyR/FuIbqxegeDykm8dp4LqKn6Tt+bseuLF6shRMlyzWCbnTbxJil8W+nose9qvRI5ShMDzKpSfX+RfA+JlyvIWmbzNZ92Wyhyw5NPWq1KA614ni2ZN+LSTzZxtdnyHP3dskTaXPEVuwWwCb0PBtyd8FchsTHvCgypjrHISBjk94efrqmmWPLXa6EXLh2d/eMUWwOHUAD+65cTfvLH+cn/Tk++jx6/+Zt/eF+8doSUceVZ3lmiucpehihMF0oh1lJhbSF+BCyt2qhJBSok8QptD/6g6DfxTJpMqSXG5z+JB08BqWrx0qDcE/iOind9JfZRSONsCTGvHR56rOijcMz7DaugwKKgPuSOvQj2pEE5qVeQgGaPCsfK0dreAJShzJhl0M0Nc4GffNnn0YEntKB3YI9yVRiu9ifi4XbSggaaR0tIRWo/Ycp6kxEs60OfZ5B2VhG4ptSC6CAFAWEWwypXCoC4XlFYXCNbhRxCcUkYbhBBaaJgDTHU+IsKLaD7NKf0WBKQCToZtCYYByHZSRWBwT9VH3CMNofoSNnhsPqm8y28PcDFm8AG8naJdDEdt3X2HzQsMKgQwhIcWixBHMvknHHddn9m06yAVmommlECwl1mGK9cNXivSMhll1xD3km6Xm89KJSs33gQNluxuphYZ/wTWZP1bgLFIlt2QE3Y51TY0l0s3YvBEpBnrhPmO5QEATJ4M5BGqRUCScvmii9YBhYDBpWQnCUxXfkr/ARdZGDJL1D/QEWD1Jdy4UdIdsL+mxV0C3SoyCDlfNVwYHA4yen7/O5qzGaFA4XnhDrleiGoNVujAKmFMwXsmMD+pMu6faTkLo0gaOV4vaO+hJAWt0qn6mk28DUamK0BEM7Rt9abtaNTxKfcT7ngOYCPUou+sCDWIK5c1AQZX3CprQ+WF+fsIoVPRl03PO2TWOVcGrLPjiHU0cxeEE7WwInv2HSZFn+9UhCD5YCt6/nqRm2zYKj96ZKKCnaPl9nn63uC1HIrDISPwBIUMlcM5Gf3t1de96EAIebC4LCLuY7RZIdmS4Ln4TbDwMV+uN1w+DsjcihWBU1y/g104RLxhQAn2CFBGTlZI1yNVodQ/oiX9yJNEC3aHQ3ezrx1AaEC0oFhZUwr04e3Vo8mRIKHqhbqmjB+VVIkXJPWxlx0J7kfafL2QlM4bPnQ5llAgwMozggz0egbEB5GhDOPiF1VeZaoDB1RdflGm+wDgdbVRpV0WInE17JEiNkijoVILE3/yOPJC+upRGfF3zV22M3ZL1TG+1xc5ZFUSFNxNmaImUExOePxE743chQSH+YryntgA6EfgW9AaEH7KoQrXy9MKibDvKdfitZAZ+8ISyW11mAg8pkGDZstZ+31d62ucs979exlR5DHuj3mcQraCcVTi8ONHLrWt9crl7pXWBMypOe6htqsicflPD7HCqk9ZfRDw7Uqu6uAbzT++La+LQYNrHHcGLbUM4HNoYFIaiTXuDIjRG3doVV8d+QkqI3xZ65kQqDs0phsc7igsWPGSBEJPN+jv/P9XNJVQL33mtN7rZeaNc9Zrz6+/Yr6+Agh1MgY68oehUCpD31GZ+bul7ZpDwFBwwIC0S1i+rYuzXC5ugirUpyMjKZhnDjFVeu0smW/Py2Mwis8l9Pnb6fUxZQjx3vUhxeoMXisWE+dq8bHFJUEhCE/RJN6ntHNwHyz1UDKnuUPpx++m/xz8mFDwTf8CdNmeyYDIRKKbarIKRPF9I7U0CEzQqnsX4usbk9khuqGRxbaksbDgPfm6jP2eiQ2imDPptMFJI5iNoFoMW2gmNa/ZiqbTYGUnl5fXVze3l+SmHlmHcSPBvKgaYaaZl1L7YYR9uy3g3adeHVTaC4khXli9y08aD0fBvmAEPxBS0mBGzx8e8P492DU+zv+28+38akTacMELKxloFYf9W3Ln7kqhHefIZD1gnwIYB2gB92u1uBDbnduvocA1svtIbd719nDgdd3FcMhu/YTQ6DLRDXgav9OeTt0r7Xvuy/u9IPAW72xPpCZvbfGW7gJS+sDORm6Md7BQLmsHvK0w1fJg7BtLo8PfpS1VfAWmatd8xAWW7XbIIBQ3w25qgcjbWx+B91v7XoHQ6xtdwfDlQvc/QD2tZbOJe1gwO1x7xE/jPRtxZdHsJUU2gRs3SH5eSzn0CnmrgG1UQcilqqM+niJtQKWAc3uy9c54/IHYi+rXZorl7ghEdONz9mT0JCMS1EcfgMhqOL+D7mEkUA=
|
|
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_list"}
|
|
>
|
|
</Heading>
|
|
|
|
<MethodEndpoint
|
|
method={"get"}
|
|
path={"/sources/ldap/"}
|
|
>
|
|
|
|
</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"}
|
|
>
|
|
Query Parameters
|
|
</h3>
|
|
</summary><div>
|
|
<ul>
|
|
<ParamsItem
|
|
className={"paramsItem"}
|
|
param={{"in":"query","name":"additional_group_dn","schema":{"type":"string"}}}
|
|
>
|
|
|
|
</ParamsItem><ParamsItem
|
|
className={"paramsItem"}
|
|
param={{"in":"query","name":"additional_user_dn","schema":{"type":"string"}}}
|
|
>
|
|
|
|
</ParamsItem><ParamsItem
|
|
className={"paramsItem"}
|
|
param={{"in":"query","name":"base_dn","schema":{"type":"string"}}}
|
|
>
|
|
|
|
</ParamsItem><ParamsItem
|
|
className={"paramsItem"}
|
|
param={{"in":"query","name":"bind_cn","schema":{"type":"string"}}}
|
|
>
|
|
|
|
</ParamsItem><ParamsItem
|
|
className={"paramsItem"}
|
|
param={{"in":"query","name":"client_certificate","schema":{"type":"string","format":"uuid"}}}
|
|
>
|
|
|
|
</ParamsItem><ParamsItem
|
|
className={"paramsItem"}
|
|
param={{"in":"query","name":"enabled","schema":{"type":"boolean"}}}
|
|
>
|
|
|
|
</ParamsItem><ParamsItem
|
|
className={"paramsItem"}
|
|
param={{"in":"query","name":"group_membership_field","schema":{"type":"string"}}}
|
|
>
|
|
|
|
</ParamsItem><ParamsItem
|
|
className={"paramsItem"}
|
|
param={{"in":"query","name":"group_object_filter","schema":{"type":"string"}}}
|
|
>
|
|
|
|
</ParamsItem><ParamsItem
|
|
className={"paramsItem"}
|
|
param={{"in":"query","name":"group_property_mappings","schema":{"type":"array","items":{"type":"string","format":"uuid"}},"explode":true,"style":"form"}}
|
|
>
|
|
|
|
</ParamsItem><ParamsItem
|
|
className={"paramsItem"}
|
|
param={{"in":"query","name":"name","schema":{"type":"string"}}}
|
|
>
|
|
|
|
</ParamsItem><ParamsItem
|
|
className={"paramsItem"}
|
|
param={{"in":"query","name":"object_uniqueness_field","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={{"in":"query","name":"password_login_update_internal_password","schema":{"type":"boolean"}}}
|
|
>
|
|
|
|
</ParamsItem><ParamsItem
|
|
className={"paramsItem"}
|
|
param={{"in":"query","name":"peer_certificate","schema":{"type":"string","format":"uuid"}}}
|
|
>
|
|
|
|
</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":"server_uri","schema":{"type":"string"}}}
|
|
>
|
|
|
|
</ParamsItem><ParamsItem
|
|
className={"paramsItem"}
|
|
param={{"in":"query","name":"slug","schema":{"type":"string"}}}
|
|
>
|
|
|
|
</ParamsItem><ParamsItem
|
|
className={"paramsItem"}
|
|
param={{"in":"query","name":"sni","schema":{"type":"boolean"}}}
|
|
>
|
|
|
|
</ParamsItem><ParamsItem
|
|
className={"paramsItem"}
|
|
param={{"in":"query","name":"start_tls","schema":{"type":"boolean"}}}
|
|
>
|
|
|
|
</ParamsItem><ParamsItem
|
|
className={"paramsItem"}
|
|
param={{"in":"query","name":"sync_groups","schema":{"type":"boolean"}}}
|
|
>
|
|
|
|
</ParamsItem><ParamsItem
|
|
className={"paramsItem"}
|
|
param={{"in":"query","name":"sync_parent_group","schema":{"type":"string","format":"uuid"}}}
|
|
>
|
|
|
|
</ParamsItem><ParamsItem
|
|
className={"paramsItem"}
|
|
param={{"in":"query","name":"sync_users","schema":{"type":"boolean"}}}
|
|
>
|
|
|
|
</ParamsItem><ParamsItem
|
|
className={"paramsItem"}
|
|
param={{"in":"query","name":"sync_users_password","schema":{"type":"boolean"}}}
|
|
>
|
|
|
|
</ParamsItem><ParamsItem
|
|
className={"paramsItem"}
|
|
param={{"in":"query","name":"user_object_filter","schema":{"type":"string"}}}
|
|
>
|
|
|
|
</ParamsItem><ParamsItem
|
|
className={"paramsItem"}
|
|
param={{"in":"query","name":"user_property_mappings","schema":{"type":"array","items":{"type":"string","format":"uuid"}},"explode":true,"style":"form"}}
|
|
>
|
|
|
|
</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={"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><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 \"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 }\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>
|
|
|