API Stability Long-Term

The findIdentityProvider() GraphQL query finds information on the identity provider.

For more information on identity providers, see the Authentication & Identity Providers documentation page.

Syntax

Below is the syntax for the findIdentityProvider() query field:

graphql
findIdentityProvider(
     email: string!
   ): IdentityProviderAuth!

The IdentityProviderAuth return datatype is used to return information about the identity provider. They're listed in a table in the Return Datatype section. Below is an example of how those parameters are entered:

Show:
graphql
query {
  findIdentityProvider(email: "bob@company.com") {
    id, name, authenticationMethod
  }
}

Returned Datatypes

The returned datatype IdentityProviderAuth has a few parameters. Below is a list of them along with their datatypes and a description of each:

Table: IdentityProviderAuth

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: Sep 25, 2024
authenticationMethodAuthenticationMethodAuthyes Long-TermThe authentication method of the authentication provider. See AuthenticationMethodAuth.
idstringyes Long-TermThe unique identifier of the authentication provider.
namestringyes Long-TermThe name of the authentication provider.