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 Directory 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="#delete">delete(userKey)</a></code></p> 89 <p class="firstline">Delete user</p> 90 <p class="toc_element"> 91 <code><a href="#get">get(userKey, projection=None, customFieldMask=None, viewType=None)</a></code></p> 92 <p class="firstline">retrieve user</p> 93 <p class="toc_element"> 94 <code><a href="#insert">insert(body)</a></code></p> 95 <p class="firstline">create user.</p> 96 <p class="toc_element"> 97 <code><a href="#list">list(orderBy=None, domain=None, projection=None, query=None, event=None, showDeleted=None, pageToken=None, sortOrder=None, maxResults=None, customer=None, customFieldMask=None, viewType=None)</a></code></p> 98 <p class="firstline">Retrieve either deleted users or all users in a domain (paginated)</p> 99 <p class="toc_element"> 100 <code><a href="#list_next">list_next(previous_request, previous_response)</a></code></p> 101 <p class="firstline">Retrieves the next page of results.</p> 102 <p class="toc_element"> 103 <code><a href="#makeAdmin">makeAdmin(userKey, body)</a></code></p> 104 <p class="firstline">change admin status of a user</p> 105 <p class="toc_element"> 106 <code><a href="#patch">patch(userKey, body)</a></code></p> 107 <p class="firstline">update user. This method supports patch semantics.</p> 108 <p class="toc_element"> 109 <code><a href="#undelete">undelete(userKey, body)</a></code></p> 110 <p class="firstline">Undelete a deleted user</p> 111 <p class="toc_element"> 112 <code><a href="#update">update(userKey, body)</a></code></p> 113 <p class="firstline">update user</p> 114 <p class="toc_element"> 115 <code><a href="#watch">watch(body, orderBy=None, domain=None, projection=None, query=None, event=None, showDeleted=None, pageToken=None, sortOrder=None, maxResults=None, customer=None, customFieldMask=None, viewType=None)</a></code></p> 116 <p class="firstline">Watch for changes in users list</p> 117 <h3>Method Details</h3> 118 <div class="method"> 119 <code class="details" id="delete">delete(userKey)</code> 120 <pre>Delete user 121 122 Args: 123 userKey: string, Email or immutable Id of the user (required) 124 </pre> 125 </div> 126 127 <div class="method"> 128 <code class="details" id="get">get(userKey, projection=None, customFieldMask=None, viewType=None)</code> 129 <pre>retrieve user 130 131 Args: 132 userKey: string, Email or immutable Id of the user (required) 133 projection: string, What subset of fields to fetch for this user. 134 Allowed values 135 basic - Do not include any custom fields for the user. 136 custom - Include custom fields from schemas mentioned in customFieldMask. 137 full - Include all fields associated with this user. 138 customFieldMask: string, Comma-separated list of schema names. All fields from these schemas are fetched. This should only be set when projection=custom. 139 viewType: string, Whether to fetch the ADMIN_VIEW or DOMAIN_PUBLIC view of the user. 140 Allowed values 141 admin_view - Fetches the ADMIN_VIEW of the user. 142 domain_public - Fetches the DOMAIN_PUBLIC view of the user. 143 144 Returns: 145 An object of the form: 146 147 { # JSON template for User object in Directory API. 148 "addresses": "", 149 "posixAccounts": "", 150 "phones": "", 151 "locations": "", 152 "isDelegatedAdmin": True or False, # Boolean indicating if the user is delegated admin (Read-only) 153 "thumbnailPhotoEtag": "A String", # ETag of the user's photo (Read-only) 154 "suspended": True or False, # Indicates if user is suspended 155 "id": "A String", # Unique identifier of User (Read-only) 156 "aliases": [ # List of aliases (Read-only) 157 "A String", 158 ], 159 "nonEditableAliases": [ # List of non editable aliases (Read-only) 160 "A String", 161 ], 162 "customSchemas": { # Custom fields of the user. 163 "a_key": { # JSON template for a set of custom properties (i.e. all fields in a particular schema) 164 "a_key": "", 165 }, 166 }, 167 "deletionTime": "A String", 168 "suspensionReason": "A String", # Suspension reason if user is suspended (Read-only) 169 "thumbnailPhotoUrl": "A String", # Photo Url of the user (Read-only) 170 "isEnrolledIn2Sv": True or False, # Is enrolled in 2-step verification (Read-only) 171 "isAdmin": True or False, # Boolean indicating if the user is admin (Read-only) 172 "relations": "", 173 "includeInGlobalAddressList": True or False, # Boolean indicating if user is included in Global Address List 174 "ims": "", 175 "etag": "A String", # ETag of the resource. 176 "lastLoginTime": "A String", # User's last login time. (Read-only) 177 "orgUnitPath": "A String", # OrgUnit of User 178 "agreedToTerms": True or False, # Indicates if user has agreed to terms (Read-only) 179 "externalIds": "", 180 "ipWhitelisted": True or False, # Boolean indicating if ip is whitelisted 181 "sshPublicKeys": "", 182 "primaryEmail": "A String", # username of User 183 "isEnforcedIn2Sv": True or False, # Is 2-step verification enforced (Read-only) 184 "isMailboxSetup": True or False, # Is mailbox setup (Read-only) 185 "password": "A String", # User's password 186 "emails": "", 187 "organizations": "", 188 "kind": "admin#directory#user", # Kind of resource this is. 189 "hashFunction": "A String", # Hash function name for password. Supported are MD5, SHA-1 and crypt 190 "name": { # JSON template for name of a user in Directory API. # User's name 191 "givenName": "A String", # First Name 192 "fullName": "A String", # Full Name 193 "familyName": "A String", # Last Name 194 }, 195 "notes": "", 196 "creationTime": "A String", # User's G Suite account creation time. (Read-only) 197 "websites": "", 198 "changePasswordAtNextLogin": True or False, # Boolean indicating if the user should change password in next login 199 "customerId": "A String", # CustomerId of User (Read-only) 200 }</pre> 201 </div> 202 203 <div class="method"> 204 <code class="details" id="insert">insert(body)</code> 205 <pre>create user. 206 207 Args: 208 body: object, The request body. (required) 209 The object takes the form of: 210 211 { # JSON template for User object in Directory API. 212 "addresses": "", 213 "posixAccounts": "", 214 "phones": "", 215 "locations": "", 216 "isDelegatedAdmin": True or False, # Boolean indicating if the user is delegated admin (Read-only) 217 "thumbnailPhotoEtag": "A String", # ETag of the user's photo (Read-only) 218 "suspended": True or False, # Indicates if user is suspended 219 "id": "A String", # Unique identifier of User (Read-only) 220 "aliases": [ # List of aliases (Read-only) 221 "A String", 222 ], 223 "nonEditableAliases": [ # List of non editable aliases (Read-only) 224 "A String", 225 ], 226 "customSchemas": { # Custom fields of the user. 227 "a_key": { # JSON template for a set of custom properties (i.e. all fields in a particular schema) 228 "a_key": "", 229 }, 230 }, 231 "deletionTime": "A String", 232 "suspensionReason": "A String", # Suspension reason if user is suspended (Read-only) 233 "thumbnailPhotoUrl": "A String", # Photo Url of the user (Read-only) 234 "isEnrolledIn2Sv": True or False, # Is enrolled in 2-step verification (Read-only) 235 "isAdmin": True or False, # Boolean indicating if the user is admin (Read-only) 236 "relations": "", 237 "includeInGlobalAddressList": True or False, # Boolean indicating if user is included in Global Address List 238 "ims": "", 239 "etag": "A String", # ETag of the resource. 240 "lastLoginTime": "A String", # User's last login time. (Read-only) 241 "orgUnitPath": "A String", # OrgUnit of User 242 "agreedToTerms": True or False, # Indicates if user has agreed to terms (Read-only) 243 "externalIds": "", 244 "ipWhitelisted": True or False, # Boolean indicating if ip is whitelisted 245 "sshPublicKeys": "", 246 "primaryEmail": "A String", # username of User 247 "isEnforcedIn2Sv": True or False, # Is 2-step verification enforced (Read-only) 248 "isMailboxSetup": True or False, # Is mailbox setup (Read-only) 249 "password": "A String", # User's password 250 "emails": "", 251 "organizations": "", 252 "kind": "admin#directory#user", # Kind of resource this is. 253 "hashFunction": "A String", # Hash function name for password. Supported are MD5, SHA-1 and crypt 254 "name": { # JSON template for name of a user in Directory API. # User's name 255 "givenName": "A String", # First Name 256 "fullName": "A String", # Full Name 257 "familyName": "A String", # Last Name 258 }, 259 "notes": "", 260 "creationTime": "A String", # User's G Suite account creation time. (Read-only) 261 "websites": "", 262 "changePasswordAtNextLogin": True or False, # Boolean indicating if the user should change password in next login 263 "customerId": "A String", # CustomerId of User (Read-only) 264 } 265 266 267 Returns: 268 An object of the form: 269 270 { # JSON template for User object in Directory API. 271 "addresses": "", 272 "posixAccounts": "", 273 "phones": "", 274 "locations": "", 275 "isDelegatedAdmin": True or False, # Boolean indicating if the user is delegated admin (Read-only) 276 "thumbnailPhotoEtag": "A String", # ETag of the user's photo (Read-only) 277 "suspended": True or False, # Indicates if user is suspended 278 "id": "A String", # Unique identifier of User (Read-only) 279 "aliases": [ # List of aliases (Read-only) 280 "A String", 281 ], 282 "nonEditableAliases": [ # List of non editable aliases (Read-only) 283 "A String", 284 ], 285 "customSchemas": { # Custom fields of the user. 286 "a_key": { # JSON template for a set of custom properties (i.e. all fields in a particular schema) 287 "a_key": "", 288 }, 289 }, 290 "deletionTime": "A String", 291 "suspensionReason": "A String", # Suspension reason if user is suspended (Read-only) 292 "thumbnailPhotoUrl": "A String", # Photo Url of the user (Read-only) 293 "isEnrolledIn2Sv": True or False, # Is enrolled in 2-step verification (Read-only) 294 "isAdmin": True or False, # Boolean indicating if the user is admin (Read-only) 295 "relations": "", 296 "includeInGlobalAddressList": True or False, # Boolean indicating if user is included in Global Address List 297 "ims": "", 298 "etag": "A String", # ETag of the resource. 299 "lastLoginTime": "A String", # User's last login time. (Read-only) 300 "orgUnitPath": "A String", # OrgUnit of User 301 "agreedToTerms": True or False, # Indicates if user has agreed to terms (Read-only) 302 "externalIds": "", 303 "ipWhitelisted": True or False, # Boolean indicating if ip is whitelisted 304 "sshPublicKeys": "", 305 "primaryEmail": "A String", # username of User 306 "isEnforcedIn2Sv": True or False, # Is 2-step verification enforced (Read-only) 307 "isMailboxSetup": True or False, # Is mailbox setup (Read-only) 308 "password": "A String", # User's password 309 "emails": "", 310 "organizations": "", 311 "kind": "admin#directory#user", # Kind of resource this is. 312 "hashFunction": "A String", # Hash function name for password. Supported are MD5, SHA-1 and crypt 313 "name": { # JSON template for name of a user in Directory API. # User's name 314 "givenName": "A String", # First Name 315 "fullName": "A String", # Full Name 316 "familyName": "A String", # Last Name 317 }, 318 "notes": "", 319 "creationTime": "A String", # User's G Suite account creation time. (Read-only) 320 "websites": "", 321 "changePasswordAtNextLogin": True or False, # Boolean indicating if the user should change password in next login 322 "customerId": "A String", # CustomerId of User (Read-only) 323 }</pre> 324 </div> 325 326 <div class="method"> 327 <code class="details" id="list">list(orderBy=None, domain=None, projection=None, query=None, event=None, showDeleted=None, pageToken=None, sortOrder=None, maxResults=None, customer=None, customFieldMask=None, viewType=None)</code> 328 <pre>Retrieve either deleted users or all users in a domain (paginated) 329 330 Args: 331 orderBy: string, Column to use for sorting results 332 Allowed values 333 email - Primary email of the user. 334 familyName - User's family name. 335 givenName - User's given name. 336 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. 337 projection: string, What subset of fields to fetch for this user. 338 Allowed values 339 basic - Do not include any custom fields for the user. 340 custom - Include custom fields from schemas mentioned in customFieldMask. 341 full - Include all fields associated with this user. 342 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 343 event: string, Event on which subscription is intended (if subscribing) 344 Allowed values 345 add - User Created Event 346 delete - User Deleted Event 347 makeAdmin - User Admin Status Change Event 348 undelete - User Undeleted Event 349 update - User Updated Event 350 showDeleted: string, If set to true retrieves the list of deleted users. Default is false 351 pageToken: string, Token to specify next page in the list 352 sortOrder: string, Whether to return results in ascending or descending order. 353 Allowed values 354 ASCENDING - Ascending order. 355 DESCENDING - Descending order. 356 maxResults: integer, Maximum number of results to return. Default is 100. Max allowed is 500 357 customer: string, Immutable ID of the G Suite account. In case of multi-domain, to fetch all users for a customer, fill this field instead of domain. 358 customFieldMask: string, Comma-separated list of schema names. All fields from these schemas are fetched. This should only be set when projection=custom. 359 viewType: string, Whether to fetch the ADMIN_VIEW or DOMAIN_PUBLIC view of the user. 360 Allowed values 361 admin_view - Fetches the ADMIN_VIEW of the user. 362 domain_public - Fetches the DOMAIN_PUBLIC view of the user. 363 364 Returns: 365 An object of the form: 366 367 { # JSON response template for List Users operation in Apps Directory API. 368 "nextPageToken": "A String", # Token used to access next page of this result. 369 "kind": "admin#directory#users", # Kind of resource this is. 370 "etag": "A String", # ETag of the resource. 371 "trigger_event": "A String", # Event that triggered this response (only used in case of Push Response) 372 "users": [ # List of user objects. 373 { # JSON template for User object in Directory API. 374 "addresses": "", 375 "posixAccounts": "", 376 "phones": "", 377 "locations": "", 378 "isDelegatedAdmin": True or False, # Boolean indicating if the user is delegated admin (Read-only) 379 "thumbnailPhotoEtag": "A String", # ETag of the user's photo (Read-only) 380 "suspended": True or False, # Indicates if user is suspended 381 "id": "A String", # Unique identifier of User (Read-only) 382 "aliases": [ # List of aliases (Read-only) 383 "A String", 384 ], 385 "nonEditableAliases": [ # List of non editable aliases (Read-only) 386 "A String", 387 ], 388 "customSchemas": { # Custom fields of the user. 389 "a_key": { # JSON template for a set of custom properties (i.e. all fields in a particular schema) 390 "a_key": "", 391 }, 392 }, 393 "deletionTime": "A String", 394 "suspensionReason": "A String", # Suspension reason if user is suspended (Read-only) 395 "thumbnailPhotoUrl": "A String", # Photo Url of the user (Read-only) 396 "isEnrolledIn2Sv": True or False, # Is enrolled in 2-step verification (Read-only) 397 "isAdmin": True or False, # Boolean indicating if the user is admin (Read-only) 398 "relations": "", 399 "includeInGlobalAddressList": True or False, # Boolean indicating if user is included in Global Address List 400 "ims": "", 401 "etag": "A String", # ETag of the resource. 402 "lastLoginTime": "A String", # User's last login time. (Read-only) 403 "orgUnitPath": "A String", # OrgUnit of User 404 "agreedToTerms": True or False, # Indicates if user has agreed to terms (Read-only) 405 "externalIds": "", 406 "ipWhitelisted": True or False, # Boolean indicating if ip is whitelisted 407 "sshPublicKeys": "", 408 "primaryEmail": "A String", # username of User 409 "isEnforcedIn2Sv": True or False, # Is 2-step verification enforced (Read-only) 410 "isMailboxSetup": True or False, # Is mailbox setup (Read-only) 411 "password": "A String", # User's password 412 "emails": "", 413 "organizations": "", 414 "kind": "admin#directory#user", # Kind of resource this is. 415 "hashFunction": "A String", # Hash function name for password. Supported are MD5, SHA-1 and crypt 416 "name": { # JSON template for name of a user in Directory API. # User's name 417 "givenName": "A String", # First Name 418 "fullName": "A String", # Full Name 419 "familyName": "A String", # Last Name 420 }, 421 "notes": "", 422 "creationTime": "A String", # User's G Suite account creation time. (Read-only) 423 "websites": "", 424 "changePasswordAtNextLogin": True or False, # Boolean indicating if the user should change password in next login 425 "customerId": "A String", # CustomerId of User (Read-only) 426 }, 427 ], 428 }</pre> 429 </div> 430 431 <div class="method"> 432 <code class="details" id="list_next">list_next(previous_request, previous_response)</code> 433 <pre>Retrieves the next page of results. 434 435 Args: 436 previous_request: The request for the previous page. (required) 437 previous_response: The response from the request for the previous page. (required) 438 439 Returns: 440 A request object that you can call 'execute()' on to request the next 441 page. Returns None if there are no more items in the collection. 442 </pre> 443 </div> 444 445 <div class="method"> 446 <code class="details" id="makeAdmin">makeAdmin(userKey, body)</code> 447 <pre>change admin status of a user 448 449 Args: 450 userKey: string, Email or immutable Id of the user as admin (required) 451 body: object, The request body. (required) 452 The object takes the form of: 453 454 { # JSON request template for setting/revoking admin status of a user in Directory API. 455 "status": True or False, # Boolean indicating new admin status of the user 456 } 457 458 </pre> 459 </div> 460 461 <div class="method"> 462 <code class="details" id="patch">patch(userKey, body)</code> 463 <pre>update user. This method supports patch semantics. 464 465 Args: 466 userKey: string, Email or immutable Id of the user. If Id, it should match with id of user object (required) 467 body: object, The request body. (required) 468 The object takes the form of: 469 470 { # JSON template for User object in Directory API. 471 "addresses": "", 472 "posixAccounts": "", 473 "phones": "", 474 "locations": "", 475 "isDelegatedAdmin": True or False, # Boolean indicating if the user is delegated admin (Read-only) 476 "thumbnailPhotoEtag": "A String", # ETag of the user's photo (Read-only) 477 "suspended": True or False, # Indicates if user is suspended 478 "id": "A String", # Unique identifier of User (Read-only) 479 "aliases": [ # List of aliases (Read-only) 480 "A String", 481 ], 482 "nonEditableAliases": [ # List of non editable aliases (Read-only) 483 "A String", 484 ], 485 "customSchemas": { # Custom fields of the user. 486 "a_key": { # JSON template for a set of custom properties (i.e. all fields in a particular schema) 487 "a_key": "", 488 }, 489 }, 490 "deletionTime": "A String", 491 "suspensionReason": "A String", # Suspension reason if user is suspended (Read-only) 492 "thumbnailPhotoUrl": "A String", # Photo Url of the user (Read-only) 493 "isEnrolledIn2Sv": True or False, # Is enrolled in 2-step verification (Read-only) 494 "isAdmin": True or False, # Boolean indicating if the user is admin (Read-only) 495 "relations": "", 496 "includeInGlobalAddressList": True or False, # Boolean indicating if user is included in Global Address List 497 "ims": "", 498 "etag": "A String", # ETag of the resource. 499 "lastLoginTime": "A String", # User's last login time. (Read-only) 500 "orgUnitPath": "A String", # OrgUnit of User 501 "agreedToTerms": True or False, # Indicates if user has agreed to terms (Read-only) 502 "externalIds": "", 503 "ipWhitelisted": True or False, # Boolean indicating if ip is whitelisted 504 "sshPublicKeys": "", 505 "primaryEmail": "A String", # username of User 506 "isEnforcedIn2Sv": True or False, # Is 2-step verification enforced (Read-only) 507 "isMailboxSetup": True or False, # Is mailbox setup (Read-only) 508 "password": "A String", # User's password 509 "emails": "", 510 "organizations": "", 511 "kind": "admin#directory#user", # Kind of resource this is. 512 "hashFunction": "A String", # Hash function name for password. Supported are MD5, SHA-1 and crypt 513 "name": { # JSON template for name of a user in Directory API. # User's name 514 "givenName": "A String", # First Name 515 "fullName": "A String", # Full Name 516 "familyName": "A String", # Last Name 517 }, 518 "notes": "", 519 "creationTime": "A String", # User's G Suite account creation time. (Read-only) 520 "websites": "", 521 "changePasswordAtNextLogin": True or False, # Boolean indicating if the user should change password in next login 522 "customerId": "A String", # CustomerId of User (Read-only) 523 } 524 525 526 Returns: 527 An object of the form: 528 529 { # JSON template for User object in Directory API. 530 "addresses": "", 531 "posixAccounts": "", 532 "phones": "", 533 "locations": "", 534 "isDelegatedAdmin": True or False, # Boolean indicating if the user is delegated admin (Read-only) 535 "thumbnailPhotoEtag": "A String", # ETag of the user's photo (Read-only) 536 "suspended": True or False, # Indicates if user is suspended 537 "id": "A String", # Unique identifier of User (Read-only) 538 "aliases": [ # List of aliases (Read-only) 539 "A String", 540 ], 541 "nonEditableAliases": [ # List of non editable aliases (Read-only) 542 "A String", 543 ], 544 "customSchemas": { # Custom fields of the user. 545 "a_key": { # JSON template for a set of custom properties (i.e. all fields in a particular schema) 546 "a_key": "", 547 }, 548 }, 549 "deletionTime": "A String", 550 "suspensionReason": "A String", # Suspension reason if user is suspended (Read-only) 551 "thumbnailPhotoUrl": "A String", # Photo Url of the user (Read-only) 552 "isEnrolledIn2Sv": True or False, # Is enrolled in 2-step verification (Read-only) 553 "isAdmin": True or False, # Boolean indicating if the user is admin (Read-only) 554 "relations": "", 555 "includeInGlobalAddressList": True or False, # Boolean indicating if user is included in Global Address List 556 "ims": "", 557 "etag": "A String", # ETag of the resource. 558 "lastLoginTime": "A String", # User's last login time. (Read-only) 559 "orgUnitPath": "A String", # OrgUnit of User 560 "agreedToTerms": True or False, # Indicates if user has agreed to terms (Read-only) 561 "externalIds": "", 562 "ipWhitelisted": True or False, # Boolean indicating if ip is whitelisted 563 "sshPublicKeys": "", 564 "primaryEmail": "A String", # username of User 565 "isEnforcedIn2Sv": True or False, # Is 2-step verification enforced (Read-only) 566 "isMailboxSetup": True or False, # Is mailbox setup (Read-only) 567 "password": "A String", # User's password 568 "emails": "", 569 "organizations": "", 570 "kind": "admin#directory#user", # Kind of resource this is. 571 "hashFunction": "A String", # Hash function name for password. Supported are MD5, SHA-1 and crypt 572 "name": { # JSON template for name of a user in Directory API. # User's name 573 "givenName": "A String", # First Name 574 "fullName": "A String", # Full Name 575 "familyName": "A String", # Last Name 576 }, 577 "notes": "", 578 "creationTime": "A String", # User's G Suite account creation time. (Read-only) 579 "websites": "", 580 "changePasswordAtNextLogin": True or False, # Boolean indicating if the user should change password in next login 581 "customerId": "A String", # CustomerId of User (Read-only) 582 }</pre> 583 </div> 584 585 <div class="method"> 586 <code class="details" id="undelete">undelete(userKey, body)</code> 587 <pre>Undelete a deleted user 588 589 Args: 590 userKey: string, The immutable id of the user (required) 591 body: object, The request body. (required) 592 The object takes the form of: 593 594 { # JSON request template to undelete a user in Directory API. 595 "orgUnitPath": "A String", # OrgUnit of User 596 } 597 598 </pre> 599 </div> 600 601 <div class="method"> 602 <code class="details" id="update">update(userKey, body)</code> 603 <pre>update user 604 605 Args: 606 userKey: string, Email or immutable Id of the user. If Id, it should match with id of user object (required) 607 body: object, The request body. (required) 608 The object takes the form of: 609 610 { # JSON template for User object in Directory API. 611 "addresses": "", 612 "posixAccounts": "", 613 "phones": "", 614 "locations": "", 615 "isDelegatedAdmin": True or False, # Boolean indicating if the user is delegated admin (Read-only) 616 "thumbnailPhotoEtag": "A String", # ETag of the user's photo (Read-only) 617 "suspended": True or False, # Indicates if user is suspended 618 "id": "A String", # Unique identifier of User (Read-only) 619 "aliases": [ # List of aliases (Read-only) 620 "A String", 621 ], 622 "nonEditableAliases": [ # List of non editable aliases (Read-only) 623 "A String", 624 ], 625 "customSchemas": { # Custom fields of the user. 626 "a_key": { # JSON template for a set of custom properties (i.e. all fields in a particular schema) 627 "a_key": "", 628 }, 629 }, 630 "deletionTime": "A String", 631 "suspensionReason": "A String", # Suspension reason if user is suspended (Read-only) 632 "thumbnailPhotoUrl": "A String", # Photo Url of the user (Read-only) 633 "isEnrolledIn2Sv": True or False, # Is enrolled in 2-step verification (Read-only) 634 "isAdmin": True or False, # Boolean indicating if the user is admin (Read-only) 635 "relations": "", 636 "includeInGlobalAddressList": True or False, # Boolean indicating if user is included in Global Address List 637 "ims": "", 638 "etag": "A String", # ETag of the resource. 639 "lastLoginTime": "A String", # User's last login time. (Read-only) 640 "orgUnitPath": "A String", # OrgUnit of User 641 "agreedToTerms": True or False, # Indicates if user has agreed to terms (Read-only) 642 "externalIds": "", 643 "ipWhitelisted": True or False, # Boolean indicating if ip is whitelisted 644 "sshPublicKeys": "", 645 "primaryEmail": "A String", # username of User 646 "isEnforcedIn2Sv": True or False, # Is 2-step verification enforced (Read-only) 647 "isMailboxSetup": True or False, # Is mailbox setup (Read-only) 648 "password": "A String", # User's password 649 "emails": "", 650 "organizations": "", 651 "kind": "admin#directory#user", # Kind of resource this is. 652 "hashFunction": "A String", # Hash function name for password. Supported are MD5, SHA-1 and crypt 653 "name": { # JSON template for name of a user in Directory API. # User's name 654 "givenName": "A String", # First Name 655 "fullName": "A String", # Full Name 656 "familyName": "A String", # Last Name 657 }, 658 "notes": "", 659 "creationTime": "A String", # User's G Suite account creation time. (Read-only) 660 "websites": "", 661 "changePasswordAtNextLogin": True or False, # Boolean indicating if the user should change password in next login 662 "customerId": "A String", # CustomerId of User (Read-only) 663 } 664 665 666 Returns: 667 An object of the form: 668 669 { # JSON template for User object in Directory API. 670 "addresses": "", 671 "posixAccounts": "", 672 "phones": "", 673 "locations": "", 674 "isDelegatedAdmin": True or False, # Boolean indicating if the user is delegated admin (Read-only) 675 "thumbnailPhotoEtag": "A String", # ETag of the user's photo (Read-only) 676 "suspended": True or False, # Indicates if user is suspended 677 "id": "A String", # Unique identifier of User (Read-only) 678 "aliases": [ # List of aliases (Read-only) 679 "A String", 680 ], 681 "nonEditableAliases": [ # List of non editable aliases (Read-only) 682 "A String", 683 ], 684 "customSchemas": { # Custom fields of the user. 685 "a_key": { # JSON template for a set of custom properties (i.e. all fields in a particular schema) 686 "a_key": "", 687 }, 688 }, 689 "deletionTime": "A String", 690 "suspensionReason": "A String", # Suspension reason if user is suspended (Read-only) 691 "thumbnailPhotoUrl": "A String", # Photo Url of the user (Read-only) 692 "isEnrolledIn2Sv": True or False, # Is enrolled in 2-step verification (Read-only) 693 "isAdmin": True or False, # Boolean indicating if the user is admin (Read-only) 694 "relations": "", 695 "includeInGlobalAddressList": True or False, # Boolean indicating if user is included in Global Address List 696 "ims": "", 697 "etag": "A String", # ETag of the resource. 698 "lastLoginTime": "A String", # User's last login time. (Read-only) 699 "orgUnitPath": "A String", # OrgUnit of User 700 "agreedToTerms": True or False, # Indicates if user has agreed to terms (Read-only) 701 "externalIds": "", 702 "ipWhitelisted": True or False, # Boolean indicating if ip is whitelisted 703 "sshPublicKeys": "", 704 "primaryEmail": "A String", # username of User 705 "isEnforcedIn2Sv": True or False, # Is 2-step verification enforced (Read-only) 706 "isMailboxSetup": True or False, # Is mailbox setup (Read-only) 707 "password": "A String", # User's password 708 "emails": "", 709 "organizations": "", 710 "kind": "admin#directory#user", # Kind of resource this is. 711 "hashFunction": "A String", # Hash function name for password. Supported are MD5, SHA-1 and crypt 712 "name": { # JSON template for name of a user in Directory API. # User's name 713 "givenName": "A String", # First Name 714 "fullName": "A String", # Full Name 715 "familyName": "A String", # Last Name 716 }, 717 "notes": "", 718 "creationTime": "A String", # User's G Suite account creation time. (Read-only) 719 "websites": "", 720 "changePasswordAtNextLogin": True or False, # Boolean indicating if the user should change password in next login 721 "customerId": "A String", # CustomerId of User (Read-only) 722 }</pre> 723 </div> 724 725 <div class="method"> 726 <code class="details" id="watch">watch(body, orderBy=None, domain=None, projection=None, query=None, event=None, showDeleted=None, pageToken=None, sortOrder=None, maxResults=None, customer=None, customFieldMask=None, viewType=None)</code> 727 <pre>Watch for changes in users list 728 729 Args: 730 body: object, The request body. (required) 731 The object takes the form of: 732 733 { # An notification channel used to watch for resource changes. 734 "resourceUri": "A String", # A version-specific identifier for the watched resource. 735 "kind": "api#channel", # Identifies this as a notification channel used to watch for changes to a resource. Value: the fixed string "api#channel". 736 "resourceId": "A String", # An opaque ID that identifies the resource being watched on this channel. Stable across different API versions. 737 "payload": True or False, # A Boolean value to indicate whether payload is wanted. Optional. 738 "token": "A String", # An arbitrary string delivered to the target address with each notification delivered over this channel. Optional. 739 "params": { # Additional parameters controlling delivery channel behavior. Optional. 740 "a_key": "A String", # Declares a new parameter by name. 741 }, 742 "expiration": "A String", # Date and time of notification channel expiration, expressed as a Unix timestamp, in milliseconds. Optional. 743 "address": "A String", # The address where notifications are delivered for this channel. 744 "type": "A String", # The type of delivery mechanism used for this channel. 745 "id": "A String", # A UUID or similar unique string that identifies this channel. 746 } 747 748 orderBy: string, Column to use for sorting results 749 Allowed values 750 email - Primary email of the user. 751 familyName - User's family name. 752 givenName - User's given name. 753 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. 754 projection: string, What subset of fields to fetch for this user. 755 Allowed values 756 basic - Do not include any custom fields for the user. 757 custom - Include custom fields from schemas mentioned in customFieldMask. 758 full - Include all fields associated with this user. 759 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 760 event: string, Event on which subscription is intended (if subscribing) 761 Allowed values 762 add - User Created Event 763 delete - User Deleted Event 764 makeAdmin - User Admin Status Change Event 765 undelete - User Undeleted Event 766 update - User Updated Event 767 showDeleted: string, If set to true retrieves the list of deleted users. Default is false 768 pageToken: string, Token to specify next page in the list 769 sortOrder: string, Whether to return results in ascending or descending order. 770 Allowed values 771 ASCENDING - Ascending order. 772 DESCENDING - Descending order. 773 maxResults: integer, Maximum number of results to return. Default is 100. Max allowed is 500 774 customer: string, Immutable ID of the G Suite account. In case of multi-domain, to fetch all users for a customer, fill this field instead of domain. 775 customFieldMask: string, Comma-separated list of schema names. All fields from these schemas are fetched. This should only be set when projection=custom. 776 viewType: string, Whether to fetch the ADMIN_VIEW or DOMAIN_PUBLIC view of the user. 777 Allowed values 778 admin_view - Fetches the ADMIN_VIEW of the user. 779 domain_public - Fetches the DOMAIN_PUBLIC view of the user. 780 781 Returns: 782 An object of the form: 783 784 { # An notification channel used to watch for resource changes. 785 "resourceUri": "A String", # A version-specific identifier for the watched resource. 786 "kind": "api#channel", # Identifies this as a notification channel used to watch for changes to a resource. Value: the fixed string "api#channel". 787 "resourceId": "A String", # An opaque ID that identifies the resource being watched on this channel. Stable across different API versions. 788 "payload": True or False, # A Boolean value to indicate whether payload is wanted. Optional. 789 "token": "A String", # An arbitrary string delivered to the target address with each notification delivered over this channel. Optional. 790 "params": { # Additional parameters controlling delivery channel behavior. Optional. 791 "a_key": "A String", # Declares a new parameter by name. 792 }, 793 "expiration": "A String", # Date and time of notification channel expiration, expressed as a Unix timestamp, in milliseconds. Optional. 794 "address": "A String", # The address where notifications are delivered for this channel. 795 "type": "A String", # The type of delivery mechanism used for this channel. 796 "id": "A String", # A UUID or similar unique string that identifies this channel. 797 }</pre> 798 </div> 799 800 </body></html>
