1<html><body> 2<style> 3 4body, 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 15body { 16 font-size: 13px; 17 padding: 1em; 18} 19 20h1 { 21 font-size: 26px; 22 margin-bottom: 1em; 23} 24 25h2 { 26 font-size: 24px; 27 margin-bottom: 1em; 28} 29 30h3 { 31 font-size: 20px; 32 margin-bottom: 1em; 33 margin-top: 1em; 34} 35 36pre, code { 37 line-height: 1.5; 38 font-family: Monaco, 'DejaVu Sans Mono', 'Bitstream Vera Sans Mono', 'Lucida Console', monospace; 39} 40 41pre { 42 margin-top: 0.5em; 43} 44 45h1, h2, h3, p { 46 font-family: Arial, sans serif; 47} 48 49h1, 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></h1> 76<h2>Instance Methods</h2> 77<p class="toc_element"> 78 <code><a href="admin_directory_v1.users.aliases.html">aliases()</a></code> 79</p> 80<p class="firstline">Returns the aliases Resource.</p> 81 82<p class="toc_element"> 83 <code><a href="admin_directory_v1.users.photos.html">photos()</a></code> 84</p> 85<p class="firstline">Returns the photos Resource.</p> 86 87<p class="toc_element"> 88 <code><a href="#close">close()</a></code></p> 89<p class="firstline">Close httplib2 connections.</p> 90<p class="toc_element"> 91 <code><a href="#delete">delete(userKey, x__xgafv=None)</a></code></p> 92<p class="firstline">Deletes a user.</p> 93<p class="toc_element"> 94 <code><a href="#get">get(userKey, customFieldMask=None, projection=None, viewType=None, x__xgafv=None)</a></code></p> 95<p class="firstline">Retrieves a user.</p> 96<p class="toc_element"> 97 <code><a href="#insert">insert(body=None, x__xgafv=None)</a></code></p> 98<p class="firstline">Creates a user.</p> 99<p class="toc_element"> 100 <code><a href="#list">list(customFieldMask=None, customer=None, domain=None, event=None, maxResults=None, orderBy=None, pageToken=None, projection=None, query=None, showDeleted=None, sortOrder=None, viewType=None, x__xgafv=None)</a></code></p> 101<p class="firstline">Retrieves a paginated list of either deleted users or all users in a domain.</p> 102<p class="toc_element"> 103 <code><a href="#list_next">list_next(previous_request, previous_response)</a></code></p> 104<p class="firstline">Retrieves the next page of results.</p> 105<p class="toc_element"> 106 <code><a href="#makeAdmin">makeAdmin(userKey, body=None, x__xgafv=None)</a></code></p> 107<p class="firstline">Makes a user a super administrator.</p> 108<p class="toc_element"> 109 <code><a href="#patch">patch(userKey, body=None, x__xgafv=None)</a></code></p> 110<p class="firstline">Updates a user using patch semantics. The update method should be used instead, since it also supports patch semantics and has better performance. This method is unable to clear fields that contain repeated objects (`addresses`, `phones`, etc). Use the update method instead.</p> 111<p class="toc_element"> 112 <code><a href="#signOut">signOut(userKey, x__xgafv=None)</a></code></p> 113<p class="firstline">Signs a user out of all web and device sessions and reset their sign-in cookies. User will have to sign in by authenticating again.</p> 114<p class="toc_element"> 115 <code><a href="#undelete">undelete(userKey, body=None, x__xgafv=None)</a></code></p> 116<p class="firstline">Undeletes a deleted user.</p> 117<p class="toc_element"> 118 <code><a href="#update">update(userKey, body=None, x__xgafv=None)</a></code></p> 119<p class="firstline">Updates a user. This method supports patch semantics, meaning you only need to include the fields you wish to update. Fields that are not present in the request will be preserved, and fields set to `null` will be cleared.</p> 120<p class="toc_element"> 121 <code><a href="#watch">watch(body=None, customFieldMask=None, customer=None, domain=None, event=None, maxResults=None, orderBy=None, pageToken=None, projection=None, query=None, showDeleted=None, sortOrder=None, viewType=None, x__xgafv=None)</a></code></p> 122<p class="firstline">Watches for changes in users list.</p> 123<h3>Method Details</h3> 124<div class="method"> 125 <code class="details" id="close">close()</code> 126 <pre>Close httplib2 connections.</pre> 127</div> 128 129<div class="method"> 130 <code class="details" id="delete">delete(userKey, x__xgafv=None)</code> 131 <pre>Deletes a user. 132 133Args: 134 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) 135 x__xgafv: string, V1 error format. 136 Allowed values 137 1 - v1 error format 138 2 - v2 error format 139</pre> 140</div> 141 142<div class="method"> 143 <code class="details" id="get">get(userKey, customFieldMask=None, projection=None, viewType=None, x__xgafv=None)</code> 144 <pre>Retrieves a user. 145 146Args: 147 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) 148 customFieldMask: string, A comma-separated list of schema names. All fields from these schemas are fetched. This should only be set when `projection=custom`. 149 projection: string, What subset of fields to fetch for this user. 150 Allowed values 151 basic - Do not include any custom fields for the user. 152 custom - Include custom fields from schemas requested in `customFieldMask`. 153 full - Include all fields associated with this user. 154 viewType: string, Whether to fetch the administrator-only or domain-wide public view of the user. For more information, see [Retrieve a user as a non-administrator](/admin-sdk/directory/v1/guides/manage-users#retrieve_users_non_admin). 155 Allowed values 156 admin_view - Results include both administrator-only and domain-public fields for the user. 157 domain_public - Results only include fields for the user that are publicly visible to other users in the domain. 158 x__xgafv: string, V1 error format. 159 Allowed values 160 1 - v1 error format 161 2 - v2 error format 162 163Returns: 164 An object of the form: 165 166 { # The Directory API allows you to create and manage your account's users, user aliases, and user Gmail chat profile photos. For more information about common tasks, see the [User Accounts Developer's Guide](/admin-sdk/directory/v1/guides/manage-users.html) and the [User Aliases Developer's Guide](/admin-sdk/directory/v1/guides/manage-user-aliases.html). 167 "addresses": "", # A list of the user's addresses. The maximum allowed data size for this field is 10Kb. 168 "agreedToTerms": True or False, # Output only. This property is `true` if the user has completed an initial login and accepted the Terms of Service agreement. 169 "aliases": [ # Output only. A list of the user's alias email addresses. 170 "A String", 171 ], 172 "archived": True or False, # Indicates if user is archived. 173 "changePasswordAtNextLogin": True or False, # Indicates if the user is forced to change their password at next login. This setting doesn't apply when [the user signs in via a third-party identity provider](https://support.google.com/a/answer/60224). 174 "creationTime": "A String", # User's G Suite account creation time. (Read-only) 175 "customSchemas": { # Custom fields of the user. The key is a `schema_name` and its values are `'field_name': 'field_value'`. 176 "a_key": { # JSON template for a set of custom properties (i.e. all fields in a particular schema) 177 "a_key": "", 178 }, 179 }, 180 "customerId": "A String", # Output only. The customer ID to [retrieve all account users](/admin-sdk/directory/v1/guides/manage-users.html#get_all_users). You can use the alias `my_customer` to represent your account's `customerId`. As a reseller administrator, you can use the resold customer account's `customerId`. To get a `customerId`, use the account's primary domain in the `domain` parameter of a [users.list](/admin-sdk/directory/v1/reference/users/list) request. 181 "deletionTime": "A String", 182 "emails": "", # A list of the user's email addresses. The maximum allowed data size for this field is 10Kb. 183 "etag": "A String", # Output only. ETag of the resource. 184 "externalIds": "", # A list of external IDs for the user, such as an employee or network ID. The maximum allowed data size for this field is 2Kb. 185 "gender": "", # The user's gender. The maximum allowed data size for this field is 1Kb. 186 "hashFunction": "A String", # Stores the hash format of the password property. We recommend sending the `password` property value as a base 16 bit hexadecimal-encoded hash value. Set the `hashFunction` values as either the [SHA-1](https://wikipedia.org/wiki/SHA-1), [MD5](https://wikipedia.org/wiki/MD5), or [crypt](https://en.wikipedia.org/wiki/Crypt_\(C\)) hash format. 187 "id": "A String", # The unique ID for the user. A user `id` can be used as a user request URI's `userKey`. 188 "ims": "", # The user's Instant Messenger (IM) accounts. A user account can have multiple ims properties. But, only one of these ims properties can be the primary IM contact. The maximum allowed data size for this field is 2Kb. 189 "includeInGlobalAddressList": True or False, # Indicates if the user's profile is visible in the Google Workspace global address list when the contact sharing feature is enabled for the domain. For more information about excluding user profiles, see the [administration help center](https://support.google.com/a/answer/1285988). 190 "ipWhitelisted": True or False, # If `true`, the user's IP address is [whitelisted](https://support.google.com/a/answer/60752). 191 "isAdmin": True or False, # Output only. Indicates a user with super admininistrator privileges. The `isAdmin` property can only be edited in the [Make a user an administrator](/admin-sdk/directory/v1/guides/manage-users.html#make_admin) operation ( [makeAdmin](/admin-sdk/directory/v1/reference/users/makeAdmin.html) method). If edited in the user [insert](/admin-sdk/directory/v1/reference/users/insert.html) or [update](/admin-sdk/directory/v1/reference/users/update.html) methods, the edit is ignored by the API service. 192 "isDelegatedAdmin": True or False, # Output only. Indicates if the user is a delegated administrator. Delegated administrators are supported by the API but cannot create or undelete users, or make users administrators. These requests are ignored by the API service. Roles and privileges for administrators are assigned using the [Admin console](https://support.google.com/a/answer/33325). 193 "isEnforcedIn2Sv": True or False, # Output only. Is 2-step verification enforced (Read-only) 194 "isEnrolledIn2Sv": True or False, # Output only. Is enrolled in 2-step verification (Read-only) 195 "isMailboxSetup": True or False, # Output only. Indicates if the user's Google mailbox is created. This property is only applicable if the user has been assigned a Gmail license. 196 "keywords": "", # The user's keywords. The maximum allowed data size for this field is 1Kb. 197 "kind": "admin#directory#user", # Output only. The type of the API resource. For Users resources, the value is `admin#directory#user`. 198 "languages": "", # The user's languages. The maximum allowed data size for this field is 1Kb. 199 "lastLoginTime": "A String", # User's last login time. (Read-only) 200 "locations": "", # The user's locations. The maximum allowed data size for this field is 10Kb. 201 "name": { # Holds the given and family names of the user, and the read-only `fullName` value. The maximum number of characters in the `givenName` and in the `familyName` values is 60. In addition, name values support unicode/UTF-8 characters, and can contain spaces, letters (a-z), numbers (0-9), dashes (-), forward slashes (/), and periods (.). For more information about character usage rules, see the [administration help center](https://support.google.com/a/answer/9193374). Maximum allowed data size for this field is 1Kb. 202 "familyName": "A String", # The user's last name. Required when creating a user account. 203 "fullName": "A String", # The user's full name formed by concatenating the first and last name values. 204 "givenName": "A String", # The user's first name. Required when creating a user account. 205 }, 206 "nonEditableAliases": [ # Output only. List of the user's non-editable alias email addresses. These are typically outside the account's primary domain or sub-domain. 207 "A String", 208 ], 209 "notes": "", # Notes for the user. 210 "orgUnitPath": "A String", # The full path of the parent organization associated with the user. If the parent organization is the top-level, it is represented as a forward slash (`/`). 211 "organizations": "", # A list of organizations the user belongs to. The maximum allowed data size for this field is 10Kb. 212 "password": "A String", # User's password 213 "phones": "", # A list of the user's phone numbers. The maximum allowed data size for this field is 1Kb. 214 "posixAccounts": "", # A list of [POSIX](https://www.opengroup.org/austin/papers/posix_faq.html) account information for the user. 215 "primaryEmail": "A String", # The user's primary email address. This property is required in a request to create a user account. The `primaryEmail` must be unique and cannot be an alias of another user. 216 "recoveryEmail": "A String", # Recovery email of the user. 217 "recoveryPhone": "A String", # Recovery phone of the user. The phone number must be in the E.164 format, starting with the plus sign (+). Example: *+16506661212*. 218 "relations": "", # A list of the user's relationships to other users. The maximum allowed data size for this field is 2Kb. 219 "sshPublicKeys": "", # A list of SSH public keys. 220 "suspended": True or False, # Indicates if user is suspended. 221 "suspensionReason": "A String", # Output only. Has the reason a user account is suspended either by the administrator or by Google at the time of suspension. The property is returned only if the `suspended` property is `true`. 222 "thumbnailPhotoEtag": "A String", # Output only. ETag of the user's photo (Read-only) 223 "thumbnailPhotoUrl": "A String", # Output only. Photo Url of the user (Read-only) 224 "websites": "", # The user's websites. The maximum allowed data size for this field is 2Kb. 225}</pre> 226</div> 227 228<div class="method"> 229 <code class="details" id="insert">insert(body=None, x__xgafv=None)</code> 230 <pre>Creates a user. 231 232Args: 233 body: object, The request body. 234 The object takes the form of: 235 236{ # The Directory API allows you to create and manage your account's users, user aliases, and user Gmail chat profile photos. For more information about common tasks, see the [User Accounts Developer's Guide](/admin-sdk/directory/v1/guides/manage-users.html) and the [User Aliases Developer's Guide](/admin-sdk/directory/v1/guides/manage-user-aliases.html). 237 "addresses": "", # A list of the user's addresses. The maximum allowed data size for this field is 10Kb. 238 "agreedToTerms": True or False, # Output only. This property is `true` if the user has completed an initial login and accepted the Terms of Service agreement. 239 "aliases": [ # Output only. A list of the user's alias email addresses. 240 "A String", 241 ], 242 "archived": True or False, # Indicates if user is archived. 243 "changePasswordAtNextLogin": True or False, # Indicates if the user is forced to change their password at next login. This setting doesn't apply when [the user signs in via a third-party identity provider](https://support.google.com/a/answer/60224). 244 "creationTime": "A String", # User's G Suite account creation time. (Read-only) 245 "customSchemas": { # Custom fields of the user. The key is a `schema_name` and its values are `'field_name': 'field_value'`. 246 "a_key": { # JSON template for a set of custom properties (i.e. all fields in a particular schema) 247 "a_key": "", 248 }, 249 }, 250 "customerId": "A String", # Output only. The customer ID to [retrieve all account users](/admin-sdk/directory/v1/guides/manage-users.html#get_all_users). You can use the alias `my_customer` to represent your account's `customerId`. As a reseller administrator, you can use the resold customer account's `customerId`. To get a `customerId`, use the account's primary domain in the `domain` parameter of a [users.list](/admin-sdk/directory/v1/reference/users/list) request. 251 "deletionTime": "A String", 252 "emails": "", # A list of the user's email addresses. The maximum allowed data size for this field is 10Kb. 253 "etag": "A String", # Output only. ETag of the resource. 254 "externalIds": "", # A list of external IDs for the user, such as an employee or network ID. The maximum allowed data size for this field is 2Kb. 255 "gender": "", # The user's gender. The maximum allowed data size for this field is 1Kb. 256 "hashFunction": "A String", # Stores the hash format of the password property. We recommend sending the `password` property value as a base 16 bit hexadecimal-encoded hash value. Set the `hashFunction` values as either the [SHA-1](https://wikipedia.org/wiki/SHA-1), [MD5](https://wikipedia.org/wiki/MD5), or [crypt](https://en.wikipedia.org/wiki/Crypt_\(C\)) hash format. 257 "id": "A String", # The unique ID for the user. A user `id` can be used as a user request URI's `userKey`. 258 "ims": "", # The user's Instant Messenger (IM) accounts. A user account can have multiple ims properties. But, only one of these ims properties can be the primary IM contact. The maximum allowed data size for this field is 2Kb. 259 "includeInGlobalAddressList": True or False, # Indicates if the user's profile is visible in the Google Workspace global address list when the contact sharing feature is enabled for the domain. For more information about excluding user profiles, see the [administration help center](https://support.google.com/a/answer/1285988). 260 "ipWhitelisted": True or False, # If `true`, the user's IP address is [whitelisted](https://support.google.com/a/answer/60752). 261 "isAdmin": True or False, # Output only. Indicates a user with super admininistrator privileges. The `isAdmin` property can only be edited in the [Make a user an administrator](/admin-sdk/directory/v1/guides/manage-users.html#make_admin) operation ( [makeAdmin](/admin-sdk/directory/v1/reference/users/makeAdmin.html) method). If edited in the user [insert](/admin-sdk/directory/v1/reference/users/insert.html) or [update](/admin-sdk/directory/v1/reference/users/update.html) methods, the edit is ignored by the API service. 262 "isDelegatedAdmin": True or False, # Output only. Indicates if the user is a delegated administrator. Delegated administrators are supported by the API but cannot create or undelete users, or make users administrators. These requests are ignored by the API service. Roles and privileges for administrators are assigned using the [Admin console](https://support.google.com/a/answer/33325). 263 "isEnforcedIn2Sv": True or False, # Output only. Is 2-step verification enforced (Read-only) 264 "isEnrolledIn2Sv": True or False, # Output only. Is enrolled in 2-step verification (Read-only) 265 "isMailboxSetup": True or False, # Output only. Indicates if the user's Google mailbox is created. This property is only applicable if the user has been assigned a Gmail license. 266 "keywords": "", # The user's keywords. The maximum allowed data size for this field is 1Kb. 267 "kind": "admin#directory#user", # Output only. The type of the API resource. For Users resources, the value is `admin#directory#user`. 268 "languages": "", # The user's languages. The maximum allowed data size for this field is 1Kb. 269 "lastLoginTime": "A String", # User's last login time. (Read-only) 270 "locations": "", # The user's locations. The maximum allowed data size for this field is 10Kb. 271 "name": { # Holds the given and family names of the user, and the read-only `fullName` value. The maximum number of characters in the `givenName` and in the `familyName` values is 60. In addition, name values support unicode/UTF-8 characters, and can contain spaces, letters (a-z), numbers (0-9), dashes (-), forward slashes (/), and periods (.). For more information about character usage rules, see the [administration help center](https://support.google.com/a/answer/9193374). Maximum allowed data size for this field is 1Kb. 272 "familyName": "A String", # The user's last name. Required when creating a user account. 273 "fullName": "A String", # The user's full name formed by concatenating the first and last name values. 274 "givenName": "A String", # The user's first name. Required when creating a user account. 275 }, 276 "nonEditableAliases": [ # Output only. List of the user's non-editable alias email addresses. These are typically outside the account's primary domain or sub-domain. 277 "A String", 278 ], 279 "notes": "", # Notes for the user. 280 "orgUnitPath": "A String", # The full path of the parent organization associated with the user. If the parent organization is the top-level, it is represented as a forward slash (`/`). 281 "organizations": "", # A list of organizations the user belongs to. The maximum allowed data size for this field is 10Kb. 282 "password": "A String", # User's password 283 "phones": "", # A list of the user's phone numbers. The maximum allowed data size for this field is 1Kb. 284 "posixAccounts": "", # A list of [POSIX](https://www.opengroup.org/austin/papers/posix_faq.html) account information for the user. 285 "primaryEmail": "A String", # The user's primary email address. This property is required in a request to create a user account. The `primaryEmail` must be unique and cannot be an alias of another user. 286 "recoveryEmail": "A String", # Recovery email of the user. 287 "recoveryPhone": "A String", # Recovery phone of the user. The phone number must be in the E.164 format, starting with the plus sign (+). Example: *+16506661212*. 288 "relations": "", # A list of the user's relationships to other users. The maximum allowed data size for this field is 2Kb. 289 "sshPublicKeys": "", # A list of SSH public keys. 290 "suspended": True or False, # Indicates if user is suspended. 291 "suspensionReason": "A String", # Output only. Has the reason a user account is suspended either by the administrator or by Google at the time of suspension. The property is returned only if the `suspended` property is `true`. 292 "thumbnailPhotoEtag": "A String", # Output only. ETag of the user's photo (Read-only) 293 "thumbnailPhotoUrl": "A String", # Output only. Photo Url of the user (Read-only) 294 "websites": "", # The user's websites. The maximum allowed data size for this field is 2Kb. 295} 296 297 x__xgafv: string, V1 error format. 298 Allowed values 299 1 - v1 error format 300 2 - v2 error format 301 302Returns: 303 An object of the form: 304 305 { # The Directory API allows you to create and manage your account's users, user aliases, and user Gmail chat profile photos. For more information about common tasks, see the [User Accounts Developer's Guide](/admin-sdk/directory/v1/guides/manage-users.html) and the [User Aliases Developer's Guide](/admin-sdk/directory/v1/guides/manage-user-aliases.html). 306 "addresses": "", # A list of the user's addresses. The maximum allowed data size for this field is 10Kb. 307 "agreedToTerms": True or False, # Output only. This property is `true` if the user has completed an initial login and accepted the Terms of Service agreement. 308 "aliases": [ # Output only. A list of the user's alias email addresses. 309 "A String", 310 ], 311 "archived": True or False, # Indicates if user is archived. 312 "changePasswordAtNextLogin": True or False, # Indicates if the user is forced to change their password at next login. This setting doesn't apply when [the user signs in via a third-party identity provider](https://support.google.com/a/answer/60224). 313 "creationTime": "A String", # User's G Suite account creation time. (Read-only) 314 "customSchemas": { # Custom fields of the user. The key is a `schema_name` and its values are `'field_name': 'field_value'`. 315 "a_key": { # JSON template for a set of custom properties (i.e. all fields in a particular schema) 316 "a_key": "", 317 }, 318 }, 319 "customerId": "A String", # Output only. The customer ID to [retrieve all account users](/admin-sdk/directory/v1/guides/manage-users.html#get_all_users). You can use the alias `my_customer` to represent your account's `customerId`. As a reseller administrator, you can use the resold customer account's `customerId`. To get a `customerId`, use the account's primary domain in the `domain` parameter of a [users.list](/admin-sdk/directory/v1/reference/users/list) request. 320 "deletionTime": "A String", 321 "emails": "", # A list of the user's email addresses. The maximum allowed data size for this field is 10Kb. 322 "etag": "A String", # Output only. ETag of the resource. 323 "externalIds": "", # A list of external IDs for the user, such as an employee or network ID. The maximum allowed data size for this field is 2Kb. 324 "gender": "", # The user's gender. The maximum allowed data size for this field is 1Kb. 325 "hashFunction": "A String", # Stores the hash format of the password property. We recommend sending the `password` property value as a base 16 bit hexadecimal-encoded hash value. Set the `hashFunction` values as either the [SHA-1](https://wikipedia.org/wiki/SHA-1), [MD5](https://wikipedia.org/wiki/MD5), or [crypt](https://en.wikipedia.org/wiki/Crypt_\(C\)) hash format. 326 "id": "A String", # The unique ID for the user. A user `id` can be used as a user request URI's `userKey`. 327 "ims": "", # The user's Instant Messenger (IM) accounts. A user account can have multiple ims properties. But, only one of these ims properties can be the primary IM contact. The maximum allowed data size for this field is 2Kb. 328 "includeInGlobalAddressList": True or False, # Indicates if the user's profile is visible in the Google Workspace global address list when the contact sharing feature is enabled for the domain. For more information about excluding user profiles, see the [administration help center](https://support.google.com/a/answer/1285988). 329 "ipWhitelisted": True or False, # If `true`, the user's IP address is [whitelisted](https://support.google.com/a/answer/60752). 330 "isAdmin": True or False, # Output only. Indicates a user with super admininistrator privileges. The `isAdmin` property can only be edited in the [Make a user an administrator](/admin-sdk/directory/v1/guides/manage-users.html#make_admin) operation ( [makeAdmin](/admin-sdk/directory/v1/reference/users/makeAdmin.html) method). If edited in the user [insert](/admin-sdk/directory/v1/reference/users/insert.html) or [update](/admin-sdk/directory/v1/reference/users/update.html) methods, the edit is ignored by the API service. 331 "isDelegatedAdmin": True or False, # Output only. Indicates if the user is a delegated administrator. Delegated administrators are supported by the API but cannot create or undelete users, or make users administrators. These requests are ignored by the API service. Roles and privileges for administrators are assigned using the [Admin console](https://support.google.com/a/answer/33325). 332 "isEnforcedIn2Sv": True or False, # Output only. Is 2-step verification enforced (Read-only) 333 "isEnrolledIn2Sv": True or False, # Output only. Is enrolled in 2-step verification (Read-only) 334 "isMailboxSetup": True or False, # Output only. Indicates if the user's Google mailbox is created. This property is only applicable if the user has been assigned a Gmail license. 335 "keywords": "", # The user's keywords. The maximum allowed data size for this field is 1Kb. 336 "kind": "admin#directory#user", # Output only. The type of the API resource. For Users resources, the value is `admin#directory#user`. 337 "languages": "", # The user's languages. The maximum allowed data size for this field is 1Kb. 338 "lastLoginTime": "A String", # User's last login time. (Read-only) 339 "locations": "", # The user's locations. The maximum allowed data size for this field is 10Kb. 340 "name": { # Holds the given and family names of the user, and the read-only `fullName` value. The maximum number of characters in the `givenName` and in the `familyName` values is 60. In addition, name values support unicode/UTF-8 characters, and can contain spaces, letters (a-z), numbers (0-9), dashes (-), forward slashes (/), and periods (.). For more information about character usage rules, see the [administration help center](https://support.google.com/a/answer/9193374). Maximum allowed data size for this field is 1Kb. 341 "familyName": "A String", # The user's last name. Required when creating a user account. 342 "fullName": "A String", # The user's full name formed by concatenating the first and last name values. 343 "givenName": "A String", # The user's first name. Required when creating a user account. 344 }, 345 "nonEditableAliases": [ # Output only. List of the user's non-editable alias email addresses. These are typically outside the account's primary domain or sub-domain. 346 "A String", 347 ], 348 "notes": "", # Notes for the user. 349 "orgUnitPath": "A String", # The full path of the parent organization associated with the user. If the parent organization is the top-level, it is represented as a forward slash (`/`). 350 "organizations": "", # A list of organizations the user belongs to. The maximum allowed data size for this field is 10Kb. 351 "password": "A String", # User's password 352 "phones": "", # A list of the user's phone numbers. The maximum allowed data size for this field is 1Kb. 353 "posixAccounts": "", # A list of [POSIX](https://www.opengroup.org/austin/papers/posix_faq.html) account information for the user. 354 "primaryEmail": "A String", # The user's primary email address. This property is required in a request to create a user account. The `primaryEmail` must be unique and cannot be an alias of another user. 355 "recoveryEmail": "A String", # Recovery email of the user. 356 "recoveryPhone": "A String", # Recovery phone of the user. The phone number must be in the E.164 format, starting with the plus sign (+). Example: *+16506661212*. 357 "relations": "", # A list of the user's relationships to other users. The maximum allowed data size for this field is 2Kb. 358 "sshPublicKeys": "", # A list of SSH public keys. 359 "suspended": True or False, # Indicates if user is suspended. 360 "suspensionReason": "A String", # Output only. Has the reason a user account is suspended either by the administrator or by Google at the time of suspension. The property is returned only if the `suspended` property is `true`. 361 "thumbnailPhotoEtag": "A String", # Output only. ETag of the user's photo (Read-only) 362 "thumbnailPhotoUrl": "A String", # Output only. Photo Url of the user (Read-only) 363 "websites": "", # The user's websites. The maximum allowed data size for this field is 2Kb. 364}</pre> 365</div> 366 367<div class="method"> 368 <code class="details" id="list">list(customFieldMask=None, customer=None, domain=None, event=None, maxResults=None, orderBy=None, pageToken=None, projection=None, query=None, showDeleted=None, sortOrder=None, viewType=None, x__xgafv=None)</code> 369 <pre>Retrieves a paginated list of either deleted users or all users in a domain. 370 371Args: 372 customFieldMask: string, A comma-separated list of schema names. All fields from these schemas are fetched. This should only be set when `projection=custom`. 373 customer: string, The unique ID for the customer's Google Workspace account. In case of a multi-domain account, to fetch all groups for a customer, fill this field instead of domain. You can also use the `my_customer` alias to represent your account's `customerId`. The `customerId` is also returned as part of the [Users resource](/admin-sdk/directory/v1/reference/users). Either the `customer` or the `domain` parameter must be provided. 374 domain: string, The domain name. Use this field to get fields from only one domain. To return all domains for a customer account, use the `customer` query parameter instead. Either the `customer` or the `domain` parameter must be provided. 375 event: string, Event on which subscription is intended (if subscribing) 376 Allowed values 377 add - User Created Event 378 delete - User Deleted Event 379 makeAdmin - User Admin Status Change Event 380 undelete - User Undeleted Event 381 update - User Updated Event 382 maxResults: integer, Maximum number of results to return. 383 orderBy: string, Property to use for sorting results. 384 Allowed values 385 email - Primary email of the user. 386 familyName - User's family name. 387 givenName - User's given name. 388 pageToken: string, Token to specify next page in the list 389 projection: string, What subset of fields to fetch for this user. 390 Allowed values 391 basic - Do not include any custom fields for the user. 392 custom - Include custom fields from schemas requested in `customFieldMask`. 393 full - Include all fields associated with this user. 394 query: string, Query string for searching user fields. For more information on constructing user queries, see [Search for Users](/admin-sdk/directory/v1/guides/search-users). 395 showDeleted: string, If set to `true`, retrieves the list of deleted users. (Default: `false`) 396 sortOrder: string, Whether to return results in ascending or descending order. 397 Allowed values 398 ASCENDING - Ascending order. 399 DESCENDING - Descending order. 400 viewType: string, Whether to fetch the administrator-only or domain-wide public view of the user. For more information, see [Retrieve a user as a non-administrator](/admin-sdk/directory/v1/guides/manage-users#retrieve_users_non_admin). 401 Allowed values 402 admin_view - Results include both administrator-only and domain-public fields for the user. 403 domain_public - Results only include fields for the user that are publicly visible to other users in the domain. 404 x__xgafv: string, V1 error format. 405 Allowed values 406 1 - v1 error format 407 2 - v2 error format 408 409Returns: 410 An object of the form: 411 412 { 413 "etag": "A String", # ETag of the resource. 414 "kind": "admin#directory#users", # Kind of resource this is. 415 "nextPageToken": "A String", # Token used to access next page of this result. 416 "trigger_event": "A String", # Event that triggered this response (only used in case of Push Response) 417 "users": [ # List of user objects. 418 { # The Directory API allows you to create and manage your account's users, user aliases, and user Gmail chat profile photos. For more information about common tasks, see the [User Accounts Developer's Guide](/admin-sdk/directory/v1/guides/manage-users.html) and the [User Aliases Developer's Guide](/admin-sdk/directory/v1/guides/manage-user-aliases.html). 419 "addresses": "", # A list of the user's addresses. The maximum allowed data size for this field is 10Kb. 420 "agreedToTerms": True or False, # Output only. This property is `true` if the user has completed an initial login and accepted the Terms of Service agreement. 421 "aliases": [ # Output only. A list of the user's alias email addresses. 422 "A String", 423 ], 424 "archived": True or False, # Indicates if user is archived. 425 "changePasswordAtNextLogin": True or False, # Indicates if the user is forced to change their password at next login. This setting doesn't apply when [the user signs in via a third-party identity provider](https://support.google.com/a/answer/60224). 426 "creationTime": "A String", # User's G Suite account creation time. (Read-only) 427 "customSchemas": { # Custom fields of the user. The key is a `schema_name` and its values are `'field_name': 'field_value'`. 428 "a_key": { # JSON template for a set of custom properties (i.e. all fields in a particular schema) 429 "a_key": "", 430 }, 431 }, 432 "customerId": "A String", # Output only. The customer ID to [retrieve all account users](/admin-sdk/directory/v1/guides/manage-users.html#get_all_users). You can use the alias `my_customer` to represent your account's `customerId`. As a reseller administrator, you can use the resold customer account's `customerId`. To get a `customerId`, use the account's primary domain in the `domain` parameter of a [users.list](/admin-sdk/directory/v1/reference/users/list) request. 433 "deletionTime": "A String", 434 "emails": "", # A list of the user's email addresses. The maximum allowed data size for this field is 10Kb. 435 "etag": "A String", # Output only. ETag of the resource. 436 "externalIds": "", # A list of external IDs for the user, such as an employee or network ID. The maximum allowed data size for this field is 2Kb. 437 "gender": "", # The user's gender. The maximum allowed data size for this field is 1Kb. 438 "hashFunction": "A String", # Stores the hash format of the password property. We recommend sending the `password` property value as a base 16 bit hexadecimal-encoded hash value. Set the `hashFunction` values as either the [SHA-1](https://wikipedia.org/wiki/SHA-1), [MD5](https://wikipedia.org/wiki/MD5), or [crypt](https://en.wikipedia.org/wiki/Crypt_\(C\)) hash format. 439 "id": "A String", # The unique ID for the user. A user `id` can be used as a user request URI's `userKey`. 440 "ims": "", # The user's Instant Messenger (IM) accounts. A user account can have multiple ims properties. But, only one of these ims properties can be the primary IM contact. The maximum allowed data size for this field is 2Kb. 441 "includeInGlobalAddressList": True or False, # Indicates if the user's profile is visible in the Google Workspace global address list when the contact sharing feature is enabled for the domain. For more information about excluding user profiles, see the [administration help center](https://support.google.com/a/answer/1285988). 442 "ipWhitelisted": True or False, # If `true`, the user's IP address is [whitelisted](https://support.google.com/a/answer/60752). 443 "isAdmin": True or False, # Output only. Indicates a user with super admininistrator privileges. The `isAdmin` property can only be edited in the [Make a user an administrator](/admin-sdk/directory/v1/guides/manage-users.html#make_admin) operation ( [makeAdmin](/admin-sdk/directory/v1/reference/users/makeAdmin.html) method). If edited in the user [insert](/admin-sdk/directory/v1/reference/users/insert.html) or [update](/admin-sdk/directory/v1/reference/users/update.html) methods, the edit is ignored by the API service. 444 "isDelegatedAdmin": True or False, # Output only. Indicates if the user is a delegated administrator. Delegated administrators are supported by the API but cannot create or undelete users, or make users administrators. These requests are ignored by the API service. Roles and privileges for administrators are assigned using the [Admin console](https://support.google.com/a/answer/33325). 445 "isEnforcedIn2Sv": True or False, # Output only. Is 2-step verification enforced (Read-only) 446 "isEnrolledIn2Sv": True or False, # Output only. Is enrolled in 2-step verification (Read-only) 447 "isMailboxSetup": True or False, # Output only. Indicates if the user's Google mailbox is created. This property is only applicable if the user has been assigned a Gmail license. 448 "keywords": "", # The user's keywords. The maximum allowed data size for this field is 1Kb. 449 "kind": "admin#directory#user", # Output only. The type of the API resource. For Users resources, the value is `admin#directory#user`. 450 "languages": "", # The user's languages. The maximum allowed data size for this field is 1Kb. 451 "lastLoginTime": "A String", # User's last login time. (Read-only) 452 "locations": "", # The user's locations. The maximum allowed data size for this field is 10Kb. 453 "name": { # Holds the given and family names of the user, and the read-only `fullName` value. The maximum number of characters in the `givenName` and in the `familyName` values is 60. In addition, name values support unicode/UTF-8 characters, and can contain spaces, letters (a-z), numbers (0-9), dashes (-), forward slashes (/), and periods (.). For more information about character usage rules, see the [administration help center](https://support.google.com/a/answer/9193374). Maximum allowed data size for this field is 1Kb. 454 "familyName": "A String", # The user's last name. Required when creating a user account. 455 "fullName": "A String", # The user's full name formed by concatenating the first and last name values. 456 "givenName": "A String", # The user's first name. Required when creating a user account. 457 }, 458 "nonEditableAliases": [ # Output only. List of the user's non-editable alias email addresses. These are typically outside the account's primary domain or sub-domain. 459 "A String", 460 ], 461 "notes": "", # Notes for the user. 462 "orgUnitPath": "A String", # The full path of the parent organization associated with the user. If the parent organization is the top-level, it is represented as a forward slash (`/`). 463 "organizations": "", # A list of organizations the user belongs to. The maximum allowed data size for this field is 10Kb. 464 "password": "A String", # User's password 465 "phones": "", # A list of the user's phone numbers. The maximum allowed data size for this field is 1Kb. 466 "posixAccounts": "", # A list of [POSIX](https://www.opengroup.org/austin/papers/posix_faq.html) account information for the user. 467 "primaryEmail": "A String", # The user's primary email address. This property is required in a request to create a user account. The `primaryEmail` must be unique and cannot be an alias of another user. 468 "recoveryEmail": "A String", # Recovery email of the user. 469 "recoveryPhone": "A String", # Recovery phone of the user. The phone number must be in the E.164 format, starting with the plus sign (+). Example: *+16506661212*. 470 "relations": "", # A list of the user's relationships to other users. The maximum allowed data size for this field is 2Kb. 471 "sshPublicKeys": "", # A list of SSH public keys. 472 "suspended": True or False, # Indicates if user is suspended. 473 "suspensionReason": "A String", # Output only. Has the reason a user account is suspended either by the administrator or by Google at the time of suspension. The property is returned only if the `suspended` property is `true`. 474 "thumbnailPhotoEtag": "A String", # Output only. ETag of the user's photo (Read-only) 475 "thumbnailPhotoUrl": "A String", # Output only. Photo Url of the user (Read-only) 476 "websites": "", # The user's websites. The maximum allowed data size for this field is 2Kb. 477 }, 478 ], 479}</pre> 480</div> 481 482<div class="method"> 483 <code class="details" id="list_next">list_next(previous_request, previous_response)</code> 484 <pre>Retrieves the next page of results. 485 486Args: 487 previous_request: The request for the previous page. (required) 488 previous_response: The response from the request for the previous page. (required) 489 490Returns: 491 A request object that you can call 'execute()' on to request the next 492 page. Returns None if there are no more items in the collection. 493 </pre> 494</div> 495 496<div class="method"> 497 <code class="details" id="makeAdmin">makeAdmin(userKey, body=None, x__xgafv=None)</code> 498 <pre>Makes a user a super administrator. 499 500Args: 501 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) 502 body: object, The request body. 503 The object takes the form of: 504 505{ 506 "status": True or False, # Indicates the administrator status of the user. 507} 508 509 x__xgafv: string, V1 error format. 510 Allowed values 511 1 - v1 error format 512 2 - v2 error format 513</pre> 514</div> 515 516<div class="method"> 517 <code class="details" id="patch">patch(userKey, body=None, x__xgafv=None)</code> 518 <pre>Updates a user using patch semantics. The update method should be used instead, since it also supports patch semantics and has better performance. This method is unable to clear fields that contain repeated objects (`addresses`, `phones`, etc). Use the update method instead. 519 520Args: 521 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) 522 body: object, The request body. 523 The object takes the form of: 524 525{ # The Directory API allows you to create and manage your account's users, user aliases, and user Gmail chat profile photos. For more information about common tasks, see the [User Accounts Developer's Guide](/admin-sdk/directory/v1/guides/manage-users.html) and the [User Aliases Developer's Guide](/admin-sdk/directory/v1/guides/manage-user-aliases.html). 526 "addresses": "", # A list of the user's addresses. The maximum allowed data size for this field is 10Kb. 527 "agreedToTerms": True or False, # Output only. This property is `true` if the user has completed an initial login and accepted the Terms of Service agreement. 528 "aliases": [ # Output only. A list of the user's alias email addresses. 529 "A String", 530 ], 531 "archived": True or False, # Indicates if user is archived. 532 "changePasswordAtNextLogin": True or False, # Indicates if the user is forced to change their password at next login. This setting doesn't apply when [the user signs in via a third-party identity provider](https://support.google.com/a/answer/60224). 533 "creationTime": "A String", # User's G Suite account creation time. (Read-only) 534 "customSchemas": { # Custom fields of the user. The key is a `schema_name` and its values are `'field_name': 'field_value'`. 535 "a_key": { # JSON template for a set of custom properties (i.e. all fields in a particular schema) 536 "a_key": "", 537 }, 538 }, 539 "customerId": "A String", # Output only. The customer ID to [retrieve all account users](/admin-sdk/directory/v1/guides/manage-users.html#get_all_users). You can use the alias `my_customer` to represent your account's `customerId`. As a reseller administrator, you can use the resold customer account's `customerId`. To get a `customerId`, use the account's primary domain in the `domain` parameter of a [users.list](/admin-sdk/directory/v1/reference/users/list) request. 540 "deletionTime": "A String", 541 "emails": "", # A list of the user's email addresses. The maximum allowed data size for this field is 10Kb. 542 "etag": "A String", # Output only. ETag of the resource. 543 "externalIds": "", # A list of external IDs for the user, such as an employee or network ID. The maximum allowed data size for this field is 2Kb. 544 "gender": "", # The user's gender. The maximum allowed data size for this field is 1Kb. 545 "hashFunction": "A String", # Stores the hash format of the password property. We recommend sending the `password` property value as a base 16 bit hexadecimal-encoded hash value. Set the `hashFunction` values as either the [SHA-1](https://wikipedia.org/wiki/SHA-1), [MD5](https://wikipedia.org/wiki/MD5), or [crypt](https://en.wikipedia.org/wiki/Crypt_\(C\)) hash format. 546 "id": "A String", # The unique ID for the user. A user `id` can be used as a user request URI's `userKey`. 547 "ims": "", # The user's Instant Messenger (IM) accounts. A user account can have multiple ims properties. But, only one of these ims properties can be the primary IM contact. The maximum allowed data size for this field is 2Kb. 548 "includeInGlobalAddressList": True or False, # Indicates if the user's profile is visible in the Google Workspace global address list when the contact sharing feature is enabled for the domain. For more information about excluding user profiles, see the [administration help center](https://support.google.com/a/answer/1285988). 549 "ipWhitelisted": True or False, # If `true`, the user's IP address is [whitelisted](https://support.google.com/a/answer/60752). 550 "isAdmin": True or False, # Output only. Indicates a user with super admininistrator privileges. The `isAdmin` property can only be edited in the [Make a user an administrator](/admin-sdk/directory/v1/guides/manage-users.html#make_admin) operation ( [makeAdmin](/admin-sdk/directory/v1/reference/users/makeAdmin.html) method). If edited in the user [insert](/admin-sdk/directory/v1/reference/users/insert.html) or [update](/admin-sdk/directory/v1/reference/users/update.html) methods, the edit is ignored by the API service. 551 "isDelegatedAdmin": True or False, # Output only. Indicates if the user is a delegated administrator. Delegated administrators are supported by the API but cannot create or undelete users, or make users administrators. These requests are ignored by the API service. Roles and privileges for administrators are assigned using the [Admin console](https://support.google.com/a/answer/33325). 552 "isEnforcedIn2Sv": True or False, # Output only. Is 2-step verification enforced (Read-only) 553 "isEnrolledIn2Sv": True or False, # Output only. Is enrolled in 2-step verification (Read-only) 554 "isMailboxSetup": True or False, # Output only. Indicates if the user's Google mailbox is created. This property is only applicable if the user has been assigned a Gmail license. 555 "keywords": "", # The user's keywords. The maximum allowed data size for this field is 1Kb. 556 "kind": "admin#directory#user", # Output only. The type of the API resource. For Users resources, the value is `admin#directory#user`. 557 "languages": "", # The user's languages. The maximum allowed data size for this field is 1Kb. 558 "lastLoginTime": "A String", # User's last login time. (Read-only) 559 "locations": "", # The user's locations. The maximum allowed data size for this field is 10Kb. 560 "name": { # Holds the given and family names of the user, and the read-only `fullName` value. The maximum number of characters in the `givenName` and in the `familyName` values is 60. In addition, name values support unicode/UTF-8 characters, and can contain spaces, letters (a-z), numbers (0-9), dashes (-), forward slashes (/), and periods (.). For more information about character usage rules, see the [administration help center](https://support.google.com/a/answer/9193374). Maximum allowed data size for this field is 1Kb. 561 "familyName": "A String", # The user's last name. Required when creating a user account. 562 "fullName": "A String", # The user's full name formed by concatenating the first and last name values. 563 "givenName": "A String", # The user's first name. Required when creating a user account. 564 }, 565 "nonEditableAliases": [ # Output only. List of the user's non-editable alias email addresses. These are typically outside the account's primary domain or sub-domain. 566 "A String", 567 ], 568 "notes": "", # Notes for the user. 569 "orgUnitPath": "A String", # The full path of the parent organization associated with the user. If the parent organization is the top-level, it is represented as a forward slash (`/`). 570 "organizations": "", # A list of organizations the user belongs to. The maximum allowed data size for this field is 10Kb. 571 "password": "A String", # User's password 572 "phones": "", # A list of the user's phone numbers. The maximum allowed data size for this field is 1Kb. 573 "posixAccounts": "", # A list of [POSIX](https://www.opengroup.org/austin/papers/posix_faq.html) account information for the user. 574 "primaryEmail": "A String", # The user's primary email address. This property is required in a request to create a user account. The `primaryEmail` must be unique and cannot be an alias of another user. 575 "recoveryEmail": "A String", # Recovery email of the user. 576 "recoveryPhone": "A String", # Recovery phone of the user. The phone number must be in the E.164 format, starting with the plus sign (+). Example: *+16506661212*. 577 "relations": "", # A list of the user's relationships to other users. The maximum allowed data size for this field is 2Kb. 578 "sshPublicKeys": "", # A list of SSH public keys. 579 "suspended": True or False, # Indicates if user is suspended. 580 "suspensionReason": "A String", # Output only. Has the reason a user account is suspended either by the administrator or by Google at the time of suspension. The property is returned only if the `suspended` property is `true`. 581 "thumbnailPhotoEtag": "A String", # Output only. ETag of the user's photo (Read-only) 582 "thumbnailPhotoUrl": "A String", # Output only. Photo Url of the user (Read-only) 583 "websites": "", # The user's websites. The maximum allowed data size for this field is 2Kb. 584} 585 586 x__xgafv: string, V1 error format. 587 Allowed values 588 1 - v1 error format 589 2 - v2 error format 590 591Returns: 592 An object of the form: 593 594 { # The Directory API allows you to create and manage your account's users, user aliases, and user Gmail chat profile photos. For more information about common tasks, see the [User Accounts Developer's Guide](/admin-sdk/directory/v1/guides/manage-users.html) and the [User Aliases Developer's Guide](/admin-sdk/directory/v1/guides/manage-user-aliases.html). 595 "addresses": "", # A list of the user's addresses. The maximum allowed data size for this field is 10Kb. 596 "agreedToTerms": True or False, # Output only. This property is `true` if the user has completed an initial login and accepted the Terms of Service agreement. 597 "aliases": [ # Output only. A list of the user's alias email addresses. 598 "A String", 599 ], 600 "archived": True or False, # Indicates if user is archived. 601 "changePasswordAtNextLogin": True or False, # Indicates if the user is forced to change their password at next login. This setting doesn't apply when [the user signs in via a third-party identity provider](https://support.google.com/a/answer/60224). 602 "creationTime": "A String", # User's G Suite account creation time. (Read-only) 603 "customSchemas": { # Custom fields of the user. The key is a `schema_name` and its values are `'field_name': 'field_value'`. 604 "a_key": { # JSON template for a set of custom properties (i.e. all fields in a particular schema) 605 "a_key": "", 606 }, 607 }, 608 "customerId": "A String", # Output only. The customer ID to [retrieve all account users](/admin-sdk/directory/v1/guides/manage-users.html#get_all_users). You can use the alias `my_customer` to represent your account's `customerId`. As a reseller administrator, you can use the resold customer account's `customerId`. To get a `customerId`, use the account's primary domain in the `domain` parameter of a [users.list](/admin-sdk/directory/v1/reference/users/list) request. 609 "deletionTime": "A String", 610 "emails": "", # A list of the user's email addresses. The maximum allowed data size for this field is 10Kb. 611 "etag": "A String", # Output only. ETag of the resource. 612 "externalIds": "", # A list of external IDs for the user, such as an employee or network ID. The maximum allowed data size for this field is 2Kb. 613 "gender": "", # The user's gender. The maximum allowed data size for this field is 1Kb. 614 "hashFunction": "A String", # Stores the hash format of the password property. We recommend sending the `password` property value as a base 16 bit hexadecimal-encoded hash value. Set the `hashFunction` values as either the [SHA-1](https://wikipedia.org/wiki/SHA-1), [MD5](https://wikipedia.org/wiki/MD5), or [crypt](https://en.wikipedia.org/wiki/Crypt_\(C\)) hash format. 615 "id": "A String", # The unique ID for the user. A user `id` can be used as a user request URI's `userKey`. 616 "ims": "", # The user's Instant Messenger (IM) accounts. A user account can have multiple ims properties. But, only one of these ims properties can be the primary IM contact. The maximum allowed data size for this field is 2Kb. 617 "includeInGlobalAddressList": True or False, # Indicates if the user's profile is visible in the Google Workspace global address list when the contact sharing feature is enabled for the domain. For more information about excluding user profiles, see the [administration help center](https://support.google.com/a/answer/1285988). 618 "ipWhitelisted": True or False, # If `true`, the user's IP address is [whitelisted](https://support.google.com/a/answer/60752). 619 "isAdmin": True or False, # Output only. Indicates a user with super admininistrator privileges. The `isAdmin` property can only be edited in the [Make a user an administrator](/admin-sdk/directory/v1/guides/manage-users.html#make_admin) operation ( [makeAdmin](/admin-sdk/directory/v1/reference/users/makeAdmin.html) method). If edited in the user [insert](/admin-sdk/directory/v1/reference/users/insert.html) or [update](/admin-sdk/directory/v1/reference/users/update.html) methods, the edit is ignored by the API service. 620 "isDelegatedAdmin": True or False, # Output only. Indicates if the user is a delegated administrator. Delegated administrators are supported by the API but cannot create or undelete users, or make users administrators. These requests are ignored by the API service. Roles and privileges for administrators are assigned using the [Admin console](https://support.google.com/a/answer/33325). 621 "isEnforcedIn2Sv": True or False, # Output only. Is 2-step verification enforced (Read-only) 622 "isEnrolledIn2Sv": True or False, # Output only. Is enrolled in 2-step verification (Read-only) 623 "isMailboxSetup": True or False, # Output only. Indicates if the user's Google mailbox is created. This property is only applicable if the user has been assigned a Gmail license. 624 "keywords": "", # The user's keywords. The maximum allowed data size for this field is 1Kb. 625 "kind": "admin#directory#user", # Output only. The type of the API resource. For Users resources, the value is `admin#directory#user`. 626 "languages": "", # The user's languages. The maximum allowed data size for this field is 1Kb. 627 "lastLoginTime": "A String", # User's last login time. (Read-only) 628 "locations": "", # The user's locations. The maximum allowed data size for this field is 10Kb. 629 "name": { # Holds the given and family names of the user, and the read-only `fullName` value. The maximum number of characters in the `givenName` and in the `familyName` values is 60. In addition, name values support unicode/UTF-8 characters, and can contain spaces, letters (a-z), numbers (0-9), dashes (-), forward slashes (/), and periods (.). For more information about character usage rules, see the [administration help center](https://support.google.com/a/answer/9193374). Maximum allowed data size for this field is 1Kb. 630 "familyName": "A String", # The user's last name. Required when creating a user account. 631 "fullName": "A String", # The user's full name formed by concatenating the first and last name values. 632 "givenName": "A String", # The user's first name. Required when creating a user account. 633 }, 634 "nonEditableAliases": [ # Output only. List of the user's non-editable alias email addresses. These are typically outside the account's primary domain or sub-domain. 635 "A String", 636 ], 637 "notes": "", # Notes for the user. 638 "orgUnitPath": "A String", # The full path of the parent organization associated with the user. If the parent organization is the top-level, it is represented as a forward slash (`/`). 639 "organizations": "", # A list of organizations the user belongs to. The maximum allowed data size for this field is 10Kb. 640 "password": "A String", # User's password 641 "phones": "", # A list of the user's phone numbers. The maximum allowed data size for this field is 1Kb. 642 "posixAccounts": "", # A list of [POSIX](https://www.opengroup.org/austin/papers/posix_faq.html) account information for the user. 643 "primaryEmail": "A String", # The user's primary email address. This property is required in a request to create a user account. The `primaryEmail` must be unique and cannot be an alias of another user. 644 "recoveryEmail": "A String", # Recovery email of the user. 645 "recoveryPhone": "A String", # Recovery phone of the user. The phone number must be in the E.164 format, starting with the plus sign (+). Example: *+16506661212*. 646 "relations": "", # A list of the user's relationships to other users. The maximum allowed data size for this field is 2Kb. 647 "sshPublicKeys": "", # A list of SSH public keys. 648 "suspended": True or False, # Indicates if user is suspended. 649 "suspensionReason": "A String", # Output only. Has the reason a user account is suspended either by the administrator or by Google at the time of suspension. The property is returned only if the `suspended` property is `true`. 650 "thumbnailPhotoEtag": "A String", # Output only. ETag of the user's photo (Read-only) 651 "thumbnailPhotoUrl": "A String", # Output only. Photo Url of the user (Read-only) 652 "websites": "", # The user's websites. The maximum allowed data size for this field is 2Kb. 653}</pre> 654</div> 655 656<div class="method"> 657 <code class="details" id="signOut">signOut(userKey, x__xgafv=None)</code> 658 <pre>Signs a user out of all web and device sessions and reset their sign-in cookies. User will have to sign in by authenticating again. 659 660Args: 661 userKey: string, Identifies the target user in the API request. The value can be the user's primary email address, alias email address, or unique user ID. (required) 662 x__xgafv: string, V1 error format. 663 Allowed values 664 1 - v1 error format 665 2 - v2 error format 666</pre> 667</div> 668 669<div class="method"> 670 <code class="details" id="undelete">undelete(userKey, body=None, x__xgafv=None)</code> 671 <pre>Undeletes a deleted user. 672 673Args: 674 userKey: string, The immutable id of the user (required) 675 body: object, The request body. 676 The object takes the form of: 677 678{ 679 "orgUnitPath": "A String", # OrgUnit of User 680} 681 682 x__xgafv: string, V1 error format. 683 Allowed values 684 1 - v1 error format 685 2 - v2 error format 686</pre> 687</div> 688 689<div class="method"> 690 <code class="details" id="update">update(userKey, body=None, x__xgafv=None)</code> 691 <pre>Updates a user. This method supports patch semantics, meaning you only need to include the fields you wish to update. Fields that are not present in the request will be preserved, and fields set to `null` will be cleared. 692 693Args: 694 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) 695 body: object, The request body. 696 The object takes the form of: 697 698{ # The Directory API allows you to create and manage your account's users, user aliases, and user Gmail chat profile photos. For more information about common tasks, see the [User Accounts Developer's Guide](/admin-sdk/directory/v1/guides/manage-users.html) and the [User Aliases Developer's Guide](/admin-sdk/directory/v1/guides/manage-user-aliases.html). 699 "addresses": "", # A list of the user's addresses. The maximum allowed data size for this field is 10Kb. 700 "agreedToTerms": True or False, # Output only. This property is `true` if the user has completed an initial login and accepted the Terms of Service agreement. 701 "aliases": [ # Output only. A list of the user's alias email addresses. 702 "A String", 703 ], 704 "archived": True or False, # Indicates if user is archived. 705 "changePasswordAtNextLogin": True or False, # Indicates if the user is forced to change their password at next login. This setting doesn't apply when [the user signs in via a third-party identity provider](https://support.google.com/a/answer/60224). 706 "creationTime": "A String", # User's G Suite account creation time. (Read-only) 707 "customSchemas": { # Custom fields of the user. The key is a `schema_name` and its values are `'field_name': 'field_value'`. 708 "a_key": { # JSON template for a set of custom properties (i.e. all fields in a particular schema) 709 "a_key": "", 710 }, 711 }, 712 "customerId": "A String", # Output only. The customer ID to [retrieve all account users](/admin-sdk/directory/v1/guides/manage-users.html#get_all_users). You can use the alias `my_customer` to represent your account's `customerId`. As a reseller administrator, you can use the resold customer account's `customerId`. To get a `customerId`, use the account's primary domain in the `domain` parameter of a [users.list](/admin-sdk/directory/v1/reference/users/list) request. 713 "deletionTime": "A String", 714 "emails": "", # A list of the user's email addresses. The maximum allowed data size for this field is 10Kb. 715 "etag": "A String", # Output only. ETag of the resource. 716 "externalIds": "", # A list of external IDs for the user, such as an employee or network ID. The maximum allowed data size for this field is 2Kb. 717 "gender": "", # The user's gender. The maximum allowed data size for this field is 1Kb. 718 "hashFunction": "A String", # Stores the hash format of the password property. We recommend sending the `password` property value as a base 16 bit hexadecimal-encoded hash value. Set the `hashFunction` values as either the [SHA-1](https://wikipedia.org/wiki/SHA-1), [MD5](https://wikipedia.org/wiki/MD5), or [crypt](https://en.wikipedia.org/wiki/Crypt_\(C\)) hash format. 719 "id": "A String", # The unique ID for the user. A user `id` can be used as a user request URI's `userKey`. 720 "ims": "", # The user's Instant Messenger (IM) accounts. A user account can have multiple ims properties. But, only one of these ims properties can be the primary IM contact. The maximum allowed data size for this field is 2Kb. 721 "includeInGlobalAddressList": True or False, # Indicates if the user's profile is visible in the Google Workspace global address list when the contact sharing feature is enabled for the domain. For more information about excluding user profiles, see the [administration help center](https://support.google.com/a/answer/1285988). 722 "ipWhitelisted": True or False, # If `true`, the user's IP address is [whitelisted](https://support.google.com/a/answer/60752). 723 "isAdmin": True or False, # Output only. Indicates a user with super admininistrator privileges. The `isAdmin` property can only be edited in the [Make a user an administrator](/admin-sdk/directory/v1/guides/manage-users.html#make_admin) operation ( [makeAdmin](/admin-sdk/directory/v1/reference/users/makeAdmin.html) method). If edited in the user [insert](/admin-sdk/directory/v1/reference/users/insert.html) or [update](/admin-sdk/directory/v1/reference/users/update.html) methods, the edit is ignored by the API service. 724 "isDelegatedAdmin": True or False, # Output only. Indicates if the user is a delegated administrator. Delegated administrators are supported by the API but cannot create or undelete users, or make users administrators. These requests are ignored by the API service. Roles and privileges for administrators are assigned using the [Admin console](https://support.google.com/a/answer/33325). 725 "isEnforcedIn2Sv": True or False, # Output only. Is 2-step verification enforced (Read-only) 726 "isEnrolledIn2Sv": True or False, # Output only. Is enrolled in 2-step verification (Read-only) 727 "isMailboxSetup": True or False, # Output only. Indicates if the user's Google mailbox is created. This property is only applicable if the user has been assigned a Gmail license. 728 "keywords": "", # The user's keywords. The maximum allowed data size for this field is 1Kb. 729 "kind": "admin#directory#user", # Output only. The type of the API resource. For Users resources, the value is `admin#directory#user`. 730 "languages": "", # The user's languages. The maximum allowed data size for this field is 1Kb. 731 "lastLoginTime": "A String", # User's last login time. (Read-only) 732 "locations": "", # The user's locations. The maximum allowed data size for this field is 10Kb. 733 "name": { # Holds the given and family names of the user, and the read-only `fullName` value. The maximum number of characters in the `givenName` and in the `familyName` values is 60. In addition, name values support unicode/UTF-8 characters, and can contain spaces, letters (a-z), numbers (0-9), dashes (-), forward slashes (/), and periods (.). For more information about character usage rules, see the [administration help center](https://support.google.com/a/answer/9193374). Maximum allowed data size for this field is 1Kb. 734 "familyName": "A String", # The user's last name. Required when creating a user account. 735 "fullName": "A String", # The user's full name formed by concatenating the first and last name values. 736 "givenName": "A String", # The user's first name. Required when creating a user account. 737 }, 738 "nonEditableAliases": [ # Output only. List of the user's non-editable alias email addresses. These are typically outside the account's primary domain or sub-domain. 739 "A String", 740 ], 741 "notes": "", # Notes for the user. 742 "orgUnitPath": "A String", # The full path of the parent organization associated with the user. If the parent organization is the top-level, it is represented as a forward slash (`/`). 743 "organizations": "", # A list of organizations the user belongs to. The maximum allowed data size for this field is 10Kb. 744 "password": "A String", # User's password 745 "phones": "", # A list of the user's phone numbers. The maximum allowed data size for this field is 1Kb. 746 "posixAccounts": "", # A list of [POSIX](https://www.opengroup.org/austin/papers/posix_faq.html) account information for the user. 747 "primaryEmail": "A String", # The user's primary email address. This property is required in a request to create a user account. The `primaryEmail` must be unique and cannot be an alias of another user. 748 "recoveryEmail": "A String", # Recovery email of the user. 749 "recoveryPhone": "A String", # Recovery phone of the user. The phone number must be in the E.164 format, starting with the plus sign (+). Example: *+16506661212*. 750 "relations": "", # A list of the user's relationships to other users. The maximum allowed data size for this field is 2Kb. 751 "sshPublicKeys": "", # A list of SSH public keys. 752 "suspended": True or False, # Indicates if user is suspended. 753 "suspensionReason": "A String", # Output only. Has the reason a user account is suspended either by the administrator or by Google at the time of suspension. The property is returned only if the `suspended` property is `true`. 754 "thumbnailPhotoEtag": "A String", # Output only. ETag of the user's photo (Read-only) 755 "thumbnailPhotoUrl": "A String", # Output only. Photo Url of the user (Read-only) 756 "websites": "", # The user's websites. The maximum allowed data size for this field is 2Kb. 757} 758 759 x__xgafv: string, V1 error format. 760 Allowed values 761 1 - v1 error format 762 2 - v2 error format 763 764Returns: 765 An object of the form: 766 767 { # The Directory API allows you to create and manage your account's users, user aliases, and user Gmail chat profile photos. For more information about common tasks, see the [User Accounts Developer's Guide](/admin-sdk/directory/v1/guides/manage-users.html) and the [User Aliases Developer's Guide](/admin-sdk/directory/v1/guides/manage-user-aliases.html). 768 "addresses": "", # A list of the user's addresses. The maximum allowed data size for this field is 10Kb. 769 "agreedToTerms": True or False, # Output only. This property is `true` if the user has completed an initial login and accepted the Terms of Service agreement. 770 "aliases": [ # Output only. A list of the user's alias email addresses. 771 "A String", 772 ], 773 "archived": True or False, # Indicates if user is archived. 774 "changePasswordAtNextLogin": True or False, # Indicates if the user is forced to change their password at next login. This setting doesn't apply when [the user signs in via a third-party identity provider](https://support.google.com/a/answer/60224). 775 "creationTime": "A String", # User's G Suite account creation time. (Read-only) 776 "customSchemas": { # Custom fields of the user. The key is a `schema_name` and its values are `'field_name': 'field_value'`. 777 "a_key": { # JSON template for a set of custom properties (i.e. all fields in a particular schema) 778 "a_key": "", 779 }, 780 }, 781 "customerId": "A String", # Output only. The customer ID to [retrieve all account users](/admin-sdk/directory/v1/guides/manage-users.html#get_all_users). You can use the alias `my_customer` to represent your account's `customerId`. As a reseller administrator, you can use the resold customer account's `customerId`. To get a `customerId`, use the account's primary domain in the `domain` parameter of a [users.list](/admin-sdk/directory/v1/reference/users/list) request. 782 "deletionTime": "A String", 783 "emails": "", # A list of the user's email addresses. The maximum allowed data size for this field is 10Kb. 784 "etag": "A String", # Output only. ETag of the resource. 785 "externalIds": "", # A list of external IDs for the user, such as an employee or network ID. The maximum allowed data size for this field is 2Kb. 786 "gender": "", # The user's gender. The maximum allowed data size for this field is 1Kb. 787 "hashFunction": "A String", # Stores the hash format of the password property. We recommend sending the `password` property value as a base 16 bit hexadecimal-encoded hash value. Set the `hashFunction` values as either the [SHA-1](https://wikipedia.org/wiki/SHA-1), [MD5](https://wikipedia.org/wiki/MD5), or [crypt](https://en.wikipedia.org/wiki/Crypt_\(C\)) hash format. 788 "id": "A String", # The unique ID for the user. A user `id` can be used as a user request URI's `userKey`. 789 "ims": "", # The user's Instant Messenger (IM) accounts. A user account can have multiple ims properties. But, only one of these ims properties can be the primary IM contact. The maximum allowed data size for this field is 2Kb. 790 "includeInGlobalAddressList": True or False, # Indicates if the user's profile is visible in the Google Workspace global address list when the contact sharing feature is enabled for the domain. For more information about excluding user profiles, see the [administration help center](https://support.google.com/a/answer/1285988). 791 "ipWhitelisted": True or False, # If `true`, the user's IP address is [whitelisted](https://support.google.com/a/answer/60752). 792 "isAdmin": True or False, # Output only. Indicates a user with super admininistrator privileges. The `isAdmin` property can only be edited in the [Make a user an administrator](/admin-sdk/directory/v1/guides/manage-users.html#make_admin) operation ( [makeAdmin](/admin-sdk/directory/v1/reference/users/makeAdmin.html) method). If edited in the user [insert](/admin-sdk/directory/v1/reference/users/insert.html) or [update](/admin-sdk/directory/v1/reference/users/update.html) methods, the edit is ignored by the API service. 793 "isDelegatedAdmin": True or False, # Output only. Indicates if the user is a delegated administrator. Delegated administrators are supported by the API but cannot create or undelete users, or make users administrators. These requests are ignored by the API service. Roles and privileges for administrators are assigned using the [Admin console](https://support.google.com/a/answer/33325). 794 "isEnforcedIn2Sv": True or False, # Output only. Is 2-step verification enforced (Read-only) 795 "isEnrolledIn2Sv": True or False, # Output only. Is enrolled in 2-step verification (Read-only) 796 "isMailboxSetup": True or False, # Output only. Indicates if the user's Google mailbox is created. This property is only applicable if the user has been assigned a Gmail license. 797 "keywords": "", # The user's keywords. The maximum allowed data size for this field is 1Kb. 798 "kind": "admin#directory#user", # Output only. The type of the API resource. For Users resources, the value is `admin#directory#user`. 799 "languages": "", # The user's languages. The maximum allowed data size for this field is 1Kb. 800 "lastLoginTime": "A String", # User's last login time. (Read-only) 801 "locations": "", # The user's locations. The maximum allowed data size for this field is 10Kb. 802 "name": { # Holds the given and family names of the user, and the read-only `fullName` value. The maximum number of characters in the `givenName` and in the `familyName` values is 60. In addition, name values support unicode/UTF-8 characters, and can contain spaces, letters (a-z), numbers (0-9), dashes (-), forward slashes (/), and periods (.). For more information about character usage rules, see the [administration help center](https://support.google.com/a/answer/9193374). Maximum allowed data size for this field is 1Kb. 803 "familyName": "A String", # The user's last name. Required when creating a user account. 804 "fullName": "A String", # The user's full name formed by concatenating the first and last name values. 805 "givenName": "A String", # The user's first name. Required when creating a user account. 806 }, 807 "nonEditableAliases": [ # Output only. List of the user's non-editable alias email addresses. These are typically outside the account's primary domain or sub-domain. 808 "A String", 809 ], 810 "notes": "", # Notes for the user. 811 "orgUnitPath": "A String", # The full path of the parent organization associated with the user. If the parent organization is the top-level, it is represented as a forward slash (`/`). 812 "organizations": "", # A list of organizations the user belongs to. The maximum allowed data size for this field is 10Kb. 813 "password": "A String", # User's password 814 "phones": "", # A list of the user's phone numbers. The maximum allowed data size for this field is 1Kb. 815 "posixAccounts": "", # A list of [POSIX](https://www.opengroup.org/austin/papers/posix_faq.html) account information for the user. 816 "primaryEmail": "A String", # The user's primary email address. This property is required in a request to create a user account. The `primaryEmail` must be unique and cannot be an alias of another user. 817 "recoveryEmail": "A String", # Recovery email of the user. 818 "recoveryPhone": "A String", # Recovery phone of the user. The phone number must be in the E.164 format, starting with the plus sign (+). Example: *+16506661212*. 819 "relations": "", # A list of the user's relationships to other users. The maximum allowed data size for this field is 2Kb. 820 "sshPublicKeys": "", # A list of SSH public keys. 821 "suspended": True or False, # Indicates if user is suspended. 822 "suspensionReason": "A String", # Output only. Has the reason a user account is suspended either by the administrator or by Google at the time of suspension. The property is returned only if the `suspended` property is `true`. 823 "thumbnailPhotoEtag": "A String", # Output only. ETag of the user's photo (Read-only) 824 "thumbnailPhotoUrl": "A String", # Output only. Photo Url of the user (Read-only) 825 "websites": "", # The user's websites. The maximum allowed data size for this field is 2Kb. 826}</pre> 827</div> 828 829<div class="method"> 830 <code class="details" id="watch">watch(body=None, customFieldMask=None, customer=None, domain=None, event=None, maxResults=None, orderBy=None, pageToken=None, projection=None, query=None, showDeleted=None, sortOrder=None, viewType=None, x__xgafv=None)</code> 831 <pre>Watches for changes in users list. 832 833Args: 834 body: object, The request body. 835 The object takes the form of: 836 837{ # An notification channel used to watch for resource changes. 838 "address": "A String", # The address where notifications are delivered for this channel. 839 "expiration": "A String", # Date and time of notification channel expiration, expressed as a Unix timestamp, in milliseconds. Optional. 840 "id": "A String", # A UUID or similar unique string that identifies this channel. 841 "kind": "api#channel", # Identifies this as a notification channel used to watch for changes to a resource, which is `api#channel`. 842 "params": { # Additional parameters controlling delivery channel behavior. Optional. 843 "a_key": "A String", 844 }, 845 "payload": True or False, # A Boolean value to indicate whether payload is wanted. Optional. 846 "resourceId": "A String", # An opaque ID that identifies the resource being watched on this channel. Stable across different API versions. 847 "resourceUri": "A String", # A version-specific identifier for the watched resource. 848 "token": "A String", # An arbitrary string delivered to the target address with each notification delivered over this channel. Optional. 849 "type": "A String", # The type of delivery mechanism used for this channel. 850} 851 852 customFieldMask: string, Comma-separated list of schema names. All fields from these schemas are fetched. This should only be set when projection=custom. 853 customer: string, Immutable ID of the Google Workspace account. In case of multi-domain, to fetch all users for a customer, fill this field instead of domain. 854 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." 855 event: string, Events to watch for. 856 Allowed values 857 add - User Created Event 858 delete - User Deleted Event 859 makeAdmin - User Admin Status Change Event 860 undelete - User Undeleted Event 861 update - User Updated Event 862 maxResults: integer, Maximum number of results to return. 863 orderBy: string, Column to use for sorting results 864 Allowed values 865 email - Primary email of the user. 866 familyName - User's family name. 867 givenName - User's given name. 868 pageToken: string, Token to specify next page in the list 869 projection: string, What subset of fields to fetch for this user. 870 Allowed values 871 basic - Do not include any custom fields for the user. 872 custom - Include custom fields from schemas mentioned in customFieldMask. 873 full - Include all fields associated with this user. 874 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 875 showDeleted: string, If set to true, retrieves the list of deleted users. (Default: false) 876 sortOrder: string, Whether to return results in ascending or descending order. 877 Allowed values 878 ASCENDING - Ascending order. 879 DESCENDING - Descending order. 880 viewType: string, Whether to fetch the administrator-only or domain-wide public view of the user. For more information, see [Retrieve a user as a non-administrator](/admin-sdk/directory/v1/guides/manage-users#retrieve_users_non_admin). 881 Allowed values 882 admin_view - Results include both administrator-only and domain-public fields. 883 domain_public - Results only include fields for the user that are publicly visible to other users in the domain. 884 x__xgafv: string, V1 error format. 885 Allowed values 886 1 - v1 error format 887 2 - v2 error format 888 889Returns: 890 An object of the form: 891 892 { # An notification channel used to watch for resource changes. 893 "address": "A String", # The address where notifications are delivered for this channel. 894 "expiration": "A String", # Date and time of notification channel expiration, expressed as a Unix timestamp, in milliseconds. Optional. 895 "id": "A String", # A UUID or similar unique string that identifies this channel. 896 "kind": "api#channel", # Identifies this as a notification channel used to watch for changes to a resource, which is `api#channel`. 897 "params": { # Additional parameters controlling delivery channel behavior. Optional. 898 "a_key": "A String", 899 }, 900 "payload": True or False, # A Boolean value to indicate whether payload is wanted. Optional. 901 "resourceId": "A String", # An opaque ID that identifies the resource being watched on this channel. Stable across different API versions. 902 "resourceUri": "A String", # A version-specific identifier for the watched resource. 903 "token": "A String", # An arbitrary string delivered to the target address with each notification delivered over this channel. Optional. 904 "type": "A String", # The type of delivery mechanism used for this channel. 905}</pre> 906</div> 907 908</body></html>