指定したユーザーがグループのメンバーかどうかを確認します。メンバーシップは直接またはネストできますが、ネストする場合は、memberKey
と groupKey
が同じドメイン内のエンティティでなければなりません。そうでない場合、Invalid input
エラーが返されます。グループのドメイン外のエンティティを含むネストされたメンバーシップを確認するには、Cloud Identity Groups API の checkTransitiveMembership()
メソッドを使用します。
HTTP リクエスト
GET https://admin.googleapis.com/admin/directory/v1/groups/{groupKey}/hasMember/{memberKey}
この URL は gRPC Transcoding 構文を使用します。
パスパラメータ
パラメータ | |
---|---|
groupKey |
API リクエスト内でグループを識別します。値には、グループのメールアドレス、グループ エイリアス、一意のグループ ID のいずれかを指定できます。 |
memberKey |
API リクエスト内のユーザー メンバーを識別します。値には、ユーザーのメインのメールアドレス、エイリアス、一意の ID のいずれかを指定できます。 |
リクエスト本文
リクエストの本文は空にする必要があります。
レスポンスの本文
Directory API の Has Member レスポンスの JSON テンプレート。
成功した場合、レスポンスの本文には次の構造のデータが含まれます。
JSON 表現 |
---|
{ "isMember": boolean } |
フィールド | |
---|---|
isMember |
出力専用。指定したユーザーがグループのメンバーであるかどうかを識別します。メンバーシップは直接またはネストできます。 |
認可スコープ
次の OAuth スコープのいずれかが必要です。
https://apps-apis.google.com/a/feeds/groups/
https://www.googleapis.com/auth/admin.directory.group
https://www.googleapis.com/auth/admin.directory.group.member
https://www.googleapis.com/auth/admin.directory.group.member.readonly
https://www.googleapis.com/auth/admin.directory.group.readonly
詳細については、承認ガイドをご覧ください。