Users.aliases: watch

Requires authorization

Watch for changes in user aliases list Try it now.

Request

HTTP request

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

Parameters

Parameter name Value Description
Path parameters
userKey string Email or immutable ID of the user
Optional query parameters
event string Events to watch for.

Acceptable values are:
  • "add": Alias Created Event
  • "delete": Alias Deleted Event

Authorization

This request requires authorization with at least one of the following scopes (read more about authentication and authorization).

Scope
https://www.googleapis.com/auth/admin.directory.user.alias.readonly
https://www.googleapis.com/auth/admin.directory.user.alias
https://www.googleapis.com/auth/admin.directory.user.readonly
https://www.googleapis.com/auth/admin.directory.user

Request body

In the request body, supply data with the following structure:

{
  "id": string,
  "token": string,
  "expiration": long,
  "type": string,
  "address": string,
  "payload": boolean,
  "params": {
    ttl: string
  }
}
Property name Value Description Notes
id string A UUID or similar unique string that identifies this channel.
token string An arbitrary string delivered to the target address with each notification delivered over this channel. Optional.
expiration long Date and time of notification channel expiration, expressed as a Unix timestamp, in milliseconds. Optional.
type string The type of delivery mechanism used for this channel.
address string The address where notifications are delivered for this channel.
payload boolean A Boolean value to indicate whether payload is wanted. Optional.
params object Additional parameters controlling delivery channel behavior. Optional.
params.ttl string Declares a new parameter by name.

Response

If successful, this method returns a response body with the following structure:

{
  "kind": "api#channel",
  "id": string,
  "resourceId": string,
  "resourceUri": string,
  "token": string,
  "expiration": long
}
Property name Value Description Notes
kind string Identifies this as a notification channel used to watch for changes to a resource, which is "api#channel".
id string A UUID or similar unique string that identifies this channel.
resourceId string An opaque ID that identifies the resource being watched on this channel. Stable across different API versions.
resourceUri string A version-specific identifier for the watched resource.
token string An arbitrary string delivered to the target address with each notification delivered over this channel. Optional.
expiration long Date and time of notification channel expiration, expressed as a Unix timestamp, in milliseconds. Optional.

Try it!

Use the APIs Explorer below to call this method on live data and see the response.

Send feedback about...

Directory API
Directory API
Need help? Visit our support page.