@sonatype/nexus-iq-api-client 0.177.1 → 0.184.0

package/dist/esm/apis/ReportsApi.js

@@ -4,7 +4,7 @@
  * Sonatype Lifecycle Public REST API
  * No description provided (generated by Openapi Generator https://github.com/openapitools/openapi-generator)
  *
- * The version of the OpenAPI document: 1.177.0-01
+ * The version of the OpenAPI document: 1.184.0-01
  *
  *
  * NOTE: This class is auto generated by OpenAPI Generator (https://openapi-generator.tech).
@@ -27,6 +27,7 @@ import { ApiApplicationReportDTOV2FromJSON, ApiComponentWaiversDTOFromJSON, ApiC
  */
 export class ReportsApi extends runtime.BaseAPI {
     /**
+     * Use this method to view all application reports for applications to which  you have access.   Permissions required: View IQ Elements
      */
     getAll1Raw(initOverrides) {
         return __awaiter(this, void 0, void 0, function* () {
@@ -45,6 +46,7 @@ export class ReportsApi extends runtime.BaseAPI {
         });
     }
     /**
+     * Use this method to view all application reports for applications to which  you have access.   Permissions required: View IQ Elements
      */
     getAll1(initOverrides) {
         return __awaiter(this, void 0, void 0, function* () {
@@ -53,11 +55,12 @@ export class ReportsApi extends runtime.BaseAPI {
         });
     }
     /**
+     * Use this method to retrieve the application reports for the specified application Id. You can view application reports only for applications to which you have access.   Permissions required: View IQ Elements
      */
     getByApplicationIdRaw(requestParameters, initOverrides) {
         return __awaiter(this, void 0, void 0, function* () {
-            if (requestParameters.applicationId === null || requestParameters.applicationId === undefined) {
-                throw new runtime.RequiredError('applicationId', 'Required parameter requestParameters.applicationId was null or undefined when calling getByApplicationId.');
+            if (requestParameters['applicationId'] == null) {
+                throw new runtime.RequiredError('applicationId', 'Required parameter "applicationId" was null or undefined when calling getByApplicationId().');
             }
             const queryParameters = {};
             const headerParameters = {};
@@ -65,7 +68,7 @@ export class ReportsApi extends runtime.BaseAPI {
                 headerParameters["Authorization"] = "Basic " + btoa(this.configuration.username + ":" + this.configuration.password);
             }
             const response = yield this.request({
-                path: `/api/v2/reports/applications/{applicationId}`.replace(`{${"applicationId"}}`, encodeURIComponent(String(requestParameters.applicationId))),
+                path: `/api/v2/reports/applications/{applicationId}`.replace(`{${"applicationId"}}`, encodeURIComponent(String(requestParameters['applicationId']))),
                 method: 'GET',
                 headers: headerParameters,
                 query: queryParameters,
@@ -74,6 +77,7 @@ export class ReportsApi extends runtime.BaseAPI {
         });
     }
     /**
+     * Use this method to retrieve the application reports for the specified application Id. You can view application reports only for applications to which you have access.   Permissions required: View IQ Elements
      */
     getByApplicationId(requestParameters, initOverrides) {
         return __awaiter(this, void 0, void 0, function* () {
@@ -82,6 +86,7 @@ export class ReportsApi extends runtime.BaseAPI {
         });
     }
     /**
+     * Use this method to retrieve all repository components that are quarantined. The response contains violation details and the quarantine Id of the component. Use the quarantine Id,  to release the component from quarantine, using the Release from Quarantine REST API.   Permissions required: View IQ Elements and access to the specific repository.
      */
     getComponentsInQuarantineRaw(initOverrides) {
         return __awaiter(this, void 0, void 0, function* () {
@@ -100,6 +105,7 @@ export class ReportsApi extends runtime.BaseAPI {
         });
     }
     /**
+     * Use this method to retrieve all repository components that are quarantined. The response contains violation details and the quarantine Id of the component. Use the quarantine Id,  to release the component from quarantine, using the Release from Quarantine REST API.   Permissions required: View IQ Elements and access to the specific repository.
      */
     getComponentsInQuarantine(initOverrides) {
         return __awaiter(this, void 0, void 0, function* () {
@@ -108,12 +114,13 @@ export class ReportsApi extends runtime.BaseAPI {
         });
     }
     /**
+     * Use this method to retrieve existing policy waivers by components. For an up-to-date response, ensure that all application and repository reports are current and contain the most recent re-evaluation data.<p>You can specify the format/ecosystem of the component for a filtered result. <p>Permissions required: View IQ Elements and access to the specific applications and repositories
      */
     getComponentsWithWaiversRaw(requestParameters, initOverrides) {
         return __awaiter(this, void 0, void 0, function* () {
             const queryParameters = {};
-            if (requestParameters.format !== undefined) {
-                queryParameters['format'] = requestParameters.format;
+            if (requestParameters['format'] != null) {
+                queryParameters['format'] = requestParameters['format'];
             }
             const headerParameters = {};
             if (this.configuration && (this.configuration.username !== undefined || this.configuration.password !== undefined)) {
@@ -129,14 +136,16 @@ export class ReportsApi extends runtime.BaseAPI {
         });
     }
     /**
+     * Use this method to retrieve existing policy waivers by components. For an up-to-date response, ensure that all application and repository reports are current and contain the most recent re-evaluation data.<p>You can specify the format/ecosystem of the component for a filtered result. <p>Permissions required: View IQ Elements and access to the specific applications and repositories
      */
-    getComponentsWithWaivers(requestParameters = {}, initOverrides) {
-        return __awaiter(this, void 0, void 0, function* () {
+    getComponentsWithWaivers() {
+        return __awaiter(this, arguments, void 0, function* (requestParameters = {}, initOverrides) {
             const response = yield this.getComponentsWithWaiversRaw(requestParameters, initOverrides);
             return yield response.value();
         });
     }
     /**
+     * Use this method to retrieve metrics data such as policy evaluation metrics, violation and remediation metrics aggregated monthly or weekly.  Permissions required: View IQ Elements
      */
     getMetricsRaw(requestParameters, initOverrides) {
         return __awaiter(this, void 0, void 0, function* () {
@@ -151,38 +160,40 @@ export class ReportsApi extends runtime.BaseAPI {
                 method: 'POST',
                 headers: headerParameters,
                 query: queryParameters,
-                body: ApiMetricsReportingQueryDTOV2ToJSON(requestParameters.apiMetricsReportingQueryDTOV2),
+                body: ApiMetricsReportingQueryDTOV2ToJSON(requestParameters['apiMetricsReportingQueryDTOV2']),
             }, initOverrides);
             return new runtime.VoidApiResponse(response);
         });
     }
     /**
+     * Use this method to retrieve metrics data such as policy evaluation metrics, violation and remediation metrics aggregated monthly or weekly.  Permissions required: View IQ Elements
      */
-    getMetrics(requestParameters = {}, initOverrides) {
-        return __awaiter(this, void 0, void 0, function* () {
+    getMetrics() {
+        return __awaiter(this, arguments, void 0, function* (requestParameters = {}, initOverrides) {
             yield this.getMetricsRaw(requestParameters, initOverrides);
         });
     }
     /**
+     * Use this method to retrieve previous application scan reports (100 max.) for the specified application. You can view application reports only for applications to which you have access.    Permissions required: View IQ Elements
      */
     getReportHistoryForApplicationRaw(requestParameters, initOverrides) {
         return __awaiter(this, void 0, void 0, function* () {
-            if (requestParameters.applicationId === null || requestParameters.applicationId === undefined) {
-                throw new runtime.RequiredError('applicationId', 'Required parameter requestParameters.applicationId was null or undefined when calling getReportHistoryForApplication.');
+            if (requestParameters['applicationId'] == null) {
+                throw new runtime.RequiredError('applicationId', 'Required parameter "applicationId" was null or undefined when calling getReportHistoryForApplication().');
             }
             const queryParameters = {};
-            if (requestParameters.stage !== undefined) {
-                queryParameters['stage'] = requestParameters.stage;
+            if (requestParameters['stage'] != null) {
+                queryParameters['stage'] = requestParameters['stage'];
             }
-            if (requestParameters.limit !== undefined) {
-                queryParameters['limit'] = requestParameters.limit;
+            if (requestParameters['limit'] != null) {
+                queryParameters['limit'] = requestParameters['limit'];
             }
             const headerParameters = {};
             if (this.configuration && (this.configuration.username !== undefined || this.configuration.password !== undefined)) {
                 headerParameters["Authorization"] = "Basic " + btoa(this.configuration.username + ":" + this.configuration.password);
             }
             const response = yield this.request({
-                path: `/api/v2/reports/applications/{applicationId}/history`.replace(`{${"applicationId"}}`, encodeURIComponent(String(requestParameters.applicationId))),
+                path: `/api/v2/reports/applications/{applicationId}/history`.replace(`{${"applicationId"}}`, encodeURIComponent(String(requestParameters['applicationId']))),
                 method: 'GET',
                 headers: headerParameters,
                 query: queryParameters,
@@ -191,6 +202,7 @@ export class ReportsApi extends runtime.BaseAPI {
         });
     }
     /**
+     * Use this method to retrieve previous application scan reports (100 max.) for the specified application. You can view application reports only for applications to which you have access.    Permissions required: View IQ Elements
      */
     getReportHistoryForApplication(requestParameters, initOverrides) {
         return __awaiter(this, void 0, void 0, function* () {
@@ -199,6 +211,7 @@ export class ReportsApi extends runtime.BaseAPI {
         });
     }
     /**
+     * Stale waivers pose a risk because they could be applied unintentionally. Use this method to retrieve stale waivers to eliminate this risk for future application evaluations.   Permissions required: View IQ Elements. You can view stale waivers only for applications/repositories  to which you have access.
      */
     getStaleWaiversRaw(initOverrides) {
         return __awaiter(this, void 0, void 0, function* () {
@@ -217,6 +230,7 @@ export class ReportsApi extends runtime.BaseAPI {
         });
     }
     /**
+     * Stale waivers pose a risk because they could be applied unintentionally. Use this method to retrieve stale waivers to eliminate this risk for future application evaluations.   Permissions required: View IQ Elements. You can view stale waivers only for applications/repositories  to which you have access.
      */
     getStaleWaivers(initOverrides) {
         return __awaiter(this, void 0, void 0, function* () {

package/dist/esm/apis/RepositoriesApi.d.ts

@@ -2,7 +2,7 @@
  * Sonatype Lifecycle Public REST API
  * No description provided (generated by Openapi Generator https://github.com/openapitools/openapi-generator)
  *
- * The version of the OpenAPI document: 1.177.0-01
+ * The version of the OpenAPI document: 1.184.0-01
  *
  *
  * NOTE: This class is auto generated by OpenAPI Generator (https://openapi-generator.tech).

package/dist/esm/apis/RepositoriesApi.js

@@ -4,7 +4,7 @@
  * Sonatype Lifecycle Public REST API
  * No description provided (generated by Openapi Generator https://github.com/openapitools/openapi-generator)
  *
- * The version of the OpenAPI document: 1.177.0-01
+ * The version of the OpenAPI document: 1.184.0-01
  *
  *
  * NOTE: This class is auto generated by OpenAPI Generator (https://openapi-generator.tech).
@@ -30,11 +30,11 @@ export class RepositoriesApi extends runtime.BaseAPI {
      */
     getQuarantinedByPathRaw(requestParameters, initOverrides) {
         return __awaiter(this, void 0, void 0, function* () {
-            if (requestParameters.repositoryManagerInstanceId === null || requestParameters.repositoryManagerInstanceId === undefined) {
-                throw new runtime.RequiredError('repositoryManagerInstanceId', 'Required parameter requestParameters.repositoryManagerInstanceId was null or undefined when calling getQuarantinedByPath.');
+            if (requestParameters['repositoryManagerInstanceId'] == null) {
+                throw new runtime.RequiredError('repositoryManagerInstanceId', 'Required parameter "repositoryManagerInstanceId" was null or undefined when calling getQuarantinedByPath().');
             }
-            if (requestParameters.repositoryPublicId === null || requestParameters.repositoryPublicId === undefined) {
-                throw new runtime.RequiredError('repositoryPublicId', 'Required parameter requestParameters.repositoryPublicId was null or undefined when calling getQuarantinedByPath.');
+            if (requestParameters['repositoryPublicId'] == null) {
+                throw new runtime.RequiredError('repositoryPublicId', 'Required parameter "repositoryPublicId" was null or undefined when calling getQuarantinedByPath().');
             }
             const queryParameters = {};
             const headerParameters = {};
@@ -43,11 +43,11 @@ export class RepositoriesApi extends runtime.BaseAPI {
                 headerParameters["Authorization"] = "Basic " + btoa(this.configuration.username + ":" + this.configuration.password);
             }
             const response = yield this.request({
-                path: `/api/v2/repositories/{repositoryManagerInstanceId}/{repositoryPublicId}/components/quarantined/pathnames`.replace(`{${"repositoryManagerInstanceId"}}`, encodeURIComponent(String(requestParameters.repositoryManagerInstanceId))).replace(`{${"repositoryPublicId"}}`, encodeURIComponent(String(requestParameters.repositoryPublicId))),
+                path: `/api/v2/repositories/{repositoryManagerInstanceId}/{repositoryPublicId}/components/quarantined/pathnames`.replace(`{${"repositoryManagerInstanceId"}}`, encodeURIComponent(String(requestParameters['repositoryManagerInstanceId']))).replace(`{${"repositoryPublicId"}}`, encodeURIComponent(String(requestParameters['repositoryPublicId']))),
                 method: 'POST',
                 headers: headerParameters,
                 query: queryParameters,
-                body: requestParameters.requestBody,
+                body: requestParameters['requestBody'],
             }, initOverrides);
             return new runtime.JSONApiResponse(response, (jsonValue) => ApiRepositoryPathResponseDTOFromJSON(jsonValue));
         });
@@ -64,8 +64,8 @@ export class RepositoriesApi extends runtime.BaseAPI {
      */
     releaseQuarantineWithoutReEvalRaw(requestParameters, initOverrides) {
         return __awaiter(this, void 0, void 0, function* () {
-            if (requestParameters.quarantineId === null || requestParameters.quarantineId === undefined) {
-                throw new runtime.RequiredError('quarantineId', 'Required parameter requestParameters.quarantineId was null or undefined when calling releaseQuarantineWithoutReEval.');
+            if (requestParameters['quarantineId'] == null) {
+                throw new runtime.RequiredError('quarantineId', 'Required parameter "quarantineId" was null or undefined when calling releaseQuarantineWithoutReEval().');
             }
             const queryParameters = {};
             const headerParameters = {};
@@ -74,11 +74,11 @@ export class RepositoriesApi extends runtime.BaseAPI {
                 headerParameters["Authorization"] = "Basic " + btoa(this.configuration.username + ":" + this.configuration.password);
             }
             const response = yield this.request({
-                path: `/api/v2/repositories/quarantine/{quarantineId}/release`.replace(`{${"quarantineId"}}`, encodeURIComponent(String(requestParameters.quarantineId))),
+                path: `/api/v2/repositories/quarantine/{quarantineId}/release`.replace(`{${"quarantineId"}}`, encodeURIComponent(String(requestParameters['quarantineId']))),
                 method: 'POST',
                 headers: headerParameters,
                 query: queryParameters,
-                body: requestParameters.body,
+                body: requestParameters['body'],
             }, initOverrides);
             return new runtime.JSONApiResponse(response, (jsonValue) => ApiComponentReleasedFromQuarantineDTOFromJSON(jsonValue));
         });

package/dist/esm/apis/RoleMembershipsApi.d.ts

@@ -2,7 +2,7 @@
  * Sonatype Lifecycle Public REST API
  * No description provided (generated by Openapi Generator https://github.com/openapitools/openapi-generator)
  *
- * The version of the OpenAPI document: 1.177.0-01
+ * The version of the OpenAPI document: 1.184.0-01
  *
  *
  * NOTE: This class is auto generated by OpenAPI Generator (https://openapi-generator.tech).
@@ -52,84 +52,90 @@ export interface RevokeRoleMembershipGlobalOrRepositoryContainerRequest {
  */
 export interface RoleMembershipsApiInterface {
     /**
-     *
-     * @param {'application' | 'organization' | 'repository_container' | 'repository_manager' | 'repository' | 'global'} ownerType
-     * @param {string} internalOwnerId
+     * Use this method to retrieve the users, user groups and the corresponding role Ids.  Permissions required: Edit system configuration and users for a global context or view IQ elements for a non-global context
+     * @param {'application' | 'organization' | 'repository_container' | 'repository_manager' | 'repository' | 'global'} ownerType Enter the ownerType for which you want to retrieve users and their role Ids.
+     * @param {string} internalOwnerId Enter the corresponding id for the ownerType specified above.
      * @param {*} [options] Override http request option.
      * @throws {RequiredError}
      * @memberof RoleMembershipsApiInterface
      */
     getRoleMembershipsApplicationOrOrganizationRaw(requestParameters: GetRoleMembershipsApplicationOrOrganizationRequest, initOverrides?: RequestInit | runtime.InitOverrideFunction): Promise<runtime.ApiResponse<ApiRoleMemberMappingListDTO>>;
     /**
+     * Use this method to retrieve the users, user groups and the corresponding role Ids.  Permissions required: Edit system configuration and users for a global context or view IQ elements for a non-global context
      */
     getRoleMembershipsApplicationOrOrganization(requestParameters: GetRoleMembershipsApplicationOrOrganizationRequest, initOverrides?: RequestInit | runtime.InitOverrideFunction): Promise<ApiRoleMemberMappingListDTO>;
     /**
-     *
-     * @param {'application' | 'organization' | 'repository_container' | 'repository_manager' | 'repository' | 'global'} ownerType
+     * Use this method to retrieve all users and roles globally or for all repositories.  Permissions required: Edit system configuration and users for a global context or view IQ elements for a non-global context
+     * @param {'application' | 'organization' | 'repository_container' | 'repository_manager' | 'repository' | 'global'} ownerType Enter the value for ownerType. Using &#x60;global&#x60; will return the users and groups who have been assigned the administrator role.
      * @param {*} [options] Override http request option.
      * @throws {RequiredError}
      * @memberof RoleMembershipsApiInterface
      */
     getRoleMembershipsGlobalOrRepositoryContainerRaw(requestParameters: GetRoleMembershipsGlobalOrRepositoryContainerRequest, initOverrides?: RequestInit | runtime.InitOverrideFunction): Promise<runtime.ApiResponse<ApiRoleMemberMappingListDTO>>;
     /**
+     * Use this method to retrieve all users and roles globally or for all repositories.  Permissions required: Edit system configuration and users for a global context or view IQ elements for a non-global context
      */
     getRoleMembershipsGlobalOrRepositoryContainer(requestParameters: GetRoleMembershipsGlobalOrRepositoryContainerRequest, initOverrides?: RequestInit | runtime.InitOverrideFunction): Promise<ApiRoleMemberMappingListDTO>;
     /**
-     *
-     * @param {'application' | 'organization' | 'repository_container' | 'repository_manager' | 'repository' | 'global'} ownerType
-     * @param {string} internalOwnerId
-     * @param {string} roleId
-     * @param {'USER' | 'GROUP'} memberType
-     * @param {string} memberName
+     * Use this method to grant a role to a user or user group for the specified application or organization.  Permissions required: Edit access control
+     * @param {'application' | 'organization' | 'repository_container' | 'repository_manager' | 'repository' | 'global'} ownerType Enter the value for the ownerType for which you want to grant the role.
+     * @param {string} internalOwnerId Enter the value for the internalId associated with the ownerType specified above.
+     * @param {string} roleId Enter the roleId for the role to be granted.  Use the Roles REST API for roleIds and descriptions.
+     * @param {'USER' | 'GROUP'} memberType Enter the value for memberType, to specify a user or a user group.
+     * @param {string} memberName Enter the value for memberName. This can be a username or group name depending upon the value of memberType above.
      * @param {*} [options] Override http request option.
      * @throws {RequiredError}
      * @memberof RoleMembershipsApiInterface
      */
     grantRoleMembershipApplicationOrOrganizationRaw(requestParameters: GrantRoleMembershipApplicationOrOrganizationRequest, initOverrides?: RequestInit | runtime.InitOverrideFunction): Promise<runtime.ApiResponse<void>>;
     /**
+     * Use this method to grant a role to a user or user group for the specified application or organization.  Permissions required: Edit access control
      */
     grantRoleMembershipApplicationOrOrganization(requestParameters: GrantRoleMembershipApplicationOrOrganizationRequest, initOverrides?: RequestInit | runtime.InitOverrideFunction): Promise<void>;
     /**
-     *
-     * @param {'application' | 'organization' | 'repository_container' | 'repository_manager' | 'repository' | 'global'} ownerType
-     * @param {string} roleId
-     * @param {'USER' | 'GROUP'} memberType
-     * @param {string} memberName
+     * Use this method to grant a role to a user or user group globally or on all repositories.  Permissions required: Edit system configuration and users for a global context or edit access control for a non-global context
+     * @param {'application' | 'organization' | 'repository_container' | 'repository_manager' | 'repository' | 'global'} ownerType Enter the value for the ownerType for which you want to grant the role.
+     * @param {string} roleId Enter the roleId for the role to be granted.  Use the Roles REST API for roleIds and descriptions.
+     * @param {'USER' | 'GROUP'} memberType Enter the value for memberType, to specify a user or a user group.
+     * @param {string} memberName Enter the value for memberName. This can be a username or group name depending upon the value of memberType above.
      * @param {*} [options] Override http request option.
      * @throws {RequiredError}
      * @memberof RoleMembershipsApiInterface
      */
     grantRoleMembershipGlobalOrRepositoryContainerRaw(requestParameters: GrantRoleMembershipGlobalOrRepositoryContainerRequest, initOverrides?: RequestInit | runtime.InitOverrideFunction): Promise<runtime.ApiResponse<void>>;
     /**
+     * Use this method to grant a role to a user or user group globally or on all repositories.  Permissions required: Edit system configuration and users for a global context or edit access control for a non-global context
      */
     grantRoleMembershipGlobalOrRepositoryContainer(requestParameters: GrantRoleMembershipGlobalOrRepositoryContainerRequest, initOverrides?: RequestInit | runtime.InitOverrideFunction): Promise<void>;
     /**
-     *
-     * @param {'application' | 'organization' | 'repository_container' | 'repository_manager' | 'repository' | 'global'} ownerType
-     * @param {string} internalOwnerId
-     * @param {string} roleId
-     * @param {'USER' | 'GROUP'} memberType
-     * @param {string} memberName
+     * Use this method to revoke a role from a user or user group, on a specific application or organization.  Permissions required: Edit access control
+     * @param {'application' | 'organization' | 'repository_container' | 'repository_manager' | 'repository' | 'global'} ownerType Enter the value for the ownerType for which you want to revoke the role. Using &#x60;global&#x60; will revoke the administrator role.
+     * @param {string} internalOwnerId Enter the internalId associated with the ownerType specified above.
+     * @param {string} roleId Enter the roleId for the role to be revoked.
+     * @param {'USER' | 'GROUP'} memberType Enter the value for memberType, to specify a user or a user group.
+     * @param {string} memberName Enter the value for memberName. This can be a username or group name depending upon the value of memberType above.
      * @param {*} [options] Override http request option.
      * @throws {RequiredError}
      * @memberof RoleMembershipsApiInterface
      */
     revokeRoleMembershipApplicationOrOrganizationRaw(requestParameters: RevokeRoleMembershipApplicationOrOrganizationRequest, initOverrides?: RequestInit | runtime.InitOverrideFunction): Promise<runtime.ApiResponse<void>>;
     /**
+     * Use this method to revoke a role from a user or user group, on a specific application or organization.  Permissions required: Edit access control
      */
     revokeRoleMembershipApplicationOrOrganization(requestParameters: RevokeRoleMembershipApplicationOrOrganizationRequest, initOverrides?: RequestInit | runtime.InitOverrideFunction): Promise<void>;
     /**
-     *
-     * @param {'application' | 'organization' | 'repository_container' | 'repository_manager' | 'repository' | 'global'} ownerType
-     * @param {string} roleId
-     * @param {'USER' | 'GROUP'} memberType
-     * @param {string} memberName
+     * Use this method to revoke roles globally or on all repositories.  Permissions required: Edit system configuration and users for a global context or view IQ elements for a non-global context
+     * @param {'application' | 'organization' | 'repository_container' | 'repository_manager' | 'repository' | 'global'} ownerType Enter the value for ownerType. Using &#x60;global&#x60; will revoke the administrator role.
+     * @param {string} roleId Enter the roleId for the role to be revoked.
+     * @param {'USER' | 'GROUP'} memberType Enter the value for memberType, to specify a user or a user group.
+     * @param {string} memberName Enter the value for memberName. This can be a username or group name depending upon the value of memberType above.
      * @param {*} [options] Override http request option.
      * @throws {RequiredError}
      * @memberof RoleMembershipsApiInterface
      */
     revokeRoleMembershipGlobalOrRepositoryContainerRaw(requestParameters: RevokeRoleMembershipGlobalOrRepositoryContainerRequest, initOverrides?: RequestInit | runtime.InitOverrideFunction): Promise<runtime.ApiResponse<void>>;
     /**
+     * Use this method to revoke roles globally or on all repositories.  Permissions required: Edit system configuration and users for a global context or view IQ elements for a non-global context
      */
     revokeRoleMembershipGlobalOrRepositoryContainer(requestParameters: RevokeRoleMembershipGlobalOrRepositoryContainerRequest, initOverrides?: RequestInit | runtime.InitOverrideFunction): Promise<void>;
 }
@@ -138,39 +144,51 @@ export interface RoleMembershipsApiInterface {
  */
 export declare class RoleMembershipsApi extends runtime.BaseAPI implements RoleMembershipsApiInterface {
     /**
+     * Use this method to retrieve the users, user groups and the corresponding role Ids.  Permissions required: Edit system configuration and users for a global context or view IQ elements for a non-global context
      */
     getRoleMembershipsApplicationOrOrganizationRaw(requestParameters: GetRoleMembershipsApplicationOrOrganizationRequest, initOverrides?: RequestInit | runtime.InitOverrideFunction): Promise<runtime.ApiResponse<ApiRoleMemberMappingListDTO>>;
     /**
+     * Use this method to retrieve the users, user groups and the corresponding role Ids.  Permissions required: Edit system configuration and users for a global context or view IQ elements for a non-global context
      */
     getRoleMembershipsApplicationOrOrganization(requestParameters: GetRoleMembershipsApplicationOrOrganizationRequest, initOverrides?: RequestInit | runtime.InitOverrideFunction): Promise<ApiRoleMemberMappingListDTO>;
     /**
+     * Use this method to retrieve all users and roles globally or for all repositories.  Permissions required: Edit system configuration and users for a global context or view IQ elements for a non-global context
      */
     getRoleMembershipsGlobalOrRepositoryContainerRaw(requestParameters: GetRoleMembershipsGlobalOrRepositoryContainerRequest, initOverrides?: RequestInit | runtime.InitOverrideFunction): Promise<runtime.ApiResponse<ApiRoleMemberMappingListDTO>>;
     /**
+     * Use this method to retrieve all users and roles globally or for all repositories.  Permissions required: Edit system configuration and users for a global context or view IQ elements for a non-global context
      */
     getRoleMembershipsGlobalOrRepositoryContainer(requestParameters: GetRoleMembershipsGlobalOrRepositoryContainerRequest, initOverrides?: RequestInit | runtime.InitOverrideFunction): Promise<ApiRoleMemberMappingListDTO>;
     /**
+     * Use this method to grant a role to a user or user group for the specified application or organization.  Permissions required: Edit access control
      */
     grantRoleMembershipApplicationOrOrganizationRaw(requestParameters: GrantRoleMembershipApplicationOrOrganizationRequest, initOverrides?: RequestInit | runtime.InitOverrideFunction): Promise<runtime.ApiResponse<void>>;
     /**
+     * Use this method to grant a role to a user or user group for the specified application or organization.  Permissions required: Edit access control
      */
     grantRoleMembershipApplicationOrOrganization(requestParameters: GrantRoleMembershipApplicationOrOrganizationRequest, initOverrides?: RequestInit | runtime.InitOverrideFunction): Promise<void>;
     /**
+     * Use this method to grant a role to a user or user group globally or on all repositories.  Permissions required: Edit system configuration and users for a global context or edit access control for a non-global context
      */
     grantRoleMembershipGlobalOrRepositoryContainerRaw(requestParameters: GrantRoleMembershipGlobalOrRepositoryContainerRequest, initOverrides?: RequestInit | runtime.InitOverrideFunction): Promise<runtime.ApiResponse<void>>;
     /**
+     * Use this method to grant a role to a user or user group globally or on all repositories.  Permissions required: Edit system configuration and users for a global context or edit access control for a non-global context
      */
     grantRoleMembershipGlobalOrRepositoryContainer(requestParameters: GrantRoleMembershipGlobalOrRepositoryContainerRequest, initOverrides?: RequestInit | runtime.InitOverrideFunction): Promise<void>;
     /**
+     * Use this method to revoke a role from a user or user group, on a specific application or organization.  Permissions required: Edit access control
      */
     revokeRoleMembershipApplicationOrOrganizationRaw(requestParameters: RevokeRoleMembershipApplicationOrOrganizationRequest, initOverrides?: RequestInit | runtime.InitOverrideFunction): Promise<runtime.ApiResponse<void>>;
     /**
+     * Use this method to revoke a role from a user or user group, on a specific application or organization.  Permissions required: Edit access control
      */
     revokeRoleMembershipApplicationOrOrganization(requestParameters: RevokeRoleMembershipApplicationOrOrganizationRequest, initOverrides?: RequestInit | runtime.InitOverrideFunction): Promise<void>;
     /**
+     * Use this method to revoke roles globally or on all repositories.  Permissions required: Edit system configuration and users for a global context or view IQ elements for a non-global context
      */
     revokeRoleMembershipGlobalOrRepositoryContainerRaw(requestParameters: RevokeRoleMembershipGlobalOrRepositoryContainerRequest, initOverrides?: RequestInit | runtime.InitOverrideFunction): Promise<runtime.ApiResponse<void>>;
     /**
+     * Use this method to revoke roles globally or on all repositories.  Permissions required: Edit system configuration and users for a global context or view IQ elements for a non-global context
      */
     revokeRoleMembershipGlobalOrRepositoryContainer(requestParameters: RevokeRoleMembershipGlobalOrRepositoryContainerRequest, initOverrides?: RequestInit | runtime.InitOverrideFunction): Promise<void>;
 }