ユーザーリストの変更を監視します。
HTTP リクエスト
POST https://admin.googleapis.com/admin/directory/v1/users/watch
この URL は gRPC Transcoding 構文を使用します。
クエリ パラメータ
パラメータ | |
---|---|
domain |
ドメインの名前。このドメインのみのユーザーを取得するには、このフィールドに入力します。代わりに、マルチドメインのすべてのユーザーを返すには、顧客フィールドに入力します。 |
customer |
Google Workspace アカウントの不変の ID です。マルチドメインの場合、顧客のすべてのユーザーを取得するには、ドメインではなくこの項目に入力します。 |
event |
監視対象のイベント。 |
customFieldMask |
スキーマ名のカンマ区切りのリスト。これらのスキーマからすべてのフィールドを取得します。これは projection=custom の場合にのみ設定する必要があります。 |
maxResults |
返される結果の最大数。 |
orderBy |
結果の並べ替えに使用する列 |
pageToken |
リストの次のページを指定するトークン |
projection |
このユーザーに対して取得するフィールドのサブセット。 |
query |
クエリ文字列検索。形式は「 |
showDeleted |
true に設定すると、削除されたユーザーのリストが取得されます。(デフォルト: false) |
sortOrder |
結果を昇順または降順で返すかどうか。 |
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
サブスクリプション イベントのタイプ
列挙型 | |
---|---|
ADD |
ユーザー作成イベント |
DELETE |
ユーザー削除イベント |
MAKE_ADMIN |
ユーザー管理者ステータス変更イベント |
UNDELETE |
ユーザーの削除取り消しイベント |
UPDATE |
ユーザー更新イベント |
OrderBy
列挙型 | |
---|---|
EMAIL |
ユーザーのメインのメールアドレス。 |
FAMILY_NAME |
ユーザーの姓。 |
GIVEN_NAME |
ユーザーの名。 |
予測
列挙型 | |
---|---|
BASIC |
ユーザーのカスタム フィールドを含めないでください。 |
CUSTOM |
customFieldMask で指定されたスキーマのカスタム フィールドを含めます。 |
FULL |
このユーザーに関連付けられているすべてのフィールドを含めます。 |
SortOrder
列挙型 | |
---|---|
ASCENDING |
昇順。 |
DESCENDING |
降順。 |
ViewType
列挙型 | |
---|---|
admin_view |
結果には、管理者専用フィールドとドメイン一般公開フィールドの両方が含まれます。 |
domain_public |
結果には、ドメイン内の他のユーザーが一般公開できるユーザーのフィールドのみが含まれます。 |