POST (/users/{requestorId}/permission/validate)
ユーザーが指定されたアクションをターゲット ユーザーのセットに対して実行することを許可されているかどうかについて、Yes または No の回答のセットを取得します。
解説
要求本文は、ユーザーのリストと設定のリストを受け取ります。結果は、ユーザー/設定の各ペアに対する許可/禁止結果です。
ネットワーク経由のマルチプレイヤー シナリオでは (Xbox ユーザー ID (XUID) を持つユーザーと、そうでないネットワーク外のユーザーの間でプライバシー通信のチェックを行う必要がある場合)、ユーザーの型については「PermissionCheckBatchRequest (JSON)」を参照してください。
URI パラメーター
| パラメーター | 型 | 説明 |
|---|---|---|
| requestorId | 文字列 | 必須。 アクションを実行するユーザーの識別子。 有効な値は xuid({xuid}) および me です。 これはログインしているユーザーでなければなりません。 値の例: xuid(0987654321)。 |
承認
| 使用される承認クレーム | クレーム | 種類 | 必須かどうか | 値の例 |
|---|---|---|---|---|
| Xuid | 64 ビット符号付き整数 | ○ | 1234567890 |
必須の要求ヘッダー
| ヘッダー | 型 | 説明 |
|---|---|---|
| Authorization | 文字列 | HTTP 認証用の認証資格情報。 値の例: XBL3.0 x=<userhash>;<token> |
| X-RequestedServiceVersion | 文字列 | この要求の送信先である Xbox LIVE サービスのビルド名/番号。 要求は、ヘッダー、認証トークン内のクレームなどの有効性が確認された後でのみ、そのサービスにルーティングされます。値の例: 1。 |
リクエストの本文
必須メンバー
「PermissionCheckBatchRequest (JSON)」を参照してください。
{
"users":
[
{"xuid":"12345"},
{"xuid":"54321"}
],
"permissions":
[
"ViewTargetGameHistory",
"ViewTargetProfile"
]
}
HTTP ステータス コード
サービスは、このリソースに対してこのメソッドで実行された要求に応答して、このセクションのステータス コードのいずれかを返します。 Xbox Live サービスで使用される標準 HTTP ステータス コードの一覧については、「標準 HTTP ステータス コード」を参照してください。
| コード | 理由 | 説明 |
|---|---|---|
| 200 | OK | セッションは正常に取得されました。 |
| 400 | 要求が無効です。 | 例: 誤った設定 ID、誤った URI など。 |
| 404 | URI に指定されたユーザーは存在しません。 | 指定されたリソースが見つかりませんでした。 |
必須の応答ヘッダー
| ヘッダー | 型 | 説明 |
|---|---|---|
| Content-Type | 文字列 | 要求の本文の MIME タイプ。 値の例: application/json |
| Content-Length | 文字列 | 応答で送信されるバイト数。 値の例: 34 |
| Cache-Control | 文字列 | キャッシュ動作を指定するためのサーバーからの正式な要求。 例: no-cache, no-store |
応答の本文
「PermissionCheckBatchResponse (JSON)」を参照してください。
サンプル応答
{
"responses":
[
{
"user": {"xuid":"12345"},
"permissions":
[
{
"isAllowed":true
},
{
"isAllowed":true
}
]
},
{
"user": {"xuid":"54321"},
"permissions":
[
{
"isAllowed":false,
"reasons":
[
{"reason":"NotAllowed"}
]
},
{
"isAllowed":false,
"reasons":
[
{"reason":"PrivilegeRest", "restrictedSetting":"AllowProfileViewing"}
]
}
]
}
]
}