Method: members.list

グループ内のすべてのメンバーのパージネーション リストを取得します。このメソッドは 60 分後にタイムアウトします。詳細については、エラーコードのトラブルシューティングをご覧ください。

HTTP リクエスト

GET https://admin.googleapis.com/admin/directory/v1/groups/{groupKey}/members

この URL は gRPC Transcoding 構文を使用します。

パスパラメータ

パラメータ
groupKey

string

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

クエリ パラメータ

パラメータ
includeDerivedMembership

boolean

間接メンバーシップを一覧表示するかどうか。デフォルトは false です。
maxResults

integer

返される結果の最大数。最大値は 200 です。
pageToken

string

リストの次のページを指定するトークン。
roles

string

roles クエリ パラメータを使用すると、グループ メンバーをロールごとに取得できます。指定できる値は OWNER、MANAGER、MEMBER です。

リクエストの本文

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

レスポンスの本文

成功すると、レスポンスの本文に次の構造のデータが含まれます。

JSON 表現 
{
  "kind": string,
  "etag": string,
  "members": [
    {
      object (Member)
    }
  ],
  "nextPageToken": string
}
フィールド
kind

string

リソースの種類。
etag

string

リソースの ETag。
members[]

object (Member)

メンバー オブジェクトのリスト。
nextPageToken

string

この結果の次のページにアクセスするために使用されるトークン。

認可スコープ

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

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