Method: users.list

削除されたユーザーまたはドメイン内のすべてのユーザーのページ分けされたリストを取得します。

HTTP リクエスト

GET https://admin.googleapis.com/admin/directory/v1/users

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

クエリ パラメータ

パラメータ
customFieldMask

string

スキーマ名のカンマ区切りリスト。これらのスキーマからすべてのフィールドが取得されます。projection=custom の場合にのみ設定する必要があります。
customer

string

お客様の Google Workspace アカウントの一意の ID。マルチドメイン アカウントの場合、顧客のすべてのユーザーを取得するには、domain の代わりにこのフィールドを使用します。my_customer エイリアスを使用してアカウントの customerId を表すこともできます。customerId も Users リソースの一部として返されます。customer パラメータまたは domain パラメータを指定する必要があります。
domain

string

ドメイン名。1 つのドメインからのみユーザーを取得するには、このフィールドを使用します。顧客アカウントのすべてのドメインを返すには、代わりに customer クエリ パラメータを使用します。customer パラメータまたは domain パラメータを指定する必要があります。
event

enum (Event)

サブスクリプションを対象とするイベント（サブスクライブする場合）
maxResults

integer

返される結果の最大数。
orderBy

enum (OrderBy)

結果の並べ替えに使用するプロパティ。
pageToken

string

リストの次のページを指定するためのトークン
projection

enum (Projection)

このユーザーに対して取得するフィールドのサブセット。
query

string

ユーザー フィールドを検索するためのクエリ文字列。ユーザークエリの作成について詳しくは、ユーザーの検索をご覧ください。
showDeleted

string

true に設定すると、削除済みのユーザーのリストが取得されます。（デフォルト: false）。
sortOrder

enum (SortOrder)

結果を昇順または降順のどちらで返すかを指定します（大文字と小文字は区別されません）。
viewType

enum (ViewType)

ユーザーの管理者のみの公開ビューを取得するか、ドメイン全体の公開ビューを取得するかを指定します。詳細については、管理者以外のユーザーを取得するをご覧ください。

リクエスト本文

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

レスポンスの本文

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

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

string

リソースの種類。
trigger_event

string

このレスポンスをトリガーしたイベント（Push レスポンスの場合にのみ使用）
etag

string

リソースの ETag。
users[]

object (User)

ユーザー オブジェクトのリスト。
nextPageToken

string

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

認可スコープ

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

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

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

イベント

サブスクリプション イベントのタイプ

列挙型
ADD ユーザー作成イベント
DELETE ユーザーによるイベント削除
MAKE_ADMIN ユーザー管理者ステータス変更イベント
UNDELETE ユーザーによる削除取り消しイベント
UPDATE ユーザーによる更新イベント

OrderBy

列挙型
EMAIL ユーザーのメインのメールアドレス。
FAMILY_NAME ユーザーの姓。
GIVEN_NAME ユーザーの名。

予測

列挙型
BASIC ユーザーのカスタム フィールドは含めないでください。
CUSTOM customFieldMask でリクエストされたスキーマのカスタム フィールドを含めます。
FULL このユーザーに関連付けられているすべての項目を含めます。

SortOrder

列挙型
ASCENDING 昇順。
DESCENDING 降順。

ViewType

列挙型
admin_view 結果には、ユーザーの管理者専用フィールドとドメイン パブリック フィールドの両方が含まれます。
domain_public 結果には、ドメイン内の他のユーザーに公開されているユーザーのフィールドのみが含まれます。