Close httplib2 connections.
delete(userKey, alias, x__xgafv=None)
Removes an alias.
insert(userKey, body=None, x__xgafv=None)
Adds an alias.
list(userKey, event=None, x__xgafv=None)
Lists all aliases for a user.
watch(userKey, body=None, event=None, x__xgafv=None)
Watches for changes in users list.
close()
Close httplib2 connections.
delete(userKey, alias, x__xgafv=None)
Removes an alias.
Args:
userKey: string, Identifies the user in the API request. The value can be the user's primary email address, alias email address, or unique user ID. (required)
alias: string, The alias to be removed. (required)
x__xgafv: string, V1 error format.
Allowed values
1 - v1 error format
2 - v2 error format
insert(userKey, body=None, x__xgafv=None)
Adds an alias.
Args:
userKey: string, Identifies the user in the API request. The value can be the user's primary email address, alias email address, or unique user ID. (required)
body: object, The request body.
The object takes the form of:
{ # JSON template for Alias object in Directory API.
"alias": "A String",
"etag": "A String",
"id": "A String",
"kind": "admin#directory#alias",
"primaryEmail": "A String",
}
x__xgafv: string, V1 error format.
Allowed values
1 - v1 error format
2 - v2 error format
Returns:
An object of the form:
{ # JSON template for Alias object in Directory API.
"alias": "A String",
"etag": "A String",
"id": "A String",
"kind": "admin#directory#alias",
"primaryEmail": "A String",
}
list(userKey, event=None, x__xgafv=None)
Lists all aliases for a user.
Args:
userKey: string, Identifies the user in the API request. The value can be the user's primary email address, alias email address, or unique user ID. (required)
event: string, Events to watch for.
Allowed values
add - Alias Created Event
delete - Alias Deleted Event
x__xgafv: string, V1 error format.
Allowed values
1 - v1 error format
2 - v2 error format
Returns:
An object of the form:
{ # JSON response template to list aliases in Directory API.
"aliases": [
"",
],
"etag": "A String",
"kind": "admin#directory#aliases",
}
watch(userKey, body=None, event=None, x__xgafv=None)
Watches for changes in users list.
Args:
userKey: string, Email or immutable ID of the user (required)
body: object, The request body.
The object takes the form of:
{ # An notification channel used to watch for resource changes.
"address": "A String", # The address where notifications are delivered for this channel.
"expiration": "A String", # Date and time of notification channel expiration, expressed as a Unix timestamp, in milliseconds. Optional.
"id": "A String", # A UUID or similar unique string that identifies this channel.
"kind": "api#channel", # Identifies this as a notification channel used to watch for changes to a resource, which is `api#channel`.
"params": { # Additional parameters controlling delivery channel behavior. Optional. For example, `params.ttl` specifies the time-to-live in seconds for the notification channel, where the default is 2 hours and the maximum TTL is 2 days.
"a_key": "A String",
},
"payload": True or False, # A Boolean value to indicate whether payload is wanted. Optional.
"resourceId": "A String", # An opaque ID that identifies the resource being watched on this channel. Stable across different API versions.
"resourceUri": "A String", # A version-specific identifier for the watched resource.
"token": "A String", # An arbitrary string delivered to the target address with each notification delivered over this channel. Optional.
"type": "A String", # The type of delivery mechanism used for this channel.
}
event: string, Events to watch for.
Allowed values
add - Alias Created Event
delete - Alias Deleted Event
x__xgafv: string, V1 error format.
Allowed values
1 - v1 error format
2 - v2 error format
Returns:
An object of the form:
{ # An notification channel used to watch for resource changes.
"address": "A String", # The address where notifications are delivered for this channel.
"expiration": "A String", # Date and time of notification channel expiration, expressed as a Unix timestamp, in milliseconds. Optional.
"id": "A String", # A UUID or similar unique string that identifies this channel.
"kind": "api#channel", # Identifies this as a notification channel used to watch for changes to a resource, which is `api#channel`.
"params": { # Additional parameters controlling delivery channel behavior. Optional. For example, `params.ttl` specifies the time-to-live in seconds for the notification channel, where the default is 2 hours and the maximum TTL is 2 days.
"a_key": "A String",
},
"payload": True or False, # A Boolean value to indicate whether payload is wanted. Optional.
"resourceId": "A String", # An opaque ID that identifies the resource being watched on this channel. Stable across different API versions.
"resourceUri": "A String", # A version-specific identifier for the watched resource.
"token": "A String", # An arbitrary string delivered to the target address with each notification delivered over this channel. Optional.
"type": "A String", # The type of delivery mechanism used for this channel.
}