@cosmotech/api-ts 0.1.14 → 2.0.4

This diff represents the content of publicly available package versions that have been released to one of the supported registries. The information contained in this diff is provided for informational purposes only and reflects changes between package versions as they appear in their respective public registries.
package/dist/api.d.ts CHANGED
@@ -2,7 +2,7 @@
2
2
  * Cosmo Tech Plaform API
3
3
  * Cosmo Tech Platform API
4
4
  *
5
- * The version of the OpenAPI document: 0.0.13-SNAPSHOT
5
+ * The version of the OpenAPI document: 2.0.4-dev
6
6
  * Contact: platform@cosmotech.com
7
7
  *
8
8
  * NOTE: This class is auto generated by OpenAPI Generator (https://openapi-generator.tech).
@@ -12,6 +12,27 @@
12
12
  import { Configuration } from './configuration';
13
13
  import { AxiosPromise, AxiosInstance, AxiosRequestConfig } from 'axios';
14
14
  import { RequestArgs, BaseAPI } from './base';
15
+ /**
16
+ * a RBAC by component
17
+ * @export
18
+ * @interface ComponentRolePermissions
19
+ */
20
+ export interface ComponentRolePermissions {
21
+ /**
22
+ *
23
+ * @type {string}
24
+ * @memberof ComponentRolePermissions
25
+ */
26
+ 'component'?: string;
27
+ /**
28
+ *
29
+ * @type {{ [key: string]: Array<string>; }}
30
+ * @memberof ComponentRolePermissions
31
+ */
32
+ 'roles'?: {
33
+ [key: string]: Array<string>;
34
+ };
35
+ }
15
36
  /**
16
37
  * a version of a Connector
17
38
  * @export
@@ -355,16 +376,54 @@ export interface Organization {
355
376
  'ownerId'?: string;
356
377
  /**
357
378
  *
358
- * @type {Array<OrganizationUser>}
379
+ * @type {OrganizationServices}
359
380
  * @memberof Organization
360
381
  */
361
- 'users'?: Array<OrganizationUser>;
382
+ 'services'?: OrganizationServices;
362
383
  /**
363
384
  *
364
- * @type {OrganizationServices}
385
+ * @type {OrganizationSecurity}
365
386
  * @memberof Organization
366
387
  */
367
- 'services'?: OrganizationServices;
388
+ 'security'?: OrganizationSecurity;
389
+ }
390
+ /**
391
+ * a Organization access control item
392
+ * @export
393
+ * @interface OrganizationAccessControl
394
+ */
395
+ export interface OrganizationAccessControl {
396
+ /**
397
+ * the identity id
398
+ * @type {string}
399
+ * @memberof OrganizationAccessControl
400
+ */
401
+ 'id': string;
402
+ /**
403
+ * a role
404
+ * @type {string}
405
+ * @memberof OrganizationAccessControl
406
+ */
407
+ 'role': string;
408
+ }
409
+ /**
410
+ * the Organization security information
411
+ * @export
412
+ * @interface OrganizationSecurity
413
+ */
414
+ export interface OrganizationSecurity {
415
+ /**
416
+ * the role by default
417
+ * @type {string}
418
+ * @memberof OrganizationSecurity
419
+ */
420
+ 'default': string;
421
+ /**
422
+ * the list which can access this Organization with detailed access control information
423
+ * @type {Array<OrganizationAccessControl>}
424
+ * @memberof OrganizationSecurity
425
+ */
426
+ 'accessControlList': Array<OrganizationAccessControl>;
368
427
  }
369
428
  /**
370
429
  * a cloud service resource
@@ -432,38 +491,6 @@ export interface OrganizationServices {
432
491
  */
433
492
  'solutionsContainerRegistry'?: OrganizationService;
434
493
  }
435
- /**
436
- * a User
437
- * @export
438
- * @interface OrganizationUser
439
- */
440
- export interface OrganizationUser {
441
- /**
442
- * the User unique identifier, in response
443
- * @type {string}
444
- * @memberof OrganizationUser
445
- */
446
- 'id'?: string;
447
- /**
448
- * the User name
449
- * @type {string}
450
- * @memberof OrganizationUser
451
- */
452
- 'name'?: string;
453
- /**
454
- * the User\'s roles for the Organization
455
- * @type {Array<string>}
456
- * @memberof OrganizationUser
457
- */
458
- 'roles': Array<OrganizationUserRolesEnum>;
459
- }
460
- export declare const OrganizationUserRolesEnum: {
461
- readonly Admin: "Admin";
462
- readonly User: "User";
463
- readonly Viewer: "Viewer";
464
- readonly Developer: "Developer";
465
- };
466
- export declare type OrganizationUserRolesEnum = typeof OrganizationUserRolesEnum[keyof typeof OrganizationUserRolesEnum];
467
494
  /**
468
495
  * a Solution Run Template
469
496
  * @export
@@ -481,7 +508,7 @@ export interface RunTemplate {
481
508
  * @type {string}
482
509
  * @memberof RunTemplate
483
510
  */
484
- 'name': string;
511
+ 'name'?: string;
485
512
  /**
486
513
  * the Run Template description
487
514
  * @type {string}
@@ -644,6 +671,12 @@ export interface RunTemplate {
644
671
  * @memberof RunTemplate
645
672
  */
646
673
  'runTemplateSourceDir'?: string;
674
+ /**
675
+ * an optional duration in seconds in which a workflow is allowed to run
676
+ * @type {number}
677
+ * @memberof RunTemplate
678
+ */
679
+ 'executionTimeout'?: number;
647
680
  }
648
681
  /**
649
682
  * the Run Template step handler identifier
@@ -676,7 +709,7 @@ export interface RunTemplateParameter {
676
709
  * @type {{ [key: string]: string; }}
677
710
  * @memberof RunTemplateParameter
678
711
  */
679
- 'labels': {
712
+ 'labels'?: {
680
713
  [key: string]: string;
681
714
  };
682
715
  /**
@@ -684,7 +717,7 @@ export interface RunTemplateParameter {
684
717
  * @type {string}
685
718
  * @memberof RunTemplateParameter
686
719
  */
687
- 'varType': string;
720
+ 'varType'?: string;
688
721
  /**
689
722
  * the default value for this parameter
690
723
  * @type {string}
@@ -735,7 +768,7 @@ export interface RunTemplateParameterGroup {
735
768
  * @type {{ [key: string]: string; }}
736
769
  * @memberof RunTemplateParameterGroup
737
770
  */
738
- 'labels': {
771
+ 'labels'?: {
739
772
  [key: string]: string;
740
773
  };
741
774
  /**
@@ -763,7 +796,7 @@ export interface RunTemplateParameterGroup {
763
796
  * @type {Array<string>}
764
797
  * @memberof RunTemplateParameterGroup
765
798
  */
766
- 'parameters': Array<string>;
799
+ 'parameters'?: Array<string>;
767
800
  }
768
801
  /**
769
802
  * the value of Analysis parameter for a Scenario for this ScenarioRun
@@ -868,12 +901,6 @@ export interface Scenario {
868
901
  * @memberof Scenario
869
902
  */
870
903
  'workspaceId'?: string;
871
- /**
872
- * the list of users Id with their role
873
- * @type {Array<ScenarioUser>}
874
- * @memberof Scenario
875
- */
876
- 'users'?: Array<ScenarioUser>;
877
904
  /**
878
905
  *
879
906
  * @type {ScenarioJobState}
@@ -946,6 +973,31 @@ export interface Scenario {
946
973
  * @memberof Scenario
947
974
  */
948
975
  'validationStatus'?: ScenarioValidationStatus;
976
+ /**
977
+ *
978
+ * @type {ScenarioSecurity}
979
+ * @memberof Scenario
980
+ */
981
+ 'security'?: ScenarioSecurity;
982
+ }
983
+ /**
984
+ * a Scenario access control item
985
+ * @export
986
+ * @interface ScenarioAccessControl
987
+ */
988
+ export interface ScenarioAccessControl {
989
+ /**
990
+ * the identity id
991
+ * @type {string}
992
+ * @memberof ScenarioAccessControl
993
+ */
994
+ 'id': string;
995
+ /**
996
+ * a role
997
+ * @type {string}
998
+ * @memberof ScenarioAccessControl
999
+ */
1000
+ 'role': string;
949
1001
  }
950
1002
  /**
951
1003
  * the difference between the values of a parameter
@@ -1660,35 +1712,24 @@ export interface ScenarioRunTemplateParameterValue {
1660
1712
  'isInherited'?: boolean;
1661
1713
  }
1662
1714
  /**
1663
- * a Scenario user with roles
1715
+ * the Scenario security information
1664
1716
  * @export
1665
- * @interface ScenarioUser
1717
+ * @interface ScenarioSecurity
1666
1718
  */
1667
- export interface ScenarioUser {
1668
- /**
1669
- * the User id
1670
- * @type {string}
1671
- * @memberof ScenarioUser
1672
- */
1673
- 'id': string;
1719
+ export interface ScenarioSecurity {
1674
1720
  /**
1675
- * the User name
1721
+ * the role by default
1676
1722
  * @type {string}
1677
- * @memberof ScenarioUser
1723
+ * @memberof ScenarioSecurity
1678
1724
  */
1679
- 'name'?: string;
1725
+ 'default': string;
1680
1726
  /**
1681
- * the User role
1682
- * @type {Array<string>}
1683
- * @memberof ScenarioUser
1727
+ * the list which can access this Scenario with detailed access control information
1728
+ * @type {Array<ScenarioAccessControl>}
1729
+ * @memberof ScenarioSecurity
1684
1730
  */
1685
- 'roles': Array<ScenarioUserRolesEnum>;
1731
+ 'accessControlList': Array<ScenarioAccessControl>;
1686
1732
  }
1687
- export declare const ScenarioUserRolesEnum: {
1688
- readonly Viewer: "Viewer";
1689
- readonly Editor: "Editor";
1690
- };
1691
- export declare type ScenarioUserRolesEnum = typeof ScenarioUserRolesEnum[keyof typeof ScenarioUserRolesEnum];
1692
1733
  /**
1693
1734
  * the validation status of the scenario
1694
1735
  * @export
@@ -1718,13 +1759,13 @@ export interface Solution {
1718
1759
  * @type {string}
1719
1760
  * @memberof Solution
1720
1761
  */
1721
- 'key': string;
1762
+ 'key'?: string;
1722
1763
  /**
1723
1764
  * the Solution name
1724
1765
  * @type {string}
1725
1766
  * @memberof Solution
1726
1767
  */
1727
- 'name': string;
1768
+ 'name'?: string;
1728
1769
  /**
1729
1770
  * the Solution description
1730
1771
  * @type {string}
@@ -1736,7 +1777,7 @@ export interface Solution {
1736
1777
  * @type {string}
1737
1778
  * @memberof Solution
1738
1779
  */
1739
- 'repository': string;
1780
+ 'repository'?: string;
1740
1781
  /**
1741
1782
  * the main Cosmo Tech simulator name used in standard Run Template
1742
1783
  * @type {string}
@@ -1748,7 +1789,7 @@ export interface Solution {
1748
1789
  * @type {string}
1749
1790
  * @memberof Solution
1750
1791
  */
1751
- 'version': string;
1792
+ 'version'?: string;
1752
1793
  /**
1753
1794
  * the User id which own this Solution
1754
1795
  * @type {string}
@@ -1790,7 +1831,7 @@ export interface Solution {
1790
1831
  * @type {Array<RunTemplate>}
1791
1832
  * @memberof Solution
1792
1833
  */
1793
- 'runTemplates': Array<RunTemplate>;
1834
+ 'runTemplates'?: Array<RunTemplate>;
1794
1835
  }
1795
1836
  /**
1796
1837
  * a User
@@ -2055,12 +2096,6 @@ export interface Workspace {
2055
2096
  * @memberof Workspace
2056
2097
  */
2057
2098
  'solution': WorkspaceSolution;
2058
- /**
2059
- * the list of users Id with their role
2060
- * @type {Array<WorkspaceUser>}
2061
- * @memberof Workspace
2062
- */
2063
- 'users'?: Array<WorkspaceUser>;
2064
2099
  /**
2065
2100
  *
2066
2101
  * @type {WorkspaceWebApp}
@@ -2079,6 +2114,37 @@ export interface Workspace {
2079
2114
  * @memberof Workspace
2080
2115
  */
2081
2116
  'useDedicatedEventHubNamespace'?: boolean;
