authentik/website/docs/developer-docs/api/reference/providers-saml-metadata-retrieve.api.mdx

---
id: providers-saml-metadata-retrieve
title: "providers_saml_metadata_retrieve"
description: "Return metadata as XML string"
sidebar_label: "providers_saml_metadata_retrieve"
hide_title: true
hide_table_of_contents: true
api: eJytVl1v2zoM/SuCnu4ALy6yPgx+usVQbAWaNWi74QJDEcgWE2tVJE+Ss2WB//sl/d3G2YZtT7YskTw8PCJ94LYAJ4Ky5kryhBfO7pQE51debPVqC0FIEcTKQXAKdsAjLsFnThVkgga3EEpnWHeQCc/+W1wzj8fNBk8XwgncRI88+XTgimy+lOD2uGdwB5fSfjXaColffJbDVvDkwMO+oL3UWg3C8KqKpo3X1mWwSpWRTbwjDz0SMOUWMXCEm1jhlU/IhU9CltxdLK6T+ewsaf345N39/fLl8ubuHg1/3eAWpHKQBf5QPefppn4RWu9ZDZmFHAbWgmXW4JYymS4l4AJY63rG+9QLEfIhczVJmDIBNuD4EYALVhqF5LH2BNsJTSsJJqj1HiMhJOUZpcaWrQxmGMLBlxKzQnUEV0L1EPEgNlTNQSwcP3rISqfCvi6zKDE99PuIK+TiQFYOfGGNB09o52dn9MgsgjGBXkVRaJXVSow/e4J8OM7Opp+J3ue5PcHMFh2rHpwSWn1HOiICi0oPqonfMT8lFAdC3mA12oSjXqCr0ulfMKjGnH16ah0NkYlIFTS0+DvUKPWj2lE1z/8qYx+RF1mbskvn7DFBxprVWoGWK6B9P3IpnBN0A1WArT/mg+BnVsL0jpBSNTdhOY5XDWQM0BpkJ/l49Rf5eAsGxZKxi+XVCUIk1kdNlP+H2T7RQeNgVPY26E/SPG+ijzd6qefYbo1lo8yxAXu1MRiS/KHYckt9fQOhbsbYQBIe9xc3pi4fH5Ss4k6XMXUVcLuuY9ea57EoVLx7FfNqdNXviNyGndGF73nIQyi6FlX3chCOOhPiUmZt65MtE4N5xClyk+b8bH4+ez2bH1VrIR6pX3VWbeZebQsN1LJIFCKrRYHVp6rxHLS2/25sH2mmLPGLvAE2pVryTV9dXDVNX7cp+CSONyrkZTrL7DYeuYiHt1TbNMZQJr6+enP5/u6yTrOwPmyFGTnvmWfE/DAATs3XkcB/Ompb2gN8C3GhEQvl17aspvLjlo2FQQT4SOpB0reliJNEc0RO5w+HVHj44HRV0edm+JIspPIi1aTstdAeIv4I+6ezvJ4vjYonjp/M8g8G5QkKGmTPfxQGeA+0wEmRkhSnUjuJ9Z/b9n6/YL89Xichd53W7MdIu1SwYBX9YeQ4d/BCEeZm4yLLoAgjk6OWSMn2TeHtJSmdRDz+42puadS9kPdJOCiN+sS9fQSD8ujQBVoTwKr6H+YvlV0=
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={"providers_saml_metadata_retrieve"}
>
</Heading>

<MethodEndpoint
  method={"get"}
  path={"/providers/saml/{id}/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":"id","schema":{"type":"integer"},"description":"A unique integer value identifying this SAML Provider.","required":true}}
      >
        
      </ParamsItem>
    </ul>
  </div>
</details><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":"download","schema":{"type":"boolean"}}}
      >
        
      </ParamsItem><ParamsItem
        className={"paramsItem"}
        param={{"in":"query","name":"force_binding","schema":{"type":"string","enum":["urn:oasis:names:tc:SAML:2.0:bindings:HTTP-POST","urn:oasis:names:tc:SAML:2.0:bindings:HTTP-Redirect"]},"description":"Optionally force the metadata to only include one binding."}}
      >
        
      </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><TabItem
        label={"404"}
        value={"404"}
      >
        <div>
          
          
          Provider has no application assigned
          
          
        </div><div>
          
        </div>
      </TabItem>
    </ApiTabs>
  </div>
</div>