Method: members.hasMember

指定されたユーザーがグループのメンバーかどうかを確認します。メンバーシップは直接的またはネストされたものになりますが、ネストされている場合、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

string

API リクエスト内でグループを識別します。値には、グループのメールアドレス、グループ エイリアス、一意のグループ ID を指定できます。
memberKey

string

API リクエスト内のユーザー メンバーを識別します。この値は、ユーザーのメインのメールアドレス、エイリアス、一意の ID のいずれかです。

リクエストの本文

リクエストの本文は空にする必要があります。

レスポンスの本文

Directory API の Has Member レスポンスの JSON テンプレート。

成功した場合、レスポンスの本文には次の構造のデータが含まれます。

JSON 表現 
{
  "isMember": boolean
}
フィールド
isMember

boolean

出力専用。指定したユーザーがグループのメンバーかどうかを特定します。メンバーシップは直接的またはネストされたものになります。

認可スコープ

以下のいずれかの 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

詳しくは、認可ガイドをご覧ください。