Watch
|
|||||
|
|
||||
Watch for changes in users list
Authorization
To use this building block you will have to grant access to at least one of the following scopes:
- View and manage the provisioning of users on your domain
- View and manage user aliases on your domain
- View user aliases on your domain
- View users on your domain
Input
This building block consumes 13 input parameters
| Name | Format | Description |
|---|---|---|
userKey Required |
STRING |
Email or immutable ID of the user |
event |
ENUMERATION |
Event on which subscription is intended (if subscribing) |
resourceId |
STRING |
An opaque ID that identifies the resource being watched on this channel. Stable across different API versions |
expiration |
INTEGER |
Date and time of notification channel expiration, expressed as a Unix timestamp, in milliseconds. Optional |
address |
STRING |
The address where notifications are delivered for this channel |
type |
STRING |
The type of delivery mechanism used for this channel |
kind |
STRING |
Identifies this as a notification channel used to watch for changes to a resource, which is "api#channel" |
token |
STRING |
An arbitrary string delivered to the target address with each notification delivered over this channel. Optional |
id |
STRING |
A UUID or similar unique string that identifies this channel |
payload |
BOOLEAN |
A Boolean value to indicate whether payload is wanted. Optional |
params |
OBJECT |
Additional parameters controlling delivery channel behavior. Optional |
params.customKey.value Required |
STRING |
Additional parameters controlling delivery channel behavior. Optional |
resourceUri |
STRING |
A version-specific identifier for the watched resource |
= Parameter name
= Format
|
userKey STRING Required Email or immutable ID of the user |
|
event ENUMERATION Event on which subscription is intended (if subscribing) |
|
resourceId STRING An opaque ID that identifies the resource being watched on this channel. Stable across different API versions |
|
expiration INTEGER Date and time of notification channel expiration, expressed as a Unix timestamp, in milliseconds. Optional |
|
address STRING The address where notifications are delivered for this channel |
|
type STRING The type of delivery mechanism used for this channel |
|
kind STRING Identifies this as a notification channel used to watch for changes to a resource, which is "api#channel" |
|
token STRING An arbitrary string delivered to the target address with each notification delivered over this channel. Optional |
|
id STRING A UUID or similar unique string that identifies this channel |
|
payload BOOLEAN A Boolean value to indicate whether payload is wanted. Optional |
|
params OBJECT Additional parameters controlling delivery channel behavior. Optional |
|
params.customKey.value STRING Required Additional parameters controlling delivery channel behavior. Optional |
|
resourceUri STRING A version-specific identifier for the watched resource |
Output
This building block provides 11 output parameters
| Name | Format | Description |
|---|---|---|
resourceId |
STRING |
An opaque ID that identifies the resource being watched on this channel. Stable across different API versions |
expiration |
INTEGER |
Date and time of notification channel expiration, expressed as a Unix timestamp, in milliseconds. Optional |
address |
STRING |
The address where notifications are delivered for this channel |
type |
STRING |
The type of delivery mechanism used for this channel |
kind |
STRING |
Identifies this as a notification channel used to watch for changes to a resource, which is "api#channel" |
token |
STRING |
An arbitrary string delivered to the target address with each notification delivered over this channel. Optional |
id |
STRING |
A UUID or similar unique string that identifies this channel |
payload |
BOOLEAN |
A Boolean value to indicate whether payload is wanted. Optional |
params |
OBJECT |
Additional parameters controlling delivery channel behavior. Optional |
params.customKey.value |
STRING |
Additional parameters controlling delivery channel behavior. Optional |
resourceUri |
STRING |
A version-specific identifier for the watched resource |
= Parameter name
= Format
|
resourceId STRING An opaque ID that identifies the resource being watched on this channel. Stable across different API versions |
|
expiration INTEGER Date and time of notification channel expiration, expressed as a Unix timestamp, in milliseconds. Optional |
|
address STRING The address where notifications are delivered for this channel |
|
type STRING The type of delivery mechanism used for this channel |
|
kind STRING Identifies this as a notification channel used to watch for changes to a resource, which is "api#channel" |
|
token STRING An arbitrary string delivered to the target address with each notification delivered over this channel. Optional |
|
id STRING A UUID or similar unique string that identifies this channel |
|
payload BOOLEAN A Boolean value to indicate whether payload is wanted. Optional |
|
params OBJECT Additional parameters controlling delivery channel behavior. Optional |
|
params.customKey.value STRING Additional parameters controlling delivery channel behavior. Optional |
|
resourceUri STRING A version-specific identifier for the watched resource |