Get organization service provider SAML2 metadata.xml for configuring the identity provider

GET /organizations/{organization_id}/idp/metadata.xml
Basic auth Api key

Gets the oranization's IdP metadata.xml. Currently unavailable in self-hosted ECE.

Path parameters

Responses

  • 200 application/xml

    The IdP info
  • 404 application/xml

    IdP was not configured yet. (code: org.idp.idp_not_configured)

    Hide headers attribute Show headers attribute
    • x-cloud-error-codes string

      The error codes associated with the response

      Value is org.idp.idp_not_configured.

    Hide response attribute Show response attribute object
    • errors array[object] Required

      A list of errors that occurred in the failing request

      Hide errors attributes Show errors attributes object
      • code string Required

        A structured code representing the error type that occurred

      • message string Required

        A human readable message describing the error that occurred

      • fields array[string]

        If the error can be tied to a specific field or fields in the user request, this lists those fields
GET /organizations/{organization_id}/idp/metadata.xml 
curl \
 --request GET 'https://{{hostname}}/api/v1/organizations/{organization_id}/idp/metadata.xml' \
 --user "username:password"
Response examples (200) 
string
Response examples (404) 
# Headers
x-cloud-error-codes: org.idp.idp_not_configured

# Payload
<?xml version="1.0" encoding="UTF-8"?>
<root>
  <errors type="array">
    <error>
      <code>string</code>
      <message>string</message>
      <fields type="array">
        <field>string</field>
      </fields>
    </error>
  </errors>
</root>