- API >
- Cloud Manager Administration API Resources >
- Federated Authentication Configuration >
- Return One Identity Provider’s Metadata
Return One Identity Provider’s Metadata¶
On this page
The federationSettings
resource allows you to return the contents of the
SAML metadata XML file for one identity provider in the specified federation.
Required Roles¶
You must have the Organization Owner
role for at least one
connected organization in the federation configuration to call this
endpoint.
Resource¶
Request Path Parameters¶
Name | Type | Description |
---|---|---|
FEDERATION-SETTINGS-ID |
string | Unique 24-hexadecimal digit string that identifies the federated authentication configuration. |
IDP-ID |
string | Unique 20-hexadecimal digit string that identifies the IdP. |
Request Query Parameters¶
The following query parameters are optional:
Name | Type | Necessity | Description | Default | ||||||
---|---|---|---|---|---|---|---|---|---|---|
pretty | boolean | Optional | Flag indicating whether the response body should be in a prettyprint format. | false |
||||||
envelope | boolean | Optional | Flag that indicates whether or not to wrap the response in an envelope. Some API clients cannot access the HTTP response headers or status code. To remediate this, set envelope=true in the query. For endpoints that return one result, the response body includes:
|
false |
Request Body Parameters¶
This endpoint doesn’t use HTTP request body parameters.
Response¶
File Type | Description |
---|---|
XML | Metadata for the IdP. |