| 1 |
<html><body> |
| 2 |
<style> |
| 3 |
|
| 4 |
body, h1, h2, h3, div, span, p, pre, a { |
| 5 |
margin: 0; |
| 6 |
padding: 0; |
| 7 |
border: 0; |
| 8 |
font-weight: inherit; |
| 9 |
font-style: inherit; |
| 10 |
font-size: 100%; |
| 11 |
font-family: inherit; |
| 12 |
vertical-align: baseline; |
| 13 |
} |
| 14 |
|
| 15 |
body { |
| 16 |
font-size: 13px; |
| 17 |
padding: 1em; |
| 18 |
} |
| 19 |
|
| 20 |
h1 { |
| 21 |
font-size: 26px; |
| 22 |
margin-bottom: 1em; |
| 23 |
} |
| 24 |
|
| 25 |
h2 { |
| 26 |
font-size: 24px; |
| 27 |
margin-bottom: 1em; |
| 28 |
} |
| 29 |
|
| 30 |
h3 { |
| 31 |
font-size: 20px; |
| 32 |
margin-bottom: 1em; |
| 33 |
margin-top: 1em; |
| 34 |
} |
| 35 |
|
| 36 |
pre, code { |
| 37 |
line-height: 1.5; |
| 38 |
font-family: Monaco, 'DejaVu Sans Mono', 'Bitstream Vera Sans Mono', 'Lucida Console', monospace; |
| 39 |
} |
| 40 |
|
| 41 |
pre { |
| 42 |
margin-top: 0.5em; |
| 43 |
} |
| 44 |
|
| 45 |
h1, h2, h3, p { |
| 46 |
font-family: Arial, sans serif; |
| 47 |
} |
| 48 |
|
| 49 |
h1, h2, h3 { |
| 50 |
border-bottom: solid #CCC 1px; |
| 51 |
} |
| 52 |
|
| 53 |
.toc_element { |
| 54 |
margin-top: 0.5em; |
| 55 |
} |
| 56 |
|
| 57 |
.firstline { |
| 58 |
margin-left: 2 em; |
| 59 |
} |
| 60 |
|
| 61 |
.method { |
| 62 |
margin-top: 1em; |
| 63 |
border: solid 1px #CCC; |
| 64 |
padding: 1em; |
| 65 |
background: #EEE; |
| 66 |
} |
| 67 |
|
| 68 |
.details { |
| 69 |
font-weight: bold; |
| 70 |
font-size: 14px; |
| 71 |
} |
| 72 |
|
| 73 |
</style> |
| 74 |
|
| 75 |
<h1><a href="admin_directory_v1.html">Admin SDK API</a> . <a href="admin_directory_v1.users.html">users</a> . <a href="admin_directory_v1.users.aliases.html">aliases</a></h1> |
| 76 |
<h2>Instance Methods</h2> |
| 77 |
<p class="toc_element"> |
| 78 |
<code><a href="#close">close()</a></code></p> |
| 79 |
<p class="firstline">Close httplib2 connections.</p> |
| 80 |
<p class="toc_element"> |
| 81 |
<code><a href="#delete">delete(userKey, alias, x__xgafv=None)</a></code></p> |
| 82 |
<p class="firstline">Removes an alias.</p> |
| 83 |
<p class="toc_element"> |
| 84 |
<code><a href="#insert">insert(userKey, body=None, x__xgafv=None)</a></code></p> |
| 85 |
<p class="firstline">Adds an alias.</p> |
| 86 |
<p class="toc_element"> |
| 87 |
<code><a href="#list">list(userKey, event=None, x__xgafv=None)</a></code></p> |
| 88 |
<p class="firstline">Lists all aliases for a user.</p> |
| 89 |
<p class="toc_element"> |
| 90 |
<code><a href="#watch">watch(userKey, body=None, event=None, x__xgafv=None)</a></code></p> |
| 91 |
<p class="firstline">Watches for changes in users list.</p> |
| 92 |
<h3>Method Details</h3> |
| 93 |
<div class="method"> |
| 94 |
<code class="details" id="close">close()</code> |
| 95 |
<pre>Close httplib2 connections.</pre> |
| 96 |
</div> |
| 97 |
|
| 98 |
<div class="method"> |
| 99 |
<code class="details" id="delete">delete(userKey, alias, x__xgafv=None)</code> |
| 100 |
<pre>Removes an alias. |
| 101 |
|
| 102 |
Args: |
| 103 |
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) |
| 104 |
alias: string, The alias to be removed. (required) |
| 105 |
x__xgafv: string, V1 error format. |
| 106 |
Allowed values |
| 107 |
1 - v1 error format |
| 108 |
2 - v2 error format |
| 109 |
</pre> |
| 110 |
</div> |
| 111 |
|
| 112 |
<div class="method"> |
| 113 |
<code class="details" id="insert">insert(userKey, body=None, x__xgafv=None)</code> |
| 114 |
<pre>Adds an alias. |
| 115 |
|
| 116 |
Args: |
| 117 |
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) |
| 118 |
body: object, The request body. |
| 119 |
The object takes the form of: |
| 120 |
|
| 121 |
{ # JSON template for Alias object in Directory API. |
| 122 |
"alias": "A String", |
| 123 |
"etag": "A String", |
| 124 |
"id": "A String", |
| 125 |
"kind": "admin#directory#alias", |
| 126 |
"primaryEmail": "A String", |
| 127 |
} |
| 128 |
|
| 129 |
x__xgafv: string, V1 error format. |
| 130 |
Allowed values |
| 131 |
1 - v1 error format |
| 132 |
2 - v2 error format |
| 133 |
|
| 134 |
Returns: |
| 135 |
An object of the form: |
| 136 |
|
| 137 |
{ # JSON template for Alias object in Directory API. |
| 138 |
"alias": "A String", |
| 139 |
"etag": "A String", |
| 140 |
"id": "A String", |
| 141 |
"kind": "admin#directory#alias", |
| 142 |
"primaryEmail": "A String", |
| 143 |
}</pre> |
| 144 |
</div> |
| 145 |
|
| 146 |
<div class="method"> |
| 147 |
<code class="details" id="list">list(userKey, event=None, x__xgafv=None)</code> |
| 148 |
<pre>Lists all aliases for a user. |
| 149 |
|
| 150 |
Args: |
| 151 |
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) |
| 152 |
event: string, Events to watch for. |
| 153 |
Allowed values |
| 154 |
add - Alias Created Event |
| 155 |
delete - Alias Deleted Event |
| 156 |
x__xgafv: string, V1 error format. |
| 157 |
Allowed values |
| 158 |
1 - v1 error format |
| 159 |
2 - v2 error format |
| 160 |
|
| 161 |
Returns: |
| 162 |
An object of the form: |
| 163 |
|
| 164 |
{ # JSON response template to list aliases in Directory API. |
| 165 |
"aliases": [ |
| 166 |
"", |
| 167 |
], |
| 168 |
"etag": "A String", |
| 169 |
"kind": "admin#directory#aliases", |
| 170 |
}</pre> |
| 171 |
</div> |
| 172 |
|
| 173 |
<div class="method"> |
| 174 |
<code class="details" id="watch">watch(userKey, body=None, event=None, x__xgafv=None)</code> |
| 175 |
<pre>Watches for changes in users list. |
| 176 |
|
| 177 |
Args: |
| 178 |
userKey: string, Email or immutable ID of the user (required) |
| 179 |
body: object, The request body. |
| 180 |
The object takes the form of: |
| 181 |
|
| 182 |
{ # An notification channel used to watch for resource changes. |
| 183 |
"address": "A String", # The address where notifications are delivered for this channel. |
| 184 |
"expiration": "A String", # Date and time of notification channel expiration, expressed as a Unix timestamp, in milliseconds. Optional. |
| 185 |
"id": "A String", # A UUID or similar unique string that identifies this channel. |
| 186 |
"kind": "api#channel", # Identifies this as a notification channel used to watch for changes to a resource, which is `api#channel`. |
| 187 |
"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. |
| 188 |
"a_key": "A String", |
| 189 |
}, |
| 190 |
"payload": True or False, # A Boolean value to indicate whether payload is wanted. Optional. |
| 191 |
"resourceId": "A String", # An opaque ID that identifies the resource being watched on this channel. Stable across different API versions. |
| 192 |
"resourceUri": "A String", # A version-specific identifier for the watched resource. |
| 193 |
"token": "A String", # An arbitrary string delivered to the target address with each notification delivered over this channel. Optional. |
| 194 |
"type": "A String", # The type of delivery mechanism used for this channel. |
| 195 |
} |
| 196 |
|
| 197 |
event: string, Events to watch for. |
| 198 |
Allowed values |
| 199 |
add - Alias Created Event |
| 200 |
delete - Alias Deleted Event |
| 201 |
x__xgafv: string, V1 error format. |
| 202 |
Allowed values |
| 203 |
1 - v1 error format |
| 204 |
2 - v2 error format |
| 205 |
|
| 206 |
Returns: |
| 207 |
An object of the form: |
| 208 |
|
| 209 |
{ # An notification channel used to watch for resource changes. |
| 210 |
"address": "A String", # The address where notifications are delivered for this channel. |
| 211 |
"expiration": "A String", # Date and time of notification channel expiration, expressed as a Unix timestamp, in milliseconds. Optional. |
| 212 |
"id": "A String", # A UUID or similar unique string that identifies this channel. |
| 213 |
"kind": "api#channel", # Identifies this as a notification channel used to watch for changes to a resource, which is `api#channel`. |
| 214 |
"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. |
| 215 |
"a_key": "A String", |
| 216 |
}, |
| 217 |
"payload": True or False, # A Boolean value to indicate whether payload is wanted. Optional. |
| 218 |
"resourceId": "A String", # An opaque ID that identifies the resource being watched on this channel. Stable across different API versions. |
| 219 |
"resourceUri": "A String", # A version-specific identifier for the watched resource. |
| 220 |
"token": "A String", # An arbitrary string delivered to the target address with each notification delivered over this channel. Optional. |
| 221 |
"type": "A String", # The type of delivery mechanism used for this channel. |
| 222 |
}</pre> |
| 223 |
</div> |
| 224 |
|
| 225 |
</body></html> |