Method: users.watch

ユーザーリストの変更を監視します。

HTTP リクエスト

POST https://admin.googleapis.com/admin/directory/v1/users/watch

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

クエリ パラメータ

パラメータ
domain

string

ドメイン名。このドメインのみのユーザーを取得するには、このフィールドに入力します。マルチドメインのすべてのユーザーを返すには、代わりに customer 項目を入力してください。」

customer

string

Google Workspace アカウントの不変の ID。マルチドメインの場合、顧客のすべてのユーザーを取得するには、ドメインではなくこのフィールドに入力します。

event

enum (EventType)

監視するイベント。

customFieldMask

string

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

maxResults

integer

返される結果の最大数。

orderBy

enum (OrderBy)

結果の並べ替えに使用する列

pageToken

string

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

projection

enum (Projection)

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

query

string

クエリ文字列の検索。「」の形式にする必要があります。完全なドキュメントについては、https: //developers.google.com/admin-sdk/directory/v1/guides/search-users をご覧ください。

showDeleted

string

true に設定した場合、削除されたユーザーのリストを取得します。(デフォルトは false)

sortOrder

enum (SortOrder)

結果を昇順または降順のどちらで返すかを指定します。

viewType

enum (ViewType)

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

リクエスト本文

リクエストの本文には SubscriptionChannel のインスタンスが含まれています。

レスポンスの本文

成功した場合、レスポンスの本文には SubscriptionChannel のインスタンスが含まれます。

認可スコープ

次の 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

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

EventType

Subscription イベントのタイプ

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

OrderBy

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

予測

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

SortOrder

列挙型
ASCENDING 昇順。
DESCENDING 降順。

ViewType

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