Files
authentik/website/docs/developer-docs/api/reference/sources-saml-metadata-retrieve.api.mdx
2024-09-13 12:17:54 -05:00

345 lines
12 KiB
Plaintext

---
id: sources-saml-metadata-retrieve
title: "sources_saml_metadata_retrieve"
description: "Return metadata as XML string"
sidebar_label: "sources_saml_metadata_retrieve"
hide_title: true
hide_table_of_contents: true
api: eJytVdtqGzEQ/RWhpxYWK03yUPzUUEwwxG3IpRRCMOPdiVexLG0krVvX7L93Zi/2GjtpH/JkaTWXM2dmjjfSFeghamfHmRzK4EqfYpgGWJrpEiNkEGHqMXqNK5SJzDCkXhfsQOY3GEtvRWcoIIifkysRyNzOyboAD/SIPsjhw0Zq9ikg5vRk6YETmpINQ5rjEuRwI+O6qL93IfYTji0Fs2BEA1RwlESUATOhrbi/uQoDWSXS40upPVJF0ZdYPSYywpwxdAVK+hQwLb2O6xoalDFHG/WCbo/s4DEUzgYyJVCnJyf8kzpKbyMfoSiMTmvi1HNgbJvDItzsGdN4UMTtBXF07d1KZ+jFpCMvoNdg9B/0zJznxkTd5O8IPkaQR8i+W7Nua6Vk7pc1DrJp6c1/OOzR9bDvnewyM4c6Gmzxd6hlxQH26+MOnL8rYz+Il6x2FSPv3SFB1tnpk0aTTZHfQy8keA9rctARl+GQD4afugyPv0CWaU4L5rqfr9qRsYPWIHuVj7N35OMSLQ1LKi6ux68QklF/9JH2v1nt3hw0AXptb5O+UWZVz0vuWEnmGGsBoGUfStWunWJdURte+kp1o6V4/9GvOpWox1YqKLRanSlZ9Vb1lvlpCuwt7LaUPMaiExO+zxA8+hqXtk+utmyL2bknkjM3JZyenJ4PPg8+HRA+gQWRJDqvpm0i6GVhcCCTuq+Q1n2lBjLxMkdj3Je522YaaMf0U9ORdKWe2kYDJ+M7CtGUzSWEoVJzHfNyNkjdUvVCqN1pZtxMUSqrrsZfR99uR3WZhQtxCbYXvGVeMPM7oX5N0XsT+k9xb0mP+DuqwhASrq7VnKbvO7mlplB++hm2gr/VlUTyjOWEm+03mxkEvPemqvjzS4me9ZmOKyB1nHHvaEQyHfhMc/YEJuAbRXy4aWf6o3gNcqcTllViBabkGx0XuO7+oKpHsstJN2maOH/zdJGmWMSe08FK8+xuN+JyxG3mDvZGth3RpDtw9KOAiJna4s4t0BI7Hb7IdwZYVX8B/xGxLA==
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 Markdown from "@theme/Markdown";
import Heading from "@theme/Heading";
import OperationTabs from "@theme/OperationTabs";
import TabItem from "@theme/TabItem";
<Heading
as={"h1"}
className={"openapi__heading"}
children={"sources_saml_metadata_retrieve"}
>
</Heading>
<MethodEndpoint
method={"get"}
path={"/sources/saml/{slug}/metadata/"}
>
</MethodEndpoint>
Return metadata as XML string
<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={"metadata"}
required={true}
schemaName={"string"}
qualifierMessage={undefined}
schema={{"type":"string","readOnly":true}}
>
</SchemaItem><SchemaItem
collapsible={false}
name={"download_url"}
required={true}
schemaName={"string"}
qualifierMessage={undefined}
schema={{"type":"string","readOnly":true}}
>
</SchemaItem>
</ul>
</details>
</TabItem><TabItem
label={"Example (from schema)"}
value={"Example (from schema)"}
>
<ResponseSamples
responseExample={"{\n \"metadata\": \"string\",\n \"download_url\": \"string\"\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>