2117
+ /**
2118
+ * Set this property to false to not send scenario metada to Azure Event Hub Namespace for this Workspace. The Event Hub Namespace must be named \\\'<organization_id\\>-<workspace_id\\>\\\' (in lower case). This Namespace must also contain two Event Hubs named \\\'scenariometadata\\\' and \\\'scenariorunmetadata\\\'.
2119
+ * @type {boolean}
2120
+ * @memberof Workspace
2121
+ */
2122
+ 'sendScenarioMetadataToEventHub'?: boolean;
2123
+ /**
2124
+ *
2125
+ * @type {WorkspaceSecurity}
2126
+ * @memberof Workspace
2127
+ */
2128
+ 'security'?: WorkspaceSecurity;
2129
+ }
2130
+ /**
2131
+ * a Workspace access control item
2132
+ * @export
2133
+ * @interface WorkspaceAccessControl
2134
+ */
2135
+ export interface WorkspaceAccessControl {
2136
+ /**
2137
+ * the identity id
2138
+ * @type {string}
2139
+ * @memberof WorkspaceAccessControl
2140
+ */
2141
+ 'id': string;
2142
+ /**
2143
+ * a role
2144
+ * @type {string}
2145
+ * @memberof WorkspaceAccessControl
2146
+ */
2147
+ 'role': string;
2082
2148
  }
2083
2149
  /**
2084
2150
  * a Workspace File resource
@@ -2093,6 +2159,25 @@ export interface WorkspaceFile {
2093
2159
  */
2094
2160
  'fileName'?: string;
2095
2161
  }
2162
+ /**
2163
+ * the workspace security information
2164
+ * @export
2165
+ * @interface WorkspaceSecurity
2166
+ */
2167
+ export interface WorkspaceSecurity {
2168
+ /**
2169
+ * the role by default
2170
+ * @type {string}
2171
+ * @memberof WorkspaceSecurity
2172
+ */
2173
+ 'default': string;
2174
+ /**
2175
+ * the list which can access this Workspace with detailed access control information
2176
+ * @type {Array<WorkspaceAccessControl>}
2177
+ * @memberof WorkspaceSecurity
2178
+ */
2179
+ 'accessControlList': Array<WorkspaceAccessControl>;
2180
+ }
2096
2181
  /**
2097
2182
  * the Workspace Solution configuration
2098
2183
  * @export
@@ -2120,37 +2205,6 @@ export interface WorkspaceSolution {
2120
2205
  [key: string]: object;
2121
2206
  };
2122
2207
  }
2123
- /**
2124
- * a Workspace user with roles
2125
- * @export
2126
- * @interface WorkspaceUser
2127
- */
2128
- export interface WorkspaceUser {
2129
- /**
2130
- * the User id
2131
- * @type {string}
2132
- * @memberof WorkspaceUser
2133
- */
2134
- 'id': string;
2135
- /**
2136
- * the User name
2137
- * @type {string}
2138
- * @memberof WorkspaceUser
2139
- */
2140
- 'name'?: string;
2141
- /**
2142
- * the User roles
2143
- * @type {Array<string>}
2144
- * @memberof WorkspaceUser
2145
- */
2146
- 'roles': Array<WorkspaceUserRolesEnum>;
2147
- }
2148
- export declare const WorkspaceUserRolesEnum: {
2149
- readonly Admin: "Admin";
2150
- readonly User: "User";
2151
- readonly Viewer: "Viewer";
2152
- };
2153
- export declare type WorkspaceUserRolesEnum = typeof WorkspaceUserRolesEnum[keyof typeof WorkspaceUserRolesEnum];
2154
2208
  /**
2155
2209
  * a Workspace Web Application
2156
2210
  * @export
@@ -2704,13 +2758,13 @@ export declare class DatasetApi extends BaseAPI {
2704
2758
  export declare const OrganizationApiAxiosParamCreator: (configuration?: Configuration) => {
2705
2759
  /**
2706
2760
  *
2707
- * @summary Add (or replace) users in the Organization specified
2761
+ * @summary add a control acccess to the Organization
2708
2762
  * @param {string} organizationId the Organization identifier
2709
- * @param {Array<OrganizationUser>} organizationUser the Users to add. Any User with the same ID is overwritten
2763
+ * @param {OrganizationAccessControl} organizationAccessControl the new Organization security access to add.
2710
2764
  * @param {*} [options] Override http request option.
2711
2765
  * @throws {RequiredError}
2712
2766
  */
2713
- addOrReplaceUsersInOrganization: (organizationId: string, organizationUser: Array<OrganizationUser>, options?: AxiosRequestConfig) => Promise<RequestArgs>;
2767
+ addOrganizationAccessControl: (organizationId: string, organizationAccessControl: OrganizationAccessControl, options?: AxiosRequestConfig) => Promise<RequestArgs>;
2714
2768
  /**
2715
2769
  *
2716
2770
  * @summary List all Organizations
@@ -2726,6 +2780,47 @@ export declare const OrganizationApiAxiosParamCreator: (configuration?: Configur
2726
2780
  * @throws {RequiredError}
2727
2781
  */
2728
2782
  findOrganizationById: (organizationId: string, options?: AxiosRequestConfig) => Promise<RequestArgs>;
2783
+ /**
2784
+ *
2785
+ * @summary Get all permissions per components
2786
+ * @param {*} [options] Override http request option.
2787
+ * @throws {RequiredError}
2788
+ */
2789
+ getAllPermissions: (options?: AxiosRequestConfig) => Promise<RequestArgs>;
2790
+ /**
2791
+ *
2792
+ * @summary get a control acccess for the Organization
2793
+ * @param {string} organizationId the Organization identifier
2794
+ * @param {string} identityId the User identifier
2795
+ * @param {*} [options] Override http request option.
2796
+ * @throws {RequiredError}
2797
+ */
2798
+ getOrganizationAccessControl: (organizationId: string, identityId: string, options?: AxiosRequestConfig) => Promise<RequestArgs>;
2799
+ /**
2800
+ *
2801
+ * @summary Get the Organization permissions by given role
2802
+ * @param {string} organizationId the Organization identifier
2803
+ * @param {string} role the Role
2804
+ * @param {*} [options] Override http request option.
2805
+ * @throws {RequiredError}
2806
+ */
2807
+ getOrganizationPermissions: (organizationId: string, role: string, options?: AxiosRequestConfig) => Promise<RequestArgs>;
2808
+ /**
2809
+ *
2810
+ * @summary Get the Organization security information
2811
+ * @param {string} organizationId the Organization identifier
2812
+ * @param {*} [options] Override http request option.
2813
+ * @throws {RequiredError}
2814
+ */
2815
+ getOrganizationSecurity: (organizationId: string, options?: AxiosRequestConfig) => Promise<RequestArgs>;
2816
+ /**
2817
+ *
2818
+ * @summary Get the Organization security users list
2819
+ * @param {string} organizationId the Organization identifier
2820
+ * @param {*} [options] Override http request option.
2821
+ * @throws {RequiredError}
2822
+ */
2823
+ getOrganizationSecurityUsers: (organizationId: string, options?: AxiosRequestConfig) => Promise<RequestArgs>;
2729
2824
  /**
2730
2825
  *
2731
2826
  * @summary Register a new organization
@@ -2736,21 +2831,22 @@ export declare const OrganizationApiAxiosParamCreator: (configuration?: Configur
2736
2831
  registerOrganization: (organization: Organization, options?: AxiosRequestConfig) => Promise<RequestArgs>;
2737
2832
  /**
2738
2833
  *
2739
- * @summary Remove all users from the Organization specified
2834
+ * @summary Remove the specified access from the given Organization
2740
2835
  * @param {string} organizationId the Organization identifier
2836
+ * @param {string} identityId the User identifier
2741
2837
  * @param {*} [options] Override http request option.
2742
2838
  * @throws {RequiredError}
2743
2839
  */
2744
- removeAllUsersInOrganization: (organizationId: string, options?: AxiosRequestConfig) => Promise<RequestArgs>;
2840
+ removeOrganizationAccessControl: (organizationId: string, identityId: string, options?: AxiosRequestConfig) => Promise<RequestArgs>;
2745
2841
  /**
2746
2842
  *
2747
- * @summary Remove the specified user from the given Organization
2843
+ * @summary set the Organization default security
2748
2844
  * @param {string} organizationId the Organization identifier
2749
- * @param {string} userId the User identifier
2845
+ * @param {string} body the new Organization default security.
2750
2846
  * @param {*} [options] Override http request option.
2751
2847
  * @throws {RequiredError}
2752
2848
  */
2753
- removeUserFromOrganization: (organizationId: string, userId: string, options?: AxiosRequestConfig) => Promise<RequestArgs>;
2849
+ setOrganizationDefaultSecurity: (organizationId: string, body: string, options?: AxiosRequestConfig) => Promise<RequestArgs>;
2754
2850
  /**
2755
2851
  *
2756
2852
  * @summary Unregister an organization
@@ -2805,13 +2901,13 @@ export declare const OrganizationApiAxiosParamCreator: (configuration?: Configur
2805
2901
  export declare const OrganizationApiFp: (configuration?: Configuration) => {
2806
2902
  /**
2807
2903
  *
2808
- * @summary Add (or replace) users in the Organization specified
2904
+ * @summary add a control acccess to the Organization
2809
2905
  * @param {string} organizationId the Organization identifier
2810
- * @param {Array<OrganizationUser>} organizationUser the Users to add. Any User with the same ID is overwritten
2906
+ * @param {OrganizationAccessControl} organizationAccessControl the new Organization security access to add.
2811
2907
  * @param {*} [options] Override http request option.
2812
2908
  * @throws {RequiredError}
2813
2909
  */
2814
- addOrReplaceUsersInOrganization(organizationId: string, organizationUser: Array<OrganizationUser>, options?: AxiosRequestConfig): Promise<(axios?: AxiosInstance, basePath?: string) => AxiosPromise<Array<OrganizationUser>>>;
2910
+ addOrganizationAccessControl(organizationId: string, organizationAccessControl: OrganizationAccessControl, options?: AxiosRequestConfig): Promise<(axios?: AxiosInstance, basePath?: string) => AxiosPromise<OrganizationAccessControl>>;
2815
2911
  /**
2816
2912
  *
2817
2913
  * @summary List all Organizations
@@ -2827,6 +2923,47 @@ export declare const OrganizationApiFp: (configuration?: Configuration) => {
2827
2923
  * @throws {RequiredError}
2828
2924
  */
2829
2925
  findOrganizationById(organizationId: string, options?: AxiosRequestConfig): Promise<(axios?: AxiosInstance, basePath?: string) => AxiosPromise<Organization>>;
2926
+ /**
2927
+ *
2928
+ * @summary Get all permissions per components
2929
+ * @param {*} [options] Override http request option.
2930
+ * @throws {RequiredError}
2931
+ */
2932
+ getAllPermissions(options?: AxiosRequestConfig): Promise<(axios?: AxiosInstance, basePath?: string) => AxiosPromise<Array<ComponentRolePermissions>>>;
2933
+ /**
2934
+ *
2935
+ * @summary get a control acccess for the Organization
2936
+ * @param {string} organizationId the Organization identifier
2937
+ * @param {string} identityId the User identifier
2938
+ * @param {*} [options] Override http request option.
2939
+ * @throws {RequiredError}
2940
+ */
2941
+ getOrganizationAccessControl(organizationId: string, identityId: string, options?: AxiosRequestConfig): Promise<(axios?: AxiosInstance, basePath?: string) => AxiosPromise<OrganizationAccessControl>>;
2942
+ /**
2943
+ *
2944
+ * @summary Get the Organization permissions by given role
2945
+ * @param {string} organizationId the Organization identifier
2946
+ * @param {string} role the Role
2947
+ * @param {*} [options] Override http request option.
2948
+ * @throws {RequiredError}
2949
+ */
2950
+ getOrganizationPermissions(organizationId: string, role: string, options?: AxiosRequestConfig): Promise<(axios?: AxiosInstance, basePath?: string) => AxiosPromise<Array<string>>>;
2951
+ /**
2952
+ *
2953
+ * @summary Get the Organization security information
2954
+ * @param {string} organizationId the Organization identifier
2955
+ * @param {*} [options] Override http request option.
2956
+ * @throws {RequiredError}
2957
+ */
2958
+ getOrganizationSecurity(organizationId: string, options?: AxiosRequestConfig): Promise<(axios?: AxiosInstance, basePath?: string) => AxiosPromise<OrganizationSecurity>>;
2959
+ /**
2960
+ *
2961
+ * @summary Get the Organization security users list
2962
+ * @param {string} organizationId the Organization identifier
2963
+ * @param {*} [options] Override http request option.
2964
+ * @throws {RequiredError}
2965
+ */
2966
+ getOrganizationSecurityUsers(organizationId: string, options?: AxiosRequestConfig): Promise<(axios?: AxiosInstance, basePath?: string) => AxiosPromise<Array<string>>>;
2830
2967
  /**
2831
2968
  *
2832
2969
  * @summary Register a new organization
@@ -2837,21 +2974,22 @@ export declare const OrganizationApiFp: (configuration?: Configuration) => {
2837
2974
  registerOrganization(organization: Organization, options?: AxiosRequestConfig): Promise<(axios?: AxiosInstance, basePath?: string) => AxiosPromise<Organization>>;
2838
2975
  /**
2839
2976
  *
2840
- * @summary Remove all users from the Organization specified
2977
+ * @summary Remove the specified access from the given Organization
2841
2978
  * @param {string} organizationId the Organization identifier
2979
+ * @param {string} identityId the User identifier
2842
2980
  * @param {*} [options] Override http request option.
2843
2981
  * @throws {RequiredError}
2844
2982
  */
