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 のメンバー レスポンスを含む 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

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