forked from docusign/OpenAPI-Specifications
-
Notifications
You must be signed in to change notification settings - Fork 0
/
admin.rest.swagger-v2.1.json
8389 lines (8389 loc) · 359 KB
/
admin.rest.swagger-v2.1.json
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
{
"swagger": "2.0",
"info": {
"version": "v2.1",
"title": "Docusign Admin API",
"description": "An API for an organization administrator to manage organizations, accounts and users",
"contact": {
"name": "Docusign Developer Center",
"url": "https://developers.docusign.com",
"email": "[email protected]"
},
"termsOfService": "https://www.docusign.com/company/terms-and-conditions/developers"
},
"host": "api.docusign.net",
"basePath": "/Management",
"schemes": [
"https"
],
"consumes": [
"application/json"
],
"produces": [
"application/json"
],
"externalDocs": {
"description": "See the Docusign Admin API Guide for more information.",
"url": "https://developers.docusign.com/docs/admin-api/reference"
},
"paths": {
"/v2/organizations": {
"get": {
"tags": [
"Organization"
],
"summary": "Returns a list of organizations that the authenticated user belongs to.",
"description": "Returns a list of organizations that the authenticated user belongs to.\n\nNote that the Docusign Admin API only returns JSON, not XML.\n\n[Required authentication scopes](/docs/admin-api/admin101/auth/): `organization_read`.\n\nThis method requires user authentication. It will fail with an [application access token](/docs/admin-api/admin101/application-auth/).",
"operationId": "Organization_Organization_GetListV2",
"produces": [
"application/json"
],
"parameters": [
{
"name": "mode",
"in": "query",
"description": "Specifies how to select the organizations. Valid values:\n\n- `org_admin`: Returns organizations for which the authenticated user is an admin.\n- `account_membership`: Returns organizations that contain an account of which the authenticated user is a member\n\nDefault value: `org_admin`",
"required": false,
"type": "string"
}
],
"responses": {
"200": {
"description": "OK",
"schema": {
"$ref": "#/definitions/OrganizationsResponse"
}
}
},
"security": [
{
"accessCode": [
"organization_read"
]
}
],
"x-ds-methodname": "getOrganizations",
"x-ds-method": "getOrganizations",
"x-ds-service": "Accounts",
"x-ds-in-sdk": true
}
},
"/v2/data_redaction/accounts/{accountId}/user": {
"post": {
"tags": [
"DataDeletion"
],
"summary": "Deletes membership data for a user on an account.",
"description": "Deletes the data for a single account membership for a specified user.\n\nTo call this endpoint: \n* You must be an administrator (or delegated administrator) of the specified account.\n* The user must have been closed for at least 24 hours.\n\n**Note:** After a user's data is deleted for every account to which they belong, their user-level data will automatically be deleted.\n\n[Required authentication scopes](/docs/admin-api/admin101/auth/): `user_data_redact`.\n\n### Related topics\n\n- [How to delete user data from an account as an account admin](/docs/admin-api/how-to/account-admin-delete-user-data/)\n",
"operationId": "DataRedaction_RedactIndividualMembershipData",
"consumes": [
"application/json"
],
"produces": [
"application/json"
],
"parameters": [
{
"name": "accountId",
"in": "path",
"description": "The ID of the account from which to delete the user's data.\n",
"required": true,
"type": "string",
"format": "uuid"
},
{
"name": "requestModel",
"in": "body",
"description": "",
"required": true,
"schema": {
"$ref": "#/definitions/IndividualMembershipDataRedactionRequest"
}
}
],
"responses": {
"200": {
"description": "OK",
"schema": {
"$ref": "#/definitions/IndividualUserDataRedactionResponse"
}
}
},
"security": [
{
"accessCode": [
"user_data_redact"
]
}
],
"x-ds-methodname": "redactIndividualMembershipData",
"x-ds-method": "redactIndividualMembershipData",
"x-ds-service": "Accounts",
"x-ds-in-sdk": true
}
},
"/v2/organizations/{organizationId}/accounts/{accountId}/permissions": {
"get": {
"tags": [
"eSignUserManagement"
],
"summary": "Returns the list of permission profiles in an account.",
"description": "Returns the list of permission profiles in an account.\n\n[Required authentication scopes](/docs/admin-api/admin101/auth/): `permission_read`.\n\n\n### Related topics\n\n- [How to create a new active eSignature user](/docs/admin-api/how-to/create-active-user/)\n",
"operationId": "Account_Accounts_GetPermissionProfilesV2",
"produces": [
"application/json"
],
"parameters": [
{
"name": "organizationId",
"in": "path",
"description": "The organization ID Guid",
"required": true,
"type": "string",
"format": "uuid"
},
{
"name": "accountId",
"in": "path",
"description": "The account ID Guid",
"required": true,
"type": "string",
"format": "uuid"
}
],
"responses": {
"200": {
"description": "OK",
"schema": {
"$ref": "#/definitions/PermissionsResponse"
}
}
},
"security": [
{
"accessCode": [
"permission_read"
]
}
],
"x-ds-methodname": "getPermissions",
"x-ds-method": "getPermissions",
"x-ds-service": "Accounts",
"x-ds-in-sdk": true
}
},
"/v2/organizations/{organizationId}/accounts/{accountId}/groups": {
"get": {
"tags": [
"eSignUserManagement"
],
"summary": "Returns the list of groups in an account.",
"description": "Returns the list of groups in an account.\n\n[Required authentication scopes](/docs/admin-api/admin101/auth/): `group_read`.\n\n\n\n### Related topics\n\n- [How to create a new active eSignature user](/docs/admin-api/how-to/create-active-user/)",
"operationId": "Account_Accounts_GetGroupsV2",
"produces": [
"application/json"
],
"parameters": [
{
"name": "organizationId",
"in": "path",
"description": "The organization ID Guid",
"required": true,
"type": "string",
"format": "uuid"
},
{
"name": "accountId",
"in": "path",
"description": "The account ID Guid",
"required": true,
"type": "string",
"format": "uuid"
},
{
"name": "start",
"in": "query",
"description": "Index of first item to include in the response. The default value is 0.",
"required": false,
"type": "integer",
"format": "int32"
},
{
"name": "take",
"in": "query",
"description": "Page size of the response. The default value is 20.",
"required": false,
"type": "integer",
"format": "int32"
},
{
"name": "end",
"in": "query",
"description": "Index of the last item to include in the response. Ignored if `take` parameter is specified.",
"required": false,
"type": "integer",
"format": "int32"
}
],
"responses": {
"200": {
"description": "OK",
"schema": {
"$ref": "#/definitions/MemberGroupsResponse"
}
}
},
"security": [
{
"accessCode": [
"group_read"
]
}
],
"x-ds-methodname": "getGroups",
"x-ds-method": "getGroups",
"x-ds-service": "Accounts",
"x-ds-in-sdk": true
}
},
"/v2/organizations/{organizationId}/exports/user_list": {
"get": {
"tags": [
"UserExport"
],
"summary": "Returns a list of pending and completed export requests.",
"description": "Returns a list of pending and completed export requests.\n\n[Required authentication scopes](/docs/admin-api/admin101/auth/): `user_read`.\n",
"operationId": "OrganizationExport_OrganizationExport_Get",
"produces": [
"application/json"
],
"parameters": [
{
"name": "organizationId",
"in": "path",
"description": "The organization ID Guid",
"required": true,
"type": "string",
"format": "uuid"
}
],
"responses": {
"200": {
"description": "OK",
"schema": {
"$ref": "#/definitions/OrganizationExportsResponse"
}
}
},
"security": [
{
"accessCode": [
"user_read"
]
}
],
"x-ds-methodname": "getUserListExports",
"x-ds-method": "getUserListExports",
"x-ds-service": "BulkExports",
"x-ds-in-sdk": true
},
"post": {
"tags": [
"UserExport"
],
"summary": "Creates a user list export request.",
"description": "Create a user list export request.\n\nThis method initiates a user list export request. You specify the type of export request as JSON in the body of method, like this:\n\n``` json\n{\n\t\"type\": \"organization_memberships_export\"\n}\n```\n\nThe export request type is one of three values:\n\n| Value | Description |\n| :----------------------------------------- | :------------------------------------------------------------------------------------------------------ |\n| `organization_memberships_export` | Every user in every account in the organization. Users in multiple accounts will appear more than once. |\n| `organization_domain_users_export` | All users of the reserved domains. |\n| `organization_external_memberships_export` | Users whose email address domain is *not* linked to the organization. |\n\n[Required authentication scopes](/docs/admin-api/admin101/auth/): `user_read`.\n\n### Next steps\n* See [how this endpoint is used to bulk export user data](/docs/admin-api/how-to/bulk-export-users/).",
"operationId": "OrganizationExport_OrganizationExport_Insert",
"consumes": [
"application/json"
],
"produces": [
"application/json"
],
"parameters": [
{
"name": "organizationId",
"in": "path",
"description": "The organization ID Guid",
"required": true,
"type": "string",
"format": "uuid"
},
{
"name": "request",
"in": "body",
"description": "",
"required": true,
"schema": {
"$ref": "#/definitions/OrganizationExportRequest"
}
}
],
"responses": {
"200": {
"description": "OK",
"schema": {
"$ref": "#/definitions/OrganizationExportResponse"
}
}
},
"security": [
{
"accessCode": [
"user_read"
]
}
],
"x-ds-methodname": "createUserListExport",
"x-ds-method": "createUserListExport",
"x-ds-service": "BulkExports",
"x-ds-in-sdk": true
}
},
"/v2/organizations/{organizationId}/exports/account_settings": {
"get": {
"tags": [
"AccountSettingsExport"
],
"summary": "Returns a list of pending and completed account settings export request.",
"description": "Returns a list of pending and completed account settings export requests.\n\n[Required authentication scopes](/docs/admin-api/admin101/auth/): `account_read`.",
"operationId": "OrganizationExport_OrganizationExport_GetAccountCompare",
"produces": [
"application/json"
],
"parameters": [
{
"name": "organizationId",
"in": "path",
"description": "The organization ID Guid",
"required": true,
"type": "string",
"format": "uuid"
}
],
"responses": {
"200": {
"description": "OK",
"schema": {
"$ref": "#/definitions/OrganizationExportsResponse"
}
}
},
"security": [
{
"accessCode": [
"account_read"
]
}
],
"x-ds-methodname": "getAccountSettingsExports",
"x-ds-method": "getAccountSettingsExports",
"x-ds-service": "BulkExports",
"x-ds-in-sdk": true
},
"post": {
"tags": [
"AccountSettingsExport"
],
"summary": "Creates a new account settings export request.",
"description": "Creates a new account settings export request.\n\nTo learn more about exporting account settings,\nsee [Account Settings Export][guide-export]\nin the Docusign Admin Guide.\n\nYou can export settings for up to 40 accounts at a time.\n\nSpecify the accounts whose settings you are requesting as JSON in the body of the request, like this:\n\n``` json\n{\n \"accounts\":\t[\n \t{ \"account_id\": \"9ca037f4-xxxx-xxxx-xxxx-212e57d4f22e\"},\n \t{ \"account_id\": \"624e3e00-xxxx-xxxx-xxxx-43918c520dab\"}\n\n ]\n}\n```\n\n[Required authentication scopes](/docs/admin-api/admin101/auth/): `account_write`.\n\n### Related topics\n\n- [Account Settings import][guide-import] guide\n- [Account Settings Export][guide-export] guide\n\n\n[guide-import]: https://support.docusign.com/s/document-item?bundleId=rrf1583359212854&topicId=nwl1583359167434.html\n[guide-export]: https://support.docusign.com/s/document-item?bundleId=rrf1583359212854&topicId=kfj1583359164049.html",
"operationId": "OrganizationExport_OrganizationExport_AccountCompare",
"consumes": [
"application/json"
],
"produces": [
"application/json"
],
"parameters": [
{
"name": "organizationId",
"in": "path",
"description": "The organization ID Guid",
"required": true,
"type": "string",
"format": "uuid"
},
{
"name": "request",
"in": "body",
"description": "",
"required": true,
"schema": {
"$ref": "#/definitions/OrganizationAccountsRequest"
}
}
],
"responses": {
"200": {
"description": "OK",
"schema": {
"$ref": "#/definitions/OrganizationExportResponse"
}
}
},
"security": [
{
"accessCode": [
"account_read"
]
}
],
"x-ds-methodname": "createAccountSettingsExport",
"x-ds-method": "createAccountSettingsExport",
"x-ds-service": "BulkExports",
"x-ds-in-sdk": true
}
},
"/v2/organizations/{organizationId}/exports/user_list/{exportId}": {
"get": {
"tags": [
"UserExport"
],
"summary": "Returns the results for single user list export request.",
"description": "Returns the results for single user list export request.\n\nGiven an export ID, this method returns the results of a single user list export request.\nTo get a list of all the export requests, use `getUserListExports`.\n\nNote that the `metadata_url` property of the response from `createUserListExport` is a read-to-use HTTP GET request to get the status.\n\nThe results are available through a URL that\nyou can access through the `results` property of the response.\nFor example, to get the URL of the first result you might use\n`results[0].url`\n\n[Required authentication scopes](/docs/admin-api/admin101/auth/): `user_read`.\n\n### Next steps\n* See [how this endpoint is used to bulk export user data](/docs/admin-api/how-to/bulk-export-users/).",
"operationId": "OrganizationExport_OrganizationExport_GetByExportId",
"produces": [
"application/json"
],
"parameters": [
{
"name": "organizationId",
"in": "path",
"description": "The organization ID Guid",
"required": true,
"type": "string",
"format": "uuid"
},
{
"name": "exportId",
"in": "path",
"description": "The export ID GUID for the request.",
"required": true,
"type": "string",
"format": "uuid"
}
],
"responses": {
"200": {
"description": "OK",
"schema": {
"$ref": "#/definitions/OrganizationExportResponse"
}
}
},
"security": [
{
"accessCode": [
"user_read"
]
}
],
"x-ds-methodname": "getUserListExport",
"x-ds-method": "getUserListExport",
"x-ds-service": "BulkExports",
"x-ds-in-sdk": true
},
"delete": {
"tags": [
"UserExport"
],
"summary": "Deletes a single user list export request.",
"description": "Deletes a single user list export request.\nUse this method to delete pending or completed user export requests.\n\n[Required authentication scopes](/docs/admin-api/admin101/auth/): `user_read`.\n\n",
"operationId": "OrganizationExport_OrganizationExport_DeleteByExportId",
"produces": [
"application/json"
],
"parameters": [
{
"name": "organizationId",
"in": "path",
"description": "The organization ID Guid",
"required": true,
"type": "string",
"format": "uuid"
},
{
"name": "exportId",
"in": "path",
"description": "The export ID GUID for the request.",
"required": true,
"type": "string",
"format": "uuid"
}
],
"responses": {
"200": {
"description": "OK",
"schema": {
"type": "object"
}
}
},
"security": [
{
"accessCode": [
"user_read"
]
}
],
"x-ds-methodname": "deleteUserListExport",
"x-ds-method": "deleteUserListExport",
"x-ds-service": "BulkExports",
"x-ds-in-sdk": true
}
},
"/v2/organizations/{organizationId}/exports/account_settings/{exportId}": {
"get": {
"tags": [
"AccountSettingsExport"
],
"summary": "Returns the results for a single account settings export request.",
"description": "Returns the results for a single account settings export request.\n\nGiven an export ID, this method returns the results of an account settings export request.\nTo get a list of all the export requests, use `getAccountSettingsExports`.\n\nThe results are available through a URL that\nyou can access through the `results` property of the response.\nFor example, to get the URL of first result you might use\n`results[0].url`\n\nThe settings export is formatted like this:\n\n``` json\n{\n \"accounts\": [\n {\n \"account_id\": \"9ca037f4-xxxx-xxxx-xxxx-212e57d4f22e\",\n \"name\": \"The Happy Company\",\n . . .\n },\n {\n \"account_id\": \"624e3e00-xxxx-xxxx-xxxx-43918c520dab\",\n \"name\": \"LoanCo\",\n . . .\n }\n ],\n \"settings\": [\n . . .\n {\n \"category\": \"Signing\",\n \"name\": \"SignerCanSignOnMobile\",\n \"account_values\": [\n {\n \"account_id\": \"9ca037f4-xxxx-xxxx-xxxx-212e57d4f22e\",\n \"value\": \"true\",\n \"rights\": \"editable\"\n },\n {\n \"account_id\": \"624e3e00-xxxx-xxxx-xxxx-43918c520dab\",\n \"value\": \"true\",\n \"rights\": \"editable\"\n }\n ]\n },\n . . .\n ]\n}\n\n```\n\n[Required authentication scopes](/docs/admin-api/admin101/auth/): `account_read`.",
"operationId": "OrganizationExport_OrganizationExport_GetAccountSettingsExportByExportId",
"produces": [
"application/json"
],
"parameters": [
{
"name": "organizationId",
"in": "path",
"description": "The organization ID Guid",
"required": true,
"type": "string",
"format": "uuid"
},
{
"name": "exportId",
"in": "path",
"description": "The export ID GUID for the request.",
"required": true,
"type": "string",
"format": "uuid"
}
],
"responses": {
"200": {
"description": "OK",
"schema": {
"$ref": "#/definitions/OrganizationExportResponse"
}
}
},
"security": [
{
"accessCode": [
"account_read"
]
}
],
"x-ds-methodname": "getAccountSettingsExport",
"x-ds-method": "getAccountSettingsExport",
"x-ds-service": "BulkExports",
"x-ds-in-sdk": true
},
"delete": {
"tags": [
"AccountSettingsExport"
],
"summary": "Deletes a single account settings export request.",
"description": "Deletes a single account settings export request.\nAny data associated with the request is also deleted.\n\n[Required authentication scopes](/docs/admin-api/admin101/auth/): `account_read`.\n",
"operationId": "OrganizationExport_OrganizationExport_DeleteByAccountSettingsExportId",
"produces": [
"application/json"
],
"parameters": [
{
"name": "organizationId",
"in": "path",
"description": "The organization ID Guid",
"required": true,
"type": "string",
"format": "uuid"
},
{
"name": "exportId",
"in": "path",
"description": "The export ID GUID for the request.",
"required": true,
"type": "string",
"format": "uuid"
}
],
"responses": {
"200": {
"description": "OK",
"schema": {
"type": "object"
}
}
},
"security": [
{
"accessCode": [
"account_read"
]
}
],
"x-ds-methodname": "deleteAccountSettingsExport",
"x-ds-method": "deleteAccountSettingsExport",
"x-ds-service": "BulkExports",
"x-ds-in-sdk": true
}
},
"/v2/organizations/{organizationId}/imports/account_settings": {
"get": {
"tags": [
"AccountSettingsImport"
],
"summary": "Returns the details and metadata for Bulk Account Settings Import requests in the organization.",
"description": "Returns the details and metadata for Bulk Account Settings Import requests in the organization.\n\n[Required authentication scopes](/docs/admin-api/admin101/auth/): `account_read`.",
"operationId": "OrganizationImport_OrganizationImportAccountSettings_Get",
"consumes": [
"application/json"
],
"produces": [
"application/json"
],
"parameters": [
{
"name": "organizationId",
"in": "path",
"description": "The organization ID Guid",
"required": true,
"type": "string",
"format": "uuid"
}
],
"responses": {
"200": {
"description": "OK",
"schema": {
"type": "array",
"items": {
"$ref": "#/definitions/OrganizationAccountSettingsImportResponse"
}
}
}
},
"security": [
{
"accessCode": [
"account_read"
]
}
],
"x-ds-methodname": "getBulkAccountSettingsImports",
"x-ds-method": "getBulkAccountSettingsImports",
"x-ds-service": "BulkImports",
"x-ds-in-sdk": true
},
"post": {
"tags": [
"AccountSettingsImport"
],
"summary": "Creates a new account settings import request.",
"description": "Creates a new account settings import request.\n\nThe request for this method consists of\nthe contents of a CSV\nfile.\n\nYou can export your current settings as a CSV file with\n[AccountSettingsExport: createAccountSettingsExport](/docs/admin-api/reference/bulkoperations/accountsettingsexport/createaccountsettingsexport/)\nand use it as the basis\nof the changes you want to import.\n\n\nTo learn more about the format\nof a settings CSV file, see\n[Preparing a CSV for account settings import][guide-import]\nin the Docusign Admin Guide.\n\nYou can import settings for up to 40 accounts at a time.\n\n[Required authentication scopes](/docs/admin-api/admin101/auth/): `account_write`.\n\n### Related topics\n\n- [Account Settings import][guide-import] guide\n- [Account Settings Export][guide-export] guide\n\n[guide-import]: https://support.docusign.com/s/document-item?bundleId=rrf1583359212854&topicId=nwl1583359167434.html\n[guide-export]: https://support.docusign.com/s/document-item?bundleId=rrf1583359212854&topicId=kfj1583359164049.html\n",
"operationId": "OrganizationImport_OrganizationImportAccountSettings_Post",
"consumes": [
"multipart/form-data"
],
"produces": [
"application/json"
],
"parameters": [
{
"name": "organizationId",
"in": "path",
"description": "The organization ID GUID.",
"required": true,
"type": "string",
"format": "uuid"
},
{
"name": "file.csv",
"in": "formData",
"description": "CSV file.",
"required": true,
"type": "file"
}
],
"responses": {
"200": {
"description": "OK",
"schema": {
"$ref": "#/definitions/OrganizationAccountSettingsImportResponse"
}
}
},
"security": [
{
"accessCode": [
"account_write"
]
}
],
"x-ds-methodname": "addBulkAccountSettingsImport",
"x-ds-method": "addBulkAccountSettingsImport",
"x-ds-service": "BulkImports",
"x-ds-in-sdk": true
}
},
"/v2/organizations/{organizationId}/imports/account_settings/{importId}": {
"get": {
"tags": [
"AccountSettingsImport"
],
"summary": "Returns the details/metadata for a Bulk Account Settings Import request.",
"description": "Returns the details/metadata for a Bulk Account Settings Import request.\n\nGiven an import ID, this method returns the results of an account settings import request.\nTo get a list of all the import requests, use `getAccountSettingsImports`.\n\n[Required authentication scopes](/docs/admin-api/admin101/auth/): `account_read`.\n",
"operationId": "OrganizationImport_OrganizationImportAccountSettings_GetById",
"consumes": [
"application/json"
],
"produces": [
"application/json"
],
"parameters": [
{
"name": "organizationId",
"in": "path",
"description": "The organization ID Guid",
"required": true,
"type": "string",
"format": "uuid"
},
{
"name": "importId",
"in": "path",
"description": "The import ID GUID for the request.",
"required": true,
"type": "string",
"format": "uuid"
}
],
"responses": {
"200": {
"description": "OK",
"schema": {
"$ref": "#/definitions/OrganizationAccountSettingsImportResponse"
}
}
},
"security": [
{
"accessCode": [
"account_read"
]
}
],
"x-ds-methodname": "getBulkAccountSettingsImport",
"x-ds-method": "getBulkAccountSettingsImport",
"x-ds-service": "BulkImports",
"x-ds-in-sdk": true
},
"delete": {
"tags": [
"AccountSettingsImport"
],
"summary": "Deletes a Bulk Account Settings Import request.",
"description": "Deletes a single account settings import request.\nAny data associated with the request is also deleted.\n\n[Required authentication scopes](/docs/admin-api/admin101/auth/): `account_write`.",
"operationId": "OrganizationImport_OrganizationImportAccountSettings_DeleteById",
"consumes": [
"application/json"
],
"produces": [
"application/json"
],
"parameters": [
{
"name": "organizationId",
"in": "path",
"description": "The organization ID Guid",
"required": true,
"type": "string",
"format": "uuid"
},
{
"name": "importId",
"in": "path",
"description": "The import ID GUID for the request.",
"required": true,
"type": "string",
"format": "uuid"
}
],
"responses": {
"200": {
"description": "OK",
"schema": {
"type": "object"
}
}
},
"security": [
{
"accessCode": [
"account_write"
]
}
],
"x-ds-methodname": "deleteBulkAccountSettingsImport",
"x-ds-method": "deleteBulkAccountSettingsImport",
"x-ds-service": "BulkImports",
"x-ds-in-sdk": true
}
},
"/v2/organizations/{organizationId}/imports/bulk_users/add": {
"post": {
"tags": [
"UserImport"
],
"summary": "Creates a request to import new users into an account.",
"description": "Creates a request to import new users.\n\nYour CSV import file is made up of a header row with the column headers and a row of user or account data for each user you want to add to an account. Only new users can be imported. Any changes to existing users will be ignored. To make changes to existing users, use [UserImport:updateBulkUserImports](/docs/admin-api/reference/bulkoperations/userimport/updatebulkuserimports/).\n\nTo ensure your CSV file is properly formatted, follow the requirements in the Support article [Build a CSV to Bulk Add Users](https://support.docusign.com/s/document-item?bundleId=rrf1583359212854&topicId=wec1593211169952.html). You can download an example file from the Add Users dialogue in the Admin UI.\n\nYou can add up to 2,000 users to an account and include up to 50 accounts per import. The maximum number of users per import is 8,000.\n\n[Required authentication scopes](/docs/admin-api/admin101/auth/): `user_write`.\n\n### Next steps\n* See an [example of adding users via bulk import in your chosen programming language](/docs/admin-api/how-to/add-users-bulk-import/).\n",
"operationId": "OrganizationImport_OrganizationImportUsers_Insert",
"consumes": [
"multipart/form-data"
],
"produces": [
"application/json"
],
"parameters": [
{
"name": "organizationId",
"in": "path",
"description": "The organization ID Guid",
"required": true,
"type": "string",
"format": "uuid"
},
{
"name": "file.csv",
"in": "formData",
"description": "CSV file.",
"required": true,
"type": "file"
}
],
"responses": {
"200": {
"description": "OK",
"schema": {
"$ref": "#/definitions/OrganizationImportResponse"
}
}
},
"security": [
{
"accessCode": [
"user_write"
]
}
],
"x-ds-methodname": "addBulkUserImport",
"x-ds-method": "addBulkUserImport",
"x-ds-service": "BulkImports",
"x-ds-in-sdk": true
}
},
"/v2/organizations/{organizationId}/accounts/{accountId}/imports/bulk_users/add": {
"post": {
"tags": [
"SingleAccountUserImport"
],
"summary": "Import request for adding a user to a single account within the organization.",
"description": "Import request for adding a user to a single account within the organization.\nThis method lets you upload user information without requiring an AccountId column.\n\n[Required authentication scopes](/docs/admin-api/admin101/auth/): `user_write`.\n",
"operationId": "OrganizationImport_OrganizationImportSingleAccountUsers_Insert",
"consumes": [
"multipart/form-data"
],
"produces": [
"application/json"
],
"parameters": [
{
"name": "organizationId",
"in": "path",
"description": "The organization ID Guid",
"required": true,
"type": "string",
"format": "uuid"
},
{
"name": "accountId",
"in": "path",
"description": "The account ID Guid",
"required": true,
"type": "string",
"format": "uuid"
},
{
"name": "file.csv",
"in": "formData",
"description": "CSV file.",
"required": true,
"type": "file"
}
],
"responses": {
"200": {
"description": "OK",
"schema": {
"$ref": "#/definitions/OrganizationImportResponse"
}
}
},
"security": [
{
"accessCode": [
"user_write"
]
}
],
"x-ds-methodname": "createBulkImportSingleAccountAddUsersRequest",
"x-ds-method": "createBulkImportSingleAccountAddUsersRequest",
"x-ds-service": "BulkImports",
"x-ds-in-sdk": true
}
},
"/v2/organizations/{organizationId}/imports/bulk_users/update": {
"post": {
"tags": [
"UserImport"
],
"summary": "Bulk updates information for existing users.",
"description": "Bulk updates information for existing users.\n\nYour CSV import file is made up of a header row with the column headers and a row of user or account data for each user you want to add to an account. \n\n\n**Update limit:** You can update up to 2,000 users on an account and include up to 50 accounts per import. The maximum number of updated users per import is 8,000.\n\nThis method requires the following HTTP headers:\n\n| Header | Value |\n| :--- | :--- |\n| Content-Type | `text/csv` |\n| Content-Disposition | `filename=filename.csv` |\n\n\n\nTo ensure your CSV is properly formatted, use the\n[Sample Bulk Update CSV file](https://admin.docusign.com/static-resources/organization-user-update-import.csv)\n as a template. The following table describes the columns.\n\nNote that the columns for bulk adding users and bulk update users are slightly different.\nThe update CSV file requires an `APIUserName` column, and does not have an `AutoActivate` column.\n\n\n\n| Column | Required | Description |\n| :------------------ | :------- | :------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------ |\n| AccountID | yes | The 32-character API account ID of the user's account in your organization. You can find this value in the API and Keys section of the Admin area of the account. |\n| AccountName | | The name of the user's account in your organization. The account name must match the account ID provided. |\n| FirstName | yes | The user's first name. |\n| LastName | yes | The user's last name. |\n| UserEmail | yes | The user's complete email address. |\n| PermissionSet | yes | The user's permission set. The PermissionSet value must match an existing permission set for the account. This value is not case sensitive. |\n| UserTitle | | The user's job title. |\n| CompanyName | | The user's company name. |\n| Group | | The user's assigned groups. The Group values must match existing Group names for the account. Additional Group columns can be added to the file to add users to more than one group. You do not need to add users to the Everyone group, since all new users are automatically added to that group. |\n| AddressLine1 | | The user's address, first line. |\n| AddressLine2 | | The user's address, second line. |\n| City | | The user's city name. |\n| StateRegionProvince | | The user's regional location. |\n| PostalCode | | The user's postal code. |\n| Phone | | The user's phone number. |\n| Language | | The user's display language for their Docusign account. Must be one of: <ul><li>Chinese Simplified: <code>zh_CN</code></li><li>Chinese Traditional: <code>zh_TW</code></li><li>Dutch: <code>nl</code></li><li>English: <code>en</code></li><li>French: <code>fr</code></li><li>German: <code>de</code></li><li>Italian: <code>it</code></li><li>Japanese: <code>ja</code></li><li>Korean: <code>ko</code></li><li>Portuguese: <code>pt</code></li><li>Portuguese Brazil: <code>pt_BR</code></li><li>Russian: <code>ru</code></li><li>Spanish: <code>es</code></li></ul> |\n| LoginPolicy | | The user's login policy. Valid values include the following: <ul> <li>Column left blank = The user is created with no policy assigned.</li> <li>FedAuthRequired = The user must log in with an Identity Provider.</li> <li>FedAuthBypass = The user may log in with an Identity Provider or their Docusign username and password.</li> </ul> For more information on login policies, see [Setting User Login Policy](https://support.docusign.com/s/document-item?bundleId=rrf1583359212854&topicId=zah1583359147774.html). |\n| AutoActivate | | For domain users, new users can be activated automatically for domain accounts using SSO by setting the value to **true.** The user is activated automatically once the import is complete. Memberships activated in this way do not receive an activation email. |\n\n\n\n## Updating user email addresses\n\nChanging a user's email address should be done carefully. The user's email address is used to log in to Docusign and receive documents to sign from others.\nOnce changed, existing documents that were sent or received:\n\n- Will still appear in the user's documents list.\n- Notifications about these documents will be sent to the new email address. If someone sends a new document to the old email address:\n- Docusign will send a notification to the old address.\n- It will not appear in the documents list of the account.\n\nThis change of email address will be applied to all of the user's account memberships.\n\n[Required authentication scopes](/docs/admin-api/admin101/auth/): `user_write`.",
"operationId": "OrganizationImport_OrganizationImportUsers_Update",
"consumes": [
"multipart/form-data"
],
"produces": [
"application/json"
],
"parameters": [
{
"name": "organizationId",
"in": "path",
"description": "The organization ID Guid",
"required": true,
"type": "string",
"format": "uuid"
},
{
"name": "file.csv",
"in": "formData",
"description": "CSV file.",
"required": true,
"type": "file"
}
],
"responses": {
"200": {
"description": "OK",
"schema": {
"$ref": "#/definitions/OrganizationImportResponse"
}
}
},
"security": [
{
"accessCode": [
"user_write"
]
}
],
"x-ds-methodname": "updateBulkUserImports",
"x-ds-method": "updateBulkUserImports",
"x-ds-service": "BulkImports",
"x-ds-in-sdk": true
}
},
"/v2/organizations/{organizationId}/accounts/{accountId}/imports/bulk_users/update": {
"post": {