2845
- removeAllUsersInOrganization(organizationId: string, options?: AxiosRequestConfig): Promise<(axios?: AxiosInstance, basePath?: string) => AxiosPromise<void>>;
2983
+ removeOrganizationAccessControl(organizationId: string, identityId: string, options?: AxiosRequestConfig): Promise<(axios?: AxiosInstance, basePath?: string) => AxiosPromise<void>>;
2846
2984
  /**
2847
2985
  *
2848
- * @summary Remove the specified user from the given Organization
2986
+ * @summary set the Organization default security
2849
2987
  * @param {string} organizationId the Organization identifier
2850
- * @param {string} userId the User identifier
2988
+ * @param {string} body the new Organization default security.
2851
2989
  * @param {*} [options] Override http request option.
2852
2990
  * @throws {RequiredError}
2853
2991
  */
2854
- removeUserFromOrganization(organizationId: string, userId: string, options?: AxiosRequestConfig): Promise<(axios?: AxiosInstance, basePath?: string) => AxiosPromise<void>>;
2992
+ setOrganizationDefaultSecurity(organizationId: string, body: string, options?: AxiosRequestConfig): Promise<(axios?: AxiosInstance, basePath?: string) => AxiosPromise<OrganizationSecurity>>;
2855
2993
  /**
2856
2994
  *
2857
2995
  * @summary Unregister an organization
@@ -2908,13 +3046,13 @@ export declare const OrganizationApiFp: (configuration?: Configuration) => {
2908
3046
  export declare const OrganizationApiFactory: (configuration?: Configuration, basePath?: string, axios?: AxiosInstance) => {
2909
3047
  /**
2910
3048
  *
2911
- * @summary Add (or replace) users in the Organization specified
3049
+ * @summary add a control acccess to the Organization
2912
3050
  * @param {string} organizationId the Organization identifier
2913
- * @param {Array<OrganizationUser>} organizationUser the Users to add. Any User with the same ID is overwritten
3051
+ * @param {OrganizationAccessControl} organizationAccessControl the new Organization security access to add.
2914
3052
  * @param {*} [options] Override http request option.
2915
3053
  * @throws {RequiredError}
2916
3054
  */
2917
- addOrReplaceUsersInOrganization(organizationId: string, organizationUser: Array<OrganizationUser>, options?: any): AxiosPromise<Array<OrganizationUser>>;
3055
+ addOrganizationAccessControl(organizationId: string, organizationAccessControl: OrganizationAccessControl, options?: any): AxiosPromise<OrganizationAccessControl>;
2918
3056
  /**
2919
3057
  *
2920
3058
  * @summary List all Organizations
@@ -2930,6 +3068,47 @@ export declare const OrganizationApiFactory: (configuration?: Configuration, bas
2930
3068
  * @throws {RequiredError}
2931
3069
  */
2932
3070
  findOrganizationById(organizationId: string, options?: any): AxiosPromise<Organization>;
3071
+ /**
3072
+ *
3073
+ * @summary Get all permissions per components
3074
+ * @param {*} [options] Override http request option.
3075
+ * @throws {RequiredError}
3076
+ */
3077
+ getAllPermissions(options?: any): AxiosPromise<Array<ComponentRolePermissions>>;
3078
+ /**
3079
+ *
3080
+ * @summary get a control acccess for the Organization
3081
+ * @param {string} organizationId the Organization identifier
3082
+ * @param {string} identityId the User identifier
3083
+ * @param {*} [options] Override http request option.
3084
+ * @throws {RequiredError}
3085
+ */
3086
+ getOrganizationAccessControl(organizationId: string, identityId: string, options?: any): AxiosPromise<OrganizationAccessControl>;
3087
+ /**
3088
+ *
3089
+ * @summary Get the Organization permissions by given role
3090
+ * @param {string} organizationId the Organization identifier
3091
+ * @param {string} role the Role
3092
+ * @param {*} [options] Override http request option.
3093
+ * @throws {RequiredError}
3094
+ */
3095
+ getOrganizationPermissions(organizationId: string, role: string, options?: any): AxiosPromise<Array<string>>;
3096
+ /**
3097
+ *
3098
+ * @summary Get the Organization security information
3099
+ * @param {string} organizationId the Organization identifier
3100
+ * @param {*} [options] Override http request option.
3101
+ * @throws {RequiredError}
3102
+ */
3103
+ getOrganizationSecurity(organizationId: string, options?: any): AxiosPromise<OrganizationSecurity>;
3104
+ /**
3105
+ *
3106
+ * @summary Get the Organization security users list
3107
+ * @param {string} organizationId the Organization identifier
3108
+ * @param {*} [options] Override http request option.
3109
+ * @throws {RequiredError}
3110
+ */
3111
+ getOrganizationSecurityUsers(organizationId: string, options?: any): AxiosPromise<Array<string>>;
2933
3112
  /**
2934
3113
  *
2935
3114
  * @summary Register a new organization
@@ -2940,21 +3119,22 @@ export declare const OrganizationApiFactory: (configuration?: Configuration, bas
2940
3119
  registerOrganization(organization: Organization, options?: any): AxiosPromise<Organization>;
2941
3120
  /**
2942
3121
  *
2943
- * @summary Remove all users from the Organization specified
3122
+ * @summary Remove the specified access from the given Organization
2944
3123
  * @param {string} organizationId the Organization identifier
3124
+ * @param {string} identityId the User identifier
2945
3125
  * @param {*} [options] Override http request option.
2946
3126
  * @throws {RequiredError}
2947
3127
  */
2948
- removeAllUsersInOrganization(organizationId: string, options?: any): AxiosPromise<void>;
3128
+ removeOrganizationAccessControl(organizationId: string, identityId: string, options?: any): AxiosPromise<void>;
2949
3129
  /**
2950
3130
  *
2951
- * @summary Remove the specified user from the given Organization
3131
+ * @summary set the Organization default security
2952
3132
  * @param {string} organizationId the Organization identifier
2953
- * @param {string} userId the User identifier
3133
+ * @param {string} body the new Organization default security.
2954
3134
  * @param {*} [options] Override http request option.
2955
3135
  * @throws {RequiredError}
2956
3136
  */
2957
- removeUserFromOrganization(organizationId: string, userId: string, options?: any): AxiosPromise<void>;
3137
+ setOrganizationDefaultSecurity(organizationId: string, body: string, options?: any): AxiosPromise<OrganizationSecurity>;
2958
3138
  /**
2959
3139
  *
2960
3140
  * @summary Unregister an organization
@@ -3013,14 +3193,14 @@ export declare const OrganizationApiFactory: (configuration?: Configuration, bas
3013
3193
  export declare class OrganizationApi extends BaseAPI {
3014
3194
  /**
3015
3195
  *
3016
- * @summary Add (or replace) users in the Organization specified
3196
+ * @summary add a control acccess to the Organization
3017
3197
  * @param {string} organizationId the Organization identifier
3018
- * @param {Array<OrganizationUser>} organizationUser the Users to add. Any User with the same ID is overwritten
3198
+ * @param {OrganizationAccessControl} organizationAccessControl the new Organization security access to add.
3019
3199
  * @param {*} [options] Override http request option.
3020
3200
  * @throws {RequiredError}
3021
3201
  * @memberof OrganizationApi
3022
3202
  */
3023
- addOrReplaceUsersInOrganization(organizationId: string, organizationUser: Array<OrganizationUser>, options?: AxiosRequestConfig): Promise<import("axios").AxiosResponse<OrganizationUser[]>>;
3203
+ addOrganizationAccessControl(organizationId: string, organizationAccessControl: OrganizationAccessControl, options?: AxiosRequestConfig): Promise<import("axios").AxiosResponse<OrganizationAccessControl>>;
3024
3204
  /**
3025
3205
  *
3026
3206
  * @summary List all Organizations
@@ -3040,71 +3220,118 @@ export declare class OrganizationApi extends BaseAPI {
3040
3220
  findOrganizationById(organizationId: string, options?: AxiosRequestConfig): Promise<import("axios").AxiosResponse<Organization>>;
3041
3221
  /**
3042
3222
  *
3043
- * @summary Register a new organization
3044
- * @param {Organization} organization the Organization to register
3223
+ * @summary Get all permissions per components
3045
3224
  * @param {*} [options] Override http request option.
3046
3225
  * @throws {RequiredError}
3047
3226
  * @memberof OrganizationApi
3048
3227
  */
3049
- registerOrganization(organization: Organization, options?: AxiosRequestConfig): Promise<import("axios").AxiosResponse<Organization>>;
3228
+ getAllPermissions(options?: AxiosRequestConfig): Promise<import("axios").AxiosResponse<ComponentRolePermissions[]>>;
3050
3229
  /**
3051
3230
  *
3052
- * @summary Remove all users from the Organization specified
3231
+ * @summary get a control acccess for the Organization
3053
3232
  * @param {string} organizationId the Organization identifier
3233
+ * @param {string} identityId the User identifier
3054
3234
  * @param {*} [options] Override http request option.
3055
3235
  * @throws {RequiredError}
3056
3236
  * @memberof OrganizationApi
3057
3237
  */
3058
- removeAllUsersInOrganization(organizationId: string, options?: AxiosRequestConfig): Promise<import("axios").AxiosResponse<void>>;
3238
+ getOrganizationAccessControl(organizationId: string, identityId: string, options?: AxiosRequestConfig): Promise<import("axios").AxiosResponse<OrganizationAccessControl>>;
3059
3239
  /**
3060
3240
  *
3061
- * @summary Remove the specified user from the given Organization
3241
+ * @summary Get the Organization permissions by given role
3062
3242
  * @param {string} organizationId the Organization identifier
3063
- * @param {string} userId the User identifier
3243
+ * @param {string} role the Role
3064
3244
  * @param {*} [options] Override http request option.
3065
3245
  * @throws {RequiredError}
3066
3246
  * @memberof OrganizationApi
3067
3247
  */
3068
- removeUserFromOrganization(organizationId: string, userId: string, options?: AxiosRequestConfig): Promise<import("axios").AxiosResponse<void>>;
3248
+ getOrganizationPermissions(organizationId: string, role: string, options?: AxiosRequestConfig): Promise<import("axios").AxiosResponse<string[]>>;
3069
3249
  /**
3070
3250
  *
3071
- * @summary Unregister an organization
3251
+ * @summary Get the Organization security information
3072
3252
  * @param {string} organizationId the Organization identifier
3073
3253
  * @param {*} [options] Override http request option.
3074
3254
  * @throws {RequiredError}
3075
3255
  * @memberof OrganizationApi
3076
3256
  */
3077
- unregisterOrganization(organizationId: string, options?: AxiosRequestConfig): Promise<import("axios").AxiosResponse<void>>;
3257
+ getOrganizationSecurity(organizationId: string, options?: AxiosRequestConfig): Promise<import("axios").AxiosResponse<OrganizationSecurity>>;
3078
3258
  /**
3079
3259
  *
3080
- * @summary Update an Organization
3260
+ * @summary Get the Organization security users list
3081
3261
  * @param {string} organizationId the Organization identifier
3082
- * @param {Organization} organization the new Organization details
3083
3262
  * @param {*} [options] Override http request option.
3084
3263
  * @throws {RequiredError}
3085
3264
  * @memberof OrganizationApi
3086
3265
  */
