Overview
Unban users so they can connect again. You can remove bans by platform, device, or user, enabling flexible access control.
Request
Authentication: Add authentication headers to the request. See Authentication.
Method:
POST
Rate limit:
100 requests/second
Endpoint: https://API domain/apigateway/users/banusers/unban
Content-Type:
application/json
Request Parameters
| Parameter | Data Type | Required | Description | |
|---|---|---|---|---|
| items | array | Yes | List of users to unban. | |
| items[].user_id | string | Yes | ID of the user to unban. Maximum length: 32 characters. | |
| items[].scope_key | string | No | Ban scope to remove. If omitted, bans are removed from all scopes. Valid values: default for a user ban; platform for bans on specified platform types; device for bans on specified devices; and ip for bans from specified IP addresses. Maximum length: 20 characters. |
Request Example
POST /apigateway/users/banusers/unban HTTP/1.1
appkey: appkey
signature: 2e639ae3600a4sdff61fb88b76f485b
nonce: nonce
timestamp: 1672568121910
Content-Type: application/json
{
"items":[
{
"user_id":"user1",
"scope_key":"default"
},
{
"user_id":"user2"
}
]
}
Response Example
{
"code":0,
"msg":"sucess"
}