Files
authentik/website/docs/developer-docs/api/reference/outposts-ldap-list.api.mdx
Tana M Berry 7a6d44d0df first pass
2024-10-22 15:10:13 -05:00

605 lines
26 KiB
Plaintext

---
id: outposts-ldap-list
title: "outposts_ldap_list"
description: "LDAPProvider Viewset"
sidebar_label: "outposts_ldap_list"
hide_title: true
hide_table_of_contents: true
api: eJy9WN9v2zYQ/lcIvezFtbM02Io8LWiCIkDbGEjWDSgCgRZPEmuKVEkqrmf4f98dKdlyJGdJW+wpFn/cHb+7++4um8TUYLmXRl+L5Dwxja+N8y5Vgtepks4nk0SAy6ys6RAeeX95MZ9b8yAFWPZJwsoBHaq55RV4sC45/7xJJB392oBd457GHfwMfyaJy0qoeHK+Sfy6pnXnrdRFst1ONt1RY1E6LU4SC18baQGty7lyMDkUfWjbX6XMSpZLUIJ5wxoHbFWCZp045ktgFlyjvJs+05SaF/BCMy4YXWK6qRaI0Ur6UuqgGpel5h5EawRD7EbtkNpDAXZgSOrkPy+15mM0w+TdywkaC76xmqHzg63PNsIBt1n5YjziNYbhUT2N+/0k8bygGNrFYoJrDrLGSr8OscUbxFJ7ucSve7qB76qNduBI4unJCf3JDFqvPf3kda1kFoJ89sWRRZuhBWbxBbIQyJZSwssorfWYjLeePqvhm++diu5PtnQMHqRp3OhmZho9fg2fbOHInjeeq5RcNy7VeW59KrWAb6P7oMXR3W3fu5/js3qP6EzeG3hozqHyvipyrvSKdM33uAZ1ITB7tnBrOQWS9FC5MeifIKVbzHWuMFHs0J3Lkfgm/VzcaIXh5W0DeyuvL8m6GPqDWJ0kC+4gFXq499i8y4+s0WTaKhBUfIRj3ALjWQbOyYXCHCSRiFSaK7NKnWqKUa29cD5y6LH6uZUGs0ciHS54tsxKrjUoRpeZeUCzBPo686wnOWwOkKGgJDBzOjWCySTJja04hmzSNFIQ9TdK8QWB2d73yqUOLGpNj+KKV9MYQ21Ijvms4t9k1VTJ+emvZ7+fvXn929nvuCh1XHy1W33zGI07JOIgnaGxDHVFgnQTpGjpOtbGX1wICHWEqBtriZ3WS/qs+BIlNOg8X3IfduOl4FH9Cy4Zw9CHQcH85vb673DdTdkl5Jx4H6UjT52QNNB7UStgwpCAzCiFsRxqB0rKuIoS9uYSTsX/iFPxDJx4t1iApq4CV3NrqoBQYU1T/wCA4f4hgmcvRDCKYOT0gGVtZcXtulsv+tDGgpVWRoQQBU1gfU5iohD1cSwgIjDaowzouIMo6WJ+fRHy+wPJ6dL7Zwutcp66pq6N7deKhTEKuB7pkbAhAk1JKSYIk4BXxGOCVQirfJXzzCNCXY1t2SDjmi1CEgi2WBNRIKtTQ8WxtFcSwcZDXIvgy7ubu3kQ3OVOzZ1bYQ82ZXcUOa40DTZoBmmFhLa2MJkzrro4j86U+E2QRUGSXNZyfMkfkDujKoGFKQPUqHNZYCTgszi6GTXbFXEe3xmAkbdmUmfGEuJRvQUi46hfUtxoz6V2/ZdNBzVxwMED5p507S6WnPtDB97ExuZtsBdFP5Ldazn2lXFYOkEMZL2nfj3IO3Q5BcnZD7ZFhxI/YX0VMTSurDXDQqsRmNCHp0D7zynt+947ydoMGe4g10hSy9W8r2+7h2dvWrTsKB6vfyIe74jwZMYwN48AIgDDSo2Wu+Ov7YdFK6AXCK3SJ55J5AC+NDTaFe2Y5kv8mHXN9YwGvRn1bKEmx+GtsYrO8FrOHl7Pkm2vAb8lQOKLem34zvbS+7rr7wMJIY22LaXUuQknW+v31ycJaY42n56cnk3fTE8HCH/gy8A3h7zkZFWrML2EvM2CI9FjhHRSglLmj8LsNE2lIbzRy1gyAuTtVPPh+g5FxGfTE9z5bFZg4WgW08xUs56I2f7XQpnFDFXp2fvrt1cfb6/CMwnViuue8A5qRlCzsZm6F4bHxusWX4+9+KxWqDT0SVbFGYV82huY8ImoCv9QtJS4RLubDdH8n1Ztt7QcJzXytpAuEPBuklvCej+tP3DVQMyZkaNHn/HSSXz0fdGQ3v8CvtOYF8/jT1jT/jvgOy157iz+HwZ0/wb4bjwezeNPqNsN/Htd9/SBI1Zo63ECxxjDKYHaT4ymeIsalNr3bg3IlaTsuOndFeUfpVa/gYncMel+kPSuhOh1TzZGdjhxZ5agMbo70z19oyKkxn8BVR6LSQ==
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={"outposts_ldap_list"}
>
</Heading>
<MethodEndpoint
method={"get"}
path={"/outposts/ldap/"}
>
</MethodEndpoint>
LDAPProvider 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>
</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={"base_dn"}
required={false}
schemaName={"string"}
qualifierMessage={undefined}
schema={{"type":"string","description":"DN under which objects are accessible."}}
>
</SchemaItem><SchemaItem
collapsible={false}
name={"bind_flow_slug"}
required={true}
schemaName={"string"}
qualifierMessage={undefined}
schema={{"type":"string"}}
>
</SchemaItem><SchemaItem
collapsible={false}
name={"application_slug"}
required={true}
schemaName={"string"}
qualifierMessage={undefined}
schema={{"type":"string","description":"Prioritise backchannel slug over direct application slug","readOnly":true}}
>
</SchemaItem><SchemaItem
collapsible={false}
name={"certificate"}
required={false}
schemaName={"uuid"}
qualifierMessage={undefined}
schema={{"type":"string","format":"uuid","nullable":true}}
>
</SchemaItem><SchemaItem
collapsible={false}
name={"tls_server_name"}
required={false}
schemaName={"string"}
qualifierMessage={undefined}
schema={{"type":"string"}}
>
</SchemaItem><SchemaItem
collapsible={false}
name={"uid_start_number"}
required={false}
schemaName={"integer"}
qualifierMessage={"**Possible values:** `>= -2147483648` and `<= 2147483647`"}
schema={{"type":"integer","maximum":2147483647,"minimum":-2147483648,"description":"The start for uidNumbers, this number is added to the user.pk to make sure that the numbers aren't too low for POSIX users. Default is 2000 to ensure that we don't collide with local users uidNumber"}}
>
</SchemaItem><SchemaItem
collapsible={false}
name={"gid_start_number"}
required={false}
schemaName={"integer"}
qualifierMessage={"**Possible values:** `>= -2147483648` and `<= 2147483647`"}
schema={{"type":"integer","maximum":2147483647,"minimum":-2147483648,"description":"The start for gidNumbers, this number is added to a number generated from the group.pk to make sure that the numbers aren't too low for POSIX groups. Default is 4000 to ensure that we don't collide with local groups or users primary groups gidNumber"}}
>
</SchemaItem><SchemaItem
collapsible={false}
name={"search_mode"}
required={false}
schemaName={"LDAPAPIAccessMode (string)"}
qualifierMessage={"**Possible values:** [`direct`, `cached`]"}
schema={{"enum":["direct","cached"],"type":"string","title":"LDAPAPIAccessMode"}}
>
</SchemaItem><SchemaItem
collapsible={false}
name={"bind_mode"}
required={false}
schemaName={"LDAPAPIAccessMode (string)"}
qualifierMessage={"**Possible values:** [`direct`, `cached`]"}
schema={{"enum":["direct","cached"],"type":"string","title":"LDAPAPIAccessMode"}}
>
</SchemaItem><SchemaItem
collapsible={false}
name={"mfa_support"}
required={false}
schemaName={"boolean"}
qualifierMessage={undefined}
schema={{"type":"boolean","description":"When enabled, code-based multi-factor authentication can be used by appending a semicolon and the TOTP code to the password. This should only be enabled if all users that will bind to this provider have a TOTP device configured, as otherwise a password may incorrectly be rejected if it contains a semicolon."}}
>
</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 \"base_dn\": \"string\",\n \"bind_flow_slug\": \"string\",\n \"application_slug\": \"string\",\n \"certificate\": \"3fa85f64-5717-4562-b3fc-2c963f66afa6\",\n \"tls_server_name\": \"string\",\n \"uid_start_number\": 0,\n \"gid_start_number\": 0,\n \"search_mode\": \"direct\",\n \"bind_mode\": \"direct\",\n \"mfa_support\": true\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>