-
Notifications
You must be signed in to change notification settings - Fork 2.6k
Expand file tree
/
Copy pathadmin_directory_v1.users.html
More file actions
1040 lines (969 loc) 路 113 KB
/
Copy pathadmin_directory_v1.users.html
File metadata and controls
1040 lines (969 loc) 路 113 KB
1
2
3
4
5
6
7
8
9
10
11
12
13
14
15
16
17
18
19
20
21
22
23
24
25
26
27
28
29
30
31
32
33
34
35
36
37
38
39
40
41
42
43
44
45
46
47
48
49
50
51
52
53
54
55
56
57
58
59
60
61
62
63
64
65
66
67
68
69
70
71
72
73
74
75
76
77
78
79
80
81
82
83
84
85
86
87
88
89
90
91
92
93
94
95
96
97
98
99
100
101
102
103
104
105
106
107
108
109
110
111
112
113
114
115
116
117
118
119
120
121
122
123
124
125
126
127
128
129
130
131
132
133
134
135
136
137
138
139
140
141
142
143
144
145
146
147
148
149
150
151
152
153
154
155
156
157
158
159
160
161
162
163
164
165
166
167
168
169
170
171
172
173
174
175
176
177
178
179
180
181
182
183
184
185
186
187
188
189
190
191
192
193
194
195
196
197
198
199
200
201
202
203
204
205
206
207
208
209
210
211
212
213
214
215
216
217
218
219
220
221
222
223
224
225
226
227
228
229
230
231
232
233
234
235
236
237
238
239
240
241
242
243
244
245
246
247
248
249
250
251
252
253
254
255
256
257
258
259
260
261
262
263
264
265
266
267
268
269
270
271
272
273
274
275
276
277
278
279
280
281
282
283
284
285
286
287
288
289
290
291
292
293
294
295
296
297
298
299
300
301
302
303
304
305
306
307
308
309
310
311
312
313
314
315
316
317
318
319
320
321
322
323
324
325
326
327
328
329
330
331
332
333
334
335
336
337
338
339
340
341
342
343
344
345
346
347
348
349
350
351
352
353
354
355
356
357
358
359
360
361
362
363
364
365
366
367
368
369
370
371
372
373
374
375
376
377
378
379
380
381
382
383
384
385
386
387
388
389
390
391
392
393
394
395
396
397
398
399
400
401
402
403
404
405
406
407
408
409
410
411
412
413
414
415
416
417
418
419
420
421
422
423
424
425
426
427
428
429
430
431
432
433
434
435
436
437
438
439
440
441
442
443
444
445
446
447
448
449
450
451
452
453
454
455
456
457
458
459
460
461
462
463
464
465
466
467
468
469
470
471
472
473
474
475
476
477
478
479
480
481
482
483
484
485
486
487
488
489
490
491
492
493
494
495
496
497
498
499
500
501
502
503
504
505
506
507
508
509
510
511
512
513
514
515
516
517
518
519
520
521
522
523
524
525
526
527
528
529
530
531
532
533
534
535
536
537
538
539
540
541
542
543
544
545
546
547
548
549
550
551
552
553
554
555
556
557
558
559
560
561
562
563
564
565
566
567
568
569
570
571
572
573
574
575
576
577
578
579
580
581
582
583
584
585
586
587
588
589
590
591
592
593
594
595
596
597
598
599
600
601
602
603
604
605
606
607
608
609
610
611
612
613
614
615
616
617
618
619
620
621
622
623
624
625
626
627
628
629
630
631
632
633
634
635
636
637
638
639
640
641
642
643
644
645
646
647
648
649
650
651
652
653
654
655
656
657
658
659
660
661
662
663
664
665
666
667
668
669
670
671
672
673
674
675
676
677
678
679
680
681
682
683
684
685
686
687
688
689
690
691
692
693
694
695
696
697
698
699
700
701
702
703
704
705
706
707
708
709
710
711
712
713
714
715
716
717
718
719
720
721
722
723
724
725
726
727
728
729
730
731
732
733
734
735
736
737
738
739
740
741
742
743
744
745
746
747
748
749
750
751
752
753
754
755
756
757
758
759
760
761
762
763
764
765
766
767
768
769
770
771
772
773
774
775
776
777
778
779
780
781
782
783
784
785
786
787
788
789
790
791
792
793
794
795
796
797
798
799
800
801
802
803
804
805
806
807
808
809
810
811
812
813
814
815
816
817
818
819
820
821
822
823
824
825
826
827
828
829
830
831
832
833
834
835
836
837
838
839
840
841
842
843
844
845
846
847
848
849
850
851
852
853
854
855
856
857
858
859
860
861
862
863
864
865
866
867
868
869
870
871
872
873
874
875
876
877
878
879
880
881
882
883
884
885
886
887
888
889
890
891
892
893
894
895
896
897
898
899
900
901
902
903
904
905
906
907
908
909
910
911
912
913
914
915
916
917
918
919
920
921
922
923
924
925
926
927
928
929
930
931
932
933
934
935
936
937
938
939
940
941
942
943
944
945
946
947
948
949
950
951
952
953
954
955
956
957
958
959
960
961
962
963
964
965
966
967
968
969
970
971
972
973
974
975
976
977
978
979
980
981
982
983
984
985
986
987
988
989
990
991
992
993
994
995
996
997
998
999
1000
<html><body>
<style>
body, h1, h2, h3, div, span, p, pre, a {
margin: 0;
padding: 0;
border: 0;
font-weight: inherit;
font-style: inherit;
font-size: 100%;
font-family: inherit;
vertical-align: baseline;
}
body {
font-size: 13px;
padding: 1em;
}
h1 {
font-size: 26px;
margin-bottom: 1em;
}
h2 {
font-size: 24px;
margin-bottom: 1em;
}
h3 {
font-size: 20px;
margin-bottom: 1em;
margin-top: 1em;
}
pre, code {
line-height: 1.5;
font-family: Monaco, 'DejaVu Sans Mono', 'Bitstream Vera Sans Mono', 'Lucida Console', monospace;
}
pre {
margin-top: 0.5em;
}
h1, h2, h3, p {
font-family: Arial, sans serif;
}
h1, h2, h3 {
border-bottom: solid #CCC 1px;
}
.toc_element {
margin-top: 0.5em;
}
.firstline {
margin-left: 2 em;
}
.method {
margin-top: 1em;
border: solid 1px #CCC;
padding: 1em;
background: #EEE;
}
.details {
font-weight: bold;
font-size: 14px;
}
</style>
<h1><a href="admin_directory_v1.html">Admin SDK API</a> . <a href="admin_directory_v1.users.html">users</a></h1>
<h2>Instance Methods</h2>
<p class="toc_element">
<code><a href="admin_directory_v1.users.aliases.html">aliases()</a></code>
</p>
<p class="firstline">Returns the aliases Resource.</p>
<p class="toc_element">
<code><a href="admin_directory_v1.users.photos.html">photos()</a></code>
</p>
<p class="firstline">Returns the photos Resource.</p>
<p class="toc_element">
<code><a href="#close">close()</a></code></p>
<p class="firstline">Close httplib2 connections.</p>
<p class="toc_element">
<code><a href="#createGuest">createGuest(body=None, x__xgafv=None)</a></code></p>
<p class="firstline">Create a guest user with access to a [subset of Workspace capabilities](https://support.google.com/a/answer/16558545). This feature is currently in Open Beta.</p>
<p class="toc_element">
<code><a href="#delete">delete(userKey, x__xgafv=None)</a></code></p>
<p class="firstline">Deletes a user.</p>
<p class="toc_element">
<code><a href="#get">get(userKey, customFieldMask=None, projection=None, viewType=None, x__xgafv=None)</a></code></p>
<p class="firstline">Retrieves a user.</p>
<p class="toc_element">
<code><a href="#insert">insert(body=None, resolveConflictAccount=None, x__xgafv=None)</a></code></p>
<p class="firstline">Creates a user. Mutate calls immediately following user creation might sometimes fail as the user isn't fully created due to propagation delay in our backends. Check the error details for the "User creation is not complete" message to see if this is the case. Retrying the calls after some time can help in this case. If `resolveConflictAccount` is set to `true`, a `202` response code means that a conflicting unmanaged account exists and was invited to join the organization. A `409` response code means that a conflicting account exists so the user wasn't created based on the [handling unmanaged user accounts](https://support.google.com/a/answer/11112794) option selected.</p>
<p class="toc_element">
<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>
<p class="firstline">Retrieves a paginated list of either deleted users or all users in a domain.</p>
<p class="toc_element">
<code><a href="#list_next">list_next()</a></code></p>
<p class="firstline">Retrieves the next page of results.</p>
<p class="toc_element">
<code><a href="#makeAdmin">makeAdmin(userKey, body=None, x__xgafv=None)</a></code></p>
<p class="firstline">Makes a user a super administrator.</p>
<p class="toc_element">
<code><a href="#patch">patch(userKey, body=None, x__xgafv=None)</a></code></p>
<p class="firstline">Updates a user using patch semantics. The update method should be used instead, because it also supports patch semantics and has better performance. If you're mapping an external identity to a Google identity, use the [`update`](https://developers.google.com/workspace/admin/directory/v1/reference/users/update) method instead of the `patch` method. This method is unable to clear fields that contain repeated objects (`addresses`, `phones`, etc). Use the update method instead.</p>
<p class="toc_element">
<code><a href="#signOut">signOut(userKey, x__xgafv=None)</a></code></p>
<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>
<p class="toc_element">
<code><a href="#undelete">undelete(userKey, body=None, x__xgafv=None)</a></code></p>
<p class="firstline">Undeletes a deleted user.</p>
<p class="toc_element">
<code><a href="#update">update(userKey, body=None, x__xgafv=None)</a></code></p>
<p class="firstline">Updates a user. This method supports patch semantics, meaning that 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. For repeating fields that contain arrays, individual items in the array can't be patched piecemeal; they must be supplied in the request body with the desired values for all items. See the [user accounts guide](https://developers.google.com/workspace/admin/directory/v1/guides/manage-users#update_user) for more information.</p>
<p class="toc_element">
<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>
<p class="firstline">Watches for changes in users list.</p>
<h3>Method Details</h3>
<div class="method">
<code class="details" id="close">close()</code>
<pre>Close httplib2 connections.</pre>
</div>
<div class="method">
<code class="details" id="createGuest">createGuest(body=None, x__xgafv=None)</code>
<pre>Create a guest user with access to a [subset of Workspace capabilities](https://support.google.com/a/answer/16558545). This feature is currently in Open Beta.
Args:
body: object, The request body.
The object takes the form of:
{ # Directory users guest creation request message.
"customer": "A String", # Optional. Immutable ID of the Google Workspace account. Only required when request is created by a service account. Defaults to the authenticated user's customer ID otherwise.
"primaryGuestEmail": "A String", # Required. External email of the guest user being created.
}
x__xgafv: string, V1 error format.
Allowed values
1 - v1 error format
2 - v2 error format
Returns:
An object of the form:
{ # The Directory API allows you to create and manage your account's users, user aliases, and user Google profile photos. For more information about common tasks, see the [User Accounts Developer's Guide](https://developers.google.com/workspace/admin/directory/v1/guides/manage-users.html) and the [User Aliases Developer's Guide](https://developers.google.com/workspace/admin/directory/v1/guides/manage-user-aliases.html).
"addresses": "", # The list of the user's addresses. The maximum allowed data size for this field is 10KB.
"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.
"aliases": [ # Output only. The list of the user's alias email addresses.
"A String",
],
"archived": True or False, # Indicates if user is archived.
"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).
"creationTime": "A String", # User's G Suite account creation time. (Read-only)
"customSchemas": { # Custom fields of the user. The key is a `schema_name` and its values are `'field_name': 'field_value'`.
"a_key": { # JSON template for a set of custom properties (i.e. all fields in a particular schema)
"a_key": "",
},
},
"customerId": "A String", # Output only. The customer ID to [retrieve all account users](https://developers.google.com/workspace/admin/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](https://developers.google.com/workspace/admin/directory/v1/reference/users/list) request.
"deletionTime": "A String",
"emails": "", # The list of the user's email addresses. The maximum allowed data size for this field is 10KB. This excludes `publicKeyEncryptionCertificates`.
"etag": "A String", # Output only. ETag of the resource.
"externalIds": "", # The list of external IDs for the user, such as an employee or network ID. The maximum allowed data size for this field is 2KB.
"gender": "", # The user's gender. The maximum allowed data size for this field is 1KB.
"guestAccountInfo": { # Account info specific to Guest users. # Immutable. Additional guest-related metadata fields
"primaryGuestEmail": "A String", # Immutable. The guest's external email.
},
"hashFunction": "A String", # Stores the hash format of the `password` property. The following `hashFunction` values are allowed: * `MD5` - Accepts simple hex-encoded values. * `SHA-1` - Accepts simple hex-encoded values. * `crypt` - Compliant with the [C crypt library](https://en.wikipedia.org/wiki/Crypt_%28C%29). Supports the DES, MD5 (hash prefix `$1$`), SHA-256 (hash prefix `$5$`), and SHA-512 (hash prefix `$6$`) hash algorithms. If rounds are specified as part of the prefix, they must be 10,000 or fewer.
"id": "A String", # The unique ID for the user. A user `id` can be used as a user request URI's `userKey`.
"ims": "", # The list of 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.
"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).
"ipWhitelisted": True or False, # If `true`, the user's IP address is subject to a deprecated IP address [`allowlist`](https://support.google.com/a/answer/60752) configuration.
"isAdmin": True or False, # Output only. Indicates a user with super administrator privileges. The `isAdmin` property can only be edited in the [Make a user an administrator](https://developers.google.com/workspace/admin/directory/v1/guides/manage-users.html#make_admin) operation ( [makeAdmin](https://developers.google.com/workspace/admin/directory/v1/reference/users/makeAdmin.html) method). If edited in the user [insert](https://developers.google.com/workspace/admin/directory/v1/reference/users/insert.html) or [update](https://developers.google.com/workspace/admin/directory/v1/reference/users/update.html) methods, the edit is ignored by the API service.
"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).
"isEnforcedIn2Sv": True or False, # Output only. Is 2-step verification enforced (Read-only)
"isEnrolledIn2Sv": True or False, # Output only. Is enrolled in 2-step verification (Read-only)
"isGuestUser": True or False, # Immutable. Indicates if the inserted user is a guest.
"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.
"keywords": "", # The list of the user's keywords. The maximum allowed data size for this field is 1KB.
"kind": "admin#directory#user", # Output only. The type of the API resource. For Users resources, the value is `admin#directory#user`.
"languages": "", # The user's languages. The maximum allowed data size for this field is 1KB.
"lastLoginTime": "A String", # User's last login time. (Read-only)
"locations": "", # The user's locations. The maximum allowed data size for this field is 10KB.
"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.
"displayName": "A String", # The user's display name. Limit: 256 characters.
"familyName": "A String", # The user's last name. Required when creating a user account.
"fullName": "A String", # The user's full name formed by concatenating the first and last name values.
"givenName": "A String", # The user's first name. Required when creating a user account.
},
"nonEditableAliases": [ # Output only. The list of the user's non-editable alias email addresses. These are typically outside the account's primary domain or sub-domain.
"A String",
],
"notes": "", # Notes for the user.
"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 (`/`).
"organizations": "", # The list of organizations the user belongs to. The maximum allowed data size for this field is 10KB.
"password": "A String", # User's password
"phones": "", # The list of the user's phone numbers. The maximum allowed data size for this field is 1KB.
"posixAccounts": "", # The list of [POSIX](https://www.opengroup.org/austin/papers/posix_faq.html) account information for the user.
"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.
"recoveryEmail": "A String", # Recovery email of the user.
"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*.
"relations": "", # The list of the user's relationships to other users. The maximum allowed data size for this field is 2KB.
"sshPublicKeys": "", # A list of SSH public keys.
"suspended": True or False, # Indicates if user is suspended.
"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`.
"thumbnailPhotoEtag": "A String", # Output only. ETag of the user's photo (Read-only)
"thumbnailPhotoUrl": "A String", # Output only. The URL of the user's profile photo. The URL might be temporary or private.
"websites": "", # The user's websites. The maximum allowed data size for this field is 2KB.
}</pre>
</div>
<div class="method">
<code class="details" id="delete">delete(userKey, x__xgafv=None)</code>
<pre>Deletes a user.
Args:
userKey: string, Identifies the user in the API request. The value can be the user's primary email address, alias email address, or unique user ID. (required)
x__xgafv: string, V1 error format.
Allowed values
1 - v1 error format
2 - v2 error format
</pre>
</div>
<div class="method">
<code class="details" id="get">get(userKey, customFieldMask=None, projection=None, viewType=None, x__xgafv=None)</code>
<pre>Retrieves a user.
Args:
userKey: string, Identifies the user in the API request. The value can be the user's primary email address, alias email address, or unique user ID. (required)
customFieldMask: string, A comma-separated list of schema names. All fields from these schemas are fetched. This should only be set when `projection=custom`.
projection: string, What subset of fields to fetch for this user.
Allowed values
basic - Do not include any custom fields for the user.
custom - Include custom fields from schemas requested in `customFieldMask`.
full - Include all fields associated with this user.
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](https://developers.google.com/workspace/admin/directory/v1/guides/manage-users#retrieve_users_non_admin).
Allowed values
admin_view - Results include both administrator-only and domain-public fields for the user.
domain_public - Results only include fields for the user that are publicly visible to other users in the domain.
x__xgafv: string, V1 error format.
Allowed values
1 - v1 error format
2 - v2 error format
Returns:
An object of the form:
{ # The Directory API allows you to create and manage your account's users, user aliases, and user Google profile photos. For more information about common tasks, see the [User Accounts Developer's Guide](https://developers.google.com/workspace/admin/directory/v1/guides/manage-users.html) and the [User Aliases Developer's Guide](https://developers.google.com/workspace/admin/directory/v1/guides/manage-user-aliases.html).
"addresses": "", # The list of the user's addresses. The maximum allowed data size for this field is 10KB.
"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.
"aliases": [ # Output only. The list of the user's alias email addresses.
"A String",
],
"archived": True or False, # Indicates if user is archived.
"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).
"creationTime": "A String", # User's G Suite account creation time. (Read-only)
"customSchemas": { # Custom fields of the user. The key is a `schema_name` and its values are `'field_name': 'field_value'`.
"a_key": { # JSON template for a set of custom properties (i.e. all fields in a particular schema)
"a_key": "",
},
},
"customerId": "A String", # Output only. The customer ID to [retrieve all account users](https://developers.google.com/workspace/admin/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](https://developers.google.com/workspace/admin/directory/v1/reference/users/list) request.
"deletionTime": "A String",
"emails": "", # The list of the user's email addresses. The maximum allowed data size for this field is 10KB. This excludes `publicKeyEncryptionCertificates`.
"etag": "A String", # Output only. ETag of the resource.
"externalIds": "", # The list of external IDs for the user, such as an employee or network ID. The maximum allowed data size for this field is 2KB.
"gender": "", # The user's gender. The maximum allowed data size for this field is 1KB.
"guestAccountInfo": { # Account info specific to Guest users. # Immutable. Additional guest-related metadata fields
"primaryGuestEmail": "A String", # Immutable. The guest's external email.
},
"hashFunction": "A String", # Stores the hash format of the `password` property. The following `hashFunction` values are allowed: * `MD5` - Accepts simple hex-encoded values. * `SHA-1` - Accepts simple hex-encoded values. * `crypt` - Compliant with the [C crypt library](https://en.wikipedia.org/wiki/Crypt_%28C%29). Supports the DES, MD5 (hash prefix `$1$`), SHA-256 (hash prefix `$5$`), and SHA-512 (hash prefix `$6$`) hash algorithms. If rounds are specified as part of the prefix, they must be 10,000 or fewer.
"id": "A String", # The unique ID for the user. A user `id` can be used as a user request URI's `userKey`.
"ims": "", # The list of 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.
"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).
"ipWhitelisted": True or False, # If `true`, the user's IP address is subject to a deprecated IP address [`allowlist`](https://support.google.com/a/answer/60752) configuration.
"isAdmin": True or False, # Output only. Indicates a user with super administrator privileges. The `isAdmin` property can only be edited in the [Make a user an administrator](https://developers.google.com/workspace/admin/directory/v1/guides/manage-users.html#make_admin) operation ( [makeAdmin](https://developers.google.com/workspace/admin/directory/v1/reference/users/makeAdmin.html) method). If edited in the user [insert](https://developers.google.com/workspace/admin/directory/v1/reference/users/insert.html) or [update](https://developers.google.com/workspace/admin/directory/v1/reference/users/update.html) methods, the edit is ignored by the API service.
"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).
"isEnforcedIn2Sv": True or False, # Output only. Is 2-step verification enforced (Read-only)
"isEnrolledIn2Sv": True or False, # Output only. Is enrolled in 2-step verification (Read-only)
"isGuestUser": True or False, # Immutable. Indicates if the inserted user is a guest.
"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.
"keywords": "", # The list of the user's keywords. The maximum allowed data size for this field is 1KB.
"kind": "admin#directory#user", # Output only. The type of the API resource. For Users resources, the value is `admin#directory#user`.
"languages": "", # The user's languages. The maximum allowed data size for this field is 1KB.
"lastLoginTime": "A String", # User's last login time. (Read-only)
"locations": "", # The user's locations. The maximum allowed data size for this field is 10KB.
"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.
"displayName": "A String", # The user's display name. Limit: 256 characters.
"familyName": "A String", # The user's last name. Required when creating a user account.
"fullName": "A String", # The user's full name formed by concatenating the first and last name values.
"givenName": "A String", # The user's first name. Required when creating a user account.
},
"nonEditableAliases": [ # Output only. The list of the user's non-editable alias email addresses. These are typically outside the account's primary domain or sub-domain.
"A String",
],
"notes": "", # Notes for the user.
"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 (`/`).
"organizations": "", # The list of organizations the user belongs to. The maximum allowed data size for this field is 10KB.
"password": "A String", # User's password
"phones": "", # The list of the user's phone numbers. The maximum allowed data size for this field is 1KB.
"posixAccounts": "", # The list of [POSIX](https://www.opengroup.org/austin/papers/posix_faq.html) account information for the user.
"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.
"recoveryEmail": "A String", # Recovery email of the user.
"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*.
"relations": "", # The list of the user's relationships to other users. The maximum allowed data size for this field is 2KB.
"sshPublicKeys": "", # A list of SSH public keys.
"suspended": True or False, # Indicates if user is suspended.
"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`.
"thumbnailPhotoEtag": "A String", # Output only. ETag of the user's photo (Read-only)
"thumbnailPhotoUrl": "A String", # Output only. The URL of the user's profile photo. The URL might be temporary or private.
"websites": "", # The user's websites. The maximum allowed data size for this field is 2KB.
}</pre>
</div>
<div class="method">
<code class="details" id="insert">insert(body=None, resolveConflictAccount=None, x__xgafv=None)</code>
<pre>Creates a user. Mutate calls immediately following user creation might sometimes fail as the user isn't fully created due to propagation delay in our backends. Check the error details for the "User creation is not complete" message to see if this is the case. Retrying the calls after some time can help in this case. If `resolveConflictAccount` is set to `true`, a `202` response code means that a conflicting unmanaged account exists and was invited to join the organization. A `409` response code means that a conflicting account exists so the user wasn't created based on the [handling unmanaged user accounts](https://support.google.com/a/answer/11112794) option selected.
Args:
body: object, The request body.
The object takes the form of:
{ # The Directory API allows you to create and manage your account's users, user aliases, and user Google profile photos. For more information about common tasks, see the [User Accounts Developer's Guide](https://developers.google.com/workspace/admin/directory/v1/guides/manage-users.html) and the [User Aliases Developer's Guide](https://developers.google.com/workspace/admin/directory/v1/guides/manage-user-aliases.html).
"addresses": "", # The list of the user's addresses. The maximum allowed data size for this field is 10KB.
"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.
"aliases": [ # Output only. The list of the user's alias email addresses.
"A String",
],
"archived": True or False, # Indicates if user is archived.
"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).
"creationTime": "A String", # User's G Suite account creation time. (Read-only)
"customSchemas": { # Custom fields of the user. The key is a `schema_name` and its values are `'field_name': 'field_value'`.
"a_key": { # JSON template for a set of custom properties (i.e. all fields in a particular schema)
"a_key": "",
},
},
"customerId": "A String", # Output only. The customer ID to [retrieve all account users](https://developers.google.com/workspace/admin/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](https://developers.google.com/workspace/admin/directory/v1/reference/users/list) request.
"deletionTime": "A String",
"emails": "", # The list of the user's email addresses. The maximum allowed data size for this field is 10KB. This excludes `publicKeyEncryptionCertificates`.
"etag": "A String", # Output only. ETag of the resource.
"externalIds": "", # The list of external IDs for the user, such as an employee or network ID. The maximum allowed data size for this field is 2KB.
"gender": "", # The user's gender. The maximum allowed data size for this field is 1KB.
"guestAccountInfo": { # Account info specific to Guest users. # Immutable. Additional guest-related metadata fields
"primaryGuestEmail": "A String", # Immutable. The guest's external email.
},
"hashFunction": "A String", # Stores the hash format of the `password` property. The following `hashFunction` values are allowed: * `MD5` - Accepts simple hex-encoded values. * `SHA-1` - Accepts simple hex-encoded values. * `crypt` - Compliant with the [C crypt library](https://en.wikipedia.org/wiki/Crypt_%28C%29). Supports the DES, MD5 (hash prefix `$1$`), SHA-256 (hash prefix `$5$`), and SHA-512 (hash prefix `$6$`) hash algorithms. If rounds are specified as part of the prefix, they must be 10,000 or fewer.
"id": "A String", # The unique ID for the user. A user `id` can be used as a user request URI's `userKey`.
"ims": "", # The list of 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.
"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).
"ipWhitelisted": True or False, # If `true`, the user's IP address is subject to a deprecated IP address [`allowlist`](https://support.google.com/a/answer/60752) configuration.
"isAdmin": True or False, # Output only. Indicates a user with super administrator privileges. The `isAdmin` property can only be edited in the [Make a user an administrator](https://developers.google.com/workspace/admin/directory/v1/guides/manage-users.html#make_admin) operation ( [makeAdmin](https://developers.google.com/workspace/admin/directory/v1/reference/users/makeAdmin.html) method). If edited in the user [insert](https://developers.google.com/workspace/admin/directory/v1/reference/users/insert.html) or [update](https://developers.google.com/workspace/admin/directory/v1/reference/users/update.html) methods, the edit is ignored by the API service.
"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).
"isEnforcedIn2Sv": True or False, # Output only. Is 2-step verification enforced (Read-only)
"isEnrolledIn2Sv": True or False, # Output only. Is enrolled in 2-step verification (Read-only)
"isGuestUser": True or False, # Immutable. Indicates if the inserted user is a guest.
"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.
"keywords": "", # The list of the user's keywords. The maximum allowed data size for this field is 1KB.
"kind": "admin#directory#user", # Output only. The type of the API resource. For Users resources, the value is `admin#directory#user`.
"languages": "", # The user's languages. The maximum allowed data size for this field is 1KB.
"lastLoginTime": "A String", # User's last login time. (Read-only)
"locations": "", # The user's locations. The maximum allowed data size for this field is 10KB.
"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.
"displayName": "A String", # The user's display name. Limit: 256 characters.
"familyName": "A String", # The user's last name. Required when creating a user account.
"fullName": "A String", # The user's full name formed by concatenating the first and last name values.
"givenName": "A String", # The user's first name. Required when creating a user account.
},
"nonEditableAliases": [ # Output only. The list of the user's non-editable alias email addresses. These are typically outside the account's primary domain or sub-domain.
"A String",
],
"notes": "", # Notes for the user.
"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 (`/`).
"organizations": "", # The list of organizations the user belongs to. The maximum allowed data size for this field is 10KB.
"password": "A String", # User's password
"phones": "", # The list of the user's phone numbers. The maximum allowed data size for this field is 1KB.
"posixAccounts": "", # The list of [POSIX](https://www.opengroup.org/austin/papers/posix_faq.html) account information for the user.
"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.
"recoveryEmail": "A String", # Recovery email of the user.
"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*.
"relations": "", # The list of the user's relationships to other users. The maximum allowed data size for this field is 2KB.
"sshPublicKeys": "", # A list of SSH public keys.
"suspended": True or False, # Indicates if user is suspended.
"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`.
"thumbnailPhotoEtag": "A String", # Output only. ETag of the user's photo (Read-only)
"thumbnailPhotoUrl": "A String", # Output only. The URL of the user's profile photo. The URL might be temporary or private.
"websites": "", # The user's websites. The maximum allowed data size for this field is 2KB.
}
resolveConflictAccount: boolean, Optional. If set to `true`, the option selected for [handling unmanaged user accounts](https://support.google.com/a/answer/11112794) will apply. Default: `false`
x__xgafv: string, V1 error format.
Allowed values
1 - v1 error format
2 - v2 error format
Returns:
An object of the form:
{ # The Directory API allows you to create and manage your account's users, user aliases, and user Google profile photos. For more information about common tasks, see the [User Accounts Developer's Guide](https://developers.google.com/workspace/admin/directory/v1/guides/manage-users.html) and the [User Aliases Developer's Guide](https://developers.google.com/workspace/admin/directory/v1/guides/manage-user-aliases.html).
"addresses": "", # The list of the user's addresses. The maximum allowed data size for this field is 10KB.
"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.
"aliases": [ # Output only. The list of the user's alias email addresses.
"A String",
],
"archived": True or False, # Indicates if user is archived.
"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).
"creationTime": "A String", # User's G Suite account creation time. (Read-only)
"customSchemas": { # Custom fields of the user. The key is a `schema_name` and its values are `'field_name': 'field_value'`.
"a_key": { # JSON template for a set of custom properties (i.e. all fields in a particular schema)
"a_key": "",
},
},
"customerId": "A String", # Output only. The customer ID to [retrieve all account users](https://developers.google.com/workspace/admin/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](https://developers.google.com/workspace/admin/directory/v1/reference/users/list) request.
"deletionTime": "A String",
"emails": "", # The list of the user's email addresses. The maximum allowed data size for this field is 10KB. This excludes `publicKeyEncryptionCertificates`.
"etag": "A String", # Output only. ETag of the resource.
"externalIds": "", # The list of external IDs for the user, such as an employee or network ID. The maximum allowed data size for this field is 2KB.
"gender": "", # The user's gender. The maximum allowed data size for this field is 1KB.
"guestAccountInfo": { # Account info specific to Guest users. # Immutable. Additional guest-related metadata fields
"primaryGuestEmail": "A String", # Immutable. The guest's external email.
},
"hashFunction": "A String", # Stores the hash format of the `password` property. The following `hashFunction` values are allowed: * `MD5` - Accepts simple hex-encoded values. * `SHA-1` - Accepts simple hex-encoded values. * `crypt` - Compliant with the [C crypt library](https://en.wikipedia.org/wiki/Crypt_%28C%29). Supports the DES, MD5 (hash prefix `$1$`), SHA-256 (hash prefix `$5$`), and SHA-512 (hash prefix `$6$`) hash algorithms. If rounds are specified as part of the prefix, they must be 10,000 or fewer.
"id": "A String", # The unique ID for the user. A user `id` can be used as a user request URI's `userKey`.
"ims": "", # The list of 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.
"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).
"ipWhitelisted": True or False, # If `true`, the user's IP address is subject to a deprecated IP address [`allowlist`](https://support.google.com/a/answer/60752) configuration.
"isAdmin": True or False, # Output only. Indicates a user with super administrator privileges. The `isAdmin` property can only be edited in the [Make a user an administrator](https://developers.google.com/workspace/admin/directory/v1/guides/manage-users.html#make_admin) operation ( [makeAdmin](https://developers.google.com/workspace/admin/directory/v1/reference/users/makeAdmin.html) method). If edited in the user [insert](https://developers.google.com/workspace/admin/directory/v1/reference/users/insert.html) or [update](https://developers.google.com/workspace/admin/directory/v1/reference/users/update.html) methods, the edit is ignored by the API service.
"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).
"isEnforcedIn2Sv": True or False, # Output only. Is 2-step verification enforced (Read-only)
"isEnrolledIn2Sv": True or False, # Output only. Is enrolled in 2-step verification (Read-only)
"isGuestUser": True or False, # Immutable. Indicates if the inserted user is a guest.
"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.
"keywords": "", # The list of the user's keywords. The maximum allowed data size for this field is 1KB.
"kind": "admin#directory#user", # Output only. The type of the API resource. For Users resources, the value is `admin#directory#user`.
"languages": "", # The user's languages. The maximum allowed data size for this field is 1KB.
"lastLoginTime": "A String", # User's last login time. (Read-only)
"locations": "", # The user's locations. The maximum allowed data size for this field is 10KB.
"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.
"displayName": "A String", # The user's display name. Limit: 256 characters.
"familyName": "A String", # The user's last name. Required when creating a user account.
"fullName": "A String", # The user's full name formed by concatenating the first and last name values.
"givenName": "A String", # The user's first name. Required when creating a user account.
},
"nonEditableAliases": [ # Output only. The list of the user's non-editable alias email addresses. These are typically outside the account's primary domain or sub-domain.
"A String",
],
"notes": "", # Notes for the user.
"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 (`/`).
"organizations": "", # The list of organizations the user belongs to. The maximum allowed data size for this field is 10KB.
"password": "A String", # User's password
"phones": "", # The list of the user's phone numbers. The maximum allowed data size for this field is 1KB.
"posixAccounts": "", # The list of [POSIX](https://www.opengroup.org/austin/papers/posix_faq.html) account information for the user.
"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.
"recoveryEmail": "A String", # Recovery email of the user.
"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*.
"relations": "", # The list of the user's relationships to other users. The maximum allowed data size for this field is 2KB.
"sshPublicKeys": "", # A list of SSH public keys.
"suspended": True or False, # Indicates if user is suspended.
"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`.
"thumbnailPhotoEtag": "A String", # Output only. ETag of the user's photo (Read-only)
"thumbnailPhotoUrl": "A String", # Output only. The URL of the user's profile photo. The URL might be temporary or private.
"websites": "", # The user's websites. The maximum allowed data size for this field is 2KB.
}</pre>
</div>
<div class="method">
<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>
<pre>Retrieves a paginated list of either deleted users or all users in a domain.
Args:
customFieldMask: string, A comma-separated list of schema names. All fields from these schemas are fetched. This should only be set when `projection=custom`.
customer: string, The unique ID for the customer's Google Workspace account. In case of a multi-domain account, to fetch all users for a customer, use 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](https://developers.google.com/workspace/admin/directory/v1/reference/users) resource. You must provide either the `customer` or the `domain` parameter.
domain: string, The domain name. Use this field to get users 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.
event: string, Event on which subscription is intended (if subscribing)
Allowed values
add - User Created Event
delete - User Deleted Event
makeAdmin - User Admin Status Change Event
undelete - User Undeleted Event
update - User Updated Event
maxResults: integer, Maximum number of results to return.
orderBy: string, Property to use for sorting results.
Allowed values
email - Primary email of the user.
familyName - User's family name.
givenName - User's given name.
pageToken: string, Token to specify next page in the list. The page token is only valid for three days.
projection: string, What subset of fields to fetch for this user.
Allowed values
basic - Do not include any custom fields for the user.
custom - Include custom fields from schemas requested in `customFieldMask`.
full - Include all fields associated with this user.
query: string, Query string for searching user fields. For more information on constructing user queries, see [Search for Users](https://developers.google.com/workspace/admin/directory/v1/guides/search-users).
showDeleted: string, If set to `true`, retrieves the list of deleted users. (Default: `false`)
sortOrder: string, Whether to return results in ascending or descending order, ignoring case.
Allowed values
ASCENDING - Ascending order.
DESCENDING - Descending order.
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](https://developers.google.com/workspace/admin/directory/v1/guides/manage-users#retrieve_users_non_admin).
Allowed values
admin_view - Results include both administrator-only and domain-public fields for the user.
domain_public - Results only include fields for the user that are publicly visible to other users in the domain.
x__xgafv: string, V1 error format.
Allowed values
1 - v1 error format
2 - v2 error format
Returns:
An object of the form:
{
"etag": "A String", # ETag of the resource.
"kind": "admin#directory#users", # Kind of resource this is.
"nextPageToken": "A String", # Token used to access next page of this result. The page token is only valid for three days.
"trigger_event": "A String", # Event that triggered this response (only used in case of Push Response)
"users": [ # A list of user objects.
{ # The Directory API allows you to create and manage your account's users, user aliases, and user Google profile photos. For more information about common tasks, see the [User Accounts Developer's Guide](https://developers.google.com/workspace/admin/directory/v1/guides/manage-users.html) and the [User Aliases Developer's Guide](https://developers.google.com/workspace/admin/directory/v1/guides/manage-user-aliases.html).
"addresses": "", # The list of the user's addresses. The maximum allowed data size for this field is 10KB.
"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.
"aliases": [ # Output only. The list of the user's alias email addresses.
"A String",
],
"archived": True or False, # Indicates if user is archived.
"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).
"creationTime": "A String", # User's G Suite account creation time. (Read-only)
"customSchemas": { # Custom fields of the user. The key is a `schema_name` and its values are `'field_name': 'field_value'`.
"a_key": { # JSON template for a set of custom properties (i.e. all fields in a particular schema)
"a_key": "",
},
},
"customerId": "A String", # Output only. The customer ID to [retrieve all account users](https://developers.google.com/workspace/admin/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](https://developers.google.com/workspace/admin/directory/v1/reference/users/list) request.
"deletionTime": "A String",
"emails": "", # The list of the user's email addresses. The maximum allowed data size for this field is 10KB. This excludes `publicKeyEncryptionCertificates`.
"etag": "A String", # Output only. ETag of the resource.
"externalIds": "", # The list of external IDs for the user, such as an employee or network ID. The maximum allowed data size for this field is 2KB.
"gender": "", # The user's gender. The maximum allowed data size for this field is 1KB.
"guestAccountInfo": { # Account info specific to Guest users. # Immutable. Additional guest-related metadata fields
"primaryGuestEmail": "A String", # Immutable. The guest's external email.
},
"hashFunction": "A String", # Stores the hash format of the `password` property. The following `hashFunction` values are allowed: * `MD5` - Accepts simple hex-encoded values. * `SHA-1` - Accepts simple hex-encoded values. * `crypt` - Compliant with the [C crypt library](https://en.wikipedia.org/wiki/Crypt_%28C%29). Supports the DES, MD5 (hash prefix `$1$`), SHA-256 (hash prefix `$5$`), and SHA-512 (hash prefix `$6$`) hash algorithms. If rounds are specified as part of the prefix, they must be 10,000 or fewer.
"id": "A String", # The unique ID for the user. A user `id` can be used as a user request URI's `userKey`.
"ims": "", # The list of 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.
"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).
"ipWhitelisted": True or False, # If `true`, the user's IP address is subject to a deprecated IP address [`allowlist`](https://support.google.com/a/answer/60752) configuration.
"isAdmin": True or False, # Output only. Indicates a user with super administrator privileges. The `isAdmin` property can only be edited in the [Make a user an administrator](https://developers.google.com/workspace/admin/directory/v1/guides/manage-users.html#make_admin) operation ( [makeAdmin](https://developers.google.com/workspace/admin/directory/v1/reference/users/makeAdmin.html) method). If edited in the user [insert](https://developers.google.com/workspace/admin/directory/v1/reference/users/insert.html) or [update](https://developers.google.com/workspace/admin/directory/v1/reference/users/update.html) methods, the edit is ignored by the API service.
"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).
"isEnforcedIn2Sv": True or False, # Output only. Is 2-step verification enforced (Read-only)
"isEnrolledIn2Sv": True or False, # Output only. Is enrolled in 2-step verification (Read-only)
"isGuestUser": True or False, # Immutable. Indicates if the inserted user is a guest.
"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.
"keywords": "", # The list of the user's keywords. The maximum allowed data size for this field is 1KB.
"kind": "admin#directory#user", # Output only. The type of the API resource. For Users resources, the value is `admin#directory#user`.
"languages": "", # The user's languages. The maximum allowed data size for this field is 1KB.
"lastLoginTime": "A String", # User's last login time. (Read-only)
"locations": "", # The user's locations. The maximum allowed data size for this field is 10KB.
"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.
"displayName": "A String", # The user's display name. Limit: 256 characters.
"familyName": "A String", # The user's last name. Required when creating a user account.
"fullName": "A String", # The user's full name formed by concatenating the first and last name values.
"givenName": "A String", # The user's first name. Required when creating a user account.
},
"nonEditableAliases": [ # Output only. The list of the user's non-editable alias email addresses. These are typically outside the account's primary domain or sub-domain.
"A String",
],
"notes": "", # Notes for the user.
"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 (`/`).
"organizations": "", # The list of organizations the user belongs to. The maximum allowed data size for this field is 10KB.
"password": "A String", # User's password
"phones": "", # The list of the user's phone numbers. The maximum allowed data size for this field is 1KB.
"posixAccounts": "", # The list of [POSIX](https://www.opengroup.org/austin/papers/posix_faq.html) account information for the user.
"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.
"recoveryEmail": "A String", # Recovery email of the user.
"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*.
"relations": "", # The list of the user's relationships to other users. The maximum allowed data size for this field is 2KB.
"sshPublicKeys": "", # A list of SSH public keys.
"suspended": True or False, # Indicates if user is suspended.
"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`.
"thumbnailPhotoEtag": "A String", # Output only. ETag of the user's photo (Read-only)
"thumbnailPhotoUrl": "A String", # Output only. The URL of the user's profile photo. The URL might be temporary or private.
"websites": "", # The user's websites. The maximum allowed data size for this field is 2KB.
},
],
}</pre>
</div>
<div class="method">
<code class="details" id="list_next">list_next()</code>
<pre>Retrieves the next page of results.
Args:
previous_request: The request for the previous page. (required)
previous_response: The response from the request for the previous page. (required)
Returns:
A request object that you can call 'execute()' on to request the next
page. Returns None if there are no more items in the collection.
</pre>
</div>
<div class="method">
<code class="details" id="makeAdmin">makeAdmin(userKey, body=None, x__xgafv=None)</code>
<pre>Makes a user a super administrator.
Args:
userKey: string, Identifies the user in the API request. The value can be the user's primary email address, alias email address, or unique user ID. (required)
body: object, The request body.
The object takes the form of:
{
"status": True or False, # Indicates the administrator status of the user.
}
x__xgafv: string, V1 error format.
Allowed values
1 - v1 error format
2 - v2 error format
</pre>
</div>
<div class="method">
<code class="details" id="patch">patch(userKey, body=None, x__xgafv=None)</code>
<pre>Updates a user using patch semantics. The update method should be used instead, because it also supports patch semantics and has better performance. If you're mapping an external identity to a Google identity, use the [`update`](https://developers.google.com/workspace/admin/directory/v1/reference/users/update) method instead of the `patch` method. This method is unable to clear fields that contain repeated objects (`addresses`, `phones`, etc). Use the update method instead.
Args:
userKey: string, Identifies the user in the API request. The value can be the user's primary email address, alias email address, or unique user ID. (required)
body: object, The request body.
The object takes the form of:
{ # The Directory API allows you to create and manage your account's users, user aliases, and user Google profile photos. For more information about common tasks, see the [User Accounts Developer's Guide](https://developers.google.com/workspace/admin/directory/v1/guides/manage-users.html) and the [User Aliases Developer's Guide](https://developers.google.com/workspace/admin/directory/v1/guides/manage-user-aliases.html).
"addresses": "", # The list of the user's addresses. The maximum allowed data size for this field is 10KB.
"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.
"aliases": [ # Output only. The list of the user's alias email addresses.
"A String",
],
"archived": True or False, # Indicates if user is archived.
"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).
"creationTime": "A String", # User's G Suite account creation time. (Read-only)
"customSchemas": { # Custom fields of the user. The key is a `schema_name` and its values are `'field_name': 'field_value'`.
"a_key": { # JSON template for a set of custom properties (i.e. all fields in a particular schema)
"a_key": "",
},
},
"customerId": "A String", # Output only. The customer ID to [retrieve all account users](https://developers.google.com/workspace/admin/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](https://developers.google.com/workspace/admin/directory/v1/reference/users/list) request.
"deletionTime": "A String",
"emails": "", # The list of the user's email addresses. The maximum allowed data size for this field is 10KB. This excludes `publicKeyEncryptionCertificates`.
"etag": "A String", # Output only. ETag of the resource.
"externalIds": "", # The list of external IDs for the user, such as an employee or network ID. The maximum allowed data size for this field is 2KB.
"gender": "", # The user's gender. The maximum allowed data size for this field is 1KB.
"guestAccountInfo": { # Account info specific to Guest users. # Immutable. Additional guest-related metadata fields
"primaryGuestEmail": "A String", # Immutable. The guest's external email.
},
"hashFunction": "A String", # Stores the hash format of the `password` property. The following `hashFunction` values are allowed: * `MD5` - Accepts simple hex-encoded values. * `SHA-1` - Accepts simple hex-encoded values. * `crypt` - Compliant with the [C crypt library](https://en.wikipedia.org/wiki/Crypt_%28C%29). Supports the DES, MD5 (hash prefix `$1$`), SHA-256 (hash prefix `$5$`), and SHA-512 (hash prefix `$6$`) hash algorithms. If rounds are specified as part of the prefix, they must be 10,000 or fewer.
"id": "A String", # The unique ID for the user. A user `id` can be used as a user request URI's `userKey`.
"ims": "", # The list of 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.
"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).
"ipWhitelisted": True or False, # If `true`, the user's IP address is subject to a deprecated IP address [`allowlist`](https://support.google.com/a/answer/60752) configuration.
"isAdmin": True or False, # Output only. Indicates a user with super administrator privileges. The `isAdmin` property can only be edited in the [Make a user an administrator](https://developers.google.com/workspace/admin/directory/v1/guides/manage-users.html#make_admin) operation ( [makeAdmin](https://developers.google.com/workspace/admin/directory/v1/reference/users/makeAdmin.html) method). If edited in the user [insert](https://developers.google.com/workspace/admin/directory/v1/reference/users/insert.html) or [update](https://developers.google.com/workspace/admin/directory/v1/reference/users/update.html) methods, the edit is ignored by the API service.
"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).
"isEnforcedIn2Sv": True or False, # Output only. Is 2-step verification enforced (Read-only)
"isEnrolledIn2Sv": True or False, # Output only. Is enrolled in 2-step verification (Read-only)
"isGuestUser": True or False, # Immutable. Indicates if the inserted user is a guest.
"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.
"keywords": "", # The list of the user's keywords. The maximum allowed data size for this field is 1KB.
"kind": "admin#directory#user", # Output only. The type of the API resource. For Users resources, the value is `admin#directory#user`.
"languages": "", # The user's languages. The maximum allowed data size for this field is 1KB.
"lastLoginTime": "A String", # User's last login time. (Read-only)
"locations": "", # The user's locations. The maximum allowed data size for this field is 10KB.
"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.
"displayName": "A String", # The user's display name. Limit: 256 characters.
"familyName": "A String", # The user's last name. Required when creating a user account.
"fullName": "A String", # The user's full name formed by concatenating the first and last name values.
"givenName": "A String", # The user's first name. Required when creating a user account.
},
"nonEditableAliases": [ # Output only. The list of the user's non-editable alias email addresses. These are typically outside the account's primary domain or sub-domain.
"A String",
],
"notes": "", # Notes for the user.
"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 (`/`).
"organizations": "", # The list of organizations the user belongs to. The maximum allowed data size for this field is 10KB.
"password": "A String", # User's password
"phones": "", # The list of the user's phone numbers. The maximum allowed data size for this field is 1KB.
"posixAccounts": "", # The list of [POSIX](https://www.opengroup.org/austin/papers/posix_faq.html) account information for the user.
"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.
"recoveryEmail": "A String", # Recovery email of the user.
"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*.
"relations": "", # The list of the user's relationships to other users. The maximum allowed data size for this field is 2KB.
"sshPublicKeys": "", # A list of SSH public keys.
"suspended": True or False, # Indicates if user is suspended.
"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`.
"thumbnailPhotoEtag": "A String", # Output only. ETag of the user's photo (Read-only)
"thumbnailPhotoUrl": "A String", # Output only. The URL of the user's profile photo. The URL might be temporary or private.
"websites": "", # The user's websites. The maximum allowed data size for this field is 2KB.
}
x__xgafv: string, V1 error format.
Allowed values
1 - v1 error format
2 - v2 error format
Returns:
An object of the form:
{ # The Directory API allows you to create and manage your account's users, user aliases, and user Google profile photos. For more information about common tasks, see the [User Accounts Developer's Guide](https://developers.google.com/workspace/admin/directory/v1/guides/manage-users.html) and the [User Aliases Developer's Guide](https://developers.google.com/workspace/admin/directory/v1/guides/manage-user-aliases.html).
"addresses": "", # The list of the user's addresses. The maximum allowed data size for this field is 10KB.
"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.
"aliases": [ # Output only. The list of the user's alias email addresses.
"A String",
],
"archived": True or False, # Indicates if user is archived.
"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).
"creationTime": "A String", # User's G Suite account creation time. (Read-only)
"customSchemas": { # Custom fields of the user. The key is a `schema_name` and its values are `'field_name': 'field_value'`.
"a_key": { # JSON template for a set of custom properties (i.e. all fields in a particular schema)
"a_key": "",
},
},
"customerId": "A String", # Output only. The customer ID to [retrieve all account users](https://developers.google.com/workspace/admin/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](https://developers.google.com/workspace/admin/directory/v1/reference/users/list) request.
"deletionTime": "A String",
"emails": "", # The list of the user's email addresses. The maximum allowed data size for this field is 10KB. This excludes `publicKeyEncryptionCertificates`.
"etag": "A String", # Output only. ETag of the resource.
"externalIds": "", # The list of external IDs for the user, such as an employee or network ID. The maximum allowed data size for this field is 2KB.
"gender": "", # The user's gender. The maximum allowed data size for this field is 1KB.
"guestAccountInfo": { # Account info specific to Guest users. # Immutable. Additional guest-related metadata fields
"primaryGuestEmail": "A String", # Immutable. The guest's external email.
},
"hashFunction": "A String", # Stores the hash format of the `password` property. The following `hashFunction` values are allowed: * `MD5` - Accepts simple hex-encoded values. * `SHA-1` - Accepts simple hex-encoded values. * `crypt` - Compliant with the [C crypt library](https://en.wikipedia.org/wiki/Crypt_%28C%29). Supports the DES, MD5 (hash prefix `$1$`), SHA-256 (hash prefix `$5$`), and SHA-512 (hash prefix `$6$`) hash algorithms. If rounds are specified as part of the prefix, they must be 10,000 or fewer.
"id": "A String", # The unique ID for the user. A user `id` can be used as a user request URI's `userKey`.
"ims": "", # The list of 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.
"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).
"ipWhitelisted": True or False, # If `true`, the user's IP address is subject to a deprecated IP address [`allowlist`](https://support.google.com/a/answer/60752) configuration.
"isAdmin": True or False, # Output only. Indicates a user with super administrator privileges. The `isAdmin` property can only be edited in the [Make a user an administrator](https://developers.google.com/workspace/admin/directory/v1/guides/manage-users.html#make_admin) operation ( [makeAdmin](https://developers.google.com/workspace/admin/directory/v1/reference/users/makeAdmin.html) method). If edited in the user [insert](https://developers.google.com/workspace/admin/directory/v1/reference/users/insert.html) or [update](https://developers.google.com/workspace/admin/directory/v1/reference/users/update.html) methods, the edit is ignored by the API service.
"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).
"isEnforcedIn2Sv": True or False, # Output only. Is 2-step verification enforced (Read-only)
"isEnrolledIn2Sv": True or False, # Output only. Is enrolled in 2-step verification (Read-only)
"isGuestUser": True or False, # Immutable. Indicates if the inserted user is a guest.
"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.
"keywords": "", # The list of the user's keywords. The maximum allowed data size for this field is 1KB.
"kind": "admin#directory#user", # Output only. The type of the API resource. For Users resources, the value is `admin#directory#user`.
"languages": "", # The user's languages. The maximum allowed data size for this field is 1KB.
"lastLoginTime": "A String", # User's last login time. (Read-only)
"locations": "", # The user's locations. The maximum allowed data size for this field is 10KB.
"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.
"displayName": "A String", # The user's display name. Limit: 256 characters.
"familyName": "A String", # The user's last name. Required when creating a user account.
"fullName": "A String", # The user's full name formed by concatenating the first and last name values.
"givenName": "A String", # The user's first name. Required when creating a user account.
},
"nonEditableAliases": [ # Output only. The list of the user's non-editable alias email addresses. These are typically outside the account's primary domain or sub-domain.
"A String",
],
"notes": "", # Notes for the user.
"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 (`/`).
"organizations": "", # The list of organizations the user belongs to. The maximum allowed data size for this field is 10KB.
"password": "A String", # User's password
"phones": "", # The list of the user's phone numbers. The maximum allowed data size for this field is 1KB.
"posixAccounts": "", # The list of [POSIX](https://www.opengroup.org/austin/papers/posix_faq.html) account information for the user.
"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.
"recoveryEmail": "A String", # Recovery email of the user.
"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*.
"relations": "", # The list of the user's relationships to other users. The maximum allowed data size for this field is 2KB.
"sshPublicKeys": "", # A list of SSH public keys.
"suspended": True or False, # Indicates if user is suspended.
"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`.
"thumbnailPhotoEtag": "A String", # Output only. ETag of the user's photo (Read-only)
"thumbnailPhotoUrl": "A String", # Output only. The URL of the user's profile photo. The URL might be temporary or private.
"websites": "", # The user's websites. The maximum allowed data size for this field is 2KB.
}</pre>
</div>
<div class="method">
<code class="details" id="signOut">signOut(userKey, x__xgafv=None)</code>
<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.
Args:
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)
x__xgafv: string, V1 error format.
Allowed values
1 - v1 error format
2 - v2 error format
</pre>
</div>
<div class="method">
<code class="details" id="undelete">undelete(userKey, body=None, x__xgafv=None)</code>
<pre>Undeletes a deleted user.
Args:
userKey: string, The immutable id of the user (required)
body: object, The request body.
The object takes the form of:
{
"orgUnitPath": "A String", # OrgUnit of User
}
x__xgafv: string, V1 error format.
Allowed values
1 - v1 error format
2 - v2 error format
</pre>
</div>
<div class="method">
<code class="details" id="update">update(userKey, body=None, x__xgafv=None)</code>
<pre>Updates a user. This method supports patch semantics, meaning that 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. For repeating fields that contain arrays, individual items in the array can't be patched piecemeal; they must be supplied in the request body with the desired values for all items. See the [user accounts guide](https://developers.google.com/workspace/admin/directory/v1/guides/manage-users#update_user) for more information.
Args:
userKey: string, Identifies the user in the API request. The value can be the user's primary email address, alias email address, or unique user ID. (required)
body: object, The request body.
The object takes the form of:
{ # The Directory API allows you to create and manage your account's users, user aliases, and user Google profile photos. For more information about common tasks, see the [User Accounts Developer's Guide](https://developers.google.com/workspace/admin/directory/v1/guides/manage-users.html) and the [User Aliases Developer's Guide](https://developers.google.com/workspace/admin/directory/v1/guides/manage-user-aliases.html).
"addresses": "", # The list of the user's addresses. The maximum allowed data size for this field is 10KB.
"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.
"aliases": [ # Output only. The list of the user's alias email addresses.
"A String",
],
"archived": True or False, # Indicates if user is archived.
"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).
"creationTime": "A String", # User's G Suite account creation time. (Read-only)
"customSchemas": { # Custom fields of the user. The key is a `schema_name` and its values are `'field_name': 'field_value'`.
"a_key": { # JSON template for a set of custom properties (i.e. all fields in a particular schema)
"a_key": "",
},
},
"customerId": "A String", # Output only. The customer ID to [retrieve all account users](https://developers.google.com/workspace/admin/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](https://developers.google.com/workspace/admin/directory/v1/reference/users/list) request.
"deletionTime": "A String",
"emails": "", # The list of the user's email addresses. The maximum allowed data size for this field is 10KB. This excludes `publicKeyEncryptionCertificates`.
"etag": "A String", # Output only. ETag of the resource.
"externalIds": "", # The list of external IDs for the user, such as an employee or network ID. The maximum allowed data size for this field is 2KB.
"gender": "", # The user's gender. The maximum allowed data size for this field is 1KB.
"guestAccountInfo": { # Account info specific to Guest users. # Immutable. Additional guest-related metadata fields
"primaryGuestEmail": "A String", # Immutable. The guest's external email.
},
"hashFunction": "A String", # Stores the hash format of the `password` property. The following `hashFunction` values are allowed: * `MD5` - Accepts simple hex-encoded values. * `SHA-1` - Accepts simple hex-encoded values. * `crypt` - Compliant with the [C crypt library](https://en.wikipedia.org/wiki/Crypt_%28C%29). Supports the DES, MD5 (hash prefix `$1$`), SHA-256 (hash prefix `$5$`), and SHA-512 (hash prefix `$6$`) hash algorithms. If rounds are specified as part of the prefix, they must be 10,000 or fewer.
"id": "A String", # The unique ID for the user. A user `id` can be used as a user request URI's `userKey`.
"ims": "", # The list of 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.
"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).
"ipWhitelisted": True or False, # If `true`, the user's IP address is subject to a deprecated IP address [`allowlist`](https://support.google.com/a/answer/60752) configuration.
"isAdmin": True or False, # Output only. Indicates a user with super administrator privileges. The `isAdmin` property can only be edited in the [Make a user an administrator](https://developers.google.com/workspace/admin/directory/v1/guides/manage-users.html#make_admin) operation ( [makeAdmin](https://developers.google.com/workspace/admin/directory/v1/reference/users/makeAdmin.html) method). If edited in the user [insert](https://developers.google.com/workspace/admin/directory/v1/reference/users/insert.html) or [update](https://developers.google.com/workspace/admin/directory/v1/reference/users/update.html) methods, the edit is ignored by the API service.
"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).
"isEnforcedIn2Sv": True or False, # Output only. Is 2-step verification enforced (Read-only)
"isEnrolledIn2Sv": True or False, # Output only. Is enrolled in 2-step verification (Read-only)
"isGuestUser": True or False, # Immutable. Indicates if the inserted user is a guest.
"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.
"keywords": "", # The list of the user's keywords. The maximum allowed data size for this field is 1KB.
"kind": "admin#directory#user", # Output only. The type of the API resource. For Users resources, the value is `admin#directory#user`.
"languages": "", # The user's languages. The maximum allowed data size for this field is 1KB.
"lastLoginTime": "A String", # User's last login time. (Read-only)
"locations": "", # The user's locations. The maximum allowed data size for this field is 10KB.
"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.
"displayName": "A String", # The user's display name. Limit: 256 characters.
"familyName": "A String", # The user's last name. Required when creating a user account.
"fullName": "A String", # The user's full name formed by concatenating the first and last name values.
"givenName": "A String", # The user's first name. Required when creating a user account.
},
"nonEditableAliases": [ # Output only. The list of the user's non-editable alias email addresses. These are typically outside the account's primary domain or sub-domain.
"A String",
],
"notes": "", # Notes for the user.
"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 (`/`).
"organizations": "", # The list of organizations the user belongs to. The maximum allowed data size for this field is 10KB.
"password": "A String", # User's password
"phones": "", # The list of the user's phone numbers. The maximum allowed data size for this field is 1KB.
"posixAccounts": "", # The list of [POSIX](https://www.opengroup.org/austin/papers/posix_faq.html) account information for the user.
"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.
"recoveryEmail": "A String", # Recovery email of the user.
"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*.
"relations": "", # The list of the user's relationships to other users. The maximum allowed data size for this field is 2KB.
"sshPublicKeys": "", # A list of SSH public keys.
"suspended": True or False, # Indicates if user is suspended.
"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`.
"thumbnailPhotoEtag": "A String", # Output only. ETag of the user's photo (Read-only)
"thumbnailPhotoUrl": "A String", # Output only. The URL of the user's profile photo. The URL might be temporary or private.
"websites": "", # The user's websites. The maximum allowed data size for this field is 2KB.
}
x__xgafv: string, V1 error format.
Allowed values
1 - v1 error format
2 - v2 error format
Returns:
An object of the form:
{ # The Directory API allows you to create and manage your account's users, user aliases, and user Google profile photos. For more information about common tasks, see the [User Accounts Developer's Guide](https://developers.google.com/workspace/admin/directory/v1/guides/manage-users.html) and the [User Aliases Developer's Guide](https://developers.google.com/workspace/admin/directory/v1/guides/manage-user-aliases.html).
"addresses": "", # The list of the user's addresses. The maximum allowed data size for this field is 10KB.
"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.
"aliases": [ # Output only. The list of the user's alias email addresses.
"A String",
],
"archived": True or False, # Indicates if user is archived.
"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).
"creationTime": "A String", # User's G Suite account creation time. (Read-only)
"customSchemas": { # Custom fields of the user. The key is a `schema_name` and its values are `'field_name': 'field_value'`.
"a_key": { # JSON template for a set of custom properties (i.e. all fields in a particular schema)
"a_key": "",
},
},
"customerId": "A String", # Output only. The customer ID to [retrieve all account users](https://developers.google.com/workspace/admin/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](https://developers.google.com/workspace/admin/directory/v1/reference/users/list) request.
"deletionTime": "A String",
"emails": "", # The list of the user's email addresses. The maximum allowed data size for this field is 10KB. This excludes `publicKeyEncryptionCertificates`.
"etag": "A String", # Output only. ETag of the resource.
"externalIds": "", # The list of external IDs for the user, such as an employee or network ID. The maximum allowed data size for this field is 2KB.
"gender": "", # The user's gender. The maximum allowed data size for this field is 1KB.
"guestAccountInfo": { # Account info specific to Guest users. # Immutable. Additional guest-related metadata fields
"primaryGuestEmail": "A String", # Immutable. The guest's external email.
},
"hashFunction": "A String", # Stores the hash format of the `password` property. The following `hashFunction` values are allowed: * `MD5` - Accepts simple hex-encoded values. * `SHA-1` - Accepts simple hex-encoded values. * `crypt` - Compliant with the [C crypt library](https://en.wikipedia.org/wiki/Crypt_%28C%29). Supports the DES, MD5 (hash prefix `$1$`), SHA-256 (hash prefix `$5$`), and SHA-512 (hash prefix `$6$`) hash algorithms. If rounds are specified as part of the prefix, they must be 10,000 or fewer.
"id": "A String", # The unique ID for the user. A user `id` can be used as a user request URI's `userKey`.
"ims": "", # The list of 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.
"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).
"ipWhitelisted": True or False, # If `true`, the user's IP address is subject to a deprecated IP address [`allowlist`](https://support.google.com/a/answer/60752) configuration.
"isAdmin": True or False, # Output only. Indicates a user with super administrator privileges. The `isAdmin` property can only be edited in the [Make a user an administrator](https://developers.google.com/workspace/admin/directory/v1/guides/manage-users.html#make_admin) operation ( [makeAdmin](https://developers.google.com/workspace/admin/directory/v1/reference/users/makeAdmin.html) method). If edited in the user [insert](https://developers.google.com/workspace/admin/directory/v1/reference/users/insert.html) or [update](https://developers.google.com/workspace/admin/directory/v1/reference/users/update.html) methods, the edit is ignored by the API service.
"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).
"isEnforcedIn2Sv": True or False, # Output only. Is 2-step verification enforced (Read-only)
"isEnrolledIn2Sv": True or False, # Output only. Is enrolled in 2-step verification (Read-only)
"isGuestUser": True or False, # Immutable. Indicates if the inserted user is a guest.
"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.
"keywords": "", # The list of the user's keywords. The maximum allowed data size for this field is 1KB.
"kind": "admin#directory#user", # Output only. The type of the API resource. For Users resources, the value is `admin#directory#user`.
"languages": "", # The user's languages. The maximum allowed data size for this field is 1KB.
"lastLoginTime": "A String", # User's last login time. (Read-only)
"locations": "", # The user's locations. The maximum allowed data size for this field is 10KB.
"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.
"displayName": "A String", # The user's display name. Limit: 256 characters.
"familyName": "A String", # The user's last name. Required when creating a user account.
"fullName": "A String", # The user's full name formed by concatenating the first and last name values.
"givenName": "A String", # The user's first name. Required when creating a user account.
},
"nonEditableAliases": [ # Output only. The list of the user's non-editable alias email addresses. These are typically outside the account's primary domain or sub-domain.
"A String",
],
"notes": "", # Notes for the user.
"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 (`/`).
"organizations": "", # The list of organizations the user belongs to. The maximum allowed data size for this field is 10KB.
"password": "A String", # User's password
"phones": "", # The list of the user's phone numbers. The maximum allowed data size for this field is 1KB.
"posixAccounts": "", # The list of [POSIX](https://www.opengroup.org/austin/papers/posix_faq.html) account information for the user.
"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.
"recoveryEmail": "A String", # Recovery email of the user.
"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*.
"relations": "", # The list of the user's relationships to other users. The maximum allowed data size for this field is 2KB.
"sshPublicKeys": "", # A list of SSH public keys.
"suspended": True or False, # Indicates if user is suspended.
"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`.
"thumbnailPhotoEtag": "A String", # Output only. ETag of the user's photo (Read-only)
"thumbnailPhotoUrl": "A String", # Output only. The URL of the user's profile photo. The URL might be temporary or private.
"websites": "", # The user's websites. The maximum allowed data size for this field is 2KB.
}</pre>
</div>
<div class="method">
<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>
<pre>Watches for changes in users list.
Args:
body: object, The request body.
The object takes the form of:
{ # An notification channel used to watch for resource changes.
"address": "A String", # The address where notifications are delivered for this channel.
"expiration": "A String", # Date and time of notification channel expiration, expressed as a Unix timestamp, in milliseconds. Optional.
"id": "A String", # A UUID or similar unique string that identifies this channel.
"kind": "api#channel", # Identifies this as a notification channel used to watch for changes to a resource, which is `api#channel`.
"params": { # Additional parameters controlling delivery channel behavior. Optional. For example, `params.ttl` specifies the time-to-live in seconds for the notification channel, where the default is 2 hours and the maximum TTL is 2 days.
"a_key": "A String",
},
"payload": True or False, # A Boolean value to indicate whether payload is wanted. Optional.
"resourceId": "A String", # An opaque ID that identifies the resource being watched on this channel. Stable across different API versions.
"resourceUri": "A String", # A version-specific identifier for the watched resource.
"token": "A String", # An arbitrary string delivered to the target address with each notification delivered over this channel. Optional.
"type": "A String", # The type of delivery mechanism used for this channel.
}
customFieldMask: string, Comma-separated list of schema names. All fields from these schemas are fetched. This should only be set when projection=custom.
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.
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."
event: string, Events to watch for.
Allowed values
add - User Created Event
delete - User Deleted Event
makeAdmin - User Admin Status Change Event
undelete - User Undeleted Event
update - User Updated Event
maxResults: integer, Maximum number of results to return.
orderBy: string, Column to use for sorting results
Allowed values
email - Primary email of the user.
familyName - User's family name.
givenName - User's given name.
pageToken: string, Token to specify next page in the list