Method: customers.v2.Groups.list

グループの一覧を取得します。

  • リクエストではフィルタを指定する必要があります。filter パラメータのないリクエストは tooMany エラーを返します。
  • filter パラメータは、displayName（displayName eq "Group Name" など）または externalId（externalId eq "ddaafa46e2b6" など）の等価性のみをサポートしています。
  • 部分文字列の一致（co、sw、ew）、論理演算子（and、or）、複合値フィルタはサポートされていません。
  • ページネーションはサポートされていません。50 件を超えるグループが一致する場合、最初の 50 件の結果のみが返されます。

HTTP リクエスト

GET https://cloudidentityscim.googleapis.com/v1beta1/customers/{customerId}/v2/Groups

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

パスパラメータ

パラメータ
customerId

string

必須。顧客の ID。

クエリ パラメータ

パラメータ
filter

string

フィルタ パラメータ。

リクエストの本文

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

レスポンスの本文

グループの一覧表示からのレスポンス メッセージ。

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

JSON 表現 
{
  "schemas": [
    string
  ],
  "resources": [
    {
      object (Group)
    }
  ],
  "totalResults": integer
}
フィールド
schemas[]

string

返されたリソースのスキーマ。
resources[]

object (Group)

リクエストされたリソースのリスト。
totalResults

integer

結果の合計数。

認可スコープ

次の OAuth スコープのいずれかが必要です。

  • https://www.googleapis.com/auth/cloud-identity.groups.readonly
  • https://www.googleapis.com/auth/cloud-identity.groups
  • https://www.googleapis.com/auth/cloud-identity
  • https://www.googleapis.com/auth/cloud-platform

詳細については、認可ガイドをご覧ください。