3087
- updateOrganization(organizationId: string, organization: Organization, options?: AxiosRequestConfig): Promise<import("axios").AxiosResponse<Organization>>;
3266
+ getOrganizationSecurityUsers(organizationId: string, options?: AxiosRequestConfig): Promise<import("axios").AxiosResponse<string[]>>;
3088
3267
  /**
3089
3268
  *
3090
- * @summary Update the solutions container registry configuration for the Organization specified
3091
- * @param {string} organizationId the Organization identifier
3092
- * @param {OrganizationService} organizationService the new solutions container registry configuration to use
3269
+ * @summary Register a new organization
3270
+ * @param {Organization} organization the Organization to register
3093
3271
  * @param {*} [options] Override http request option.
3094
3272
  * @throws {RequiredError}
3095
3273
  * @memberof OrganizationApi
3096
3274
  */
3097
- updateSolutionsContainerRegistryByOrganizationId(organizationId: string, organizationService: OrganizationService, options?: AxiosRequestConfig): Promise<import("axios").AxiosResponse<OrganizationService>>;
3275
+ registerOrganization(organization: Organization, options?: AxiosRequestConfig): Promise<import("axios").AxiosResponse<Organization>>;
3098
3276
  /**
3099
3277
  *
3100
- * @summary Update storage configuration for the Organization specified
3278
+ * @summary Remove the specified access from the given Organization
3101
3279
  * @param {string} organizationId the Organization identifier
3102
- * @param {OrganizationService} organizationService the new Storage configuration to use
3280
+ * @param {string} identityId the User identifier
3103
3281
  * @param {*} [options] Override http request option.
3104
3282
  * @throws {RequiredError}
3105
3283
  * @memberof OrganizationApi
3106
3284
  */
3107
- updateStorageByOrganizationId(organizationId: string, organizationService: OrganizationService, options?: AxiosRequestConfig): Promise<import("axios").AxiosResponse<OrganizationService>>;
3285
+ removeOrganizationAccessControl(organizationId: string, identityId: string, options?: AxiosRequestConfig): Promise<import("axios").AxiosResponse<void>>;
3286
+ /**
3287
+ *
3288
+ * @summary set the Organization default security
3289
+ * @param {string} organizationId the Organization identifier
3290
+ * @param {string} body the new Organization default security.
3291
+ * @param {*} [options] Override http request option.
3292
+ * @throws {RequiredError}
3293
+ * @memberof OrganizationApi
3294
+ */
3295
+ setOrganizationDefaultSecurity(organizationId: string, body: string, options?: AxiosRequestConfig): Promise<import("axios").AxiosResponse<OrganizationSecurity>>;
3296
+ /**
3297
+ *
3298
+ * @summary Unregister an organization
3299
+ * @param {string} organizationId the Organization identifier
3300
+ * @param {*} [options] Override http request option.
3301
+ * @throws {RequiredError}
3302
+ * @memberof OrganizationApi
3303
+ */
3304
+ unregisterOrganization(organizationId: string, options?: AxiosRequestConfig): Promise<import("axios").AxiosResponse<void>>;
3305
+ /**
3306
+ *
3307
+ * @summary Update an Organization
3308
+ * @param {string} organizationId the Organization identifier
3309
+ * @param {Organization} organization the new Organization details
3310
+ * @param {*} [options] Override http request option.
3311
+ * @throws {RequiredError}
3312
+ * @memberof OrganizationApi
3313
+ */
3314
+ updateOrganization(organizationId: string, organization: Organization, options?: AxiosRequestConfig): Promise<import("axios").AxiosResponse<Organization>>;
3315
+ /**
3316
+ *
3317
+ * @summary Update the solutions container registry configuration for the Organization specified
3318
+ * @param {string} organizationId the Organization identifier
3319
+ * @param {OrganizationService} organizationService the new solutions container registry configuration to use
3320
+ * @param {*} [options] Override http request option.
3321
+ * @throws {RequiredError}
3322
+ * @memberof OrganizationApi
3323
+ */
3324
+ updateSolutionsContainerRegistryByOrganizationId(organizationId: string, organizationService: OrganizationService, options?: AxiosRequestConfig): Promise<import("axios").AxiosResponse<OrganizationService>>;
3325
+ /**
3326
+ *
3327
+ * @summary Update storage configuration for the Organization specified
3328
+ * @param {string} organizationId the Organization identifier
3329
+ * @param {OrganizationService} organizationService the new Storage configuration to use
3330
+ * @param {*} [options] Override http request option.
3331
+ * @throws {RequiredError}
3332
+ * @memberof OrganizationApi
3333
+ */
3334
+ updateStorageByOrganizationId(organizationId: string, organizationService: OrganizationService, options?: AxiosRequestConfig): Promise<import("axios").AxiosResponse<OrganizationService>>;
3108
3335
  /**
3109
3336
  *
3110
3337
  * @summary Update tenant credentials for the Organization specified
@@ -3138,15 +3365,15 @@ export declare const ScenarioApiAxiosParamCreator: (configuration?: Configuratio
3138
3365
  addOrReplaceScenarioParameterValues: (organizationId: string, workspaceId: string, scenarioId: string, scenarioRunTemplateParameterValue: Array<ScenarioRunTemplateParameterValue>, options?: AxiosRequestConfig) => Promise<RequestArgs>;
3139
3366
  /**
3140
3367
  *
3141
- * @summary Add (or replace) users in the Scenario specified
3368
+ * @summary add a control acccess to the Scenario
3142
3369
  * @param {string} organizationId the Organization identifier
3143
3370
  * @param {string} workspaceId the Workspace identifier
3144
3371
  * @param {string} scenarioId the Scenario identifier
3145
- * @param {Array<ScenarioUser>} scenarioUser the Users to add. Any User with the same ID is overwritten
3372
+ * @param {ScenarioAccessControl} scenarioAccessControl the new Scenario security access to add.
3146
3373
  * @param {*} [options] Override http request option.
3147
3374
  * @throws {RequiredError}
3148
3375
  */
3149
- addOrReplaceUsersInScenario: (organizationId: string, workspaceId: string, scenarioId: string, scenarioUser: Array<ScenarioUser>, options?: AxiosRequestConfig) => Promise<RequestArgs>;
3376
+ addScenarioAccessControl: (organizationId: string, workspaceId: string, scenarioId: string, scenarioAccessControl: ScenarioAccessControl, options?: AxiosRequestConfig) => Promise<RequestArgs>;
3150
3377
  /**
3151
3378
  *
3152
3379
  * @summary Compare the Scenario with another one and returns the difference for parameters values
@@ -3227,6 +3454,17 @@ export declare const ScenarioApiAxiosParamCreator: (configuration?: Configuratio
3227
3454
  * @throws {RequiredError}
3228
3455
  */
3229
3456
  findScenarioById: (organizationId: string, workspaceId: string, scenarioId: string, options?: AxiosRequestConfig) => Promise<RequestArgs>;
3457
+ /**
3458
+ *
3459
+ * @summary get a control acccess for the Scenario
3460
+ * @param {string} organizationId the Organization identifier
3461
+ * @param {string} workspaceId the Workspace identifier
3462
+ * @param {string} scenarioId the Scenario identifier
3463
+ * @param {string} identityId the User identifier
3464
+ * @param {*} [options] Override http request option.
3465
+ * @throws {RequiredError}
3466
+ */
3467
+ getScenarioAccessControl: (organizationId: string, workspaceId: string, scenarioId: string, identityId: string, options?: AxiosRequestConfig) => Promise<RequestArgs>;
3230
3468
  /**
3231
3469
  *
3232
3470
  * @summary Get Scenario data download URL
@@ -3238,6 +3476,36 @@ export declare const ScenarioApiAxiosParamCreator: (configuration?: Configuratio
3238
3476
  * @throws {RequiredError}
3239
3477
  */
3240
3478
  getScenarioDataDownloadJobInfo: (organizationId: string, workspaceId: string, scenarioId: string, downloadId: string, options?: AxiosRequestConfig) => Promise<RequestArgs>;
3479
+ /**
3480
+ *
3481
+ * @summary Get the Scenario permission by given role
3482
+ * @param {string} organizationId the Organization identifier
3483
+ * @param {string} workspaceId the Workspace identifier
3484
+ * @param {string} role the Role
3485
+ * @param {*} [options] Override http request option.
3486
+ * @throws {RequiredError}
3487
+ */
3488
+ getScenarioPermissions: (organizationId: string, workspaceId: string, role: string, options?: AxiosRequestConfig) => Promise<RequestArgs>;
3489
+ /**
3490
+ *
3491
+ * @summary Get the Scenario security information
3492
+ * @param {string} organizationId the Organization identifier
3493
+ * @param {string} workspaceId the Workspace identifier
3494
+ * @param {string} scenarioId the Scenario identifier
3495
+ * @param {*} [options] Override http request option.
3496
+ * @throws {RequiredError}
3497
+ */
3498
+ getScenarioSecurity: (organizationId: string, workspaceId: string, scenarioId: string, options?: AxiosRequestConfig) => Promise<RequestArgs>;
3499
+ /**
3500
+ *
3501
+ * @summary Get the Scenario security users list
3502
+ * @param {string} organizationId the Organization identifier
3503
+ * @param {string} workspaceId the Workspace identifier
3504
+ * @param {string} scenarioId the Scenario identifier
3505
+ * @param {*} [options] Override http request option.
3506
+ * @throws {RequiredError}
3507
+ */
3508
+ getScenarioSecurityUsers: (organizationId: string, workspaceId: string, scenarioId: string, options?: AxiosRequestConfig) => Promise<RequestArgs>;
3241
3509
  /**
3242
3510
  *
3243
3511
  * @summary Get the validation status of an scenario
@@ -3269,25 +3537,26 @@ export declare const ScenarioApiAxiosParamCreator: (configuration?: Configuratio
3269
3537
  removeAllScenarioParameterValues: (organizationId: string, workspaceId: string, scenarioId: string, options?: AxiosRequestConfig) => Promise<RequestArgs>;
3270
3538
  /**
3271
3539
  *
3272
- * @summary Remove all users from the Scenario specified
3540
+ * @summary Remove the specified access from the given Organization Scenario
3273
3541
  * @param {string} organizationId the Organization identifier
3274
3542
  * @param {string} workspaceId the Workspace identifier
3275
3543
  * @param {string} scenarioId the Scenario identifier
3544
+ * @param {string} identityId the User identifier
3276
3545
  * @param {*} [options] Override http request option.
3277
3546
  * @throws {RequiredError}
3278
3547
  */
3279
- removeAllUsersOfScenario: (organizationId: string, workspaceId: string, scenarioId: string, options?: AxiosRequestConfig) => Promise<RequestArgs>;
3548
+ removeScenarioAccessControl: (organizationId: string, workspaceId: string, scenarioId: string, identityId: string, options?: AxiosRequestConfig) => Promise<RequestArgs>;
3280
3549
  /**
3281
3550
  *
3282
- * @summary Remove the specified user from the given Scenario
3551
+ * @summary set the Scenario default security
3283
3552
  * @param {string} organizationId the Organization identifier
3284
3553
  * @param {string} workspaceId the Workspace identifier
3285
3554
  * @param {string} scenarioId the Scenario identifier
3286
- * @param {string} userId the User identifier
3555
+ * @param {string} body the new Scenario default security.
3287
3556
  * @param {*} [options] Override http request option.
3288
3557
  * @throws {RequiredError}
3289
3558
  */
3290
- removeUserFromScenario: (organizationId: string, workspaceId: string, scenarioId: string, userId: string, options?: AxiosRequestConfig) => Promise<RequestArgs>;
3559
+ setScenarioDefaultSecurity: (organizationId: string, workspaceId: string, scenarioId: string, body: string, options?: AxiosRequestConfig) => Promise<RequestArgs>;
3291
3560
  /**
3292
3561
  *
3293
3562
  * @summary Update a scenario
@@ -3318,15 +3587,15 @@ export declare const ScenarioApiFp: (configuration?: Configuration) => {
3318
3587
  addOrReplaceScenarioParameterValues(organizationId: string, workspaceId: string, scenarioId: string, scenarioRunTemplateParameterValue: Array<ScenarioRunTemplateParameterValue>, options?: AxiosRequestConfig): Promise<(axios?: AxiosInstance, basePath?: string) => AxiosPromise<Array<ScenarioRunTemplateParameterValue>>>;
3319
3588
  /**
3320
3589
  *
3321
- * @summary Add (or replace) users in the Scenario specified
3590
+ * @summary add a control acccess to the Scenario
3322
3591
  * @param {string} organizationId the Organization identifier
3323
3592
  * @param {string} workspaceId the Workspace identifier
3324
3593
  * @param {string} scenarioId the Scenario identifier
3325
- * @param {Array<ScenarioUser>} scenarioUser the Users to add. Any User with the same ID is overwritten
3594
+ * @param {ScenarioAccessControl} scenarioAccessControl the new Scenario security access to add.
3326
3595
  * @param {*} [options] Override http request option.
3327
3596
  * @throws {RequiredError}
3328
3597
  */
