GET (/users/{requestorId}/permission/validate)
- [アーティクル]
-
-
ユーザーが指定されたアクションをターゲット ユーザーに対して実行することを許可されているかどうかについて、Yes または No の回答を取得します。
URI パラメーター
パラメーター |
型 |
説明 |
requestorId |
文字列 |
必須。 アクションを実行するユーザーの識別子。 有効な値は xuid({xuid}) および me です。 これはログインしているユーザーでなければなりません。 値の例: xuid(0987654321) 。 |
クエリ文字列パラメーター
パラメーター |
型 |
説明 |
setting |
文字列列挙型 |
チェックするアクセス権 ID の値。 値の例: "CommunicateUsingText" |
target |
文字列 |
アクションの実行対象となるユーザーの識別子。 有効な値は xuid({xuid}) です。 値の例: xuid(0987654321) |
承認
使用される承認クレーム |
クレーム |
種類 |
必須かどうか |
値の例 |
Xuid |
64 ビット符号付き整数 |
○ |
1234567890 |
|
ヘッダー |
型 |
説明 |
Authorization |
文字列 |
HTTP 認証用の認証資格情報。 値の例: XBL3.0 x=<userhash>;<token> |
X-RequestedServiceVersion |
文字列 |
この要求の送信先である Xbox LIVE サービスのビルド名/番号。 要求は、ヘッダー、認証トークン内のクレームなどの有効性が確認された後でのみ、そのサービスにルーティングされます。値の例: 1。 |
リクエストの本文
この要求の本体で送信されるオブジェクトはありません。
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 |
応答の本文
「PermissionCheckResponse (JSON)」を参照してください。
サンプル応答
{
"isAllowed": false,
"reasons":
[
{"reason": "BlockedByRequestor"},
{"reason": "MissingPrivilege", "restrictedSetting": "VideoCommunications"}
]
}
関連項目
親
/users/{requestorId}/permission/validate
PermissionId 列挙型