Documentation

CreateOpenIdConnection

Registers a relationship between a title and an Open ID Connect provider.

Request Details

CreateOpenIdConnectionRequest
Request Properties
ClientId (required) String

The client ID given by the ID provider.

ClientSecret (required) String

The client secret given by the ID provider.

ConnectionId (required) String

A name for the connection that identifies it within the title.

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 OpenIdIssuerInformation

Manually specified information for an OpenID Connect issuer.

POST https://{{TitleID}}.playfabapi.com/Admin/CreateOpenIdConnection
    Content-Type: application/json
    X-SecretKey: <developer_secret_key>
{
  "ConnectionId": "oidconnection1",
  "ClientId": "example_id_1",
  "ClientSecret": "example_secret_1",
  "IssuerInformation": {
    "Issuer": "https://issuer.example.com/",
    "AuthorizationUrl": "https://issuer.example.com/authorize",
    "TokenUrl": "https://issuer.example.com/oauth2/token",
    "JsonWebKeySet": {
      "keys": [
        "..."
      ]
    }
  }
}
        

Response Details

EmptyResponse
Result Properties

Sample Response

HTTP/1.1 200 OK
Content-Type: application/json; charset=utf-8


Authentication

SecretKey

Possible Error Codes

Name Code