3329
- addOrReplaceUsersInScenario(organizationId: string, workspaceId: string, scenarioId: string, scenarioUser: Array<ScenarioUser>, options?: AxiosRequestConfig): Promise<(axios?: AxiosInstance, basePath?: string) => AxiosPromise<Array<ScenarioUser>>>;
3598
+ addScenarioAccessControl(organizationId: string, workspaceId: string, scenarioId: string, scenarioAccessControl: ScenarioAccessControl, options?: AxiosRequestConfig): Promise<(axios?: AxiosInstance, basePath?: string) => AxiosPromise<ScenarioAccessControl>>;
3330
3599
  /**
3331
3600
  *
3332
3601
  * @summary Compare the Scenario with another one and returns the difference for parameters values
@@ -3407,6 +3676,17 @@ export declare const ScenarioApiFp: (configuration?: Configuration) => {
3407
3676
  * @throws {RequiredError}
3408
3677
  */
3409
3678
  findScenarioById(organizationId: string, workspaceId: string, scenarioId: string, options?: AxiosRequestConfig): Promise<(axios?: AxiosInstance, basePath?: string) => AxiosPromise<Scenario>>;
3679
+ /**
3680
+ *
3681
+ * @summary get a control acccess for the Scenario
3682
+ * @param {string} organizationId the Organization identifier
3683
+ * @param {string} workspaceId the Workspace identifier
3684
+ * @param {string} scenarioId the Scenario identifier
3685
+ * @param {string} identityId the User identifier
3686
+ * @param {*} [options] Override http request option.
3687
+ * @throws {RequiredError}
3688
+ */
3689
+ getScenarioAccessControl(organizationId: string, workspaceId: string, scenarioId: string, identityId: string, options?: AxiosRequestConfig): Promise<(axios?: AxiosInstance, basePath?: string) => AxiosPromise<ScenarioAccessControl>>;
3410
3690
  /**
3411
3691
  *
3412
3692
  * @summary Get Scenario data download URL
@@ -3418,6 +3698,36 @@ export declare const ScenarioApiFp: (configuration?: Configuration) => {
3418
3698
  * @throws {RequiredError}
3419
3699
  */
3420
3700
  getScenarioDataDownloadJobInfo(organizationId: string, workspaceId: string, scenarioId: string, downloadId: string, options?: AxiosRequestConfig): Promise<(axios?: AxiosInstance, basePath?: string) => AxiosPromise<ScenarioDataDownloadInfo>>;
3701
+ /**
3702
+ *
3703
+ * @summary Get the Scenario permission by given role
3704
+ * @param {string} organizationId the Organization identifier
3705
+ * @param {string} workspaceId the Workspace identifier
3706
+ * @param {string} role the Role
3707
+ * @param {*} [options] Override http request option.
3708
+ * @throws {RequiredError}
3709
+ */
3710
+ getScenarioPermissions(organizationId: string, workspaceId: string, role: string, options?: AxiosRequestConfig): Promise<(axios?: AxiosInstance, basePath?: string) => AxiosPromise<Array<string>>>;
3711
+ /**
3712
+ *
3713
+ * @summary Get the Scenario security information
3714
+ * @param {string} organizationId the Organization identifier
3715
+ * @param {string} workspaceId the Workspace identifier
3716
+ * @param {string} scenarioId the Scenario identifier
3717
+ * @param {*} [options] Override http request option.
3718
+ * @throws {RequiredError}
3719
+ */
3720
+ getScenarioSecurity(organizationId: string, workspaceId: string, scenarioId: string, options?: AxiosRequestConfig): Promise<(axios?: AxiosInstance, basePath?: string) => AxiosPromise<ScenarioSecurity>>;
3721
+ /**
3722
+ *
3723
+ * @summary Get the Scenario security users list
3724
+ * @param {string} organizationId the Organization identifier
3725
+ * @param {string} workspaceId the Workspace identifier
3726
+ * @param {string} scenarioId the Scenario identifier
3727
+ * @param {*} [options] Override http request option.
3728
+ * @throws {RequiredError}
3729
+ */
3730
+ getScenarioSecurityUsers(organizationId: string, workspaceId: string, scenarioId: string, options?: AxiosRequestConfig): Promise<(axios?: AxiosInstance, basePath?: string) => AxiosPromise<Array<string>>>;
3421
3731
  /**
3422
3732
  *
3423
3733
  * @summary Get the validation status of an scenario
@@ -3449,25 +3759,26 @@ export declare const ScenarioApiFp: (configuration?: Configuration) => {
3449
3759
  removeAllScenarioParameterValues(organizationId: string, workspaceId: string, scenarioId: string, options?: AxiosRequestConfig): Promise<(axios?: AxiosInstance, basePath?: string) => AxiosPromise<void>>;
3450
3760
  /**
3451
3761
  *
3452
- * @summary Remove all users from the Scenario specified
3762
+ * @summary Remove the specified access from the given Organization Scenario
3453
3763
  * @param {string} organizationId the Organization identifier
3454
3764
  * @param {string} workspaceId the Workspace identifier
3455
3765
  * @param {string} scenarioId the Scenario identifier
3766
+ * @param {string} identityId the User identifier
3456
3767
  * @param {*} [options] Override http request option.
3457
3768
  * @throws {RequiredError}
3458
3769
  */
3459
- removeAllUsersOfScenario(organizationId: string, workspaceId: string, scenarioId: string, options?: AxiosRequestConfig): Promise<(axios?: AxiosInstance, basePath?: string) => AxiosPromise<void>>;
3770
+ removeScenarioAccessControl(organizationId: string, workspaceId: string, scenarioId: string, identityId: string, options?: AxiosRequestConfig): Promise<(axios?: AxiosInstance, basePath?: string) => AxiosPromise<void>>;
3460
3771
  /**
3461
3772
  *
3462
- * @summary Remove the specified user from the given Scenario
3773
+ * @summary set the Scenario default security
3463
3774
  * @param {string} organizationId the Organization identifier
3464
3775
  * @param {string} workspaceId the Workspace identifier
3465
3776
  * @param {string} scenarioId the Scenario identifier
3466
- * @param {string} userId the User identifier
3777
+ * @param {string} body the new Scenario default security.
3467
3778
  * @param {*} [options] Override http request option.
3468
3779
  * @throws {RequiredError}
3469
3780
  */
3470
- removeUserFromScenario(organizationId: string, workspaceId: string, scenarioId: string, userId: string, options?: AxiosRequestConfig): Promise<(axios?: AxiosInstance, basePath?: string) => AxiosPromise<void>>;
3781
+ setScenarioDefaultSecurity(organizationId: string, workspaceId: string, scenarioId: string, body: string, options?: AxiosRequestConfig): Promise<(axios?: AxiosInstance, basePath?: string) => AxiosPromise<ScenarioSecurity>>;
3471
3782
  /**
3472
3783
  *
3473
3784
  * @summary Update a scenario
@@ -3498,15 +3809,15 @@ export declare const ScenarioApiFactory: (configuration?: Configuration, basePat
3498
3809
  addOrReplaceScenarioParameterValues(organizationId: string, workspaceId: string, scenarioId: string, scenarioRunTemplateParameterValue: Array<ScenarioRunTemplateParameterValue>, options?: any): AxiosPromise<Array<ScenarioRunTemplateParameterValue>>;
3499
3810
  /**
3500
3811
  *
3501
- * @summary Add (or replace) users in the Scenario specified
3812
+ * @summary add a control acccess to the Scenario
3502
3813
  * @param {string} organizationId the Organization identifier
3503
3814
  * @param {string} workspaceId the Workspace identifier
3504
3815
  * @param {string} scenarioId the Scenario identifier
3505
- * @param {Array<ScenarioUser>} scenarioUser the Users to add. Any User with the same ID is overwritten
3816
+ * @param {ScenarioAccessControl} scenarioAccessControl the new Scenario security access to add.
3506
3817
  * @param {*} [options] Override http request option.
3507
3818
  * @throws {RequiredError}
3508
3819
  */
3509
- addOrReplaceUsersInScenario(organizationId: string, workspaceId: string, scenarioId: string, scenarioUser: Array<ScenarioUser>, options?: any): AxiosPromise<Array<ScenarioUser>>;
3820
+ addScenarioAccessControl(organizationId: string, workspaceId: string, scenarioId: string, scenarioAccessControl: ScenarioAccessControl, options?: any): AxiosPromise<ScenarioAccessControl>;
3510
3821
  /**
3511
3822
  *
3512
3823
  * @summary Compare the Scenario with another one and returns the difference for parameters values
@@ -3587,6 +3898,17 @@ export declare const ScenarioApiFactory: (configuration?: Configuration, basePat
3587
3898
  * @throws {RequiredError}
3588
3899
  */
3589
3900
  findScenarioById(organizationId: string, workspaceId: string, scenarioId: string, options?: any): AxiosPromise<Scenario>;
3901
+ /**
3902
+ *
3903
+ * @summary get a control acccess for the Scenario
3904
+ * @param {string} organizationId the Organization identifier
3905
+ * @param {string} workspaceId the Workspace identifier
3906
+ * @param {string} scenarioId the Scenario identifier
3907
+ * @param {string} identityId the User identifier
3908
+ * @param {*} [options] Override http request option.
3909
+ * @throws {RequiredError}
3910
+ */
3911
+ getScenarioAccessControl(organizationId: string, workspaceId: string, scenarioId: string, identityId: string, options?: any): AxiosPromise<ScenarioAccessControl>;
3590
3912
  /**
3591
3913
  *
3592
3914
  * @summary Get Scenario data download URL
@@ -3598,6 +3920,36 @@ export declare const ScenarioApiFactory: (configuration?: Configuration, basePat
3598
3920
  * @throws {RequiredError}
3599
3921
  */
3600
3922
  getScenarioDataDownloadJobInfo(organizationId: string, workspaceId: string, scenarioId: string, downloadId: string, options?: any): AxiosPromise<ScenarioDataDownloadInfo>;
3923
+ /**
3924
+ *
3925
+ * @summary Get the Scenario permission by given role
3926
+ * @param {string} organizationId the Organization identifier
3927
+ * @param {string} workspaceId the Workspace identifier
3928
+ * @param {string} role the Role
3929
+ * @param {*} [options] Override http request option.
3930
+ * @throws {RequiredError}
3931
+ */
3932
+ getScenarioPermissions(organizationId: string, workspaceId: string, role: string, options?: any): AxiosPromise<Array<string>>;
3933
+ /**
3934
+ *
3935
+ * @summary Get the Scenario security information
3936
+ * @param {string} organizationId the Organization identifier
3937
+ * @param {string} workspaceId the Workspace identifier
3938
+ * @param {string} scenarioId the Scenario identifier
3939
+ * @param {*} [options] Override http request option.
3940
+ * @throws {RequiredError}
3941
+ */
3942
+ getScenarioSecurity(organizationId: string, workspaceId: string, scenarioId: string, options?: any): AxiosPromise<ScenarioSecurity>;
3943
+ /**
3944
+ *
3945
+ * @summary Get the Scenario security users list
3946
+ * @param {string} organizationId the Organization identifier
3947
+ * @param {string} workspaceId the Workspace identifier
3948
+ * @param {string} scenarioId the Scenario identifier
3949
+ * @param {*} [options] Override http request option.
3950
+ * @throws {RequiredError}
3951
+ */
3952
+ getScenarioSecurityUsers(organizationId: string, workspaceId: string, scenarioId: string, options?: any): AxiosPromise<Array<string>>;
3601
3953
  /**
3602
3954
  *
3603
3955
  * @summary Get the validation status of an scenario
@@ -3629,25 +3981,26 @@ export declare const ScenarioApiFactory: (configuration?: Configuration, basePat
3629
3981
  removeAllScenarioParameterValues(organizationId: string, workspaceId: string, scenarioId: string, options?: any): AxiosPromise<void>;
3630
3982
  /**
3631
3983
  *
3632
- * @summary Remove all users from the Scenario specified
3984
+ * @summary Remove the specified access from the given Organization Scenario
3633
3985
  * @param {string} organizationId the Organization identifier
3634
3986
  * @param {string} workspaceId the Workspace identifier
3635
3987
  * @param {string} scenarioId the Scenario identifier
3988
+ * @param {string} identityId the User identifier
3636
3989
  * @param {*} [options] Override http request option.
3637
3990
  * @throws {RequiredError}
3638
3991
  */
