-
Notifications
You must be signed in to change notification settings - Fork 5
/
openapi.yaml
1661 lines (1650 loc) · 55.8 KB
/
openapi.yaml
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
openapi: 3.0.3
info:
title: Visier User Management APIs
description: Visier APIs for managing users within an organization
version: 22222222.99201.1256
license:
name: Apache License, Version 2.0
url: https://www.apache.org/licenses/LICENSE-2.0
x-api-status-urls: false
x-konfig-ignore:
object-with-no-properties: true
servers:
- url: https://{vanity-name}.api.visier.io
variables:
vanity-name:
default: vanity
tags:
- description: |-
Use these APIs to manage users within an organization.
<br>**Tip**: Visier recommends that administrating tenant users focus primarily on managing users at the administrating
tenant level. These users likely belong directly to your organization, such as customer support, customer value
managers, account executives, and customer success. These users work with clients to manage their day-to-day
solution needs.
name: UserManagement
- description: |-
Use these APIs to manage users within an organization.
<br>**Note:** <em>These are version 2 of the User Management APIs and are released in **limited availability**.
If you are interested in using them, please contact your Customer Success Manager (CSM).</em>
<br>**Tip:** Visier recommends that administrating tenant users focus primarily on managing users at the administrating
tenant level. These users likely belong directly to your organization, such as customer support, customer value
managers, account executives, and customer success. These users work with clients to manage their day-to-day
solution needs.
name: UserManagementV2
paths:
/v1/admin/permissions/users:
put:
tags:
- UserManagement
summary: Assign permissions to users
operationId: UserManagement_AssignPermissions
description: >-
This API allows you to assign a permission to specific users.
Administrating tenant users can assign permissions
to users in the administrating tenant and in the analytic tenants those users belong to.
requestBody:
content:
application/json:
schema:
$ref: '#/components/schemas/AssignRevokePermissionsRequest'
required: true
responses:
'200':
description: OK
content:
application/json:
schema:
$ref: '#/components/schemas/AssignRevokePermissionsResponseDTO'
default:
description: Default error response
content:
application/json:
schema:
$ref: '#/components/schemas/Status'
delete:
tags:
- UserManagement
summary: Remove permissions from users
operationId: UserManagement_RemovePermissions
description: >-
This API allows you to remove a permission from specific users.
Administrating tenant users can remove permissions
from users in the administrating tenant and in the analytic tenants those users belong to.
requestBody:
content:
application/json:
schema:
$ref: '#/components/schemas/AssignRevokePermissionsRequest'
required: true
responses:
'200':
description: OK
content:
application/json:
schema:
$ref: '#/components/schemas/AssignRevokePermissionsResponseDTO'
default:
description: Default error response
content:
application/json:
schema:
$ref: '#/components/schemas/Status'
/v1/admin/permissions/{permissionId}/users:
get:
tags:
- UserManagement
summary: Retrieve users that are assigned a specific permission
operationId: UserManagement_GetPermissionAssignedUsers
description: >-
This API allows you to retrieve all the users that are assigned a
specified permission. You must know the ID
of the permission you want to retrieve users for.
parameters:
- description: >-
The unique identifier of the permission you want to retrieve users
for.
name: permissionId
in: path
required: true
schema:
type: string
- description: >-
If true, the response returns a list of all users that are assigned
the permission, including users that are
assigned the permission through a user group.
If false, the response returns a list of the users that are directly
assigned the permission.
name: includeUserGroups
in: query
schema:
type: boolean
- description: Specify the tenant to retrieve the list of users from.
name: tenantFilter
in: query
schema:
type: string
- description: >-
The number of results to return. The maximum number of tenants to
retrieve is 100.
name: limit
in: query
schema:
type: integer
format: int32
- description: >-
The index to start retrieving results from, also known as offset.
The index begins at 0.
name: start
in: query
schema:
type: integer
format: int32
responses:
'200':
description: OK
content:
application/json:
schema:
$ref: '#/components/schemas/PermissionAssignedUsersDTO'
default:
description: Default error response
content:
application/json:
schema:
$ref: '#/components/schemas/Status'
/v1/admin/user-groups:
get:
tags:
- UserManagement
summary: Retrieve a list of all user groups
operationId: UserManagement_GetAllUserGroups
description: >-
This API allows you to retrieve the full list of user groups in a
tenant.
parameters:
- description: Specify the tenant to retrieve the list of user groups from.
name: tenantCode
in: query
schema:
type: string
- description: >-
The number of results to return. The maximum number of users to
retrieve is 1000.
name: limit
in: query
schema:
type: integer
format: uint32
- description: The index to start retrieving results from, also known as offset.
name: start
in: query
schema:
type: integer
format: uint32
responses:
'200':
description: OK
content:
application/json:
schema:
$ref: '#/components/schemas/UserGroupsGetAPIResponseDTO'
default:
description: Default error response
content:
application/json:
schema:
$ref: '#/components/schemas/Status'
/v1/admin/user-groups/permissions:
put:
tags:
- UserManagement
summary: Assign permissions to user groups
operationId: UserManagement_AssignPermissionsToUserGroups
description: >-
This API allows you to assign a permission to specific user groups. This
assigns the permission to all users in the user group.
requestBody:
content:
application/json:
schema:
$ref: '#/components/schemas/PermissionsToUserGroupsRequestDTO'
required: true
responses:
'200':
description: OK
content:
application/json:
schema:
$ref: '#/components/schemas/PermissionsToUserGroupForTenantDTO'
default:
description: Default error response
content:
application/json:
schema:
$ref: '#/components/schemas/Status'
delete:
tags:
- UserManagement
summary: Remove permissions from user groups
operationId: UserManagement_RevokePermissionsFromUserGroups
description: This API allows you to remove a permission from specific user groups.
requestBody:
content:
application/json:
schema:
$ref: '#/components/schemas/PermissionsToUserGroupsRequestDTO'
required: true
responses:
'200':
description: OK
content:
application/json:
schema:
$ref: '#/components/schemas/PermissionsToUserGroupForTenantDTO'
default:
description: Default error response
content:
application/json:
schema:
$ref: '#/components/schemas/Status'
/v1/admin/user-groups/users:
put:
tags:
- UserManagement
summary: Assign users to user groups
operationId: UserManagement_AddUsersToUserGroup
description: This API allows you to assign users to specific user groups.
requestBody:
content:
application/json:
schema:
$ref: '#/components/schemas/UsersToUserGroupsRequestDTO'
required: true
responses:
'200':
description: OK
content:
application/json:
schema:
$ref: '#/components/schemas/SecurityAssignmentResponseDTO'
default:
description: Default error response
content:
application/json:
schema:
$ref: '#/components/schemas/Status'
delete:
tags:
- UserManagement
summary: Remove users from user groups
operationId: UserManagement_RemoveUsersFromUserGroup
description: This API allows you to remove users from specific user groups.
requestBody:
content:
application/json:
schema:
$ref: '#/components/schemas/UsersToUserGroupsRequestDTO'
required: true
responses:
'200':
description: OK
content:
application/json:
schema:
$ref: '#/components/schemas/SecurityAssignmentResponseDTO'
default:
description: Default error response
content:
application/json:
schema:
$ref: '#/components/schemas/Status'
/v1/admin/user-groups/{userGroupId}/users:
get:
tags:
- UserManagement
summary: Retrieve a list of user group users
operationId: UserManagement_GetUserGroupUsers
description: >-
This API allows you to retrieve the list of users explicitly assigned to
a user group. Users that are implicitly
included in the user group through the user group's dynamic filters are not returned by this endpoint.
parameters:
- description: The ID of user group.
name: userGroupId
in: path
required: true
schema:
type: string
- description: Specifies the tenant to retrieve the list of users from.
name: tenantFilter
in: query
schema:
type: string
- description: >-
The number of results to return. The maximum number of tenants to
retrieve is 100.
name: limit
in: query
schema:
type: integer
format: uint32
- description: >-
The index to start retrieving results from, also known as offset.
The index begins at 0.
name: start
in: query
schema:
type: integer
format: uint32
responses:
'200':
description: OK
content:
application/json:
schema:
$ref: '#/components/schemas/UserGroupsUsersDTO'
default:
description: Default error response
content:
application/json:
schema:
$ref: '#/components/schemas/Status'
/v1/admin/users:
get:
tags:
- UserManagement
summary: Retrieve a list of all users
operationId: UserManagement_GetAllUsers
description: >-
This API allows you to retrieve the full list of users and their current
states.
parameters:
- description: Specify the tenant to retrieve a list of users from.
name: tenantCode
in: query
schema:
type: string
- description: >-
If true, the response returns a list of the user's assigned
profiles.
name: assignedProfiles
in: query
schema:
type: boolean
- description: If true, the response returns the user's assigned permissions.
name: assignedPermissions
in: query
schema:
type: boolean
- description: If true, the response returns the user's assigned user groups.
name: assignedUserGroups
in: query
schema:
type: boolean
- description: >-
The number of results to return. The maximum number of users to
retrieve is 1000.
name: limit
in: query
schema:
type: integer
format: uint32
- description: >-
The index to start retrieving results from, also known as offset.
The index begins at 0.
name: start
in: query
schema:
type: integer
format: uint32
responses:
'200':
description: OK
content:
application/json:
schema:
$ref: '#/components/schemas/AllUsersGetAPIResponseDTO'
default:
description: Default error response
content:
application/json:
schema:
$ref: '#/components/schemas/Status'
post:
tags:
- UserManagement
summary: Add a user
operationId: UserManagement_AddUser
description: >-
This API allows you to create a new user. Administrating tenant users
can specify the tenant in which to add a user.
parameters:
- description: Specify the tenant to create a user in.
name: tenantCode
in: query
schema:
type: string
requestBody:
content:
application/json:
schema:
$ref: '#/components/schemas/UserCreationAPIRequestDTO'
required: true
responses:
'200':
description: OK
content:
application/json:
schema:
$ref: '#/components/schemas/UserCreationAPIResponseDTO'
default:
description: Default error response
content:
application/json:
schema:
$ref: '#/components/schemas/Status'
/v1/admin/users/{userId}:
get:
tags:
- UserManagement
summary: Retrieve a user's details
operationId: UserManagement_GetUserDetail
description: This API allows you to retrieve all details for a specified user.
parameters:
- description: The ID of the user you want to retrieve.
name: userId
in: path
required: true
schema:
type: string
- description: Specify the tenant to retrieve a user from.
name: tenantCode
in: query
schema:
type: string
- description: >-
If true, the response returns a list of the user's assigned
profiles.
name: assignedProfiles
in: query
schema:
type: boolean
- description: If true, the response returns the user's assigned permissions.
name: assignedPermissions
in: query
schema:
type: boolean
- description: If true, the response returns the user's assigned user groups.
name: assignedUserGroups
in: query
schema:
type: boolean
responses:
'200':
description: OK
content:
application/json:
schema:
$ref: '#/components/schemas/UserGetAPIResponseDTO'
default:
description: Default error response
content:
application/json:
schema:
$ref: '#/components/schemas/Status'
put:
tags:
- UserManagement
summary: Update a user
operationId: UserManagement_UpdateUser
description: >-
This API allows you to update an existing user's information, such as
their display name or if the user is enabled in Visier.
parameters:
- description: The ID of the user you want to update.
name: userId
in: path
required: true
schema:
type: string
- description: Specify the tenant to update a user in.
name: tenantCode
in: query
schema:
type: string
requestBody:
content:
application/json:
schema:
$ref: '#/components/schemas/UserUpdateAPIRequestDTO'
required: true
responses:
'200':
description: OK
content:
application/json:
schema:
$ref: '#/components/schemas/UserUpdateAPIRequestDTO'
default:
description: Default error response
content:
application/json:
schema:
$ref: '#/components/schemas/Status'
delete:
tags:
- UserManagement
summary: Delete a user
operationId: UserManagement_DeleteUser
description: >-
This API allows you to delete an existing user. Administrating tenant
users can specify the tenant from which to delete a user.
parameters:
- description: The ID of the user you want to delete.
name: userId
in: path
required: true
schema:
type: string
- description: Specify the tenant to delete a user in.
name: tenantCode
in: query
schema:
type: string
responses:
'200':
description: OK
content:
application/json:
schema:
$ref: '#/components/schemas/DeleteUserResponse'
default:
description: Default error response
content:
application/json:
schema:
$ref: '#/components/schemas/Status'
/v2/admin/users:
put:
tags:
- UserManagementV2
summary: Update users
operationId: UserManagementV2_UpdateUsers
description: >-
This API allows you to update an existing user's information, such as
their display name or if the user is enabled in Visier.
<br>**Note:** <em>This API is in **limited availability**. If you are interested in using it, please contact your Customer Success Manager (CSM).</em>
parameters:
- description: Specify the tenant to update a user in.
name: tenantCode
in: query
schema:
type: string
requestBody:
content:
application/json:
schema:
$ref: '#/components/schemas/UsersUpdateAPIRequestDTO'
required: true
responses:
'200':
description: OK
content:
application/json:
schema:
$ref: '#/components/schemas/UsersAPIResponseDTO'
default:
description: Default error response
content:
application/json:
schema:
$ref: '#/components/schemas/Status'
post:
tags:
- UserManagementV2
summary: Add users
operationId: UserManagementV2_AddUsers
description: >-
This API allows you to create new users. Administrating tenant users can
specify the tenant in which to add these users.
<br>**Note:** <em>This API is in **limited availability**. If you are interested in using it, please contact your Customer Success Manager (CSM).</em>
parameters:
- description: Specify the tenant to create a user in.
name: tenantCode
in: query
schema:
type: string
requestBody:
content:
application/json:
schema:
$ref: '#/components/schemas/UsersCreationAPIRequestDTO'
required: true
responses:
'200':
description: OK
content:
application/json:
schema:
$ref: '#/components/schemas/UsersAPIResponseDTO'
default:
description: Default error response
content:
application/json:
schema:
$ref: '#/components/schemas/Status'
delete:
tags:
- UserManagementV2
summary: Delete users
operationId: UserManagementV2_DeleteUsers
description: >-
This API allows you to delete an existing user. Administrating tenant
users can specify the tenant from which to delete a user.
<br>**Note:** <em>This API is in **limited availability**. If you are interested in using it, please contact your Customer Success Manager (CSM).</em>
parameters:
- description: Specify the tenant to delete a user in.
name: tenantCode
in: query
schema:
type: string
requestBody:
content:
application/json:
schema:
$ref: '#/components/schemas/UsersDeleteAPIRequestDTO'
required: true
responses:
'200':
description: OK
content:
application/json:
schema:
$ref: '#/components/schemas/UsersAPIResponseDTO'
default:
description: Default error response
content:
application/json:
schema:
$ref: '#/components/schemas/Status'
/v1/admin/users/reports/application-logs:
get:
tags:
- UserManagement
summary: Retrieve the Application Logs
operationId: UserManagement_GetApplicationLogsXLSX
description: >-
This API allows you to export the Application Logs for a tenant. The
Application Logs track information about your
users and how they are using the application. Performing regular audits will help you identify potential security
issues and keep your data safe. As part of user management, download the Application Logs to monitor user activity
and logon events to ensure your users are performing authorized activities.
Administrating tenant users can export application logs for the administrating tenant and the analytic tenants
those users belong to.
parameters:
- description: An inclusive date-time to start retrieving Application Logs from.
name: startTime
in: query
schema:
type: string
- description: An exclusive date-time to stop retrieving Application Logs from.
name: endTime
in: query
schema:
type: string
- description: Specify the tenant to retrieve Application Logs from.
name: tenantCode
in: query
schema:
type: string
responses:
'200':
description: An XLSX file.
content:
application/vnd.ms-excel:
schema:
$ref: >-
#/components/schemas/UserManagementGetApplicationLogsXlsxResponse
default:
description: Default error response
content:
application/json:
schema:
$ref: '#/components/schemas/Status'
/v1/admin/users/{userId}/reports/data-security:
get:
tags:
- UserManagement
summary: Retrieve the Data Security Report
operationId: UserManagement_GetDataSecurityReportXLSX
description: >-
This API allows you to export the data security report of a user. The
Data Security Report provides information
about a specific user to see which populations and properties that user has access to as a result of the
permissions assigned to them.
Administrating tenant users can export the report for users in the administrating tenant and the analytic
tenants those users belong to.
parameters:
- description: The ID of the user to retrieve the report for.
name: userId
in: path
required: true
schema:
type: string
- description: Specify the tenant to retrieve the Data Security Report from.
name: tenantCode
in: query
schema:
type: string
responses:
'200':
description: An XLSX file.
content:
application/vnd.ms-excel:
schema:
$ref: >-
#/components/schemas/UserManagementGetDataSecurityReportXlsxResponse
default:
description: Default error response
content:
application/json:
schema:
$ref: '#/components/schemas/Status'
/v1/admin/users/reports/profile-assignments:
get:
tags:
- UserManagement
summary: Retrieve user profile assignments in XLSX format
operationId: UserManagement_GetProfileAssignmentsXLSX
description: >-
This API allows you to export the profiles assigned to each user. This
report details the profiles assigned to
each user and the profile validity period.
Administrating tenant users can export profile assignments for the administrating tenant and the analytic tenants
those users belong to.
parameters:
- description: Specify the tenant to retrieve profile assignments from.
name: tenantCode
in: query
schema:
type: string
responses:
'200':
description: An XLSX file.
content:
application/vnd.ms-excel:
schema:
$ref: >-
#/components/schemas/UserManagementGetProfileAssignmentsXlsxResponse
default:
description: Default error response
content:
application/json:
schema:
$ref: '#/components/schemas/Status'
/v1/admin/users/reports/permission-assignments:
get:
tags:
- UserManagement
summary: Retrieve user permissions in XLSX format
operationId: UserManagement_GetUserPermissionsXLSX
description: >-
This API allows you to export the user permission assignments for a
tenant. The permission assignments report
provides a summary of the permissions your users have been assigned and how each permission is being used across
your user base, as well as the users that do not have any permissions assigned to them.
Administrating tenant users can export permission assignments for the administrating tenant and the analytic
tenants those users belong to.
parameters:
- description: >-
Specify the tenant to retrieve the permission assignments report
from.
name: tenantCode
in: query
schema:
type: string
responses:
'200':
description: An XLSX file.
content:
application/vnd.ms-excel:
schema:
$ref: >-
#/components/schemas/UserManagementGetUserPermissionsXlsxResponse
default:
description: Default error response
content:
application/json:
schema:
$ref: '#/components/schemas/Status'
/v1/admin/users/reports/permissions-list:
get:
tags:
- UserManagement
summary: Retrieve a list of all permissions in XLSX format
operationId: UserManagement_GetAllPermissionsXLSX
description: >-
This API allows you to export the list of permissions in a tenant. This
report includes the permission name,
permission description, and permission ID for all permissions in the tenant.
Administrating tenant users can export permissions lists for the administrating tenant and the analytic tenants
those users belong to.
parameters:
- description: Specify the tenant to retrieve permissions from.
name: tenantCode
in: query
schema:
type: string
responses:
'200':
description: An XLSX file.
content:
application/vnd.ms-excel:
schema:
$ref: >-
#/components/schemas/UserManagementGetAllPermissionsXlsxResponse
default:
description: Default error response
content:
application/json:
schema:
$ref: '#/components/schemas/Status'
components:
schemas:
AdditionalCapabilitiesDTO:
type: object
properties:
additionalCapabilities:
description: The additional capabilities assigned to this profile.
type: array
items:
type: string
AllPermissionsAssignedForLocalTenantDTO:
type: object
properties:
assignedPermissions:
description: A list of objects representing the user's permissions.
type: array
items:
$ref: '#/components/schemas/PermissionAssignedForLocalTenantDTO'
AllProfileAssignedForLocalTenantDTO:
type: object
properties:
assignedProfiles:
description: >-
A list of objects representing the user profiles assigned to the
user and their validity range.
type: array
items:
$ref: '#/components/schemas/ProfileAssignedForLocalTenantDTO'
AllUserGroupsAssignedForLocalTenantDTO:
type: object
properties:
assignedUserGroups:
description: A list of objects representing the available user groups.
type: array
items:
$ref: '#/components/schemas/UserGroupAssignedForLocalTenantDTO'
AllUsersGetAPIResponseDTO:
type: object
properties:
users:
description: A list of available users.
type: array
items:
$ref: '#/components/schemas/UserGetAPIResponseDTO'
limit:
description: >-
The number of results to return. The maximum number of users to
retrieve is 1000.
type: integer
format: uint32
start:
description: >-
The index to start retrieving results from, also known as offset.
The index begins at 0.
type: integer
format: uint32
AssignRevokePermissionByPermissionDTO:
description: The results of the permission assignment or removal.
type: object
properties:
permission:
$ref: '#/components/schemas/PermissionAssignedForLocalTenantDTO'
users:
description: >-
A list of objects representing the users that was permission was
assigned to or removed from.
type: array
items:
$ref: '#/components/schemas/AssignRevokePermissionByUserDTO'
AssignRevokePermissionByTenantDTO:
description: The permissions organized by tenant.
type: object
properties:
tenantCode:
description: The unique identifier associated with the tenant.
type: string
permissions:
description: A list of objects representing the assigned or removed permissions.
type: array
items:
$ref: '#/components/schemas/AssignRevokePermissionByPermissionDTO'
status:
description: >-
The state of the permission assignment. Valid values are Succeed or
Failed.
enum:
- Unknown
- Succeed
- Failed
type: string
format: enum
message:
description: A detailed description of the request outcome, if available.
type: string
AssignRevokePermissionByUserDTO:
description: The results of the permission assignment or removal by user.
type: object
properties:
userId:
description: The unique identifier associated with the user.
type: string
username:
description: >-
The user's username. This is typically the user's email, such as
john@visier.com.
type: string
message:
description: A meaningful message about the user permission.
type: string
AssignRevokePermissionsRequest:
type: object
properties:
permissions:
description: >-
A list of objects representing the permissions to assign to or
remove from users.
type: array
items:
$ref: '#/components/schemas/Permission'
AssignRevokePermissionsResponseDTO:
description: The results of the permission assignment or removal.
type: object
properties:
tenants:
description: >-
A list of objects representing the users that were assigned
permissions, organized by the tenants the users belong to.
type: array
items:
$ref: '#/components/schemas/AssignRevokePermissionByTenantDTO'
CapabilitiesDTO:
type: object
properties:
capability:
description: The name of the capability.
type: string
accessLevel:
description: The access level of the profile for the given capability.