POST /ban/{プレイヤー識別子}

エンドポイント: POST /v1/pdapi/ban/<player_identifier>

認証: ベアラートークン

許可: REST.Punishments.Ban

目的

ユーザーを禁止し、Banlist.json に禁止を記録します。現在オンラインの場合、ターゲットはキックされる可能性があります。

なし。

オプションの JSON フィールド: Reason string および 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": "Human-readable message",
        "Details": {}
    }
}

HTTP	エラーコード	それが起こったとき
`401`	`INVALID_TOKEN`	`Authorization` ヘッダーが欠落しているか、形式が不正であるか、構成されたベアラートークンと一致しません。
`403`	`MISSING_PERMISSION`	トークンは有効ですが、このエンドポイント権限が含まれていません。
`400`	`INVALID_JSON`	リクエスト本文が指定されましたが、JSON として解析できませんでした。
`400`	`REQUEST_FAILED`	ゲームスレッドコールバックが例外をスローしたか、共有プレーヤー/リソースリゾルバーが失敗しました。
`500`	`REQUEST_TIMEOUT`	内部ゲームスレッドコールバックは 5 秒以内に完了しませんでした。
`400`	`VALIDATION_FAILED`	オプションのリクエストフィールドの JSON タイプが間違っています。
`400`	`IP_UNAVAILABLE`	`IP` は `true` でしたが、サーバーはターゲットユーザーの IP を解決できませんでした。

POST /v1/pdapi/ban/steam_76561198012345678

{
    "Reason": "Chargeback fraud"
}

POST /v1/pdapi/ban/ps5_0f4b8c2d91aa34ef

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