Documentation

UpdatePlayerSharedSecret

Updates a existing Player Shared Secret Key. It may take up to 5 minutes for this update to become generally available after this API returns.

Request Details

Player Shared Secret Keys are used for the call to Client/GetTitlePublicKey, which exchanges the shared secret for an RSA CSP blob to be used to encrypt the payload of account creation requests when that API requires a signature header.

UpdatePlayerSharedSecretRequest
Request Properties
Disabled (required) Boolean

Disable or Enable this key

FriendlyName String

Friendly name for this key

SecretKey String

The shared secret key to update

POST https://{{TitleID}}.playfabapi.com/Admin/UpdatePlayerSharedSecret
    Content-Type: application/json
    X-SecretKey: <developer_secret_key>
{
  "SecretKey": "keysaresecret",
  "FriendlyName": "XBox Users",
  "Disabled": false
}
        

Response Details

UpdatePlayerSharedSecretResult
Result Properties

Sample Response

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


Authentication

SecretKey

Possible Error Codes

Name Code