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 を表すこともできます。customerIdUsers リソースの一部としても返されます。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

詳しくは、OAuth 2.0 の概要をご覧ください。

イベント

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

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

OrderBy

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

予測

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

SortOrder

列挙型
ASCENDING 昇順。
DESCENDING 降順。

ViewType

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