POST /ban/{player_identifier}

端点: POST /v1/pdapi/ban/<player_identifier>

认证: Bearer 令牌

权限: REST.Punishments.Ban

用途

封禁用户并将记录写入 Banlist.json。如果目标当前在线，可能会被踢出。

player_identifier: UserId, PlayerUID, or another supported player identifier.

无。

可选 JSON 字段：字符串 Reason 和布尔值 IP。只有在同时想封禁解析出的 IP 地址时，才将 IP 设为 true。

Field	Type	Description
`Success`	boolean	`true` when the ban was recorded.
`UserId`	string	User ID that was banned.
`IP`	boolean	Whether the request also banned an IP address.
`BannedIP`	string	Banned IP address, or an empty string when no IP was banned.
`Kicked`	integer	Number of online players kicked by the ban action.

错误响应使用以下格式:

{
    "Error": {
        "Code": "ERROR_CODE",
        "Message": "人类可读的消息",
        "详情": {}
    }
}

HTTP	错误代码	发生条件
`401`	`INVALID_TOKEN`	`Authorization` 头缺失、格式错误，或与配置的 Bearer 令牌不匹配。
`403`	`MISSING_PERMISSION`	令牌有效，但不包含此端点权限。
`400`	`INVALID_JSON`	提供了请求体，但无法解析为 JSON。
`400`	`REQUEST_FAILED`	游戏线程回调抛出异常，或共享玩家/资源解析器失败。
`500`	`REQUEST_TIMEOUT`	内部游戏线程回调未在 5 秒内完成。
`400`	`VALIDATION_FAILED`	An optional request field has the wrong JSON type.
`400`	`IP_UNAVAILABLE`	`IP` was `true`, but the server could not resolve an IP for the target user.

POST /v1/pdapi/ban/steam_76561198012345678

{
    "Reason": "Chargeback fraud"
}

POST /v1/pdapi/ban/ps5_0f4b8c2d91aa34ef

{
    "Reason": "Ban evasion",
    "IP": true
}