Method: customers.v2.Users.list

ユーザーのリストを取得します。

  • リクエストでは、フィルタを指定する必要があります。filter パラメータのないリクエストは、tooMany エラーを返します。
  • filter パラメータは、userName の等価性のみをサポートします（例: userName eq "user@domain.com"）。
  • 部分文字列の一致（co、sw、ew）、論理演算子（and、or）、複雑な値フィルタはサポートされていません。
  • ページネーションはサポートされていません。

HTTP リクエスト

GET https://cloudidentityscim.googleapis.com/v1/customers/{customerId}/v2/Users

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

パスパラメータ

パラメータ
customerId

string

必須。お客様 ID。

クエリ パラメータ

パラメータ
filter

string

フィルタ パラメータ。現在、userName の等価性のみをサポートしています。

リクエストの本文

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

レスポンスの本文

ユーザーのリスト取得からのレスポンス メッセージ。

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

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

string

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

object (User)

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

integer

結果の合計数。

認可スコープ

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

  • https://www.googleapis.com/auth/admin.directory.user.readonly
  • https://www.googleapis.com/auth/admin.directory.user

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