Authentication - Create OpenId Connection
Registers a relationship between a title and an Open ID Connect provider.
POST https://titleId.playfabapi.com/Admin/CreateOpenIdConnectionRequest Header
| Name | Required | Type | Description |
|---|---|---|---|
| X-SecretKey | True |
string |
This API requires a title secret key, available to title admins, from PlayFab Game Manager. |
Request Body
| Name | Required | Type | Description |
|---|---|---|---|
| ClientId | True |
string |
The client ID given by the ID provider. |
| ClientSecret | True |
string |
The client secret given by the ID provider. |
| ConnectionId | True |
string |
A name for the connection that identifies it within the title. |
| IgnoreNonce |
boolean |
Ignore 'nonce' claim in identity tokens. |
|
| IssuerDiscoveryUrl |
string |
The discovery document URL to read issuer information from. This must be the absolute URL to the JSON OpenId Configuration document and must be accessible from the internet. If you don't know it, try your issuer URL followed by "/.well-known/openid-configuration". For example, if the issuer is https://example.com, try https://example.com/.well-known/openid-configuration |
|
| IssuerInformation |
Manually specified information for an OpenID Connect issuer. |
||
| IssuerOverride |
string |
Override the issuer name for user indexing and lookup. |
Responses
| Name | Type | Description |
|---|---|---|
| 200 OK | ||
| 400 Bad Request |
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 |
|---|---|
|
Api |
The basic wrapper around every failed API response |
|
Create |
|
|
Empty |
|
|
Open |
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 |
CreateOpenIdConnectionRequest
| 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 that identifies it within the title. |
| IgnoreNonce |
boolean |
Ignore 'nonce' claim in identity tokens. |
| IssuerDiscoveryUrl |
string |
The discovery document URL to read issuer information from. This must be the absolute URL to the JSON OpenId Configuration document and must be accessible from the internet. If you don't know it, try your issuer URL followed by "/.well-known/openid-configuration". For example, if the issuer is https://example.com, try https://example.com/.well-known/openid-configuration |
| IssuerInformation |
Manually specified information for an OpenID Connect issuer. |
|
| IssuerOverride |
string |
Override the issuer name for user indexing and lookup. |
EmptyResponse
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. |
Error Codes
| Name | Code |
|---|---|
| ValueAlreadyExists | 1031 |