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:

Show:
graphql
query {
  fetchSamlMetadataFromDiscoveryEndpoint(
     discoveryEndpoint: "https://saml.company.com"
     )
  {entityID, signOnUrl, certificate}
}

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

ParameterTypeRequiredDefaultStabilityDescription
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
certificatestringyes Long-TermThe SAML authentication certificate.
entityIDstringyes Long-TermThe unique identifier of the entity.
signOnUrlstringyes Long-TermThe URL where the sign on page can be found.