3639
- removeAllUsersOfScenario(organizationId: string, workspaceId: string, scenarioId: string, options?: any): AxiosPromise<void>;
3992
+ removeScenarioAccessControl(organizationId: string, workspaceId: string, scenarioId: string, identityId: string, options?: any): AxiosPromise<void>;
3640
3993
  /**
3641
3994
  *
3642
- * @summary Remove the specified user from the given Scenario
3995
+ * @summary set the Scenario default security
3643
3996
  * @param {string} organizationId the Organization identifier
3644
3997
  * @param {string} workspaceId the Workspace identifier
3645
3998
  * @param {string} scenarioId the Scenario identifier
3646
- * @param {string} userId the User identifier
3999
+ * @param {string} body the new Scenario default security.
3647
4000
  * @param {*} [options] Override http request option.
3648
4001
  * @throws {RequiredError}
3649
4002
  */
3650
- removeUserFromScenario(organizationId: string, workspaceId: string, scenarioId: string, userId: string, options?: any): AxiosPromise<void>;
4003
+ setScenarioDefaultSecurity(organizationId: string, workspaceId: string, scenarioId: string, body: string, options?: any): AxiosPromise<ScenarioSecurity>;
3651
4004
  /**
3652
4005
  *
3653
4006
  * @summary Update a scenario
@@ -3681,16 +4034,16 @@ export declare class ScenarioApi extends BaseAPI {
3681
4034
  addOrReplaceScenarioParameterValues(organizationId: string, workspaceId: string, scenarioId: string, scenarioRunTemplateParameterValue: Array<ScenarioRunTemplateParameterValue>, options?: AxiosRequestConfig): Promise<import("axios").AxiosResponse<ScenarioRunTemplateParameterValue[]>>;
3682
4035
  /**
3683
4036
  *
3684
- * @summary Add (or replace) users in the Scenario specified
4037
+ * @summary add a control acccess to the Scenario
3685
4038
  * @param {string} organizationId the Organization identifier
3686
4039
  * @param {string} workspaceId the Workspace identifier
3687
4040
  * @param {string} scenarioId the Scenario identifier
3688
- * @param {Array<ScenarioUser>} scenarioUser the Users to add. Any User with the same ID is overwritten
4041
+ * @param {ScenarioAccessControl} scenarioAccessControl the new Scenario security access to add.
3689
4042
  * @param {*} [options] Override http request option.
3690
4043
  * @throws {RequiredError}
3691
4044
  * @memberof ScenarioApi
3692
4045
  */
3693
- addOrReplaceUsersInScenario(organizationId: string, workspaceId: string, scenarioId: string, scenarioUser: Array<ScenarioUser>, options?: AxiosRequestConfig): Promise<import("axios").AxiosResponse<ScenarioUser[]>>;
4046
+ addScenarioAccessControl(organizationId: string, workspaceId: string, scenarioId: string, scenarioAccessControl: ScenarioAccessControl, options?: AxiosRequestConfig): Promise<import("axios").AxiosResponse<ScenarioAccessControl>>;
3694
4047
  /**
3695
4048
  *
3696
4049
  * @summary Compare the Scenario with another one and returns the difference for parameters values
@@ -3779,6 +4132,18 @@ export declare class ScenarioApi extends BaseAPI {
3779
4132
  * @memberof ScenarioApi
3780
4133
  */
3781
4134
  findScenarioById(organizationId: string, workspaceId: string, scenarioId: string, options?: AxiosRequestConfig): Promise<import("axios").AxiosResponse<Scenario>>;
4135
+ /**
4136
+ *
4137
+ * @summary get a control acccess for the Scenario
4138
+ * @param {string} organizationId the Organization identifier
4139
+ * @param {string} workspaceId the Workspace identifier
4140
+ * @param {string} scenarioId the Scenario identifier
4141
+ * @param {string} identityId the User identifier
4142
+ * @param {*} [options] Override http request option.
4143
+ * @throws {RequiredError}
4144
+ * @memberof ScenarioApi
4145
+ */
4146
+ getScenarioAccessControl(organizationId: string, workspaceId: string, scenarioId: string, identityId: string, options?: AxiosRequestConfig): Promise<import("axios").AxiosResponse<ScenarioAccessControl>>;
3782
4147
  /**
3783
4148
  *
3784
4149
  * @summary Get Scenario data download URL
@@ -3791,6 +4156,39 @@ export declare class ScenarioApi extends BaseAPI {
3791
4156
  * @memberof ScenarioApi
3792
4157
  */
3793
4158
  getScenarioDataDownloadJobInfo(organizationId: string, workspaceId: string, scenarioId: string, downloadId: string, options?: AxiosRequestConfig): Promise<import("axios").AxiosResponse<ScenarioDataDownloadInfo>>;
4159
+ /**
4160
+ *
4161
+ * @summary Get the Scenario permission by given role
4162
+ * @param {string} organizationId the Organization identifier
4163
+ * @param {string} workspaceId the Workspace identifier
4164
+ * @param {string} role the Role
4165
+ * @param {*} [options] Override http request option.
4166
+ * @throws {RequiredError}
4167
+ * @memberof ScenarioApi
4168
+ */
4169
+ getScenarioPermissions(organizationId: string, workspaceId: string, role: string, options?: AxiosRequestConfig): Promise<import("axios").AxiosResponse<string[]>>;
4170
+ /**
4171
+ *
4172
+ * @summary Get the Scenario security information
4173
+ * @param {string} organizationId the Organization identifier
4174
+ * @param {string} workspaceId the Workspace identifier
4175
+ * @param {string} scenarioId the Scenario identifier
4176
+ * @param {*} [options] Override http request option.
4177
+ * @throws {RequiredError}
4178
+ * @memberof ScenarioApi
4179
+ */
4180
+ getScenarioSecurity(organizationId: string, workspaceId: string, scenarioId: string, options?: AxiosRequestConfig): Promise<import("axios").AxiosResponse<ScenarioSecurity>>;
4181
+ /**
4182
+ *
4183
+ * @summary Get the Scenario security users list
4184
+ * @param {string} organizationId the Organization identifier
4185
+ * @param {string} workspaceId the Workspace identifier
4186
+ * @param {string} scenarioId the Scenario identifier
4187
+ * @param {*} [options] Override http request option.
4188
+ * @throws {RequiredError}
4189
+ * @memberof ScenarioApi
4190
+ */
4191
+ getScenarioSecurityUsers(organizationId: string, workspaceId: string, scenarioId: string, options?: AxiosRequestConfig): Promise<import("axios").AxiosResponse<string[]>>;
3794
4192
  /**
3795
4193
  *
3796
4194
  * @summary Get the validation status of an scenario
@@ -3825,27 +4223,28 @@ export declare class ScenarioApi extends BaseAPI {
3825
4223
  removeAllScenarioParameterValues(organizationId: string, workspaceId: string, scenarioId: string, options?: AxiosRequestConfig): Promise<import("axios").AxiosResponse<void>>;
3826
4224
  /**
3827
4225
  *
3828
- * @summary Remove all users from the Scenario specified
4226
+ * @summary Remove the specified access from the given Organization Scenario
3829
4227
  * @param {string} organizationId the Organization identifier
3830
4228
  * @param {string} workspaceId the Workspace identifier
3831
4229
  * @param {string} scenarioId the Scenario identifier
4230
+ * @param {string} identityId the User identifier
3832
4231
  * @param {*} [options] Override http request option.
3833
4232
  * @throws {RequiredError}
3834
4233
  * @memberof ScenarioApi
3835
4234
  */
3836
- removeAllUsersOfScenario(organizationId: string, workspaceId: string, scenarioId: string, options?: AxiosRequestConfig): Promise<import("axios").AxiosResponse<void>>;
4235
+ removeScenarioAccessControl(organizationId: string, workspaceId: string, scenarioId: string, identityId: string, options?: AxiosRequestConfig): Promise<import("axios").AxiosResponse<void>>;
3837
4236
  /**
3838
4237
  *
3839
- * @summary Remove the specified user from the given Scenario
4238
+ * @summary set the Scenario default security
3840
4239
  * @param {string} organizationId the Organization identifier
3841
4240
  * @param {string} workspaceId the Workspace identifier
3842
4241
  * @param {string} scenarioId the Scenario identifier
3843
- * @param {string} userId the User identifier
4242
+ * @param {string} body the new Scenario default security.
3844
4243
  * @param {*} [options] Override http request option.
3845
4244
  * @throws {RequiredError}
3846
4245
  * @memberof ScenarioApi
3847
4246
  */
3848
- removeUserFromScenario(organizationId: string, workspaceId: string, scenarioId: string, userId: string, options?: AxiosRequestConfig): Promise<import("axios").AxiosResponse<void>>;
4247
+ setScenarioDefaultSecurity(organizationId: string, workspaceId: string, scenarioId: string, body: string, options?: AxiosRequestConfig): Promise<import("axios").AxiosResponse<ScenarioSecurity>>;
3849
4248
  /**
3850
4249
  *
3851
4250
  * @summary Update a scenario
@@ -3864,6 +4263,24 @@ export declare class ScenarioApi extends BaseAPI {
3864
4263
  * @export
3865
4264
  */
