Authentication - List OpenId Connection
Retrieves a list of all Open ID Connect providers registered to a title.
POST https://titleId.playfabapi.com/Admin/ListOpenIdConnection
Name | Required | Type | Description |
---|---|---|---|
X-SecretKey | True |
string |
This API requires a title secret key, available to title admins, from PlayFab Game Manager. |
Name | Type | Description |
---|---|---|
200 OK | ||
400 Bad Request |
This is the outer wrapper for all responses with errors |
This API requires a title secret key, available to title admins, from PlayFab Game Manager.
Type:
apiKey
In:
header
Name | Description |
---|---|
Api |
The basic wrapper around every failed API response |
List |
|
List |
|
Open |
|
Open |
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 |
Name | Type | Description |
---|---|---|
Connections |
The list of Open ID Connections |
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 |
Information for an OpenID Connect provider. |
|
IssuerOverride |
string |
Override the issuer name for user indexing and lookup. |
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. |