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
|
<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 Directory 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="#delete">delete(userKey)</a></code></p>
<p class="firstline">Delete user</p>
<p class="toc_element">
<code><a href="#get">get(userKey, projection=None, customFieldMask=None, viewType=None)</a></code></p>
<p class="firstline">retrieve user</p>
<p class="toc_element">
<code><a href="#insert">insert(body)</a></code></p>
<p class="firstline">create user.</p>
<p class="toc_element">
<code><a href="#list">list(orderBy=None, domain=None, projection=None, query=None, event=None, showDeleted=None, pageToken=None, sortOrder=None, maxResults=None, customer=None, customFieldMask=None, viewType=None)</a></code></p>
<p class="firstline">Retrieve either deleted users or all users in a domain (paginated)</p>
<p class="toc_element">
<code><a href="#list_next">list_next(previous_request, previous_response)</a></code></p>
<p class="firstline">Retrieves the next page of results.</p>
<p class="toc_element">
<code><a href="#makeAdmin">makeAdmin(userKey, body)</a></code></p>
<p class="firstline">change admin status of a user</p>
<p class="toc_element">
<code><a href="#patch">patch(userKey, body)</a></code></p>
<p class="firstline">update user. This method supports patch semantics.</p>
<p class="toc_element">
<code><a href="#undelete">undelete(userKey, body)</a></code></p>
<p class="firstline">Undelete a deleted user</p>
<p class="toc_element">
<code><a href="#update">update(userKey, body)</a></code></p>
<p class="firstline">update user</p>
<p class="toc_element">
<code><a href="#watch">watch(body, orderBy=None, domain=None, projection=None, query=None, event=None, showDeleted=None, pageToken=None, sortOrder=None, maxResults=None, customer=None, customFieldMask=None, viewType=None)</a></code></p>
<p class="firstline">Watch for changes in users list</p>
<h3>Method Details</h3>
<div class="method">
<code class="details" id="delete">delete(userKey)</code>
<pre>Delete user
Args:
userKey: string, Email or immutable ID of the user (required)
</pre>
</div>
<div class="method">
<code class="details" id="get">get(userKey, projection=None, customFieldMask=None, viewType=None)</code>
<pre>retrieve user
Args:
userKey: string, Email or immutable ID of the user (required)
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 mentioned in customFieldMask.
full - Include all fields associated with this user.
customFieldMask: string, Comma-separated list of schema names. All fields from these schemas are fetched. This should only be set when projection=custom.
viewType: string, Whether to fetch the ADMIN_VIEW or DOMAIN_PUBLIC view of the user.
Allowed values
admin_view - Fetches the ADMIN_VIEW of the user.
domain_public - Fetches the DOMAIN_PUBLIC view of the user.
Returns:
An object of the form:
{ # JSON template for User object in Directory API.
"addresses": "",
"posixAccounts": "",
"phones": "",
"locations": "",
"isDelegatedAdmin": True or False, # Boolean indicating if the user is delegated admin (Read-only)
"thumbnailPhotoEtag": "A String", # ETag of the user's photo (Read-only)
"suspended": True or False, # Indicates if user is suspended.
"keywords": "",
"id": "A String", # Unique identifier of User (Read-only)
"aliases": [ # List of aliases (Read-only)
"A String",
],
"nonEditableAliases": [ # List of non editable aliases (Read-only)
"A String",
],
"archived": True or False, # Indicates if user is archived.
"deletionTime": "A String",
"suspensionReason": "A String", # Suspension reason if user is suspended (Read-only)
"thumbnailPhotoUrl": "A String", # Photo Url of the user (Read-only)
"isEnrolledIn2Sv": True or False, # Is enrolled in 2-step verification (Read-only)
"isAdmin": True or False, # Boolean indicating if the user is admin (Read-only)
"relations": "",
"includeInGlobalAddressList": True or False, # Boolean indicating if user is included in Global Address List
"languages": "",
"ims": "",
"etag": "A String", # ETag of the resource.
"lastLoginTime": "A String", # User's last login time. (Read-only)
"orgUnitPath": "A String", # OrgUnit of User
"agreedToTerms": True or False, # Indicates if user has agreed to terms (Read-only)
"externalIds": "",
"ipWhitelisted": True or False, # Boolean indicating if ip is whitelisted
"sshPublicKeys": "",
"customSchemas": { # Custom fields of the user.
"a_key": { # JSON template for a set of custom properties (i.e. all fields in a particular schema)
"a_key": "",
},
},
"isEnforcedIn2Sv": True or False, # Is 2-step verification enforced (Read-only)
"isMailboxSetup": True or False, # Is mailbox setup (Read-only)
"primaryEmail": "A String", # username of User
"password": "A String", # User's password
"emails": "",
"organizations": "",
"kind": "admin#directory#user", # Kind of resource this is.
"hashFunction": "A String", # Hash function name for password. Supported are MD5, SHA-1 and crypt
"name": { # JSON template for name of a user in Directory API. # User's name
"givenName": "A String", # First Name
"fullName": "A String", # Full Name
"familyName": "A String", # Last Name
},
"gender": "",
"notes": "",
"creationTime": "A String", # User's G Suite account creation time. (Read-only)
"websites": "",
"changePasswordAtNextLogin": True or False, # Boolean indicating if the user should change password in next login
"customerId": "A String", # CustomerId of User (Read-only)
}</pre>
</div>
<div class="method">
<code class="details" id="insert">insert(body)</code>
<pre>create user.
Args:
body: object, The request body. (required)
The object takes the form of:
{ # JSON template for User object in Directory API.
"addresses": "",
"posixAccounts": "",
"phones": "",
"locations": "",
"isDelegatedAdmin": True or False, # Boolean indicating if the user is delegated admin (Read-only)
"thumbnailPhotoEtag": "A String", # ETag of the user's photo (Read-only)
"suspended": True or False, # Indicates if user is suspended.
"keywords": "",
"id": "A String", # Unique identifier of User (Read-only)
"aliases": [ # List of aliases (Read-only)
"A String",
],
"nonEditableAliases": [ # List of non editable aliases (Read-only)
"A String",
],
"archived": True or False, # Indicates if user is archived.
"deletionTime": "A String",
"suspensionReason": "A String", # Suspension reason if user is suspended (Read-only)
"thumbnailPhotoUrl": "A String", # Photo Url of the user (Read-only)
"isEnrolledIn2Sv": True or False, # Is enrolled in 2-step verification (Read-only)
"isAdmin": True or False, # Boolean indicating if the user is admin (Read-only)
"relations": "",
"includeInGlobalAddressList": True or False, # Boolean indicating if user is included in Global Address List
"languages": "",
"ims": "",
"etag": "A String", # ETag of the resource.
"lastLoginTime": "A String", # User's last login time. (Read-only)
"orgUnitPath": "A String", # OrgUnit of User
"agreedToTerms": True or False, # Indicates if user has agreed to terms (Read-only)
"externalIds": "",
"ipWhitelisted": True or False, # Boolean indicating if ip is whitelisted
"sshPublicKeys": "",
"customSchemas": { # Custom fields of the user.
"a_key": { # JSON template for a set of custom properties (i.e. all fields in a particular schema)
"a_key": "",
},
},
"isEnforcedIn2Sv": True or False, # Is 2-step verification enforced (Read-only)
"isMailboxSetup": True or False, # Is mailbox setup (Read-only)
"primaryEmail": "A String", # username of User
"password": "A String", # User's password
"emails": "",
"organizations": "",
"kind": "admin#directory#user", # Kind of resource this is.
"hashFunction": "A String", # Hash function name for password. Supported are MD5, SHA-1 and crypt
"name": { # JSON template for name of a user in Directory API. # User's name
"givenName": "A String", # First Name
"fullName": "A String", # Full Name
"familyName": "A String", # Last Name
},
"gender": "",
"notes": "",
"creationTime": "A String", # User's G Suite account creation time. (Read-only)
"websites": "",
"changePasswordAtNextLogin": True or False, # Boolean indicating if the user should change password in next login
"customerId": "A String", # CustomerId of User (Read-only)
}
Returns:
An object of the form:
{ # JSON template for User object in Directory API.
"addresses": "",
"posixAccounts": "",
"phones": "",
"locations": "",
"isDelegatedAdmin": True or False, # Boolean indicating if the user is delegated admin (Read-only)
"thumbnailPhotoEtag": "A String", # ETag of the user's photo (Read-only)
"suspended": True or False, # Indicates if user is suspended.
"keywords": "",
"id": "A String", # Unique identifier of User (Read-only)
"aliases": [ # List of aliases (Read-only)
"A String",
],
"nonEditableAliases": [ # List of non editable aliases (Read-only)
"A String",
],
"archived": True or False, # Indicates if user is archived.
"deletionTime": "A String",
"suspensionReason": "A String", # Suspension reason if user is suspended (Read-only)
"thumbnailPhotoUrl": "A String", # Photo Url of the user (Read-only)
"isEnrolledIn2Sv": True or False, # Is enrolled in 2-step verification (Read-only)
"isAdmin": True or False, # Boolean indicating if the user is admin (Read-only)
"relations": "",
"includeInGlobalAddressList": True or False, # Boolean indicating if user is included in Global Address List
"languages": "",
"ims": "",
"etag": "A String", # ETag of the resource.
"lastLoginTime": "A String", # User's last login time. (Read-only)
"orgUnitPath": "A String", # OrgUnit of User
"agreedToTerms": True or False, # Indicates if user has agreed to terms (Read-only)
"externalIds": "",
"ipWhitelisted": True or False, # Boolean indicating if ip is whitelisted
"sshPublicKeys": "",
"customSchemas": { # Custom fields of the user.
"a_key": { # JSON template for a set of custom properties (i.e. all fields in a particular schema)
"a_key": "",
},
},
"isEnforcedIn2Sv": True or False, # Is 2-step verification enforced (Read-only)
"isMailboxSetup": True or False, # Is mailbox setup (Read-only)
"primaryEmail": "A String", # username of User
"password": "A String", # User's password
"emails": "",
"organizations": "",
"kind": "admin#directory#user", # Kind of resource this is.
"hashFunction": "A String", # Hash function name for password. Supported are MD5, SHA-1 and crypt
"name": { # JSON template for name of a user in Directory API. # User's name
"givenName": "A String", # First Name
"fullName": "A String", # Full Name
"familyName": "A String", # Last Name
},
"gender": "",
"notes": "",
"creationTime": "A String", # User's G Suite account creation time. (Read-only)
"websites": "",
"changePasswordAtNextLogin": True or False, # Boolean indicating if the user should change password in next login
"customerId": "A String", # CustomerId of User (Read-only)
}</pre>
</div>
<div class="method">
<code class="details" id="list">list(orderBy=None, domain=None, projection=None, query=None, event=None, showDeleted=None, pageToken=None, sortOrder=None, maxResults=None, customer=None, customFieldMask=None, viewType=None)</code>
<pre>Retrieve either deleted users or all users in a domain (paginated)
Args:
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.
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.
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 mentioned in customFieldMask.
full - Include all fields associated with this user.
query: string, Query string search. Should be of the form "". Complete documentation is at https://developers.google.com/admin-sdk/directory/v1/guides/search-users
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
showDeleted: string, If set to true retrieves the list of deleted users. Default is false
pageToken: string, Token to specify next page in the list
sortOrder: string, Whether to return results in ascending or descending order.
Allowed values
ASCENDING - Ascending order.
DESCENDING - Descending order.
maxResults: integer, Maximum number of results to return. Default is 100. Max allowed is 500
customer: string, Immutable ID of the G Suite account. In case of multi-domain, to fetch all users for a customer, fill this field instead of domain.
customFieldMask: string, Comma-separated list of schema names. All fields from these schemas are fetched. This should only be set when projection=custom.
viewType: string, Whether to fetch the ADMIN_VIEW or DOMAIN_PUBLIC view of the user.
Allowed values
admin_view - Fetches the ADMIN_VIEW of the user.
domain_public - Fetches the DOMAIN_PUBLIC view of the user.
Returns:
An object of the form:
{ # JSON response template for List Users operation in Apps Directory API.
"nextPageToken": "A String", # Token used to access next page of this result.
"kind": "admin#directory#users", # Kind of resource this is.
"etag": "A String", # ETag of the resource.
"trigger_event": "A String", # Event that triggered this response (only used in case of Push Response)
"users": [ # List of user objects.
{ # JSON template for User object in Directory API.
"addresses": "",
"posixAccounts": "",
"phones": "",
"locations": "",
"isDelegatedAdmin": True or False, # Boolean indicating if the user is delegated admin (Read-only)
"thumbnailPhotoEtag": "A String", # ETag of the user's photo (Read-only)
"suspended": True or False, # Indicates if user is suspended.
"keywords": "",
"id": "A String", # Unique identifier of User (Read-only)
"aliases": [ # List of aliases (Read-only)
"A String",
],
"nonEditableAliases": [ # List of non editable aliases (Read-only)
"A String",
],
"archived": True or False, # Indicates if user is archived.
"deletionTime": "A String",
"suspensionReason": "A String", # Suspension reason if user is suspended (Read-only)
"thumbnailPhotoUrl": "A String", # Photo Url of the user (Read-only)
"isEnrolledIn2Sv": True or False, # Is enrolled in 2-step verification (Read-only)
"isAdmin": True or False, # Boolean indicating if the user is admin (Read-only)
"relations": "",
"includeInGlobalAddressList": True or False, # Boolean indicating if user is included in Global Address List
"languages": "",
"ims": "",
"etag": "A String", # ETag of the resource.
"lastLoginTime": "A String", # User's last login time. (Read-only)
"orgUnitPath": "A String", # OrgUnit of User
"agreedToTerms": True or False, # Indicates if user has agreed to terms (Read-only)
"externalIds": "",
"ipWhitelisted": True or False, # Boolean indicating if ip is whitelisted
"sshPublicKeys": "",
"customSchemas": { # Custom fields of the user.
"a_key": { # JSON template for a set of custom properties (i.e. all fields in a particular schema)
"a_key": "",
},
},
"isEnforcedIn2Sv": True or False, # Is 2-step verification enforced (Read-only)
"isMailboxSetup": True or False, # Is mailbox setup (Read-only)
"primaryEmail": "A String", # username of User
"password": "A String", # User's password
"emails": "",
"organizations": "",
"kind": "admin#directory#user", # Kind of resource this is.
"hashFunction": "A String", # Hash function name for password. Supported are MD5, SHA-1 and crypt
"name": { # JSON template for name of a user in Directory API. # User's name
"givenName": "A String", # First Name
"fullName": "A String", # Full Name
"familyName": "A String", # Last Name
},
"gender": "",
"notes": "",
"creationTime": "A String", # User's G Suite account creation time. (Read-only)
"websites": "",
"changePasswordAtNextLogin": True or False, # Boolean indicating if the user should change password in next login
"customerId": "A String", # CustomerId of User (Read-only)
},
],
}</pre>
</div>
<div class="method">
<code class="details" id="list_next">list_next(previous_request, previous_response)</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)</code>
<pre>change admin status of a user
Args:
userKey: string, Email or immutable ID of the user as admin (required)
body: object, The request body. (required)
The object takes the form of:
{ # JSON request template for setting/revoking admin status of a user in Directory API.
"status": True or False, # Boolean indicating new admin status of the user
}
</pre>
</div>
<div class="method">
<code class="details" id="patch">patch(userKey, body)</code>
<pre>update user. This method supports patch semantics.
Args:
userKey: string, Email or immutable ID of the user. If ID, it should match with id of user object (required)
body: object, The request body. (required)
The object takes the form of:
{ # JSON template for User object in Directory API.
"addresses": "",
"posixAccounts": "",
"phones": "",
"locations": "",
"isDelegatedAdmin": True or False, # Boolean indicating if the user is delegated admin (Read-only)
"thumbnailPhotoEtag": "A String", # ETag of the user's photo (Read-only)
"suspended": True or False, # Indicates if user is suspended.
"keywords": "",
"id": "A String", # Unique identifier of User (Read-only)
"aliases": [ # List of aliases (Read-only)
"A String",
],
"nonEditableAliases": [ # List of non editable aliases (Read-only)
"A String",
],
"archived": True or False, # Indicates if user is archived.
"deletionTime": "A String",
"suspensionReason": "A String", # Suspension reason if user is suspended (Read-only)
"thumbnailPhotoUrl": "A String", # Photo Url of the user (Read-only)
"isEnrolledIn2Sv": True or False, # Is enrolled in 2-step verification (Read-only)
"isAdmin": True or False, # Boolean indicating if the user is admin (Read-only)
"relations": "",
"includeInGlobalAddressList": True or False, # Boolean indicating if user is included in Global Address List
"languages": "",
"ims": "",
"etag": "A String", # ETag of the resource.
"lastLoginTime": "A String", # User's last login time. (Read-only)
"orgUnitPath": "A String", # OrgUnit of User
"agreedToTerms": True or False, # Indicates if user has agreed to terms (Read-only)
"externalIds": "",
"ipWhitelisted": True or False, # Boolean indicating if ip is whitelisted
"sshPublicKeys": "",
"customSchemas": { # Custom fields of the user.
"a_key": { # JSON template for a set of custom properties (i.e. all fields in a particular schema)
"a_key": "",
},
},
"isEnforcedIn2Sv": True or False, # Is 2-step verification enforced (Read-only)
"isMailboxSetup": True or False, # Is mailbox setup (Read-only)
"primaryEmail": "A String", # username of User
"password": "A String", # User's password
"emails": "",
"organizations": "",
"kind": "admin#directory#user", # Kind of resource this is.
"hashFunction": "A String", # Hash function name for password. Supported are MD5, SHA-1 and crypt
"name": { # JSON template for name of a user in Directory API. # User's name
"givenName": "A String", # First Name
"fullName": "A String", # Full Name
"familyName": "A String", # Last Name
},
"gender": "",
"notes": "",
"creationTime": "A String", # User's G Suite account creation time. (Read-only)
"websites": "",
"changePasswordAtNextLogin": True or False, # Boolean indicating if the user should change password in next login
"customerId": "A String", # CustomerId of User (Read-only)
}
Returns:
An object of the form:
{ # JSON template for User object in Directory API.
"addresses": "",
"posixAccounts": "",
"phones": "",
"locations": "",
"isDelegatedAdmin": True or False, # Boolean indicating if the user is delegated admin (Read-only)
"thumbnailPhotoEtag": "A String", # ETag of the user's photo (Read-only)
"suspended": True or False, # Indicates if user is suspended.
"keywords": "",
"id": "A String", # Unique identifier of User (Read-only)
"aliases": [ # List of aliases (Read-only)
"A String",
],
"nonEditableAliases": [ # List of non editable aliases (Read-only)
"A String",
],
"archived": True or False, # Indicates if user is archived.
"deletionTime": "A String",
"suspensionReason": "A String", # Suspension reason if user is suspended (Read-only)
"thumbnailPhotoUrl": "A String", # Photo Url of the user (Read-only)
"isEnrolledIn2Sv": True or False, # Is enrolled in 2-step verification (Read-only)
"isAdmin": True or False, # Boolean indicating if the user is admin (Read-only)
"relations": "",
"includeInGlobalAddressList": True or False, # Boolean indicating if user is included in Global Address List
"languages": "",
"ims": "",
"etag": "A String", # ETag of the resource.
"lastLoginTime": "A String", # User's last login time. (Read-only)
"orgUnitPath": "A String", # OrgUnit of User
"agreedToTerms": True or False, # Indicates if user has agreed to terms (Read-only)
"externalIds": "",
"ipWhitelisted": True or False, # Boolean indicating if ip is whitelisted
"sshPublicKeys": "",
"customSchemas": { # Custom fields of the user.
"a_key": { # JSON template for a set of custom properties (i.e. all fields in a particular schema)
"a_key": "",
},
},
"isEnforcedIn2Sv": True or False, # Is 2-step verification enforced (Read-only)
"isMailboxSetup": True or False, # Is mailbox setup (Read-only)
"primaryEmail": "A String", # username of User
"password": "A String", # User's password
"emails": "",
"organizations": "",
"kind": "admin#directory#user", # Kind of resource this is.
"hashFunction": "A String", # Hash function name for password. Supported are MD5, SHA-1 and crypt
"name": { # JSON template for name of a user in Directory API. # User's name
"givenName": "A String", # First Name
"fullName": "A String", # Full Name
"familyName": "A String", # Last Name
},
"gender": "",
"notes": "",
"creationTime": "A String", # User's G Suite account creation time. (Read-only)
"websites": "",
"changePasswordAtNextLogin": True or False, # Boolean indicating if the user should change password in next login
"customerId": "A String", # CustomerId of User (Read-only)
}</pre>
</div>
<div class="method">
<code class="details" id="undelete">undelete(userKey, body)</code>
<pre>Undelete a deleted user
Args:
userKey: string, The immutable id of the user (required)
body: object, The request body. (required)
The object takes the form of:
{ # JSON request template to undelete a user in Directory API.
"orgUnitPath": "A String", # OrgUnit of User
}
</pre>
</div>
<div class="method">
<code class="details" id="update">update(userKey, body)</code>
<pre>update user
Args:
userKey: string, Email or immutable ID of the user. If ID, it should match with id of user object (required)
body: object, The request body. (required)
The object takes the form of:
{ # JSON template for User object in Directory API.
"addresses": "",
"posixAccounts": "",
"phones": "",
"locations": "",
"isDelegatedAdmin": True or False, # Boolean indicating if the user is delegated admin (Read-only)
"thumbnailPhotoEtag": "A String", # ETag of the user's photo (Read-only)
"suspended": True or False, # Indicates if user is suspended.
"keywords": "",
"id": "A String", # Unique identifier of User (Read-only)
"aliases": [ # List of aliases (Read-only)
"A String",
],
"nonEditableAliases": [ # List of non editable aliases (Read-only)
"A String",
],
"archived": True or False, # Indicates if user is archived.
"deletionTime": "A String",
"suspensionReason": "A String", # Suspension reason if user is suspended (Read-only)
"thumbnailPhotoUrl": "A String", # Photo Url of the user (Read-only)
"isEnrolledIn2Sv": True or False, # Is enrolled in 2-step verification (Read-only)
"isAdmin": True or False, # Boolean indicating if the user is admin (Read-only)
"relations": "",
"includeInGlobalAddressList": True or False, # Boolean indicating if user is included in Global Address List
"languages": "",
"ims": "",
"etag": "A String", # ETag of the resource.
"lastLoginTime": "A String", # User's last login time. (Read-only)
"orgUnitPath": "A String", # OrgUnit of User
"agreedToTerms": True or False, # Indicates if user has agreed to terms (Read-only)
"externalIds": "",
"ipWhitelisted": True or False, # Boolean indicating if ip is whitelisted
"sshPublicKeys": "",
"customSchemas": { # Custom fields of the user.
"a_key": { # JSON template for a set of custom properties (i.e. all fields in a particular schema)
"a_key": "",
},
},
"isEnforcedIn2Sv": True or False, # Is 2-step verification enforced (Read-only)
"isMailboxSetup": True or False, # Is mailbox setup (Read-only)
"primaryEmail": "A String", # username of User
"password": "A String", # User's password
"emails": "",
"organizations": "",
"kind": "admin#directory#user", # Kind of resource this is.
"hashFunction": "A String", # Hash function name for password. Supported are MD5, SHA-1 and crypt
"name": { # JSON template for name of a user in Directory API. # User's name
"givenName": "A String", # First Name
"fullName": "A String", # Full Name
"familyName": "A String", # Last Name
},
"gender": "",
"notes": "",
"creationTime": "A String", # User's G Suite account creation time. (Read-only)
"websites": "",
"changePasswordAtNextLogin": True or False, # Boolean indicating if the user should change password in next login
"customerId": "A String", # CustomerId of User (Read-only)
}
Returns:
An object of the form:
{ # JSON template for User object in Directory API.
"addresses": "",
"posixAccounts": "",
"phones": "",
"locations": "",
"isDelegatedAdmin": True or False, # Boolean indicating if the user is delegated admin (Read-only)
"thumbnailPhotoEtag": "A String", # ETag of the user's photo (Read-only)
"suspended": True or False, # Indicates if user is suspended.
"keywords": "",
"id": "A String", # Unique identifier of User (Read-only)
"aliases": [ # List of aliases (Read-only)
"A String",
],
"nonEditableAliases": [ # List of non editable aliases (Read-only)
"A String",
],
"archived": True or False, # Indicates if user is archived.
"deletionTime": "A String",
"suspensionReason": "A String", # Suspension reason if user is suspended (Read-only)
"thumbnailPhotoUrl": "A String", # Photo Url of the user (Read-only)
"isEnrolledIn2Sv": True or False, # Is enrolled in 2-step verification (Read-only)
"isAdmin": True or False, # Boolean indicating if the user is admin (Read-only)
"relations": "",
"includeInGlobalAddressList": True or False, # Boolean indicating if user is included in Global Address List
"languages": "",
"ims": "",
"etag": "A String", # ETag of the resource.
"lastLoginTime": "A String", # User's last login time. (Read-only)
"orgUnitPath": "A String", # OrgUnit of User
"agreedToTerms": True or False, # Indicates if user has agreed to terms (Read-only)
"externalIds": "",
"ipWhitelisted": True or False, # Boolean indicating if ip is whitelisted
"sshPublicKeys": "",
"customSchemas": { # Custom fields of the user.
"a_key": { # JSON template for a set of custom properties (i.e. all fields in a particular schema)
"a_key": "",
},
},
"isEnforcedIn2Sv": True or False, # Is 2-step verification enforced (Read-only)
"isMailboxSetup": True or False, # Is mailbox setup (Read-only)
"primaryEmail": "A String", # username of User
"password": "A String", # User's password
"emails": "",
"organizations": "",
"kind": "admin#directory#user", # Kind of resource this is.
"hashFunction": "A String", # Hash function name for password. Supported are MD5, SHA-1 and crypt
"name": { # JSON template for name of a user in Directory API. # User's name
"givenName": "A String", # First Name
"fullName": "A String", # Full Name
"familyName": "A String", # Last Name
},
"gender": "",
"notes": "",
"creationTime": "A String", # User's G Suite account creation time. (Read-only)
"websites": "",
"changePasswordAtNextLogin": True or False, # Boolean indicating if the user should change password in next login
"customerId": "A String", # CustomerId of User (Read-only)
}</pre>
</div>
<div class="method">
<code class="details" id="watch">watch(body, orderBy=None, domain=None, projection=None, query=None, event=None, showDeleted=None, pageToken=None, sortOrder=None, maxResults=None, customer=None, customFieldMask=None, viewType=None)</code>
<pre>Watch for changes in users list
Args:
body: object, The request body. (required)
The object takes the form of:
{ # An notification channel used to watch for resource changes.
"resourceUri": "A String", # A version-specific identifier for the watched resource.
"kind": "api#channel", # Identifies this as a notification channel used to watch for changes to a resource. Value: the fixed string "api#channel".
"resourceId": "A String", # An opaque ID that identifies the resource being watched on this channel. Stable across different API versions.
"payload": True or False, # A Boolean value to indicate whether payload is wanted. Optional.
"token": "A String", # An arbitrary string delivered to the target address with each notification delivered over this channel. Optional.
"params": { # Additional parameters controlling delivery channel behavior. Optional.
"a_key": "A String", # Declares a new parameter by name.
},
"expiration": "A String", # Date and time of notification channel expiration, expressed as a Unix timestamp, in milliseconds. Optional.
"address": "A String", # The address where notifications are delivered for this channel.
"type": "A String", # The type of delivery mechanism used for this channel.
"id": "A String", # A UUID or similar unique string that identifies this channel.
}
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.
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.
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 mentioned in customFieldMask.
full - Include all fields associated with this user.
query: string, Query string search. Should be of the form "". Complete documentation is at https://developers.google.com/admin-sdk/directory/v1/guides/search-users
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
showDeleted: string, If set to true retrieves the list of deleted users. Default is false
pageToken: string, Token to specify next page in the list
sortOrder: string, Whether to return results in ascending or descending order.
Allowed values
ASCENDING - Ascending order.
DESCENDING - Descending order.
maxResults: integer, Maximum number of results to return. Default is 100. Max allowed is 500
customer: string, Immutable ID of the G Suite account. In case of multi-domain, to fetch all users for a customer, fill this field instead of domain.
customFieldMask: string, Comma-separated list of schema names. All fields from these schemas are fetched. This should only be set when projection=custom.
viewType: string, Whether to fetch the ADMIN_VIEW or DOMAIN_PUBLIC view of the user.
Allowed values
admin_view - Fetches the ADMIN_VIEW of the user.
domain_public - Fetches the DOMAIN_PUBLIC view of the user.
Returns:
An object of the form:
{ # An notification channel used to watch for resource changes.
"resourceUri": "A String", # A version-specific identifier for the watched resource.
"kind": "api#channel", # Identifies this as a notification channel used to watch for changes to a resource. Value: the fixed string "api#channel".
"resourceId": "A String", # An opaque ID that identifies the resource being watched on this channel. Stable across different API versions.
"payload": True or False, # A Boolean value to indicate whether payload is wanted. Optional.
"token": "A String", # An arbitrary string delivered to the target address with each notification delivered over this channel. Optional.
"params": { # Additional parameters controlling delivery channel behavior. Optional.
"a_key": "A String", # Declares a new parameter by name.
},
"expiration": "A String", # Date and time of notification channel expiration, expressed as a Unix timestamp, in milliseconds. Optional.
"address": "A String", # The address where notifications are delivered for this channel.
"type": "A String", # The type of delivery mechanism used for this channel.
"id": "A String", # A UUID or similar unique string that identifies this channel.
}</pre>
</div>
</body></html>
|
