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 users on your domain
- View and manage your data across Google Cloud Platform services
Input
This building block consumes 23 input parameters
| Name | Format | Description |
|---|---|---|
event |
ENUMERATION |
Event on which subscription is intended |
viewType |
ENUMERATION |
Whether to fetch the ADMIN_VIEW or DOMAIN_PUBLIC view of the user |
customer |
STRING |
Immutable ID of the G Suite account. In case of multi-domain, to fetch all users for a customer, fill this field instead of domain |
showDeleted |
STRING |
If set to true, retrieves the list of deleted users. (Default: false) |
maxResults |
INTEGER |
Maximum number of results to return |
pageToken |
STRING |
Token to specify next page in the list |
projection |
ENUMERATION |
What subset of fields to fetch for this user |
sortOrder |
ENUMERATION |
Whether to return results in ascending or descending order |
query |
STRING |
Query string search. Should be of the form "". Complete documentation is at https: //developers.google.com/admin-sdk/directory/v1/guides/search-users |
domain |
STRING |
Name of the domain. Fill this field to get users from only this domain. To return all users in a multi-domain fill customer field instead." |
customFieldMask |
STRING |
Comma-separated list of schema names. All fields from these schemas are fetched. This should only be set when projection=custom |
orderBy |
ENUMERATION |
Column to use for sorting results |
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
|
event ENUMERATION Event on which subscription is intended |
|
viewType ENUMERATION Whether to fetch the ADMIN_VIEW or DOMAIN_PUBLIC view of the user |
|
customer STRING Immutable ID of the G Suite account. In case of multi-domain, to fetch all users for a customer, fill this field instead of domain |
|
showDeleted STRING If set to true, retrieves the list of deleted users. (Default: false) |
|
maxResults INTEGER Maximum number of results to return |
|
pageToken STRING Token to specify next page in the list |
|
projection ENUMERATION What subset of fields to fetch for this user |
|
sortOrder ENUMERATION Whether to return results in ascending or descending order |
|
query STRING Query string search. Should be of the form "". Complete documentation is at https: //developers.google.com/admin-sdk/directory/v1/guides/search-users |
|
domain STRING Name of the domain. Fill this field to get users from only this domain. To return all users in a multi-domain fill customer field instead." |
|
customFieldMask STRING Comma-separated list of schema names. All fields from these schemas are fetched. This should only be set when projection=custom |
|
orderBy ENUMERATION Column to use for sorting results |
|
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 |