@sonatype/nexus-iq-api-client 0.193.0 → 0.193.3
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/.openapi-generator/FILES +2 -0
- package/dist/apis/AdvancedSearchApi.d.ts +10 -10
- package/dist/apis/ApplicationCategoriesApi.d.ts +45 -45
- package/dist/apis/ApplicationReportDataApi.d.ts +25 -25
- package/dist/apis/ApplicationsApi.d.ts +40 -40
- package/dist/apis/AuditLogsApi.d.ts +5 -5
- package/dist/apis/AutoPolicyWaiverExclusionsApi.d.ts +15 -15
- package/dist/apis/AutoPolicyWaiversApi.d.ts +40 -40
- package/dist/apis/CPEMatchingConfigurationApi.d.ts +10 -10
- package/dist/apis/ClaimComponentsApi.d.ts +15 -15
- package/dist/apis/ComponentLabelsApi.d.ts +30 -30
- package/dist/apis/ComponentSearchApi.d.ts +5 -5
- package/dist/apis/ComponentsApi.d.ts +25 -25
- package/dist/apis/CompositeSourceControlApi.d.ts +5 -5
- package/dist/apis/CompositeSourceControlValidatorApi.d.ts +5 -5
- package/dist/apis/ConfigCrowdApi.d.ts +10 -10
- package/dist/apis/ConfigJiraApi.d.ts +5 -5
- package/dist/apis/ConfigMailApi.d.ts +10 -10
- package/dist/apis/ConfigProxyServerApi.d.ts +5 -5
- package/dist/apis/ConfigReverseProxyAuthenticationApi.d.ts +5 -5
- package/dist/apis/ConfigSourceControlApi.d.ts +5 -5
- package/dist/apis/ConfigZscalerApi.d.ts +20 -20
- package/dist/apis/ConfigurationApi.d.ts +15 -15
- package/dist/apis/ConfigureArtifactoryConnectionApi.d.ts +40 -40
- package/dist/apis/CycloneDXApi.d.ts +10 -10
- package/dist/apis/DataRetentionPoliciesApi.d.ts +15 -15
- package/dist/apis/DeveloperPrioritiesApi.d.ts +10 -10
- package/dist/apis/EndpointsApi.d.ts +5 -5
- package/dist/apis/FeatureConfigurationApi.d.ts +10 -10
- package/dist/apis/FirewallApi.d.ts +70 -70
- package/dist/apis/LicenseLegalMetadataApi.d.ts +40 -40
- package/dist/apis/LicenseLegalMetadataTemplatesApi.d.ts +15 -15
- package/dist/apis/LicenseOverridesApi.d.ts +20 -20
- package/dist/apis/OrganizationsApi.d.ts +25 -25
- package/dist/apis/PolicyEvaluationApi.d.ts +25 -25
- package/dist/apis/PolicyViolationDetailsApi.d.ts +45 -45
- package/dist/apis/PolicyWaiverRequestsApi.d.ts +20 -20
- package/dist/apis/PolicyWaiversApi.d.ts +45 -45
- package/dist/apis/ProductLicenseApi.d.ts +67 -0
- package/dist/apis/ProductLicenseApi.js +105 -0
- package/dist/apis/ReportsApi.d.ts +20 -20
- package/dist/apis/RepositoriesApi.d.ts +10 -10
- package/dist/apis/RoleMembershipsApi.d.ts +30 -30
- package/dist/apis/SBOMApi.d.ts +45 -45
- package/dist/apis/SPDXApi.d.ts +10 -10
- package/dist/apis/SecurityVulnerabilityOverridesApi.d.ts +5 -5
- package/dist/apis/SolutionsApi.d.ts +5 -5
- package/dist/apis/SourceControlApi.d.ts +40 -40
- package/dist/apis/SourceControlMetricsApi.d.ts +5 -5
- package/dist/apis/ThirdPartyAnalysisApi.d.ts +10 -10
- package/dist/apis/UserTokensApi.d.ts +15 -15
- package/dist/apis/UsersApi.d.ts +25 -25
- package/dist/apis/VulnerabilityDetailsApi.d.ts +5 -5
- package/dist/apis/index.d.ts +1 -0
- package/dist/apis/index.js +1 -0
- package/dist/esm/apis/AdvancedSearchApi.d.ts +10 -10
- package/dist/esm/apis/ApplicationCategoriesApi.d.ts +45 -45
- package/dist/esm/apis/ApplicationReportDataApi.d.ts +25 -25
- package/dist/esm/apis/ApplicationsApi.d.ts +40 -40
- package/dist/esm/apis/AuditLogsApi.d.ts +5 -5
- package/dist/esm/apis/AutoPolicyWaiverExclusionsApi.d.ts +15 -15
- package/dist/esm/apis/AutoPolicyWaiversApi.d.ts +40 -40
- package/dist/esm/apis/CPEMatchingConfigurationApi.d.ts +10 -10
- package/dist/esm/apis/ClaimComponentsApi.d.ts +15 -15
- package/dist/esm/apis/ComponentLabelsApi.d.ts +30 -30
- package/dist/esm/apis/ComponentSearchApi.d.ts +5 -5
- package/dist/esm/apis/ComponentsApi.d.ts +25 -25
- package/dist/esm/apis/CompositeSourceControlApi.d.ts +5 -5
- package/dist/esm/apis/CompositeSourceControlValidatorApi.d.ts +5 -5
- package/dist/esm/apis/ConfigCrowdApi.d.ts +10 -10
- package/dist/esm/apis/ConfigJiraApi.d.ts +5 -5
- package/dist/esm/apis/ConfigMailApi.d.ts +10 -10
- package/dist/esm/apis/ConfigProxyServerApi.d.ts +5 -5
- package/dist/esm/apis/ConfigReverseProxyAuthenticationApi.d.ts +5 -5
- package/dist/esm/apis/ConfigSourceControlApi.d.ts +5 -5
- package/dist/esm/apis/ConfigZscalerApi.d.ts +20 -20
- package/dist/esm/apis/ConfigurationApi.d.ts +15 -15
- package/dist/esm/apis/ConfigureArtifactoryConnectionApi.d.ts +40 -40
- package/dist/esm/apis/CycloneDXApi.d.ts +10 -10
- package/dist/esm/apis/DataRetentionPoliciesApi.d.ts +15 -15
- package/dist/esm/apis/DeveloperPrioritiesApi.d.ts +10 -10
- package/dist/esm/apis/EndpointsApi.d.ts +5 -5
- package/dist/esm/apis/FeatureConfigurationApi.d.ts +10 -10
- package/dist/esm/apis/FirewallApi.d.ts +70 -70
- package/dist/esm/apis/LicenseLegalMetadataApi.d.ts +40 -40
- package/dist/esm/apis/LicenseLegalMetadataTemplatesApi.d.ts +15 -15
- package/dist/esm/apis/LicenseOverridesApi.d.ts +20 -20
- package/dist/esm/apis/OrganizationsApi.d.ts +25 -25
- package/dist/esm/apis/PolicyEvaluationApi.d.ts +25 -25
- package/dist/esm/apis/PolicyViolationDetailsApi.d.ts +45 -45
- package/dist/esm/apis/PolicyWaiverRequestsApi.d.ts +20 -20
- package/dist/esm/apis/PolicyWaiversApi.d.ts +45 -45
- package/dist/esm/apis/ProductLicenseApi.d.ts +67 -0
- package/dist/esm/apis/ProductLicenseApi.js +101 -0
- package/dist/esm/apis/ReportsApi.d.ts +20 -20
- package/dist/esm/apis/RepositoriesApi.d.ts +10 -10
- package/dist/esm/apis/RoleMembershipsApi.d.ts +30 -30
- package/dist/esm/apis/SBOMApi.d.ts +45 -45
- package/dist/esm/apis/SPDXApi.d.ts +10 -10
- package/dist/esm/apis/SecurityVulnerabilityOverridesApi.d.ts +5 -5
- package/dist/esm/apis/SolutionsApi.d.ts +5 -5
- package/dist/esm/apis/SourceControlApi.d.ts +40 -40
- package/dist/esm/apis/SourceControlMetricsApi.d.ts +5 -5
- package/dist/esm/apis/ThirdPartyAnalysisApi.d.ts +10 -10
- package/dist/esm/apis/UserTokensApi.d.ts +15 -15
- package/dist/esm/apis/UsersApi.d.ts +25 -25
- package/dist/esm/apis/VulnerabilityDetailsApi.d.ts +5 -5
- package/dist/esm/apis/index.d.ts +1 -0
- package/dist/esm/apis/index.js +1 -0
- package/dist/esm/models/ApiJiraConfigurationDTO.d.ts +2 -2
- package/dist/esm/models/InstallLicenseRequest.d.ts +32 -0
- package/dist/esm/models/InstallLicenseRequest.js +41 -0
- package/dist/esm/models/index.d.ts +1 -0
- package/dist/esm/models/index.js +1 -0
- package/dist/models/ApiJiraConfigurationDTO.d.ts +2 -2
- package/dist/models/InstallLicenseRequest.d.ts +32 -0
- package/dist/models/InstallLicenseRequest.js +48 -0
- package/dist/models/index.d.ts +1 -0
- package/dist/models/index.js +1 -0
- package/package.json +1 -1
- package/src/apis/AdvancedSearchApi.ts +10 -10
- package/src/apis/ApplicationCategoriesApi.ts +45 -45
- package/src/apis/ApplicationReportDataApi.ts +25 -25
- package/src/apis/ApplicationsApi.ts +40 -40
- package/src/apis/AuditLogsApi.ts +5 -5
- package/src/apis/AutoPolicyWaiverExclusionsApi.ts +15 -15
- package/src/apis/AutoPolicyWaiversApi.ts +40 -40
- package/src/apis/CPEMatchingConfigurationApi.ts +10 -10
- package/src/apis/ClaimComponentsApi.ts +15 -15
- package/src/apis/ComponentLabelsApi.ts +30 -30
- package/src/apis/ComponentSearchApi.ts +5 -5
- package/src/apis/ComponentsApi.ts +25 -25
- package/src/apis/CompositeSourceControlApi.ts +5 -5
- package/src/apis/CompositeSourceControlValidatorApi.ts +5 -5
- package/src/apis/ConfigCrowdApi.ts +10 -10
- package/src/apis/ConfigJiraApi.ts +5 -5
- package/src/apis/ConfigMailApi.ts +10 -10
- package/src/apis/ConfigProxyServerApi.ts +5 -5
- package/src/apis/ConfigReverseProxyAuthenticationApi.ts +5 -5
- package/src/apis/ConfigSourceControlApi.ts +5 -5
- package/src/apis/ConfigZscalerApi.ts +20 -20
- package/src/apis/ConfigurationApi.ts +15 -15
- package/src/apis/ConfigureArtifactoryConnectionApi.ts +40 -40
- package/src/apis/CycloneDXApi.ts +10 -10
- package/src/apis/DataRetentionPoliciesApi.ts +15 -15
- package/src/apis/DeveloperPrioritiesApi.ts +10 -10
- package/src/apis/EndpointsApi.ts +5 -5
- package/src/apis/FeatureConfigurationApi.ts +10 -10
- package/src/apis/FirewallApi.ts +70 -70
- package/src/apis/LicenseLegalMetadataApi.ts +40 -40
- package/src/apis/LicenseLegalMetadataTemplatesApi.ts +15 -15
- package/src/apis/LicenseOverridesApi.ts +20 -20
- package/src/apis/OrganizationsApi.ts +25 -25
- package/src/apis/PolicyEvaluationApi.ts +25 -25
- package/src/apis/PolicyViolationDetailsApi.ts +45 -45
- package/src/apis/PolicyWaiverRequestsApi.ts +20 -20
- package/src/apis/PolicyWaiversApi.ts +45 -45
- package/src/apis/ProductLicenseApi.ts +140 -0
- package/src/apis/ReportsApi.ts +20 -20
- package/src/apis/RepositoriesApi.ts +10 -10
- package/src/apis/RoleMembershipsApi.ts +30 -30
- package/src/apis/SBOMApi.ts +45 -45
- package/src/apis/SPDXApi.ts +10 -10
- package/src/apis/SecurityVulnerabilityOverridesApi.ts +5 -5
- package/src/apis/SolutionsApi.ts +5 -5
- package/src/apis/SourceControlApi.ts +40 -40
- package/src/apis/SourceControlMetricsApi.ts +5 -5
- package/src/apis/ThirdPartyAnalysisApi.ts +10 -10
- package/src/apis/UserTokensApi.ts +15 -15
- package/src/apis/UsersApi.ts +25 -25
- package/src/apis/VulnerabilityDetailsApi.ts +5 -5
- package/src/apis/index.ts +1 -0
- package/src/models/ApiJiraConfigurationDTO.ts +2 -2
- package/src/models/InstallLicenseRequest.ts +65 -0
- package/src/models/index.ts +1 -0
|
@@ -11,35 +11,35 @@
|
|
|
11
11
|
*/
|
|
12
12
|
import * as runtime from '../runtime';
|
|
13
13
|
import type { ApiSourceControlDTO, SCMUserMappingsDTO, SCMUserMappingsResponseDTO, SCMUserMatchingResultDTO } from '../models/index';
|
|
14
|
-
export interface
|
|
14
|
+
export interface SourceControlApiAddSourceControlRequest {
|
|
15
15
|
ownerType: AddSourceControlOwnerTypeEnum;
|
|
16
16
|
internalOwnerId: string;
|
|
17
17
|
apiSourceControlDTO?: ApiSourceControlDTO;
|
|
18
18
|
}
|
|
19
|
-
export interface
|
|
19
|
+
export interface SourceControlApiAddUserMappingsRequest {
|
|
20
20
|
organizationId: string;
|
|
21
21
|
sCMUserMappingsDTO?: SCMUserMappingsDTO;
|
|
22
22
|
}
|
|
23
|
-
export interface
|
|
23
|
+
export interface SourceControlApiAutomaticRoleAssignmentRequest {
|
|
24
24
|
publicId: string;
|
|
25
25
|
sCMUserMappingsDTO?: SCMUserMappingsDTO;
|
|
26
26
|
}
|
|
27
|
-
export interface
|
|
27
|
+
export interface SourceControlApiDeleteSourceControlRequest {
|
|
28
28
|
ownerType: DeleteSourceControlOwnerTypeEnum;
|
|
29
29
|
internalOwnerId: string;
|
|
30
30
|
}
|
|
31
|
-
export interface
|
|
31
|
+
export interface SourceControlApiDeleteUserMappingsRequest {
|
|
32
32
|
organizationId: string;
|
|
33
33
|
}
|
|
34
|
-
export interface
|
|
34
|
+
export interface SourceControlApiGetSourceControl1Request {
|
|
35
35
|
ownerType: GetSourceControl1OwnerTypeEnum;
|
|
36
36
|
internalOwnerId: string;
|
|
37
37
|
}
|
|
38
|
-
export interface
|
|
38
|
+
export interface SourceControlApiGetUserMappingsByOwnerRequest {
|
|
39
39
|
ownerType: GetUserMappingsByOwnerOwnerTypeEnum;
|
|
40
40
|
internalOwnerId: string;
|
|
41
41
|
}
|
|
42
|
-
export interface
|
|
42
|
+
export interface SourceControlApiUpdateSourceControlRequest {
|
|
43
43
|
ownerType: UpdateSourceControlOwnerTypeEnum;
|
|
44
44
|
internalOwnerId: string;
|
|
45
45
|
apiSourceControlDTO?: ApiSourceControlDTO;
|
|
@@ -60,11 +60,11 @@ export interface SourceControlApiInterface {
|
|
|
60
60
|
* @throws {RequiredError}
|
|
61
61
|
* @memberof SourceControlApiInterface
|
|
62
62
|
*/
|
|
63
|
-
addSourceControlRaw(requestParameters:
|
|
63
|
+
addSourceControlRaw(requestParameters: SourceControlApiAddSourceControlRequest, initOverrides?: RequestInit | runtime.InitOverrideFunction): Promise<runtime.ApiResponse<ApiSourceControlDTO>>;
|
|
64
64
|
/**
|
|
65
65
|
* Use this method to create a source control configuration setting. Permissions required: Edit IQ Elements
|
|
66
66
|
*/
|
|
67
|
-
addSourceControl(requestParameters:
|
|
67
|
+
addSourceControl(requestParameters: SourceControlApiAddSourceControlRequest, initOverrides?: RequestInit | runtime.InitOverrideFunction): Promise<ApiSourceControlDTO>;
|
|
68
68
|
/**
|
|
69
69
|
* Use this method to apply user mappings from SCM (GitHub) to Lifecycle. The user mappings will be inherited by all child organizations and applications in the organization hierarchy. If a user mapping for an organization already exists, it will be replaced with new mappings provided here. Permissions required: Edit IQ Elements
|
|
70
70
|
* @param {string} organizationId Enter the organizationId. Use `ROOT_ORGANIZATION_ID` for the root organization
|
|
@@ -73,11 +73,11 @@ export interface SourceControlApiInterface {
|
|
|
73
73
|
* @throws {RequiredError}
|
|
74
74
|
* @memberof SourceControlApiInterface
|
|
75
75
|
*/
|
|
76
|
-
addUserMappingsRaw(requestParameters:
|
|
76
|
+
addUserMappingsRaw(requestParameters: SourceControlApiAddUserMappingsRequest, initOverrides?: RequestInit | runtime.InitOverrideFunction): Promise<runtime.ApiResponse<void>>;
|
|
77
77
|
/**
|
|
78
78
|
* Use this method to apply user mappings from SCM (GitHub) to Lifecycle. The user mappings will be inherited by all child organizations and applications in the organization hierarchy. If a user mapping for an organization already exists, it will be replaced with new mappings provided here. Permissions required: Edit IQ Elements
|
|
79
79
|
*/
|
|
80
|
-
addUserMappings(requestParameters:
|
|
80
|
+
addUserMappings(requestParameters: SourceControlApiAddUserMappingsRequest, initOverrides?: RequestInit | runtime.InitOverrideFunction): Promise<void>;
|
|
81
81
|
/**
|
|
82
82
|
* Use this method to automatically grant the supplied role to all contributors of a repository on a given application. Prerequisites for automatic role assignment are:<ol><li>SCM configuration for the application and authentication token should exist.</li><li>The contributors to the repository should match a user in IQ based on the supplied mappings.</li><li>Either user mapping strategies have been configured for your organization, or they are provided in the request</li></ol> Permissions required: Edit access control on the application.
|
|
83
83
|
* @param {string} publicId Enter the public applicationId for automatic role assignment.
|
|
@@ -86,11 +86,11 @@ export interface SourceControlApiInterface {
|
|
|
86
86
|
* @throws {RequiredError}
|
|
87
87
|
* @memberof SourceControlApiInterface
|
|
88
88
|
*/
|
|
89
|
-
automaticRoleAssignmentRaw(requestParameters:
|
|
89
|
+
automaticRoleAssignmentRaw(requestParameters: SourceControlApiAutomaticRoleAssignmentRequest, initOverrides?: RequestInit | runtime.InitOverrideFunction): Promise<runtime.ApiResponse<SCMUserMatchingResultDTO>>;
|
|
90
90
|
/**
|
|
91
91
|
* Use this method to automatically grant the supplied role to all contributors of a repository on a given application. Prerequisites for automatic role assignment are:<ol><li>SCM configuration for the application and authentication token should exist.</li><li>The contributors to the repository should match a user in IQ based on the supplied mappings.</li><li>Either user mapping strategies have been configured for your organization, or they are provided in the request</li></ol> Permissions required: Edit access control on the application.
|
|
92
92
|
*/
|
|
93
|
-
automaticRoleAssignment(requestParameters:
|
|
93
|
+
automaticRoleAssignment(requestParameters: SourceControlApiAutomaticRoleAssignmentRequest, initOverrides?: RequestInit | runtime.InitOverrideFunction): Promise<SCMUserMatchingResultDTO>;
|
|
94
94
|
/**
|
|
95
95
|
* Use this method to delete a SCM setting for the specified ownerType/ownerId. Permissions required: Edit IQ Elements
|
|
96
96
|
* @param {'application' | 'organization'} ownerType Enter the value for ownerType.
|
|
@@ -99,11 +99,11 @@ export interface SourceControlApiInterface {
|
|
|
99
99
|
* @throws {RequiredError}
|
|
100
100
|
* @memberof SourceControlApiInterface
|
|
101
101
|
*/
|
|
102
|
-
deleteSourceControlRaw(requestParameters:
|
|
102
|
+
deleteSourceControlRaw(requestParameters: SourceControlApiDeleteSourceControlRequest, initOverrides?: RequestInit | runtime.InitOverrideFunction): Promise<runtime.ApiResponse<void>>;
|
|
103
103
|
/**
|
|
104
104
|
* Use this method to delete a SCM setting for the specified ownerType/ownerId. Permissions required: Edit IQ Elements
|
|
105
105
|
*/
|
|
106
|
-
deleteSourceControl(requestParameters:
|
|
106
|
+
deleteSourceControl(requestParameters: SourceControlApiDeleteSourceControlRequest, initOverrides?: RequestInit | runtime.InitOverrideFunction): Promise<void>;
|
|
107
107
|
/**
|
|
108
108
|
* Use this method to delete existing SCM user mappings for an organization. Permissions required: Edit IQ Elements
|
|
109
109
|
* @param {string} organizationId Enter the organizationId.
|
|
@@ -111,11 +111,11 @@ export interface SourceControlApiInterface {
|
|
|
111
111
|
* @throws {RequiredError}
|
|
112
112
|
* @memberof SourceControlApiInterface
|
|
113
113
|
*/
|
|
114
|
-
deleteUserMappingsRaw(requestParameters:
|
|
114
|
+
deleteUserMappingsRaw(requestParameters: SourceControlApiDeleteUserMappingsRequest, initOverrides?: RequestInit | runtime.InitOverrideFunction): Promise<runtime.ApiResponse<void>>;
|
|
115
115
|
/**
|
|
116
116
|
* Use this method to delete existing SCM user mappings for an organization. Permissions required: Edit IQ Elements
|
|
117
117
|
*/
|
|
118
|
-
deleteUserMappings(requestParameters:
|
|
118
|
+
deleteUserMappings(requestParameters: SourceControlApiDeleteUserMappingsRequest, initOverrides?: RequestInit | runtime.InitOverrideFunction): Promise<void>;
|
|
119
119
|
/**
|
|
120
120
|
* Use this method to retrieve the source control configuration settings for an organization or an application. Permissions required: View IQ Elements
|
|
121
121
|
* @param {'application' | 'organization'} ownerType Enter the value for ownerType.
|
|
@@ -124,11 +124,11 @@ export interface SourceControlApiInterface {
|
|
|
124
124
|
* @throws {RequiredError}
|
|
125
125
|
* @memberof SourceControlApiInterface
|
|
126
126
|
*/
|
|
127
|
-
getSourceControl1Raw(requestParameters:
|
|
127
|
+
getSourceControl1Raw(requestParameters: SourceControlApiGetSourceControl1Request, initOverrides?: RequestInit | runtime.InitOverrideFunction): Promise<runtime.ApiResponse<ApiSourceControlDTO>>;
|
|
128
128
|
/**
|
|
129
129
|
* Use this method to retrieve the source control configuration settings for an organization or an application. Permissions required: View IQ Elements
|
|
130
130
|
*/
|
|
131
|
-
getSourceControl1(requestParameters:
|
|
131
|
+
getSourceControl1(requestParameters: SourceControlApiGetSourceControl1Request, initOverrides?: RequestInit | runtime.InitOverrideFunction): Promise<ApiSourceControlDTO>;
|
|
132
132
|
/**
|
|
133
133
|
* Use this method to retrieve SCM user mappings for an organization or application. Permissions required: View IQ Elements
|
|
134
134
|
* @param {'application' | 'organization'} ownerType Enter the value for ownerType.
|
|
@@ -137,11 +137,11 @@ export interface SourceControlApiInterface {
|
|
|
137
137
|
* @throws {RequiredError}
|
|
138
138
|
* @memberof SourceControlApiInterface
|
|
139
139
|
*/
|
|
140
|
-
getUserMappingsByOwnerRaw(requestParameters:
|
|
140
|
+
getUserMappingsByOwnerRaw(requestParameters: SourceControlApiGetUserMappingsByOwnerRequest, initOverrides?: RequestInit | runtime.InitOverrideFunction): Promise<runtime.ApiResponse<SCMUserMappingsResponseDTO>>;
|
|
141
141
|
/**
|
|
142
142
|
* Use this method to retrieve SCM user mappings for an organization or application. Permissions required: View IQ Elements
|
|
143
143
|
*/
|
|
144
|
-
getUserMappingsByOwner(requestParameters:
|
|
144
|
+
getUserMappingsByOwner(requestParameters: SourceControlApiGetUserMappingsByOwnerRequest, initOverrides?: RequestInit | runtime.InitOverrideFunction): Promise<SCMUserMappingsResponseDTO>;
|
|
145
145
|
/**
|
|
146
146
|
* Use this method to update an existing SCM setting. Permissions required: Edit IQ Elements
|
|
147
147
|
* @param {'application' | 'organization'} ownerType Enter the value for ownerType.
|
|
@@ -151,11 +151,11 @@ export interface SourceControlApiInterface {
|
|
|
151
151
|
* @throws {RequiredError}
|
|
152
152
|
* @memberof SourceControlApiInterface
|
|
153
153
|
*/
|
|
154
|
-
updateSourceControlRaw(requestParameters:
|
|
154
|
+
updateSourceControlRaw(requestParameters: SourceControlApiUpdateSourceControlRequest, initOverrides?: RequestInit | runtime.InitOverrideFunction): Promise<runtime.ApiResponse<ApiSourceControlDTO>>;
|
|
155
155
|
/**
|
|
156
156
|
* Use this method to update an existing SCM setting. Permissions required: Edit IQ Elements
|
|
157
157
|
*/
|
|
158
|
-
updateSourceControl(requestParameters:
|
|
158
|
+
updateSourceControl(requestParameters: SourceControlApiUpdateSourceControlRequest, initOverrides?: RequestInit | runtime.InitOverrideFunction): Promise<ApiSourceControlDTO>;
|
|
159
159
|
}
|
|
160
160
|
/**
|
|
161
161
|
*
|
|
@@ -164,67 +164,67 @@ export declare class SourceControlApi extends runtime.BaseAPI implements SourceC
|
|
|
164
164
|
/**
|
|
165
165
|
* Use this method to create a source control configuration setting. Permissions required: Edit IQ Elements
|
|
166
166
|
*/
|
|
167
|
-
addSourceControlRaw(requestParameters:
|
|
167
|
+
addSourceControlRaw(requestParameters: SourceControlApiAddSourceControlRequest, initOverrides?: RequestInit | runtime.InitOverrideFunction): Promise<runtime.ApiResponse<ApiSourceControlDTO>>;
|
|
168
168
|
/**
|
|
169
169
|
* Use this method to create a source control configuration setting. Permissions required: Edit IQ Elements
|
|
170
170
|
*/
|
|
171
|
-
addSourceControl(requestParameters:
|
|
171
|
+
addSourceControl(requestParameters: SourceControlApiAddSourceControlRequest, initOverrides?: RequestInit | runtime.InitOverrideFunction): Promise<ApiSourceControlDTO>;
|
|
172
172
|
/**
|
|
173
173
|
* Use this method to apply user mappings from SCM (GitHub) to Lifecycle. The user mappings will be inherited by all child organizations and applications in the organization hierarchy. If a user mapping for an organization already exists, it will be replaced with new mappings provided here. Permissions required: Edit IQ Elements
|
|
174
174
|
*/
|
|
175
|
-
addUserMappingsRaw(requestParameters:
|
|
175
|
+
addUserMappingsRaw(requestParameters: SourceControlApiAddUserMappingsRequest, initOverrides?: RequestInit | runtime.InitOverrideFunction): Promise<runtime.ApiResponse<void>>;
|
|
176
176
|
/**
|
|
177
177
|
* Use this method to apply user mappings from SCM (GitHub) to Lifecycle. The user mappings will be inherited by all child organizations and applications in the organization hierarchy. If a user mapping for an organization already exists, it will be replaced with new mappings provided here. Permissions required: Edit IQ Elements
|
|
178
178
|
*/
|
|
179
|
-
addUserMappings(requestParameters:
|
|
179
|
+
addUserMappings(requestParameters: SourceControlApiAddUserMappingsRequest, initOverrides?: RequestInit | runtime.InitOverrideFunction): Promise<void>;
|
|
180
180
|
/**
|
|
181
181
|
* Use this method to automatically grant the supplied role to all contributors of a repository on a given application. Prerequisites for automatic role assignment are:<ol><li>SCM configuration for the application and authentication token should exist.</li><li>The contributors to the repository should match a user in IQ based on the supplied mappings.</li><li>Either user mapping strategies have been configured for your organization, or they are provided in the request</li></ol> Permissions required: Edit access control on the application.
|
|
182
182
|
*/
|
|
183
|
-
automaticRoleAssignmentRaw(requestParameters:
|
|
183
|
+
automaticRoleAssignmentRaw(requestParameters: SourceControlApiAutomaticRoleAssignmentRequest, initOverrides?: RequestInit | runtime.InitOverrideFunction): Promise<runtime.ApiResponse<SCMUserMatchingResultDTO>>;
|
|
184
184
|
/**
|
|
185
185
|
* Use this method to automatically grant the supplied role to all contributors of a repository on a given application. Prerequisites for automatic role assignment are:<ol><li>SCM configuration for the application and authentication token should exist.</li><li>The contributors to the repository should match a user in IQ based on the supplied mappings.</li><li>Either user mapping strategies have been configured for your organization, or they are provided in the request</li></ol> Permissions required: Edit access control on the application.
|
|
186
186
|
*/
|
|
187
|
-
automaticRoleAssignment(requestParameters:
|
|
187
|
+
automaticRoleAssignment(requestParameters: SourceControlApiAutomaticRoleAssignmentRequest, initOverrides?: RequestInit | runtime.InitOverrideFunction): Promise<SCMUserMatchingResultDTO>;
|
|
188
188
|
/**
|
|
189
189
|
* Use this method to delete a SCM setting for the specified ownerType/ownerId. Permissions required: Edit IQ Elements
|
|
190
190
|
*/
|
|
191
|
-
deleteSourceControlRaw(requestParameters:
|
|
191
|
+
deleteSourceControlRaw(requestParameters: SourceControlApiDeleteSourceControlRequest, initOverrides?: RequestInit | runtime.InitOverrideFunction): Promise<runtime.ApiResponse<void>>;
|
|
192
192
|
/**
|
|
193
193
|
* Use this method to delete a SCM setting for the specified ownerType/ownerId. Permissions required: Edit IQ Elements
|
|
194
194
|
*/
|
|
195
|
-
deleteSourceControl(requestParameters:
|
|
195
|
+
deleteSourceControl(requestParameters: SourceControlApiDeleteSourceControlRequest, initOverrides?: RequestInit | runtime.InitOverrideFunction): Promise<void>;
|
|
196
196
|
/**
|
|
197
197
|
* Use this method to delete existing SCM user mappings for an organization. Permissions required: Edit IQ Elements
|
|
198
198
|
*/
|
|
199
|
-
deleteUserMappingsRaw(requestParameters:
|
|
199
|
+
deleteUserMappingsRaw(requestParameters: SourceControlApiDeleteUserMappingsRequest, initOverrides?: RequestInit | runtime.InitOverrideFunction): Promise<runtime.ApiResponse<void>>;
|
|
200
200
|
/**
|
|
201
201
|
* Use this method to delete existing SCM user mappings for an organization. Permissions required: Edit IQ Elements
|
|
202
202
|
*/
|
|
203
|
-
deleteUserMappings(requestParameters:
|
|
203
|
+
deleteUserMappings(requestParameters: SourceControlApiDeleteUserMappingsRequest, initOverrides?: RequestInit | runtime.InitOverrideFunction): Promise<void>;
|
|
204
204
|
/**
|
|
205
205
|
* Use this method to retrieve the source control configuration settings for an organization or an application. Permissions required: View IQ Elements
|
|
206
206
|
*/
|
|
207
|
-
getSourceControl1Raw(requestParameters:
|
|
207
|
+
getSourceControl1Raw(requestParameters: SourceControlApiGetSourceControl1Request, initOverrides?: RequestInit | runtime.InitOverrideFunction): Promise<runtime.ApiResponse<ApiSourceControlDTO>>;
|
|
208
208
|
/**
|
|
209
209
|
* Use this method to retrieve the source control configuration settings for an organization or an application. Permissions required: View IQ Elements
|
|
210
210
|
*/
|
|
211
|
-
getSourceControl1(requestParameters:
|
|
211
|
+
getSourceControl1(requestParameters: SourceControlApiGetSourceControl1Request, initOverrides?: RequestInit | runtime.InitOverrideFunction): Promise<ApiSourceControlDTO>;
|
|
212
212
|
/**
|
|
213
213
|
* Use this method to retrieve SCM user mappings for an organization or application. Permissions required: View IQ Elements
|
|
214
214
|
*/
|
|
215
|
-
getUserMappingsByOwnerRaw(requestParameters:
|
|
215
|
+
getUserMappingsByOwnerRaw(requestParameters: SourceControlApiGetUserMappingsByOwnerRequest, initOverrides?: RequestInit | runtime.InitOverrideFunction): Promise<runtime.ApiResponse<SCMUserMappingsResponseDTO>>;
|
|
216
216
|
/**
|
|
217
217
|
* Use this method to retrieve SCM user mappings for an organization or application. Permissions required: View IQ Elements
|
|
218
218
|
*/
|
|
219
|
-
getUserMappingsByOwner(requestParameters:
|
|
219
|
+
getUserMappingsByOwner(requestParameters: SourceControlApiGetUserMappingsByOwnerRequest, initOverrides?: RequestInit | runtime.InitOverrideFunction): Promise<SCMUserMappingsResponseDTO>;
|
|
220
220
|
/**
|
|
221
221
|
* Use this method to update an existing SCM setting. Permissions required: Edit IQ Elements
|
|
222
222
|
*/
|
|
223
|
-
updateSourceControlRaw(requestParameters:
|
|
223
|
+
updateSourceControlRaw(requestParameters: SourceControlApiUpdateSourceControlRequest, initOverrides?: RequestInit | runtime.InitOverrideFunction): Promise<runtime.ApiResponse<ApiSourceControlDTO>>;
|
|
224
224
|
/**
|
|
225
225
|
* Use this method to update an existing SCM setting. Permissions required: Edit IQ Elements
|
|
226
226
|
*/
|
|
227
|
-
updateSourceControl(requestParameters:
|
|
227
|
+
updateSourceControl(requestParameters: SourceControlApiUpdateSourceControlRequest, initOverrides?: RequestInit | runtime.InitOverrideFunction): Promise<ApiSourceControlDTO>;
|
|
228
228
|
}
|
|
229
229
|
/**
|
|
230
230
|
* @export
|
|
@@ -11,7 +11,7 @@
|
|
|
11
11
|
*/
|
|
12
12
|
import * as runtime from '../runtime';
|
|
13
13
|
import type { ApiPullRequestResults } from '../models/index';
|
|
14
|
-
export interface
|
|
14
|
+
export interface SourceControlMetricsApiGetSourceControlRequest {
|
|
15
15
|
ownerType: GetSourceControlOwnerTypeEnum;
|
|
16
16
|
internalOwnerId: string;
|
|
17
17
|
}
|
|
@@ -30,11 +30,11 @@ export interface SourceControlMetricsApiInterface {
|
|
|
30
30
|
* @throws {RequiredError}
|
|
31
31
|
* @memberof SourceControlMetricsApiInterface
|
|
32
32
|
*/
|
|
33
|
-
getSourceControlRaw(requestParameters:
|
|
33
|
+
getSourceControlRaw(requestParameters: SourceControlMetricsApiGetSourceControlRequest, initOverrides?: RequestInit | runtime.InitOverrideFunction): Promise<runtime.ApiResponse<ApiPullRequestResults>>;
|
|
34
34
|
/**
|
|
35
35
|
* Use this method to view the source control pull request metrics. Permissions required: View IQ Elements
|
|
36
36
|
*/
|
|
37
|
-
getSourceControl(requestParameters:
|
|
37
|
+
getSourceControl(requestParameters: SourceControlMetricsApiGetSourceControlRequest, initOverrides?: RequestInit | runtime.InitOverrideFunction): Promise<ApiPullRequestResults>;
|
|
38
38
|
}
|
|
39
39
|
/**
|
|
40
40
|
*
|
|
@@ -43,11 +43,11 @@ export declare class SourceControlMetricsApi extends runtime.BaseAPI implements
|
|
|
43
43
|
/**
|
|
44
44
|
* Use this method to view the source control pull request metrics. Permissions required: View IQ Elements
|
|
45
45
|
*/
|
|
46
|
-
getSourceControlRaw(requestParameters:
|
|
46
|
+
getSourceControlRaw(requestParameters: SourceControlMetricsApiGetSourceControlRequest, initOverrides?: RequestInit | runtime.InitOverrideFunction): Promise<runtime.ApiResponse<ApiPullRequestResults>>;
|
|
47
47
|
/**
|
|
48
48
|
* Use this method to view the source control pull request metrics. Permissions required: View IQ Elements
|
|
49
49
|
*/
|
|
50
|
-
getSourceControl(requestParameters:
|
|
50
|
+
getSourceControl(requestParameters: SourceControlMetricsApiGetSourceControlRequest, initOverrides?: RequestInit | runtime.InitOverrideFunction): Promise<ApiPullRequestResults>;
|
|
51
51
|
}
|
|
52
52
|
/**
|
|
53
53
|
* @export
|
|
@@ -11,11 +11,11 @@
|
|
|
11
11
|
*/
|
|
12
12
|
import * as runtime from '../runtime';
|
|
13
13
|
import type { ApiThirdPartyScanResultDTO, ApiThirdPartyScanTicketDTO } from '../models/index';
|
|
14
|
-
export interface
|
|
14
|
+
export interface ThirdPartyAnalysisApiGetScanStatusRequest {
|
|
15
15
|
applicationId: string;
|
|
16
16
|
scanRequestId: string;
|
|
17
17
|
}
|
|
18
|
-
export interface
|
|
18
|
+
export interface ThirdPartyAnalysisApiScanComponentsRequest {
|
|
19
19
|
applicationId: string;
|
|
20
20
|
source: string;
|
|
21
21
|
stageId?: string;
|
|
@@ -36,11 +36,11 @@ export interface ThirdPartyAnalysisApiInterface {
|
|
|
36
36
|
* @throws {RequiredError}
|
|
37
37
|
* @memberof ThirdPartyAnalysisApiInterface
|
|
38
38
|
*/
|
|
39
|
-
getScanStatusRaw(requestParameters:
|
|
39
|
+
getScanStatusRaw(requestParameters: ThirdPartyAnalysisApiGetScanStatusRequest, initOverrides?: RequestInit | runtime.InitOverrideFunction): Promise<runtime.ApiResponse<ApiThirdPartyScanResultDTO>>;
|
|
40
40
|
/**
|
|
41
41
|
* SBOM evaluation is an asynchronous operation. Use this method to check on the status of the SBOM evaluation. Permissions required: Evaluate Applications
|
|
42
42
|
*/
|
|
43
|
-
getScanStatus(requestParameters:
|
|
43
|
+
getScanStatus(requestParameters: ThirdPartyAnalysisApiGetScanStatusRequest, initOverrides?: RequestInit | runtime.InitOverrideFunction): Promise<ApiThirdPartyScanResultDTO>;
|
|
44
44
|
/**
|
|
45
45
|
* Use this method to perform an analysis of an SBOM. Permissions required: Evaluate Applications
|
|
46
46
|
* @param {string} applicationId Enter the application internal id. Use the Applications REST API to retrieve theapplication internal id.
|
|
@@ -51,11 +51,11 @@ export interface ThirdPartyAnalysisApiInterface {
|
|
|
51
51
|
* @throws {RequiredError}
|
|
52
52
|
* @memberof ThirdPartyAnalysisApiInterface
|
|
53
53
|
*/
|
|
54
|
-
scanComponentsRaw(requestParameters:
|
|
54
|
+
scanComponentsRaw(requestParameters: ThirdPartyAnalysisApiScanComponentsRequest, initOverrides?: RequestInit | runtime.InitOverrideFunction): Promise<runtime.ApiResponse<ApiThirdPartyScanTicketDTO>>;
|
|
55
55
|
/**
|
|
56
56
|
* Use this method to perform an analysis of an SBOM. Permissions required: Evaluate Applications
|
|
57
57
|
*/
|
|
58
|
-
scanComponents(requestParameters:
|
|
58
|
+
scanComponents(requestParameters: ThirdPartyAnalysisApiScanComponentsRequest, initOverrides?: RequestInit | runtime.InitOverrideFunction): Promise<ApiThirdPartyScanTicketDTO>;
|
|
59
59
|
}
|
|
60
60
|
/**
|
|
61
61
|
*
|
|
@@ -64,17 +64,17 @@ export declare class ThirdPartyAnalysisApi extends runtime.BaseAPI implements Th
|
|
|
64
64
|
/**
|
|
65
65
|
* SBOM evaluation is an asynchronous operation. Use this method to check on the status of the SBOM evaluation. Permissions required: Evaluate Applications
|
|
66
66
|
*/
|
|
67
|
-
getScanStatusRaw(requestParameters:
|
|
67
|
+
getScanStatusRaw(requestParameters: ThirdPartyAnalysisApiGetScanStatusRequest, initOverrides?: RequestInit | runtime.InitOverrideFunction): Promise<runtime.ApiResponse<ApiThirdPartyScanResultDTO>>;
|
|
68
68
|
/**
|
|
69
69
|
* SBOM evaluation is an asynchronous operation. Use this method to check on the status of the SBOM evaluation. Permissions required: Evaluate Applications
|
|
70
70
|
*/
|
|
71
|
-
getScanStatus(requestParameters:
|
|
71
|
+
getScanStatus(requestParameters: ThirdPartyAnalysisApiGetScanStatusRequest, initOverrides?: RequestInit | runtime.InitOverrideFunction): Promise<ApiThirdPartyScanResultDTO>;
|
|
72
72
|
/**
|
|
73
73
|
* Use this method to perform an analysis of an SBOM. Permissions required: Evaluate Applications
|
|
74
74
|
*/
|
|
75
|
-
scanComponentsRaw(requestParameters:
|
|
75
|
+
scanComponentsRaw(requestParameters: ThirdPartyAnalysisApiScanComponentsRequest, initOverrides?: RequestInit | runtime.InitOverrideFunction): Promise<runtime.ApiResponse<ApiThirdPartyScanTicketDTO>>;
|
|
76
76
|
/**
|
|
77
77
|
* Use this method to perform an analysis of an SBOM. Permissions required: Evaluate Applications
|
|
78
78
|
*/
|
|
79
|
-
scanComponents(requestParameters:
|
|
79
|
+
scanComponents(requestParameters: ThirdPartyAnalysisApiScanComponentsRequest, initOverrides?: RequestInit | runtime.InitOverrideFunction): Promise<ApiThirdPartyScanTicketDTO>;
|
|
80
80
|
}
|
|
@@ -11,14 +11,14 @@
|
|
|
11
11
|
*/
|
|
12
12
|
import * as runtime from '../runtime';
|
|
13
13
|
import type { ApiUserTokenDTO, ApiUserTokenExistsDTO } from '../models/index';
|
|
14
|
-
export interface
|
|
14
|
+
export interface UserTokensApiDeleteUserTokenByUserCodeRequest {
|
|
15
15
|
userCode: string;
|
|
16
16
|
}
|
|
17
|
-
export interface
|
|
17
|
+
export interface UserTokensApiGetUserTokenByUsernameAndRealmIdRequest {
|
|
18
18
|
username: string;
|
|
19
19
|
realm?: string;
|
|
20
20
|
}
|
|
21
|
-
export interface
|
|
21
|
+
export interface UserTokensApiGetUserTokensByCreatedBetweenAndRealmIdRequest {
|
|
22
22
|
createdAfter?: string;
|
|
23
23
|
createdBefore?: string;
|
|
24
24
|
realm?: string;
|
|
@@ -59,11 +59,11 @@ export interface UserTokensApiInterface {
|
|
|
59
59
|
* @throws {RequiredError}
|
|
60
60
|
* @memberof UserTokensApiInterface
|
|
61
61
|
*/
|
|
62
|
-
deleteUserTokenByUserCodeRaw(requestParameters:
|
|
62
|
+
deleteUserTokenByUserCodeRaw(requestParameters: UserTokensApiDeleteUserTokenByUserCodeRequest, initOverrides?: RequestInit | runtime.InitOverrideFunction): Promise<runtime.ApiResponse<void>>;
|
|
63
63
|
/**
|
|
64
64
|
* Use this method to delete an existing user token by specifying the userCode. Permissions required: Edit System Configuration and Users
|
|
65
65
|
*/
|
|
66
|
-
deleteUserTokenByUserCode(requestParameters:
|
|
66
|
+
deleteUserTokenByUserCode(requestParameters: UserTokensApiDeleteUserTokenByUserCodeRequest, initOverrides?: RequestInit | runtime.InitOverrideFunction): Promise<void>;
|
|
67
67
|
/**
|
|
68
68
|
* Use this method to retrieve a user token by specifying a username and realmId. Permissions required: Edit System Configuration and Users
|
|
69
69
|
* @param {string} username Enter the username.
|
|
@@ -72,11 +72,11 @@ export interface UserTokensApiInterface {
|
|
|
72
72
|
* @throws {RequiredError}
|
|
73
73
|
* @memberof UserTokensApiInterface
|
|
74
74
|
*/
|
|
75
|
-
getUserTokenByUsernameAndRealmIdRaw(requestParameters:
|
|
75
|
+
getUserTokenByUsernameAndRealmIdRaw(requestParameters: UserTokensApiGetUserTokenByUsernameAndRealmIdRequest, initOverrides?: RequestInit | runtime.InitOverrideFunction): Promise<runtime.ApiResponse<ApiUserTokenDTO>>;
|
|
76
76
|
/**
|
|
77
77
|
* Use this method to retrieve a user token by specifying a username and realmId. Permissions required: Edit System Configuration and Users
|
|
78
78
|
*/
|
|
79
|
-
getUserTokenByUsernameAndRealmId(requestParameters:
|
|
79
|
+
getUserTokenByUsernameAndRealmId(requestParameters: UserTokensApiGetUserTokenByUsernameAndRealmIdRequest, initOverrides?: RequestInit | runtime.InitOverrideFunction): Promise<ApiUserTokenDTO>;
|
|
80
80
|
/**
|
|
81
81
|
* Use this method to check if a user token has been issued to the logged in user. Permissions required: None
|
|
82
82
|
* @param {*} [options] Override http request option.
|
|
@@ -97,11 +97,11 @@ export interface UserTokensApiInterface {
|
|
|
97
97
|
* @throws {RequiredError}
|
|
98
98
|
* @memberof UserTokensApiInterface
|
|
99
99
|
*/
|
|
100
|
-
getUserTokensByCreatedBetweenAndRealmIdRaw(requestParameters:
|
|
100
|
+
getUserTokensByCreatedBetweenAndRealmIdRaw(requestParameters: UserTokensApiGetUserTokensByCreatedBetweenAndRealmIdRequest, initOverrides?: RequestInit | runtime.InitOverrideFunction): Promise<runtime.ApiResponse<Array<ApiUserTokenDTO>>>;
|
|
101
101
|
/**
|
|
102
102
|
* Use this method to retrieve user tokens created within a date range, in the supported IQ Server realms. Permissions required: Edit System Configuration and Users.
|
|
103
103
|
*/
|
|
104
|
-
getUserTokensByCreatedBetweenAndRealmId(requestParameters:
|
|
104
|
+
getUserTokensByCreatedBetweenAndRealmId(requestParameters: UserTokensApiGetUserTokensByCreatedBetweenAndRealmIdRequest, initOverrides?: RequestInit | runtime.InitOverrideFunction): Promise<Array<ApiUserTokenDTO>>;
|
|
105
105
|
/**
|
|
106
106
|
* Use this method to delete all existing LDAP user tokens. Permissions required: Edit System Configuration and Users
|
|
107
107
|
* @param {*} [options] Override http request option.
|
|
@@ -137,19 +137,19 @@ export declare class UserTokensApi extends runtime.BaseAPI implements UserTokens
|
|
|
137
137
|
/**
|
|
138
138
|
* Use this method to delete an existing user token by specifying the userCode. Permissions required: Edit System Configuration and Users
|
|
139
139
|
*/
|
|
140
|
-
deleteUserTokenByUserCodeRaw(requestParameters:
|
|
140
|
+
deleteUserTokenByUserCodeRaw(requestParameters: UserTokensApiDeleteUserTokenByUserCodeRequest, initOverrides?: RequestInit | runtime.InitOverrideFunction): Promise<runtime.ApiResponse<void>>;
|
|
141
141
|
/**
|
|
142
142
|
* Use this method to delete an existing user token by specifying the userCode. Permissions required: Edit System Configuration and Users
|
|
143
143
|
*/
|
|
144
|
-
deleteUserTokenByUserCode(requestParameters:
|
|
144
|
+
deleteUserTokenByUserCode(requestParameters: UserTokensApiDeleteUserTokenByUserCodeRequest, initOverrides?: RequestInit | runtime.InitOverrideFunction): Promise<void>;
|
|
145
145
|
/**
|
|
146
146
|
* Use this method to retrieve a user token by specifying a username and realmId. Permissions required: Edit System Configuration and Users
|
|
147
147
|
*/
|
|
148
|
-
getUserTokenByUsernameAndRealmIdRaw(requestParameters:
|
|
148
|
+
getUserTokenByUsernameAndRealmIdRaw(requestParameters: UserTokensApiGetUserTokenByUsernameAndRealmIdRequest, initOverrides?: RequestInit | runtime.InitOverrideFunction): Promise<runtime.ApiResponse<ApiUserTokenDTO>>;
|
|
149
149
|
/**
|
|
150
150
|
* Use this method to retrieve a user token by specifying a username and realmId. Permissions required: Edit System Configuration and Users
|
|
151
151
|
*/
|
|
152
|
-
getUserTokenByUsernameAndRealmId(requestParameters:
|
|
152
|
+
getUserTokenByUsernameAndRealmId(requestParameters: UserTokensApiGetUserTokenByUsernameAndRealmIdRequest, initOverrides?: RequestInit | runtime.InitOverrideFunction): Promise<ApiUserTokenDTO>;
|
|
153
153
|
/**
|
|
154
154
|
* Use this method to check if a user token has been issued to the logged in user. Permissions required: None
|
|
155
155
|
*/
|
|
@@ -161,11 +161,11 @@ export declare class UserTokensApi extends runtime.BaseAPI implements UserTokens
|
|
|
161
161
|
/**
|
|
162
162
|
* Use this method to retrieve user tokens created within a date range, in the supported IQ Server realms. Permissions required: Edit System Configuration and Users.
|
|
163
163
|
*/
|
|
164
|
-
getUserTokensByCreatedBetweenAndRealmIdRaw(requestParameters:
|
|
164
|
+
getUserTokensByCreatedBetweenAndRealmIdRaw(requestParameters: UserTokensApiGetUserTokensByCreatedBetweenAndRealmIdRequest, initOverrides?: RequestInit | runtime.InitOverrideFunction): Promise<runtime.ApiResponse<Array<ApiUserTokenDTO>>>;
|
|
165
165
|
/**
|
|
166
166
|
* Use this method to retrieve user tokens created within a date range, in the supported IQ Server realms. Permissions required: Edit System Configuration and Users.
|
|
167
167
|
*/
|
|
168
|
-
getUserTokensByCreatedBetweenAndRealmId(requestParameters?:
|
|
168
|
+
getUserTokensByCreatedBetweenAndRealmId(requestParameters?: UserTokensApiGetUserTokensByCreatedBetweenAndRealmIdRequest, initOverrides?: RequestInit | runtime.InitOverrideFunction): Promise<Array<ApiUserTokenDTO>>;
|
|
169
169
|
/**
|
|
170
170
|
* Use this method to delete all existing LDAP user tokens. Permissions required: Edit System Configuration and Users
|
|
171
171
|
*/
|
|
@@ -11,21 +11,21 @@
|
|
|
11
11
|
*/
|
|
12
12
|
import * as runtime from '../runtime';
|
|
13
13
|
import type { ApiUserDTO, ApiUserListDTO } from '../models/index';
|
|
14
|
-
export interface
|
|
14
|
+
export interface UsersApiAddRequest {
|
|
15
15
|
apiUserDTO?: ApiUserDTO;
|
|
16
16
|
}
|
|
17
|
-
export interface
|
|
17
|
+
export interface UsersApiDelete1Request {
|
|
18
18
|
username: string;
|
|
19
19
|
realm?: string;
|
|
20
20
|
}
|
|
21
|
-
export interface
|
|
21
|
+
export interface UsersApiGet1Request {
|
|
22
22
|
username: string;
|
|
23
23
|
realm?: string;
|
|
24
24
|
}
|
|
25
|
-
export interface
|
|
25
|
+
export interface UsersApiGetAll2Request {
|
|
26
26
|
realm?: string;
|
|
27
27
|
}
|
|
28
|
-
export interface
|
|
28
|
+
export interface UsersApiUpdateRequest {
|
|
29
29
|
username: string;
|
|
30
30
|
apiUserDTO?: ApiUserDTO;
|
|
31
31
|
}
|
|
@@ -43,11 +43,11 @@ export interface UsersApiInterface {
|
|
|
43
43
|
* @throws {RequiredError}
|
|
44
44
|
* @memberof UsersApiInterface
|
|
45
45
|
*/
|
|
46
|
-
addRaw(requestParameters:
|
|
46
|
+
addRaw(requestParameters: UsersApiAddRequest, initOverrides?: RequestInit | runtime.InitOverrideFunction): Promise<runtime.ApiResponse<void>>;
|
|
47
47
|
/**
|
|
48
48
|
* Use this method to create a new user. Permissions required: Edit System Configuration and Users
|
|
49
49
|
*/
|
|
50
|
-
add(requestParameters:
|
|
50
|
+
add(requestParameters: UsersApiAddRequest, initOverrides?: RequestInit | runtime.InitOverrideFunction): Promise<void>;
|
|
51
51
|
/**
|
|
52
52
|
* Use this method to delete an existing user. Permissions required: Edit System Configuration and Users
|
|
53
53
|
* @param {string} username Enter the username to be deleted.
|
|
@@ -56,11 +56,11 @@ export interface UsersApiInterface {
|
|
|
56
56
|
* @throws {RequiredError}
|
|
57
57
|
* @memberof UsersApiInterface
|
|
58
58
|
*/
|
|
59
|
-
delete1Raw(requestParameters:
|
|
59
|
+
delete1Raw(requestParameters: UsersApiDelete1Request, initOverrides?: RequestInit | runtime.InitOverrideFunction): Promise<runtime.ApiResponse<void>>;
|
|
60
60
|
/**
|
|
61
61
|
* Use this method to delete an existing user. Permissions required: Edit System Configuration and Users
|
|
62
62
|
*/
|
|
63
|
-
delete1(requestParameters:
|
|
63
|
+
delete1(requestParameters: UsersApiDelete1Request, initOverrides?: RequestInit | runtime.InitOverrideFunction): Promise<void>;
|
|
64
64
|
/**
|
|
65
65
|
* Use this method to retrieve user details for the specified user. Permissions required: Edit System Configuration and Users
|
|
66
66
|
* @param {string} username Enter the username.
|
|
@@ -69,11 +69,11 @@ export interface UsersApiInterface {
|
|
|
69
69
|
* @throws {RequiredError}
|
|
70
70
|
* @memberof UsersApiInterface
|
|
71
71
|
*/
|
|
72
|
-
get1Raw(requestParameters:
|
|
72
|
+
get1Raw(requestParameters: UsersApiGet1Request, initOverrides?: RequestInit | runtime.InitOverrideFunction): Promise<runtime.ApiResponse<ApiUserDTO>>;
|
|
73
73
|
/**
|
|
74
74
|
* Use this method to retrieve user details for the specified user. Permissions required: Edit System Configuration and Users
|
|
75
75
|
*/
|
|
76
|
-
get1(requestParameters:
|
|
76
|
+
get1(requestParameters: UsersApiGet1Request, initOverrides?: RequestInit | runtime.InitOverrideFunction): Promise<ApiUserDTO>;
|
|
77
77
|
/**
|
|
78
78
|
* Use this method to retrieve user details for all users. Permissions required: Edit System Configuration and Users
|
|
79
79
|
* @param {string} [realm] Enter the `realm`. Allowed values are `Internal`,`OAUTH2`, and `SAML`.
|
|
@@ -81,11 +81,11 @@ export interface UsersApiInterface {
|
|
|
81
81
|
* @throws {RequiredError}
|
|
82
82
|
* @memberof UsersApiInterface
|
|
83
83
|
*/
|
|
84
|
-
getAll2Raw(requestParameters:
|
|
84
|
+
getAll2Raw(requestParameters: UsersApiGetAll2Request, initOverrides?: RequestInit | runtime.InitOverrideFunction): Promise<runtime.ApiResponse<ApiUserListDTO>>;
|
|
85
85
|
/**
|
|
86
86
|
* Use this method to retrieve user details for all users. Permissions required: Edit System Configuration and Users
|
|
87
87
|
*/
|
|
88
|
-
getAll2(requestParameters:
|
|
88
|
+
getAll2(requestParameters: UsersApiGetAll2Request, initOverrides?: RequestInit | runtime.InitOverrideFunction): Promise<ApiUserListDTO>;
|
|
89
89
|
/**
|
|
90
90
|
* Use this method to update user details for an existing internal user, by specifying the username. Permissions required: Edit System Configuration and Users
|
|
91
91
|
* @param {string} username Enter the username.
|
|
@@ -94,11 +94,11 @@ export interface UsersApiInterface {
|
|
|
94
94
|
* @throws {RequiredError}
|
|
95
95
|
* @memberof UsersApiInterface
|
|
96
96
|
*/
|
|
97
|
-
updateRaw(requestParameters:
|
|
97
|
+
updateRaw(requestParameters: UsersApiUpdateRequest, initOverrides?: RequestInit | runtime.InitOverrideFunction): Promise<runtime.ApiResponse<ApiUserDTO>>;
|
|
98
98
|
/**
|
|
99
99
|
* Use this method to update user details for an existing internal user, by specifying the username. Permissions required: Edit System Configuration and Users
|
|
100
100
|
*/
|
|
101
|
-
update(requestParameters:
|
|
101
|
+
update(requestParameters: UsersApiUpdateRequest, initOverrides?: RequestInit | runtime.InitOverrideFunction): Promise<ApiUserDTO>;
|
|
102
102
|
}
|
|
103
103
|
/**
|
|
104
104
|
*
|
|
@@ -107,41 +107,41 @@ export declare class UsersApi extends runtime.BaseAPI implements UsersApiInterfa
|
|
|
107
107
|
/**
|
|
108
108
|
* Use this method to create a new user. Permissions required: Edit System Configuration and Users
|
|
109
109
|
*/
|
|
110
|
-
addRaw(requestParameters:
|
|
110
|
+
addRaw(requestParameters: UsersApiAddRequest, initOverrides?: RequestInit | runtime.InitOverrideFunction): Promise<runtime.ApiResponse<void>>;
|
|
111
111
|
/**
|
|
112
112
|
* Use this method to create a new user. Permissions required: Edit System Configuration and Users
|
|
113
113
|
*/
|
|
114
|
-
add(requestParameters?:
|
|
114
|
+
add(requestParameters?: UsersApiAddRequest, initOverrides?: RequestInit | runtime.InitOverrideFunction): Promise<void>;
|
|
115
115
|
/**
|
|
116
116
|
* Use this method to delete an existing user. Permissions required: Edit System Configuration and Users
|
|
117
117
|
*/
|
|
118
|
-
delete1Raw(requestParameters:
|
|
118
|
+
delete1Raw(requestParameters: UsersApiDelete1Request, initOverrides?: RequestInit | runtime.InitOverrideFunction): Promise<runtime.ApiResponse<void>>;
|
|
119
119
|
/**
|
|
120
120
|
* Use this method to delete an existing user. Permissions required: Edit System Configuration and Users
|
|
121
121
|
*/
|
|
122
|
-
delete1(requestParameters:
|
|
122
|
+
delete1(requestParameters: UsersApiDelete1Request, initOverrides?: RequestInit | runtime.InitOverrideFunction): Promise<void>;
|
|
123
123
|
/**
|
|
124
124
|
* Use this method to retrieve user details for the specified user. Permissions required: Edit System Configuration and Users
|
|
125
125
|
*/
|
|
126
|
-
get1Raw(requestParameters:
|
|
126
|
+
get1Raw(requestParameters: UsersApiGet1Request, initOverrides?: RequestInit | runtime.InitOverrideFunction): Promise<runtime.ApiResponse<ApiUserDTO>>;
|
|
127
127
|
/**
|
|
128
128
|
* Use this method to retrieve user details for the specified user. Permissions required: Edit System Configuration and Users
|
|
129
129
|
*/
|
|
130
|
-
get1(requestParameters:
|
|
130
|
+
get1(requestParameters: UsersApiGet1Request, initOverrides?: RequestInit | runtime.InitOverrideFunction): Promise<ApiUserDTO>;
|
|
131
131
|
/**
|
|
132
132
|
* Use this method to retrieve user details for all users. Permissions required: Edit System Configuration and Users
|
|
133
133
|
*/
|
|
134
|
-
getAll2Raw(requestParameters:
|
|
134
|
+
getAll2Raw(requestParameters: UsersApiGetAll2Request, initOverrides?: RequestInit | runtime.InitOverrideFunction): Promise<runtime.ApiResponse<ApiUserListDTO>>;
|
|
135
135
|
/**
|
|
136
136
|
* Use this method to retrieve user details for all users. Permissions required: Edit System Configuration and Users
|
|
137
137
|
*/
|
|
138
|
-
getAll2(requestParameters?:
|
|
138
|
+
getAll2(requestParameters?: UsersApiGetAll2Request, initOverrides?: RequestInit | runtime.InitOverrideFunction): Promise<ApiUserListDTO>;
|
|
139
139
|
/**
|
|
140
140
|
* Use this method to update user details for an existing internal user, by specifying the username. Permissions required: Edit System Configuration and Users
|
|
141
141
|
*/
|
|
142
|
-
updateRaw(requestParameters:
|
|
142
|
+
updateRaw(requestParameters: UsersApiUpdateRequest, initOverrides?: RequestInit | runtime.InitOverrideFunction): Promise<runtime.ApiResponse<ApiUserDTO>>;
|
|
143
143
|
/**
|
|
144
144
|
* Use this method to update user details for an existing internal user, by specifying the username. Permissions required: Edit System Configuration and Users
|
|
145
145
|
*/
|
|
146
|
-
update(requestParameters:
|
|
146
|
+
update(requestParameters: UsersApiUpdateRequest, initOverrides?: RequestInit | runtime.InitOverrideFunction): Promise<ApiUserDTO>;
|
|
147
147
|
}
|