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

353 lines
12 KiB
Plaintext

---
id: sources-ldap-debug-retrieve
title: "sources_ldap_debug_retrieve"
description: "Get raw LDAP data to debug"
sidebar_label: "sources_ldap_debug_retrieve"
hide_title: true
hide_table_of_contents: true
api: eJy1VVtr2zAU/itCTxuYuLR9GHlaWUMJtFvpZS+lBNk+jdXIkirJ2ULwf985st045MJg65Ml61y+852jT2tuLDgRpNHTgo+5N7XLwc9UIeysgKyezxwEJ2EJPOEF+NxJS9ZoewWBOfGLXV9e3LJCBMGCYdEHTa1wooIAzvPx05pLcrAilHik8YBSqWjo8xIqwcdrHlY2/sd0er6TbaoxmBaKtRAZRUlY7aFgUrPHu2s/4k3CHbzV0gHWElwNzXPCg5gThr40jr885LWTYRWhiTqUoINc4O6ZHBx4a7RHUwR1enJCn9xgeh1oKaxVMo+Upa+esK13izDZK+SBeHBEcJBtNITrBlbCObFCIxmg8vu8RVFISiTU7TBOEwsVxQ+tVl2hCZ87U9uPCl5BlWEvS/lBGbY699TVspU2acmjhsqgKA3N3WUct4b8t8eFZuH8H3u3HfGnULKIrmzinHE7zdVGz14kqGIGdO7/gqlu1gl+bgrYf3KIxQ0TG2gtsoN8nP1HPq5Ag5M5u7idHiCkgCCk2lPUsWqHY9AFGPS8S3qkzDisoTSkZnOIV5BkZ8zTTgBS0rZ0TfLTpFGuUpIhcMterGqnyF5YmS7PUt4MFOOeyGmrG+jGex1lCLbXNNpnIBy4CErqFxMtu0o27gmnzC3+05PT89GX0ekO2zdigQyx3qvtGfOysgpGPIlNFXlsKnaPWOclKGW+zs17ppE0xD12HFDe4si2UnwzfaD7FcumEvw4TecylHU2yk2VDkKkm1WmTJZiKp1eT79Nvt9PYpnW+FAJPQje0c6I9vZ5YIeelMFsHn9dOroD/A6pVYiB6or41127N3qPBWNm/Iy7F6cPQnNVIlwyXq8z4eHRqaah3281OHodcLkUToqMWoaTUUhPa5ytF6E8HIH/6a6b48/sEN5eGzQpw1Komna4XMCqfx6bZ7QrUSrp2cD87dFFnoMNA6eda0wj+34LribUXWrcYFK7yUz6BUXfCwiZiRYPZgEa2enxBdoTwKb5A/PN2Co=
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_debug_retrieve"}
>
</Heading>
<MethodEndpoint
method={"get"}
path={"/sources/ldap/{slug}/debug/"}
>
</MethodEndpoint>
Get raw LDAP data to debug
<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={"user"}
required={true}
schemaName={"object[]"}
qualifierMessage={undefined}
schema={{"type":"array","items":{"type":"object","additionalProperties":{}},"readOnly":true}}
>
</SchemaItem><SchemaItem
collapsible={false}
name={"group"}
required={true}
schemaName={"object[]"}
qualifierMessage={undefined}
schema={{"type":"array","items":{"type":"object","additionalProperties":{}},"readOnly":true}}
>
</SchemaItem><SchemaItem
collapsible={false}
name={"membership"}
required={true}
schemaName={"object[]"}
qualifierMessage={undefined}
schema={{"type":"array","items":{"type":"object","additionalProperties":{}},"readOnly":true}}
>
</SchemaItem>
</ul>
</details>
</TabItem><TabItem
label={"Example (from schema)"}
value={"Example (from schema)"}
>
<ResponseSamples
responseExample={"{\n \"user\": [\n {}\n ],\n \"group\": [\n {}\n ],\n \"membership\": [\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>