Method: users.aliases.watch
Watches for changes in users list.
HTTP request
POST https://admin.googleapis.com/admin/directory/v1/users/{userKey}/aliases/watch
The URL uses gRPC Transcoding syntax.
Path parameters
| Parameters |
userKey |
string
Email or immutable ID of the user
|
Query parameters
| Parameters |
event |
enum (Event)
Events to watch for.
|
Request body
The request body contains an instance of SubscriptionChannel.
Response body
If successful, the response body contains an instance of SubscriptionChannel.
Authorization scopes
Requires one of the following OAuth scopes:
https://apps-apis.google.com/a/feeds/alias/
https://www.googleapis.com/auth/admin.directory.user
https://www.googleapis.com/auth/admin.directory.user.readonly
https://www.googleapis.com/auth/admin.directory.user.alias
https://www.googleapis.com/auth/admin.directory.user.alias.readonly
For more information, see the Authorization guide.
Event
| Enums |
ADD |
Alias Created Event |
DELETE |
Alias Deleted Event |
Except as otherwise noted, the content of this page is licensed under the Creative Commons Attribution 4.0 License, and code samples are licensed under the Apache 2.0 License. For details, see the Google Developers Site Policies. Java is a registered trademark of Oracle and/or its affiliates.
Last updated 2024-08-22 UTC.
[null,null,["Last updated 2024-08-22 UTC."],[[["This API endpoint allows you to watch for changes (creation or deletion) in a user's aliases within Google Directory."],["It uses a `POST` request to `https://admin.googleapis.com/admin/directory/v1/users/{userKey}/aliases/watch`, accepting a `SubscriptionChannel` in the request body."],["Requires specific OAuth scopes like `https://www.googleapis.com/auth/admin.directory.user.alias` for authorization."],["Successful responses return a `SubscriptionChannel` object, confirming the watch setup."],["The `event` query parameter enables filtering for specific alias events like `ADD` or `DELETE`."]]],["This API endpoint allows watching for changes in a user's alias list. It uses a `POST` request to `https://admin.googleapis.com/admin/directory/v1/users/{userKey}/aliases/watch`, where `userKey` is the user's email or ID. The `event` query parameter specifies the type of events to monitor (e.g., `ADD` or `DELETE`). The request body contains a `SubscriptionChannel`, and the successful response also returns a `SubscriptionChannel`. Authorization requires specific OAuth scopes.\n"]]
