Authentication - Update Player Shared Secret

Service:

Admin

API Version:

241122

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.

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

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.

Request Body

Name	Required	Type	Description
Disabled	True	boolean	Disable or Enable this key
FriendlyName		string	Friendly name for this key
SecretKey		string	The shared secret key to update

Responses

Name	Type	Description
200 OK	UpdatePlayerSharedSecretResult
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
UpdatePlayerSharedSecretRequest	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.
UpdatePlayerSharedSecretResult

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

UpdatePlayerSharedSecretRequest

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.

Name	Type	Description
Disabled	boolean	Disable or Enable this key
FriendlyName	string	Friendly name for this key
SecretKey	string	The shared secret key to update

UpdatePlayerSharedSecretResult