Account Management - Revoke Bans
Revoke all active bans specified with BanId.
POST https://titleId.playfabapi.com/Admin/RevokeBansRequest 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 |
|---|---|---|---|
| BanIds | True |
string[] |
Ids of the bans to be revoked. Maximum 100. |
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 |
|
Ban |
Contains information for a ban. |
|
Revoke |
Setting the active state of all bans requested to Inactive regardless of whether that ban has already expired. BanIds that do not exist will be skipped. Returns information about applied updates only. |
|
Revoke |
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 |
BanInfo
Contains information for a ban.
| Name | Type | Description |
|---|---|---|
| Active |
boolean |
The active state of this ban. Expired bans may still have this value set to true but they will have no effect. |
| BanId |
string |
The unique Ban Id associated with this ban. |
| Created |
string |
The time when this ban was applied. |
| Expires |
string |
The time when this ban expires. Permanent bans do not have expiration date. |
| IPAddress |
string |
The IP address on which the ban was applied. May affect multiple players. |
| PlayFabId |
string |
Unique PlayFab assigned ID of the user on whom the operation will be performed. |
| Reason |
string |
The reason why this ban was applied. |
| UserFamilyType |
string |
The family type of the suer that is included in the ban. |
RevokeBansRequest
Setting the active state of all bans requested to Inactive regardless of whether that ban has already expired. BanIds that do not exist will be skipped. Returns information about applied updates only.
| Name | Type | Description |
|---|---|---|
| BanIds |
string[] |
Ids of the bans to be revoked. Maximum 100. |
RevokeBansResult
| Name | Type | Description |
|---|---|---|
| BanData |
Ban |
Information on the bans that were revoked |