Share via


Authentication - List OpenId Connection

Retrieves a list of all Open ID Connect providers registered to a title.

POST https://titleId.playfabapi.com/Admin/ListOpenIdConnection

Request Header

Name Required Type Description
X-SecretKey True

string

This API requires a title secret key, available to title admins, from PlayFab Game Manager.

Responses

Name Type Description
200 OK

ListOpenIdConnectionResponse

400 Bad Request

ApiErrorWrapper

This is the outer wrapper for all responses with errors

Security

X-SecretKey

This API requires a title secret key, available to title admins, from PlayFab Game Manager.

Type: apiKey
In: header

Definitions

Name Description
ApiErrorWrapper

The basic wrapper around every failed API response

ListOpenIdConnectionRequest
ListOpenIdConnectionResponse
OpenIdConnection
OpenIdIssuerInformation

ApiErrorWrapper

The basic wrapper around every failed API response

Name Type Description
code

integer

Numerical HTTP code

error

string

Playfab error code

errorCode

integer

Numerical PlayFab error code

errorDetails

object

Detailed description of individual issues with the request object

errorMessage

string

Description for the PlayFab errorCode

status

string

String HTTP code

ListOpenIdConnectionRequest

ListOpenIdConnectionResponse

Name Type Description
Connections

OpenIdConnection[]

The list of Open ID Connections

OpenIdConnection

Name Type Description
ClientId

string

The client ID given by the ID provider.

ClientSecret

string

The client secret given by the ID provider.

ConnectionId

string

A name for the connection to identify it within the title.

DiscoverConfiguration

boolean

Shows if data about the connection will be loaded from the issuer's discovery document

IgnoreNonce

boolean

Ignore 'nonce' claim in identity tokens.

IssuerInformation

OpenIdIssuerInformation

Information for an OpenID Connect provider.

IssuerOverride

string

Override the issuer name for user indexing and lookup.

OpenIdIssuerInformation

Name Type Description
AuthorizationUrl

string

Authorization endpoint URL to direct users to for signin.

Issuer

string

The URL of the issuer of the tokens. This must match the exact URL of the issuer field in tokens.

JsonWebKeySet

object

JSON Web Key Set for validating the signature of tokens.

TokenUrl

string

Token endpoint URL for code verification.