3866
4265
  export declare const ScenariorunApiAxiosParamCreator: (configuration?: Configuration) => {
4266
+ /**
4267
+ *
4268
+ * @summary Delete all historical ScenarioRuns in the database
4269
+ * @param {string} organizationId the Organization identifier
4270
+ * @param {*} [options] Override http request option.
4271
+ * @throws {RequiredError}
4272
+ */
4273
+ deleteHistoricalDataOrganization: (organizationId: string, options?: AxiosRequestConfig) => Promise<RequestArgs>;
4274
+ /**
4275
+ *
4276
+ * @summary Delete all historical ScenarioRuns for the Scenario
4277
+ * @param {string} organizationId the Organization identifier
4278
+ * @param {string} workspaceId the Workspace identifier
4279
+ * @param {string} scenarioId the Scenario identifier
4280
+ * @param {*} [options] Override http request option.
4281
+ * @throws {RequiredError}
4282
+ */
4283
+ deleteHistoricalScenarioRunsByScenario: (organizationId: string, workspaceId: string, scenarioId: string, options?: AxiosRequestConfig) => Promise<RequestArgs>;
3867
4284
  /**
3868
4285
  *
3869
4286
  * @summary Delete a scenariorun
@@ -3971,6 +4388,24 @@ export declare const ScenariorunApiAxiosParamCreator: (configuration?: Configura
3971
4388
  * @export
3972
4389
  */
3973
4390
  export declare const ScenariorunApiFp: (configuration?: Configuration) => {
4391
+ /**
4392
+ *
4393
+ * @summary Delete all historical ScenarioRuns in the database
4394
+ * @param {string} organizationId the Organization identifier
4395
+ * @param {*} [options] Override http request option.
4396
+ * @throws {RequiredError}
4397
+ */
4398
+ deleteHistoricalDataOrganization(organizationId: string, options?: AxiosRequestConfig): Promise<(axios?: AxiosInstance, basePath?: string) => AxiosPromise<void>>;
4399
+ /**
4400
+ *
4401
+ * @summary Delete all historical ScenarioRuns for the Scenario
4402
+ * @param {string} organizationId the Organization identifier
4403
+ * @param {string} workspaceId the Workspace identifier
4404
+ * @param {string} scenarioId the Scenario identifier
4405
+ * @param {*} [options] Override http request option.
4406
+ * @throws {RequiredError}
4407
+ */
4408
+ deleteHistoricalScenarioRunsByScenario(organizationId: string, workspaceId: string, scenarioId: string, options?: AxiosRequestConfig): Promise<(axios?: AxiosInstance, basePath?: string) => AxiosPromise<void>>;
3974
4409
  /**
3975
4410
  *
3976
4411
  * @summary Delete a scenariorun
@@ -4078,6 +4513,24 @@ export declare const ScenariorunApiFp: (configuration?: Configuration) => {
4078
4513
  * @export
4079
4514
  */
4080
4515
  export declare const ScenariorunApiFactory: (configuration?: Configuration, basePath?: string, axios?: AxiosInstance) => {
4516
+ /**
4517
+ *
4518
+ * @summary Delete all historical ScenarioRuns in the database
4519
+ * @param {string} organizationId the Organization identifier
4520
+ * @param {*} [options] Override http request option.
4521
+ * @throws {RequiredError}
4522
+ */
4523
+ deleteHistoricalDataOrganization(organizationId: string, options?: any): AxiosPromise<void>;
4524
+ /**
4525
+ *
4526
+ * @summary Delete all historical ScenarioRuns for the Scenario
4527
+ * @param {string} organizationId the Organization identifier
4528
+ * @param {string} workspaceId the Workspace identifier
4529
+ * @param {string} scenarioId the Scenario identifier
4530
+ * @param {*} [options] Override http request option.
4531
+ * @throws {RequiredError}
4532
+ */
4533
+ deleteHistoricalScenarioRunsByScenario(organizationId: string, workspaceId: string, scenarioId: string, options?: any): AxiosPromise<void>;
4081
4534
  /**
4082
4535
  *
4083
4536
  * @summary Delete a scenariorun
@@ -4187,6 +4640,26 @@ export declare const ScenariorunApiFactory: (configuration?: Configuration, base
4187
4640
  * @extends {BaseAPI}
4188
4641
  */
4189
4642
  export declare class ScenariorunApi extends BaseAPI {
4643
+ /**
4644
+ *
4645
+ * @summary Delete all historical ScenarioRuns in the database
4646
+ * @param {string} organizationId the Organization identifier
4647
+ * @param {*} [options] Override http request option.
4648
+ * @throws {RequiredError}
4649
+ * @memberof ScenariorunApi
4650
+ */
4651
+ deleteHistoricalDataOrganization(organizationId: string, options?: AxiosRequestConfig): Promise<import("axios").AxiosResponse<void>>;
4652
+ /**
4653
+ *
4654
+ * @summary Delete all historical ScenarioRuns for the Scenario
4655
+ * @param {string} organizationId the Organization identifier
4656
+ * @param {string} workspaceId the Workspace identifier
4657
+ * @param {string} scenarioId the Scenario identifier
4658
+ * @param {*} [options] Override http request option.
4659
+ * @throws {RequiredError}
4660
+ * @memberof ScenariorunApi
4661
+ */
4662
+ deleteHistoricalScenarioRunsByScenario(organizationId: string, workspaceId: string, scenarioId: string, options?: AxiosRequestConfig): Promise<import("axios").AxiosResponse<void>>;
4190
4663
  /**
4191
4664
  *
4192
4665
  * @summary Delete a scenariorun
@@ -5655,14 +6128,14 @@ export declare class ValidatorApi extends BaseAPI {
5655
6128
  export declare const WorkspaceApiAxiosParamCreator: (configuration?: Configuration) => {
5656
6129
  /**
5657
6130
  *
5658
- * @summary Add (or replace) users to the Workspace specified
6131
+ * @summary add a control acccess to the Workspace
5659
6132
  * @param {string} organizationId the Organization identifier
5660
6133
  * @param {string} workspaceId the Workspace identifier
5661
- * @param {Array<WorkspaceUser>} workspaceUser the Users to add. Any User with the same ID is overwritten
6134
+ * @param {WorkspaceAccessControl} workspaceAccessControl the new Workspace security access to add.
5662
6135
  * @param {*} [options] Override http request option.
5663
6136
  * @throws {RequiredError}
5664
6137
  */
5665
- addOrReplaceUsersInOrganizationWorkspace: (organizationId: string, workspaceId: string, workspaceUser: Array<WorkspaceUser>, options?: AxiosRequestConfig) => Promise<RequestArgs>;
6138
+ addWorkspaceAccessControl: (organizationId: string, workspaceId: string, workspaceAccessControl: WorkspaceAccessControl, options?: AxiosRequestConfig) => Promise<RequestArgs>;
5666
6139
  /**
5667
6140
  *
5668
6141
  * @summary Create a new workspace
@@ -5738,23 +6211,62 @@ export declare const WorkspaceApiAxiosParamCreator: (configuration?: Configurati
5738
6211
  findWorkspaceById: (organizationId: string, workspaceId: string, options?: AxiosRequestConfig) => Promise<RequestArgs>;
5739
6212
  /**
5740
6213
  *
5741
- * @summary Remove all users from the Workspace specified
6214
+ * @summary get a control acccess for the Workspace
5742
6215
  * @param {string} organizationId the Organization identifier
5743
6216
  * @param {string} workspaceId the Workspace identifier
6217
+ * @param {string} identityId the User identifier
5744
6218
  * @param {*} [options] Override http request option.
5745
6219
  * @throws {RequiredError}
5746
6220
  */
5747
- removeAllUsersOfWorkspace: (organizationId: string, workspaceId: string, options?: AxiosRequestConfig) => Promise<RequestArgs>;
6221
+ getWorkspaceAccessControl: (organizationId: string, workspaceId: string, identityId: string, options?: AxiosRequestConfig) => Promise<RequestArgs>;
5748
6222
  /**
5749
6223
  *
5750
- * @summary Remove the specified user from the given Organization Workspace
6224
+ * @summary Get the Workspace permission by given role
5751
6225
  * @param {string} organizationId the Organization identifier
5752
6226
  * @param {string} workspaceId the Workspace identifier
5753
- * @param {string} userId the User identifier
6227
+ * @param {string} role the Role
6228
+ * @param {*} [options] Override http request option.
6229
+ * @throws {RequiredError}
6230
+ */
6231
+ getWorkspacePermissions: (organizationId: string, workspaceId: string, role: string, options?: AxiosRequestConfig) => Promise<RequestArgs>;
6232
+ /**
6233
+ *
6234
+ * @summary Get the Workspace security information
6235
+ * @param {string} organizationId the Organization identifier
6236
+ * @param {string} workspaceId the Workspace identifier
6237
+ * @param {*} [options] Override http request option.
6238
+ * @throws {RequiredError}
6239
+ */
6240
+ getWorkspaceSecurity: (organizationId: string, workspaceId: string, options?: AxiosRequestConfig) => Promise<RequestArgs>;
6241
+ /**
6242
+ *
6243
+ * @summary Get the Workspace security users list
6244
+ * @param {string} organizationId the Organization identifier
6245
+ * @param {string} workspaceId the Workspace identifier
6246
+ * @param {*} [options] Override http request option.
6247
+ * @throws {RequiredError}
6248
+ */
6249
+ getWorkspaceSecurityUsers: (organizationId: string, workspaceId: string, options?: AxiosRequestConfig) => Promise<RequestArgs>;
6250
+ /**
6251
+ *
6252
+ * @summary Remove the specified access from the given Organization Workspace
6253
+ * @param {string} organizationId the Organization identifier
6254
+ * @param {string} workspaceId the Workspace identifier
6255
+ * @param {string} identityId the User identifier
5754
6256
  * @param {*} [options] Override http request option.
5755
6257
  * @throws {RequiredError}
5756
6258
  */
5757
- removeUserFromOrganizationWorkspace: (organizationId: string, workspaceId: string, userId: string, options?: AxiosRequestConfig) => Promise<RequestArgs>;
6259
+ removeWorkspaceAccessControl: (organizationId: string, workspaceId: string, identityId: string, options?: AxiosRequestConfig) => Promise<RequestArgs>;
6260
+ /**
6261
+ *
6262
+ * @summary set the Workspace default security
6263
+ * @param {string} organizationId the Organization identifier
6264
+ * @param {string} workspaceId the Workspace identifier
6265
+ * @param {string} body the new Workspace default security.
6266
+ * @param {*} [options] Override http request option.
6267
+ * @throws {RequiredError}
6268
+ */
6269
+ setWorkspaceDefaultSecurity: (organizationId: string, workspaceId: string, body: string, options?: AxiosRequestConfig) => Promise<RequestArgs>;
5758
6270
  /**
5759
6271
  *
5760
6272
  * @summary Update a workspace
@@ -5785,14 +6297,14 @@ export declare const WorkspaceApiAxiosParamCreator: (configuration?: Configurati
5785
6297
  export declare const WorkspaceApiFp: (configuration?: Configuration) => {
5786
6298
  /**
5787
6299
  *
5788
- * @summary Add (or replace) users to the Workspace specified
6300
+ * @summary add a control acccess to the Workspace
5789
6301
  * @param {string} organizationId the Organization identifier
5790
6302
  * @param {string} workspaceId the Workspace identifier
5791
- * @param {Array<WorkspaceUser>} workspaceUser the Users to add. Any User with the same ID is overwritten
6303
+ * @param {WorkspaceAccessControl} workspaceAccessControl the new Workspace security access to add.
5792
6304
  * @param {*} [options] Override http request option.
5793
6305
  * @throws {RequiredError}
5794
6306
  */
5795
- addOrReplaceUsersInOrganizationWorkspace(organizationId: string, workspaceId: string, workspaceUser: Array<WorkspaceUser>, options?: AxiosRequestConfig): Promise<(axios?: AxiosInstance, basePath?: string) => AxiosPromise<Array<WorkspaceUser>>>;
6307
+ addWorkspaceAccessControl(organizationId: string, workspaceId: string, workspaceAccessControl: WorkspaceAccessControl, options?: AxiosRequestConfig): Promise<(axios?: AxiosInstance, basePath?: string) => AxiosPromise<WorkspaceAccessControl>>;
5796
6308
  /**
5797
6309
  *
5798
6310
  * @summary Create a new workspace
@@ -5868,23 +6380,62 @@ export declare const WorkspaceApiFp: (configuration?: Configuration) => {
5868
6380
  findWorkspaceById(organizationId: string, workspaceId: string, options?: AxiosRequestConfig): Promise<(axios?: AxiosInstance, basePath?: string) => AxiosPromise<Workspace>>;
5869
6381
  /**
5870
6382
  *
5871
- * @summary Remove all users from the Workspace specified
6383
+ * @summary get a control acccess for the Workspace
5872
6384
  * @param {string} organizationId the Organization identifier
5873
6385
  * @param {string} workspaceId the Workspace identifier
6386
+ * @param {string} identityId the User identifier
5874
6387
  * @param {*} [options] Override http request option.
5875
6388
  * @throws {RequiredError}
5876
6389
  */
5877
- removeAllUsersOfWorkspace(organizationId: string, workspaceId: string, options?: AxiosRequestConfig): Promise<(axios?: AxiosInstance, basePath?: string) => AxiosPromise<void>>;
6390
+ getWorkspaceAccessControl(organizationId: string, workspaceId: string, identityId: string, options?: AxiosRequestConfig): Promise<(axios?: AxiosInstance, basePath?: string) => AxiosPromise<WorkspaceAccessControl>>;
5878
6391
  /**
5879
6392
  *
5880
- * @summary Remove the specified user from the given Organization Workspace
6393
+ * @summary Get the Workspace permission by given role
6394
+ * @param {string} organizationId the Organization identifier
6395
+ * @param {string} workspaceId the Workspace identifier
6396
+ * @param {string} role the Role
6397
+ * @param {*} [options] Override http request option.
6398
+ * @throws {RequiredError}
6399
+ */
6400
+ getWorkspacePermissions(organizationId: string, workspaceId: string, role: string, options?: AxiosRequestConfig): Promise<(axios?: AxiosInstance, basePath?: string) => AxiosPromise<Array<string>>>;
6401
+ /**
6402
+ *
6403
+ * @summary Get the Workspace security information
5881
6404
  * @param {string} organizationId the Organization identifier
5882
6405
  * @param {string} workspaceId the Workspace identifier
5883
- * @param {string} userId the User identifier
5884
6406
  * @param {*} [options] Override http request option.
5885
6407
  * @throws {RequiredError}
5886
6408
  */
5887
- removeUserFromOrganizationWorkspace(organizationId: string, workspaceId: string, userId: string, options?: AxiosRequestConfig): Promise<(axios?: AxiosInstance, basePath?: string) => AxiosPromise<void>>;
6409
+ getWorkspaceSecurity(organizationId: string, workspaceId: string, options?: AxiosRequestConfig): Promise<(axios?: AxiosInstance, basePath?: string) => AxiosPromise<WorkspaceSecurity>>;
6410
+ /**
6411
+ *
6412
+ * @summary Get the Workspace security users list
6413
+ * @param {string} organizationId the Organization identifier
6414
+ * @param {string} workspaceId the Workspace identifier
6415
+ * @param {*} [options] Override http request option.
6416
+ * @throws {RequiredError}
6417
+ */
6418
+ getWorkspaceSecurityUsers(organizationId: string, workspaceId: string, options?: AxiosRequestConfig): Promise<(axios?: AxiosInstance, basePath?: string) => AxiosPromise<Array<string>>>;
6419
+ /**
6420
+ *
6421
+ * @summary Remove the specified access from the given Organization Workspace
6422
+ * @param {string} organizationId the Organization identifier
6423
+ * @param {string} workspaceId the Workspace identifier
6424
+ * @param {string} identityId the User identifier
6425
+ * @param {*} [options] Override http request option.
6426
+ * @throws {RequiredError}
6427
+ */
6428
+ removeWorkspaceAccessControl(organizationId: string, workspaceId: string, identityId: string, options?: AxiosRequestConfig): Promise<(axios?: AxiosInstance, basePath?: string) => AxiosPromise<void>>;
6429
+ /**
6430
+ *
6431
+ * @summary set the Workspace default security
6432
+ * @param {string} organizationId the Organization identifier
6433
+ * @param {string} workspaceId the Workspace identifier
6434
+ * @param {string} body the new Workspace default security.
6435
+ * @param {*} [options] Override http request option.
6436
+ * @throws {RequiredError}
6437
+ */
6438
+ setWorkspaceDefaultSecurity(organizationId: string, workspaceId: string, body: string, options?: AxiosRequestConfig): Promise<(axios?: AxiosInstance, basePath?: string) => AxiosPromise<WorkspaceSecurity>>;
5888
6439
  /**
5889
6440
  *
5890
6441
  * @summary Update a workspace
@@ -5915,14 +6466,14 @@ export declare const WorkspaceApiFp: (configuration?: Configuration) => {
5915
6466
  export declare const WorkspaceApiFactory: (configuration?: Configuration, basePath?: string, axios?: AxiosInstance) => {
5916
6467
  /**
5917
6468
  *
5918
- * @summary Add (or replace) users to the Workspace specified
6469
+ * @summary add a control acccess to the Workspace
5919
6470
  * @param {string} organizationId the Organization identifier
5920
6471
  * @param {string} workspaceId the Workspace identifier
5921
- * @param {Array<WorkspaceUser>} workspaceUser the Users to add. Any User with the same ID is overwritten
6472
+ * @param {WorkspaceAccessControl} workspaceAccessControl the new Workspace security access to add.
5922
6473
  * @param {*} [options] Override http request option.
5923
6474
  * @throws {RequiredError}
5924
6475
  */
5925
- addOrReplaceUsersInOrganizationWorkspace(organizationId: string, workspaceId: string, workspaceUser: Array<WorkspaceUser>, options?: any): AxiosPromise<Array<WorkspaceUser>>;
6476
+ addWorkspaceAccessControl(organizationId: string, workspaceId: string, workspaceAccessControl: WorkspaceAccessControl, options?: any): AxiosPromise<WorkspaceAccessControl>;
5926
6477
  /**
5927
6478
  *
5928
6479
  * @summary Create a new workspace
@@ -5998,23 +6549,62 @@ export declare const WorkspaceApiFactory: (configuration?: Configuration, basePa
5998
6549
  findWorkspaceById(organizationId: string, workspaceId: string, options?: any): AxiosPromise<Workspace>;
5999
6550
  /**
6000
6551
  *
6001
- * @summary Remove all users from the Workspace specified
6552
+ * @summary get a control acccess for the Workspace
6002
6553
  * @param {string} organizationId the Organization identifier
6003
6554
  * @param {string} workspaceId the Workspace identifier
6555
+ * @param {string} identityId the User identifier
6004
6556
  * @param {*} [options] Override http request option.
6005
6557
  * @throws {RequiredError}
6006
6558
  */
6007
- removeAllUsersOfWorkspace(organizationId: string, workspaceId: string, options?: any): AxiosPromise<void>;
6559
+ getWorkspaceAccessControl(organizationId: string, workspaceId: string, identityId: string, options?: any): AxiosPromise<WorkspaceAccessControl>;
6008
6560
  /**
6009
6561
  *
6010
- * @summary Remove the specified user from the given Organization Workspace
6562
+ * @summary Get the Workspace permission by given role
6563
+ * @param {string} organizationId the Organization identifier
6564
+ * @param {string} workspaceId the Workspace identifier
6565
+ * @param {string} role the Role
6566
+ * @param {*} [options] Override http request option.
6567
+ * @throws {RequiredError}
6568
+ */
6569
+ getWorkspacePermissions(organizationId: string, workspaceId: string, role: string, options?: any): AxiosPromise<Array<string>>;
6570
+ /**
6571
+ *
6572
+ * @summary Get the Workspace security information
6011
6573
  * @param {string} organizationId the Organization identifier
6012
6574
  * @param {string} workspaceId the Workspace identifier
6013
- * @param {string} userId the User identifier
6014
6575
  * @param {*} [options] Override http request option.
6015
6576
  * @throws {RequiredError}
6016
6577
  */
6017
- removeUserFromOrganizationWorkspace(organizationId: string, workspaceId: string, userId: string, options?: any): AxiosPromise<void>;
6578
+ getWorkspaceSecurity(organizationId: string, workspaceId: string, options?: any): AxiosPromise<WorkspaceSecurity>;
6579
+ /**
6580
+ *
6581
+ * @summary Get the Workspace security users list
6582
+ * @param {string} organizationId the Organization identifier
6583
+ * @param {string} workspaceId the Workspace identifier
6584
+ * @param {*} [options] Override http request option.
6585
+ * @throws {RequiredError}
6586
+ */
6587
+ getWorkspaceSecurityUsers(organizationId: string, workspaceId: string, options?: any): AxiosPromise<Array<string>>;
6588
+ /**
6589
+ *
6590
+ * @summary Remove the specified access from the given Organization Workspace
6591
+ * @param {string} organizationId the Organization identifier
6592
+ * @param {string} workspaceId the Workspace identifier
6593
+ * @param {string} identityId the User identifier
6594
+ * @param {*} [options] Override http request option.
6595
+ * @throws {RequiredError}
6596
+ */
6597
+ removeWorkspaceAccessControl(organizationId: string, workspaceId: string, identityId: string, options?: any): AxiosPromise<void>;
6598
+ /**
6599
+ *
6600
+ * @summary set the Workspace default security
6601
+ * @param {string} organizationId the Organization identifier
6602
+ * @param {string} workspaceId the Workspace identifier
6603
+ * @param {string} body the new Workspace default security.
6604
+ * @param {*} [options] Override http request option.
6605
+ * @throws {RequiredError}
6606
+ */
6607
+ setWorkspaceDefaultSecurity(organizationId: string, workspaceId: string, body: string, options?: any): AxiosPromise<WorkspaceSecurity>;
6018
6608
  /**
6019
6609
  *
6020
6610
  * @summary Update a workspace
@@ -6047,15 +6637,15 @@ export declare const WorkspaceApiFactory: (configuration?: Configuration, basePa
6047
6637
  export declare class WorkspaceApi extends BaseAPI {
6048
6638
  /**
6049
6639
  *
6050
- * @summary Add (or replace) users to the Workspace specified
6640
+ * @summary add a control acccess to the Workspace
6051
6641
  * @param {string} organizationId the Organization identifier
6052
6642
  * @param {string} workspaceId the Workspace identifier
6053
- * @param {Array<WorkspaceUser>} workspaceUser the Users to add. Any User with the same ID is overwritten
6643
+ * @param {WorkspaceAccessControl} workspaceAccessControl the new Workspace security access to add.
6054
6644
  * @param {*} [options] Override http request option.
6055
6645
  * @throws {RequiredError}
6056
6646
  * @memberof WorkspaceApi
6057
6647
  */
6058
- addOrReplaceUsersInOrganizationWorkspace(organizationId: string, workspaceId: string, workspaceUser: Array<WorkspaceUser>, options?: AxiosRequestConfig): Promise<import("axios").AxiosResponse<WorkspaceUser[]>>;
6648
+ addWorkspaceAccessControl(organizationId: string, workspaceId: string, workspaceAccessControl: WorkspaceAccessControl, options?: AxiosRequestConfig): Promise<import("axios").AxiosResponse<WorkspaceAccessControl>>;
6059
6649
  /**
6060
6650
  *
6061
6651
  * @summary Create a new workspace
@@ -6139,25 +6729,68 @@ export declare class WorkspaceApi extends BaseAPI {
6139
6729
  findWorkspaceById(organizationId: string, workspaceId: string, options?: AxiosRequestConfig): Promise<import("axios").AxiosResponse<Workspace>>;
6140
6730
  /**
6141
6731
  *
6142
- * @summary Remove all users from the Workspace specified
6732
+ * @summary get a control acccess for the Workspace
6143
6733
  * @param {string} organizationId the Organization identifier
6144
6734
  * @param {string} workspaceId the Workspace identifier
6735
+ * @param {string} identityId the User identifier
6145
6736
  * @param {*} [options] Override http request option.
6146
6737
  * @throws {RequiredError}
6147
6738
  * @memberof WorkspaceApi
6148
6739
  */
6149
- removeAllUsersOfWorkspace(organizationId: string, workspaceId: string, options?: AxiosRequestConfig): Promise<import("axios").AxiosResponse<void>>;
6740
+ getWorkspaceAccessControl(organizationId: string, workspaceId: string, identityId: string, options?: AxiosRequestConfig): Promise<import("axios").AxiosResponse<WorkspaceAccessControl>>;
6150
6741
  /**
6151
6742
  *
6152
- * @summary Remove the specified user from the given Organization Workspace
6743
+ * @summary Get the Workspace permission by given role
6153
6744
  * @param {string} organizationId the Organization identifier
6154
6745
  * @param {string} workspaceId the Workspace identifier
6155
- * @param {string} userId the User identifier
6746
+ * @param {string} role the Role
6747
+ * @param {*} [options] Override http request option.
6748
+ * @throws {RequiredError}
6749
+ * @memberof WorkspaceApi
6750
+ */
6751
+ getWorkspacePermissions(organizationId: string, workspaceId: string, role: string, options?: AxiosRequestConfig): Promise<import("axios").AxiosResponse<string[]>>;
6752
+ /**
6753
+ *
6754
+ * @summary Get the Workspace security information
6755
+ * @param {string} organizationId the Organization identifier
6756
+ * @param {string} workspaceId the Workspace identifier
6757
+ * @param {*} [options] Override http request option.
6758
+ * @throws {RequiredError}
6759
+ * @memberof WorkspaceApi
6760
+ */
6761
+ getWorkspaceSecurity(organizationId: string, workspaceId: string, options?: AxiosRequestConfig): Promise<import("axios").AxiosResponse<WorkspaceSecurity>>;
6762
+ /**
6763
+ *
6764
+ * @summary Get the Workspace security users list
6765
+ * @param {string} organizationId the Organization identifier
6766
+ * @param {string} workspaceId the Workspace identifier
6767
+ * @param {*} [options] Override http request option.
6768
+ * @throws {RequiredError}
6769
+ * @memberof WorkspaceApi
6770
+ */
6771
+ getWorkspaceSecurityUsers(organizationId: string, workspaceId: string, options?: AxiosRequestConfig): Promise<import("axios").AxiosResponse<string[]>>;
6772
+ /**
6773
+ *
6774
+ * @summary Remove the specified access from the given Organization Workspace
6775
+ * @param {string} organizationId the Organization identifier
6776
+ * @param {string} workspaceId the Workspace identifier
6777
+ * @param {string} identityId the User identifier
6778
+ * @param {*} [options] Override http request option.
6779
+ * @throws {RequiredError}
6780
+ * @memberof WorkspaceApi
6781
+ */
6782
+ removeWorkspaceAccessControl(organizationId: string, workspaceId: string, identityId: string, options?: AxiosRequestConfig): Promise<import("axios").AxiosResponse<void>>;
6783
+ /**
6784
+ *
6785
+ * @summary set the Workspace default security
6786
+ * @param {string} organizationId the Organization identifier
6787
+ * @param {string} workspaceId the Workspace identifier
6788
+ * @param {string} body the new Workspace default security.
6156
6789
  * @param {*} [options] Override http request option.
6157
6790
  * @throws {RequiredError}
6158
6791
  * @memberof WorkspaceApi
6159
6792
  */
6160
- removeUserFromOrganizationWorkspace(organizationId: string, workspaceId: string, userId: string, options?: AxiosRequestConfig): Promise<import("axios").AxiosResponse<void>>;
6793
+ setWorkspaceDefaultSecurity(organizationId: string, workspaceId: string, body: string, options?: AxiosRequestConfig): Promise<import("axios").AxiosResponse<WorkspaceSecurity>>;
6161
6794
  /**
6162
6795
  *
6163
6796
  * @summary Update a workspace