API Stability |
Long-Term
|
The fetchSamlMetadataFromDiscoveryEndpoint() GraphQL query field will fetch the SAML metadata from a discovery endpoint provided.
For more information on SAML, see the Configuration & Authentication with SAML documentation page. You may also want to look at Authentication & Identity Providers for related information.
Syntax
Below is the syntax for the fetchSamlMetadataFromDiscoveryEndpoint() query field:
graphql
fetchSamlMetadataFromDiscoveryEndpoint(
discoveryEndpoint: string!
): SamlMetadata!
Below is an example of this query, along with requests for several return parameters:
Returned Datatypes
The returned datatype SamlMetadata
has only
a few parameters. Below is a list of them along with a description
of each:
Table: SamlMetadata
Parameter | Type | Required | Default | Stability | Description |
---|---|---|---|---|---|
Some arguments may be required, as indicated in the Required column. For some fields, this column indicates that a result will always be returned for this column. | |||||
Table last updated: Mar 19, 2025 | |||||
certificate | string | yes | Long-Term | The SAML authentication certificate. | |
entityID | string | yes | Long-Term | The unique identifier of the entity. | |
signOnUrl | string | yes | Long-Term | The URL where the sign on page can be found. |