@sailpoint/api-client 2.2.50 → 2.2.52
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/access_profiles/api.d.ts +1110 -3
- package/dist/access_profiles/api.js +964 -6
- package/dist/access_profiles/api.js.map +1 -1
- package/dist/approvals/api.d.ts +121 -46
- package/dist/approvals/api.js +37 -24
- package/dist/approvals/api.js.map +1 -1
- package/dist/capabilities/api.d.ts +2 -2
- package/dist/capabilities/api.js +2 -2
- package/dist/capabilities/api.js.map +1 -1
- package/dist/capabilities/base.d.ts +2 -2
- package/dist/capabilities/base.js +2 -2
- package/dist/capabilities/base.js.map +1 -1
- package/dist/capabilities/common.d.ts +2 -2
- package/dist/capabilities/common.js +2 -2
- package/dist/capabilities/common.js.map +1 -1
- package/dist/capabilities/configuration.d.ts +2 -2
- package/dist/capabilities/configuration.js +2 -2
- package/dist/capabilities/configuration.js.map +1 -1
- package/dist/capabilities/index.d.ts +2 -2
- package/dist/capabilities/index.js +2 -2
- package/dist/capabilities/index.js.map +1 -1
- package/dist/credentials/api.d.ts +2 -2
- package/dist/credentials/api.js +2 -2
- package/dist/credentials/api.js.map +1 -1
- package/dist/credentials/base.d.ts +2 -2
- package/dist/credentials/base.js +2 -2
- package/dist/credentials/base.js.map +1 -1
- package/dist/credentials/common.d.ts +2 -2
- package/dist/credentials/common.js +2 -2
- package/dist/credentials/common.js.map +1 -1
- package/dist/credentials/configuration.d.ts +2 -2
- package/dist/credentials/configuration.js +2 -2
- package/dist/credentials/configuration.js.map +1 -1
- package/dist/credentials/index.d.ts +2 -2
- package/dist/credentials/index.js +2 -2
- package/dist/credentials/index.js.map +1 -1
- package/dist/data_access_security/api.d.ts +10 -10
- package/dist/data_access_security/api.js +8 -8
- package/dist/data_access_security/api.js.map +1 -1
- package/dist/devices/api.d.ts +2 -2
- package/dist/devices/api.js +2 -2
- package/dist/devices/api.js.map +1 -1
- package/dist/devices/base.d.ts +2 -2
- package/dist/devices/base.js +2 -2
- package/dist/devices/base.js.map +1 -1
- package/dist/devices/common.d.ts +2 -2
- package/dist/devices/common.js +2 -2
- package/dist/devices/common.js.map +1 -1
- package/dist/devices/configuration.d.ts +2 -2
- package/dist/devices/configuration.js +2 -2
- package/dist/devices/configuration.js.map +1 -1
- package/dist/devices/index.d.ts +2 -2
- package/dist/devices/index.js +2 -2
- package/dist/devices/index.js.map +1 -1
- package/dist/esm/access_profiles/api.js +963 -5
- package/dist/esm/approvals/api.js +36 -23
- package/dist/esm/capabilities/api.js +2 -2
- package/dist/esm/capabilities/base.js +2 -2
- package/dist/esm/capabilities/common.js +2 -2
- package/dist/esm/capabilities/configuration.js +2 -2
- package/dist/esm/capabilities/index.js +2 -2
- package/dist/esm/credentials/api.js +2 -2
- package/dist/esm/credentials/base.js +2 -2
- package/dist/esm/credentials/common.js +2 -2
- package/dist/esm/credentials/configuration.js +2 -2
- package/dist/esm/credentials/index.js +2 -2
- package/dist/esm/data_access_security/api.js +8 -8
- package/dist/esm/devices/api.js +2 -2
- package/dist/esm/devices/base.js +2 -2
- package/dist/esm/devices/common.js +2 -2
- package/dist/esm/devices/configuration.js +2 -2
- package/dist/esm/devices/index.js +2 -2
- package/dist/esm/generic_request_approval_config/api.js +2 -2
- package/dist/esm/generic_request_approval_config/base.js +2 -2
- package/dist/esm/generic_request_approval_config/common.js +2 -2
- package/dist/esm/generic_request_approval_config/configuration.js +2 -2
- package/dist/esm/generic_request_approval_config/index.js +2 -2
- package/dist/esm/index.js +6 -0
- package/dist/esm/machine_account_recommendation/api.js +2 -2
- package/dist/esm/machine_account_recommendation/base.js +2 -2
- package/dist/esm/machine_account_recommendation/common.js +2 -2
- package/dist/esm/machine_account_recommendation/configuration.js +2 -2
- package/dist/esm/machine_account_recommendation/index.js +2 -2
- package/dist/esm/machine_identities_lifecycle_actions/api.js +35 -32
- package/dist/esm/machine_identity_metadata/api.js +2 -2
- package/dist/esm/machine_identity_metadata/base.js +2 -2
- package/dist/esm/machine_identity_metadata/common.js +2 -2
- package/dist/esm/machine_identity_metadata/configuration.js +2 -2
- package/dist/esm/machine_identity_metadata/index.js +2 -2
- package/dist/esm/machine_mapping_metadata/api.js +2 -2
- package/dist/esm/machine_mapping_metadata/base.js +2 -2
- package/dist/esm/machine_mapping_metadata/common.js +2 -2
- package/dist/esm/machine_mapping_metadata/configuration.js +2 -2
- package/dist/esm/machine_mapping_metadata/index.js +2 -2
- package/dist/esm/nerm/common.js +2 -2
- package/dist/esm/nermv2025/common.js +2 -2
- package/dist/esm/reminder_escalations/api.js +522 -0
- package/dist/esm/reminder_escalations/base.js +83 -0
- package/dist/esm/reminder_escalations/common.js +287 -0
- package/dist/esm/reminder_escalations/configuration.js +42 -0
- package/dist/esm/reminder_escalations/index.js +15 -0
- package/dist/esm/roles/api.js +529 -2
- package/dist/esm/sources/api.js +2 -1
- package/dist/esm/ui_plugins/api.js +1657 -0
- package/dist/esm/ui_plugins/base.js +83 -0
- package/dist/esm/ui_plugins/common.js +287 -0
- package/dist/esm/ui_plugins/configuration.js +42 -0
- package/dist/esm/ui_plugins/index.js +15 -0
- package/dist/generic_request_approval_config/api.d.ts +2 -2
- package/dist/generic_request_approval_config/api.js +2 -2
- package/dist/generic_request_approval_config/api.js.map +1 -1
- package/dist/generic_request_approval_config/base.d.ts +2 -2
- package/dist/generic_request_approval_config/base.js +2 -2
- package/dist/generic_request_approval_config/base.js.map +1 -1
- package/dist/generic_request_approval_config/common.d.ts +2 -2
- package/dist/generic_request_approval_config/common.js +2 -2
- package/dist/generic_request_approval_config/common.js.map +1 -1
- package/dist/generic_request_approval_config/configuration.d.ts +2 -2
- package/dist/generic_request_approval_config/configuration.js +2 -2
- package/dist/generic_request_approval_config/configuration.js.map +1 -1
- package/dist/generic_request_approval_config/index.d.ts +2 -2
- package/dist/generic_request_approval_config/index.js +2 -2
- package/dist/generic_request_approval_config/index.js.map +1 -1
- package/dist/index.d.ts +6 -0
- package/dist/index.js +103 -97
- package/dist/index.js.map +1 -1
- package/dist/machine_account_recommendation/api.d.ts +2 -2
- package/dist/machine_account_recommendation/api.js +2 -2
- package/dist/machine_account_recommendation/api.js.map +1 -1
- package/dist/machine_account_recommendation/base.d.ts +2 -2
- package/dist/machine_account_recommendation/base.js +2 -2
- package/dist/machine_account_recommendation/base.js.map +1 -1
- package/dist/machine_account_recommendation/common.d.ts +2 -2
- package/dist/machine_account_recommendation/common.js +2 -2
- package/dist/machine_account_recommendation/common.js.map +1 -1
- package/dist/machine_account_recommendation/configuration.d.ts +2 -2
- package/dist/machine_account_recommendation/configuration.js +2 -2
- package/dist/machine_account_recommendation/configuration.js.map +1 -1
- package/dist/machine_account_recommendation/index.d.ts +2 -2
- package/dist/machine_account_recommendation/index.js +2 -2
- package/dist/machine_account_recommendation/index.js.map +1 -1
- package/dist/machine_identities_lifecycle_actions/api.d.ts +67 -63
- package/dist/machine_identities_lifecycle_actions/api.js +36 -33
- package/dist/machine_identities_lifecycle_actions/api.js.map +1 -1
- package/dist/machine_identity_metadata/api.d.ts +2 -2
- package/dist/machine_identity_metadata/api.js +2 -2
- package/dist/machine_identity_metadata/api.js.map +1 -1
- package/dist/machine_identity_metadata/base.d.ts +2 -2
- package/dist/machine_identity_metadata/base.js +2 -2
- package/dist/machine_identity_metadata/base.js.map +1 -1
- package/dist/machine_identity_metadata/common.d.ts +2 -2
- package/dist/machine_identity_metadata/common.js +2 -2
- package/dist/machine_identity_metadata/common.js.map +1 -1
- package/dist/machine_identity_metadata/configuration.d.ts +2 -2
- package/dist/machine_identity_metadata/configuration.js +2 -2
- package/dist/machine_identity_metadata/configuration.js.map +1 -1
- package/dist/machine_identity_metadata/index.d.ts +2 -2
- package/dist/machine_identity_metadata/index.js +2 -2
- package/dist/machine_identity_metadata/index.js.map +1 -1
- package/dist/machine_mapping_metadata/api.d.ts +2 -2
- package/dist/machine_mapping_metadata/api.js +2 -2
- package/dist/machine_mapping_metadata/api.js.map +1 -1
- package/dist/machine_mapping_metadata/base.d.ts +2 -2
- package/dist/machine_mapping_metadata/base.js +2 -2
- package/dist/machine_mapping_metadata/base.js.map +1 -1
- package/dist/machine_mapping_metadata/common.d.ts +2 -2
- package/dist/machine_mapping_metadata/common.js +2 -2
- package/dist/machine_mapping_metadata/common.js.map +1 -1
- package/dist/machine_mapping_metadata/configuration.d.ts +2 -2
- package/dist/machine_mapping_metadata/configuration.js +2 -2
- package/dist/machine_mapping_metadata/configuration.js.map +1 -1
- package/dist/machine_mapping_metadata/index.d.ts +2 -2
- package/dist/machine_mapping_metadata/index.js +2 -2
- package/dist/machine_mapping_metadata/index.js.map +1 -1
- package/dist/nerm/common.js +2 -2
- package/dist/nerm/common.js.map +1 -1
- package/dist/nermv2025/common.js +2 -2
- package/dist/nermv2025/common.js.map +1 -1
- package/dist/reminder_escalations/api.d.ts +665 -0
- package/dist/reminder_escalations/api.js +532 -0
- package/dist/reminder_escalations/api.js.map +1 -0
- package/dist/reminder_escalations/base.d.ts +66 -0
- package/dist/reminder_escalations/base.js +90 -0
- package/dist/reminder_escalations/base.js.map +1 -0
- package/dist/reminder_escalations/common.d.ts +65 -0
- package/dist/reminder_escalations/common.js +300 -0
- package/dist/reminder_escalations/common.js.map +1 -0
- package/dist/reminder_escalations/configuration.d.ts +91 -0
- package/dist/reminder_escalations/configuration.js +46 -0
- package/dist/reminder_escalations/configuration.js.map +1 -0
- package/dist/reminder_escalations/index.d.ts +13 -0
- package/dist/reminder_escalations/index.js +32 -0
- package/dist/reminder_escalations/index.js.map +1 -0
- package/dist/roles/api.d.ts +972 -88
- package/dist/roles/api.js +530 -3
- package/dist/roles/api.js.map +1 -1
- package/dist/sources/api.d.ts +2 -1
- package/dist/sources/api.js +2 -1
- package/dist/sources/api.js.map +1 -1
- package/dist/ui_plugins/api.d.ts +1514 -0
- package/dist/ui_plugins/api.js +1667 -0
- package/dist/ui_plugins/api.js.map +1 -0
- package/dist/ui_plugins/base.d.ts +66 -0
- package/dist/ui_plugins/base.js +90 -0
- package/dist/ui_plugins/base.js.map +1 -0
- package/dist/ui_plugins/common.d.ts +65 -0
- package/dist/ui_plugins/common.js +300 -0
- package/dist/ui_plugins/common.js.map +1 -0
- package/dist/ui_plugins/configuration.d.ts +91 -0
- package/dist/ui_plugins/configuration.js +46 -0
- package/dist/ui_plugins/configuration.js.map +1 -0
- package/dist/ui_plugins/index.d.ts +13 -0
- package/dist/ui_plugins/index.js +32 -0
- package/dist/ui_plugins/index.js.map +1 -0
- package/package.json +1 -1
- package/sailpoint-scopes.json +487 -18
|
@@ -96,6 +96,30 @@ export var AccessProfileApprovalSchemeApproverTypeEnum = {
|
|
|
96
96
|
AdditionalOwner: 'ADDITIONAL_OWNER',
|
|
97
97
|
AdditionalGovernanceGroup: 'ADDITIONAL_GOVERNANCE_GROUP'
|
|
98
98
|
};
|
|
99
|
+
export var AccessProfileEntitlementPrivilegeLevelDirectEnum = {
|
|
100
|
+
High: 'HIGH',
|
|
101
|
+
Low: 'LOW',
|
|
102
|
+
Medium: 'MEDIUM',
|
|
103
|
+
None: 'NONE'
|
|
104
|
+
};
|
|
105
|
+
export var AccessProfileEntitlementPrivilegeLevelSetByTypeEnum = {
|
|
106
|
+
Override: 'OVERRIDE',
|
|
107
|
+
CustomCriteria: 'CUSTOM_CRITERIA',
|
|
108
|
+
ConnectorCriteria: 'CONNECTOR_CRITERIA',
|
|
109
|
+
SingleLevelCriteria: 'SINGLE_LEVEL_CRITERIA'
|
|
110
|
+
};
|
|
111
|
+
export var AccessProfileEntitlementPrivilegeLevelInheritedEnum = {
|
|
112
|
+
High: 'HIGH',
|
|
113
|
+
Low: 'LOW',
|
|
114
|
+
Medium: 'MEDIUM',
|
|
115
|
+
None: 'NONE'
|
|
116
|
+
};
|
|
117
|
+
export var AccessProfileEntitlementPrivilegeLevelEffectiveEnum = {
|
|
118
|
+
High: 'HIGH',
|
|
119
|
+
Low: 'LOW',
|
|
120
|
+
Medium: 'MEDIUM',
|
|
121
|
+
None: 'NONE'
|
|
122
|
+
};
|
|
99
123
|
export var AccessProfileMetadataBulkUpdateByFilterRequestOperationEnum = {
|
|
100
124
|
Add: 'ADD',
|
|
101
125
|
Remove: 'REMOVE',
|
|
@@ -135,12 +159,26 @@ export var AccessProfileMetadataBulkUpdateResponseStatusEnum = {
|
|
|
135
159
|
PreProcessFailed: 'PRE_PROCESS_FAILED',
|
|
136
160
|
Failed: 'FAILED'
|
|
137
161
|
};
|
|
162
|
+
export var AccessProfilePrivilegeLevelEffectiveEnum = {
|
|
163
|
+
None: 'NONE',
|
|
164
|
+
Low: 'LOW',
|
|
165
|
+
Medium: 'MEDIUM',
|
|
166
|
+
High: 'HIGH',
|
|
167
|
+
Undetermined: 'UNDETERMINED'
|
|
168
|
+
};
|
|
138
169
|
export var AccessProfileSourceRefTypeEnum = {
|
|
139
170
|
Source: 'SOURCE'
|
|
140
171
|
};
|
|
141
172
|
export var AccessProfileUsageUsedByInnerTypeEnum = {
|
|
142
173
|
Role: 'ROLE'
|
|
143
174
|
};
|
|
175
|
+
export var Accessprofilev2PrivilegeLevelEffectiveEnum = {
|
|
176
|
+
None: 'NONE',
|
|
177
|
+
Low: 'LOW',
|
|
178
|
+
Medium: 'MEDIUM',
|
|
179
|
+
High: 'HIGH',
|
|
180
|
+
Undetermined: 'UNDETERMINED'
|
|
181
|
+
};
|
|
144
182
|
export var AdditionalOwnerRefTypeEnum = {
|
|
145
183
|
Identity: 'IDENTITY',
|
|
146
184
|
GovernanceGroup: 'GOVERNANCE_GROUP'
|
|
@@ -152,6 +190,30 @@ export var AttributeValueDTOTypeEnum = {
|
|
|
152
190
|
export var EntitlementOwnerTypeEnum = {
|
|
153
191
|
Identity: 'IDENTITY'
|
|
154
192
|
};
|
|
193
|
+
export var EntitlementPrivilegeLevelDirectEnum = {
|
|
194
|
+
High: 'HIGH',
|
|
195
|
+
Low: 'LOW',
|
|
196
|
+
Medium: 'MEDIUM',
|
|
197
|
+
None: 'NONE'
|
|
198
|
+
};
|
|
199
|
+
export var EntitlementPrivilegeLevelSetByTypeEnum = {
|
|
200
|
+
Override: 'OVERRIDE',
|
|
201
|
+
CustomCriteria: 'CUSTOM_CRITERIA',
|
|
202
|
+
ConnectorCriteria: 'CONNECTOR_CRITERIA',
|
|
203
|
+
SingleLevelCriteria: 'SINGLE_LEVEL_CRITERIA'
|
|
204
|
+
};
|
|
205
|
+
export var EntitlementPrivilegeLevelInheritedEnum = {
|
|
206
|
+
High: 'HIGH',
|
|
207
|
+
Low: 'LOW',
|
|
208
|
+
Medium: 'MEDIUM',
|
|
209
|
+
None: 'NONE'
|
|
210
|
+
};
|
|
211
|
+
export var EntitlementPrivilegeLevelEffectiveEnum = {
|
|
212
|
+
High: 'HIGH',
|
|
213
|
+
Low: 'LOW',
|
|
214
|
+
Medium: 'MEDIUM',
|
|
215
|
+
None: 'NONE'
|
|
216
|
+
};
|
|
155
217
|
export var EntitlementRefTypeEnum = {
|
|
156
218
|
Entitlement: 'ENTITLEMENT'
|
|
157
219
|
};
|
|
@@ -229,6 +291,47 @@ export var AccessProfilesApiAxiosParamCreator = function (configuration) {
|
|
|
229
291
|
});
|
|
230
292
|
});
|
|
231
293
|
},
|
|
294
|
+
/**
|
|
295
|
+
* Create an access profile. This version accepts the same request body and applies the same validation as [Create Access Profile V1](https://developer.sailpoint.com/docs/api/create-access-profile-v-1). It returns the v2 access profile shape, which adds the read-only `privilegeLevel` field. A user with `ROLE_SUBADMIN` or `SOURCE_SUBADMIN` authority must be associated with the access profile\'s source. The maximum supported length for the description field is 2000 characters. Longer descriptions will be preserved for existing access profiles. However, any new access profiles as well as any updates to existing descriptions are limited to 2000 characters. >**Note:** To use this endpoint, you need all the listed scopes. >**Note:** `privilegeLevel` is read-only and is ignored if supplied in the request body. It is calculated asynchronously from the access profile\'s entitlements, so it is typically absent from the create response.
|
|
296
|
+
* @summary Create access profile
|
|
297
|
+
* @param {Accessprofilev2} accessprofilev2
|
|
298
|
+
* @param {string} [xSailPointExperimental] Use this header to enable this experimental API.
|
|
299
|
+
* @param {*} [axiosOptions] Override http request option.
|
|
300
|
+
* @throws {RequiredError}
|
|
301
|
+
*/
|
|
302
|
+
createAccessProfileV2: function (accessprofilev2, xSailPointExperimental, axiosOptions) {
|
|
303
|
+
if (axiosOptions === void 0) { axiosOptions = {}; }
|
|
304
|
+
return __awaiter(_this, void 0, void 0, function () {
|
|
305
|
+
var localVarPath, localVarUrlObj, baseOptions, localVarRequestOptions, localVarHeaderParameter, localVarQueryParameter, headersFromBaseOptions;
|
|
306
|
+
return __generator(this, function (_a) {
|
|
307
|
+
// verify required parameter 'accessprofilev2' is not null or undefined
|
|
308
|
+
assertParamExists('createAccessProfileV2', 'accessprofilev2', accessprofilev2);
|
|
309
|
+
if (xSailPointExperimental === undefined) {
|
|
310
|
+
xSailPointExperimental = 'true';
|
|
311
|
+
}
|
|
312
|
+
localVarPath = "/access-profiles/v2";
|
|
313
|
+
localVarUrlObj = new URL(localVarPath, DUMMY_BASE_URL);
|
|
314
|
+
if (configuration) {
|
|
315
|
+
baseOptions = configuration.baseOptions;
|
|
316
|
+
}
|
|
317
|
+
localVarRequestOptions = __assign(__assign({ method: 'POST' }, baseOptions), axiosOptions);
|
|
318
|
+
localVarHeaderParameter = {};
|
|
319
|
+
localVarQueryParameter = {};
|
|
320
|
+
localVarHeaderParameter['Content-Type'] = 'application/json';
|
|
321
|
+
if (xSailPointExperimental != null) {
|
|
322
|
+
localVarHeaderParameter['X-SailPoint-Experimental'] = String(xSailPointExperimental);
|
|
323
|
+
}
|
|
324
|
+
setSearchParams(localVarUrlObj, localVarQueryParameter);
|
|
325
|
+
headersFromBaseOptions = baseOptions && baseOptions.headers ? baseOptions.headers : {};
|
|
326
|
+
localVarRequestOptions.headers = __assign(__assign(__assign({}, localVarHeaderParameter), headersFromBaseOptions), axiosOptions.headers);
|
|
327
|
+
localVarRequestOptions.data = serializeDataIfNeeded(accessprofilev2, localVarRequestOptions, configuration);
|
|
328
|
+
return [2 /*return*/, {
|
|
329
|
+
url: toPathString(localVarUrlObj),
|
|
330
|
+
axiosOptions: localVarRequestOptions,
|
|
331
|
+
}];
|
|
332
|
+
});
|
|
333
|
+
});
|
|
334
|
+
},
|
|
232
335
|
/**
|
|
233
336
|
* This API deletes an existing Access Profile. The Access Profile must not be in use, for example, Access Profile can not be deleted if they belong to an Application, Life Cycle State or a Role. If it is, a 400 error is returned. A user with SOURCE_SUBADMIN must be able to administer the Source associated with the Access Profile.
|
|
234
337
|
* @summary Delete the specified access profile
|
|
@@ -262,6 +365,46 @@ export var AccessProfilesApiAxiosParamCreator = function (configuration) {
|
|
|
262
365
|
});
|
|
263
366
|
});
|
|
264
367
|
},
|
|
368
|
+
/**
|
|
369
|
+
* This API deletes an existing Access Profile. This version behaves identically to [Delete the Specified Access Profile V1](https://developer.sailpoint.com/docs/api/delete-access-profile-v-1). The Access Profile must not be in use, for example, Access Profile can not be deleted if they belong to an Application, Life Cycle State or a Role. If it is, a 400 error is returned. A user with SOURCE_SUBADMIN must be able to administer the Source associated with the Access Profile.
|
|
370
|
+
* @summary Delete the specified access profile
|
|
371
|
+
* @param {string} id ID of the Access Profile to delete
|
|
372
|
+
* @param {string} [xSailPointExperimental] Use this header to enable this experimental API.
|
|
373
|
+
* @param {*} [axiosOptions] Override http request option.
|
|
374
|
+
* @throws {RequiredError}
|
|
375
|
+
*/
|
|
376
|
+
deleteAccessProfileV2: function (id, xSailPointExperimental, axiosOptions) {
|
|
377
|
+
if (axiosOptions === void 0) { axiosOptions = {}; }
|
|
378
|
+
return __awaiter(_this, void 0, void 0, function () {
|
|
379
|
+
var localVarPath, localVarUrlObj, baseOptions, localVarRequestOptions, localVarHeaderParameter, localVarQueryParameter, headersFromBaseOptions;
|
|
380
|
+
return __generator(this, function (_a) {
|
|
381
|
+
// verify required parameter 'id' is not null or undefined
|
|
382
|
+
assertParamExists('deleteAccessProfileV2', 'id', id);
|
|
383
|
+
if (xSailPointExperimental === undefined) {
|
|
384
|
+
xSailPointExperimental = 'true';
|
|
385
|
+
}
|
|
386
|
+
localVarPath = "/access-profiles/v2/{id}"
|
|
387
|
+
.replace("{".concat("id", "}"), encodeURIComponent(String(id)));
|
|
388
|
+
localVarUrlObj = new URL(localVarPath, DUMMY_BASE_URL);
|
|
389
|
+
if (configuration) {
|
|
390
|
+
baseOptions = configuration.baseOptions;
|
|
391
|
+
}
|
|
392
|
+
localVarRequestOptions = __assign(__assign({ method: 'DELETE' }, baseOptions), axiosOptions);
|
|
393
|
+
localVarHeaderParameter = {};
|
|
394
|
+
localVarQueryParameter = {};
|
|
395
|
+
if (xSailPointExperimental != null) {
|
|
396
|
+
localVarHeaderParameter['X-SailPoint-Experimental'] = String(xSailPointExperimental);
|
|
397
|
+
}
|
|
398
|
+
setSearchParams(localVarUrlObj, localVarQueryParameter);
|
|
399
|
+
headersFromBaseOptions = baseOptions && baseOptions.headers ? baseOptions.headers : {};
|
|
400
|
+
localVarRequestOptions.headers = __assign(__assign(__assign({}, localVarHeaderParameter), headersFromBaseOptions), axiosOptions.headers);
|
|
401
|
+
return [2 /*return*/, {
|
|
402
|
+
url: toPathString(localVarUrlObj),
|
|
403
|
+
axiosOptions: localVarRequestOptions,
|
|
404
|
+
}];
|
|
405
|
+
});
|
|
406
|
+
});
|
|
407
|
+
},
|
|
265
408
|
/**
|
|
266
409
|
* This endpoint initiates a bulk deletion of one or more access profiles. When the request is successful, the endpoint returns the bulk delete\'s task result ID. To follow the task, you can use [Get Task Status by ID](https://developer.sailpoint.com/docs/api/get-task-status-v-1), which will return the task result\'s status and information. This endpoint can only bulk delete up to a limit of 50 access profiles per request. By default, if any of the indicated access profiles are in use, no deletions will be performed and the **inUse** field of the response indicates the usages that must be removed first. If the request field **bestEffortOnly** is **true**, however, usages are reported in the **inUse** response field but all other indicated access profiles will be deleted. A SOURCE_SUBADMIN user can only use this endpoint to delete access profiles associated with sources they\'re able to administer.
|
|
267
410
|
* @summary Delete access profile(s)
|
|
@@ -296,6 +439,47 @@ export var AccessProfilesApiAxiosParamCreator = function (configuration) {
|
|
|
296
439
|
});
|
|
297
440
|
});
|
|
298
441
|
},
|
|
442
|
+
/**
|
|
443
|
+
* This endpoint initiates a bulk deletion of one or more access profiles. This version behaves identically to [Delete Access Profile(s) V1](https://developer.sailpoint.com/docs/api/delete-access-profiles-in-bulk-v-1). When the request is successful, the endpoint returns the bulk delete\'s task result ID. To follow the task, you can use [Get Task Status by ID](https://developer.sailpoint.com/docs/api/get-task-status-v-1), which will return the task result\'s status and information. This endpoint can only bulk delete up to a limit of 50 access profiles per request. By default, if any of the indicated access profiles are in use, no deletions will be performed and the **inUse** field of the response indicates the usages that must be removed first. If the request field **bestEffortOnly** is **true**, however, usages are reported in the **inUse** response field but all other indicated access profiles will be deleted. A SOURCE_SUBADMIN user can only use this endpoint to delete access profiles associated with sources they\'re able to administer.
|
|
444
|
+
* @summary Delete access profile(s)
|
|
445
|
+
* @param {AccessProfileBulkDeleteRequest} accessProfileBulkDeleteRequest
|
|
446
|
+
* @param {string} [xSailPointExperimental] Use this header to enable this experimental API.
|
|
447
|
+
* @param {*} [axiosOptions] Override http request option.
|
|
448
|
+
* @throws {RequiredError}
|
|
449
|
+
*/
|
|
450
|
+
deleteAccessProfilesInBulkV2: function (accessProfileBulkDeleteRequest, xSailPointExperimental, axiosOptions) {
|
|
451
|
+
if (axiosOptions === void 0) { axiosOptions = {}; }
|
|
452
|
+
return __awaiter(_this, void 0, void 0, function () {
|
|
453
|
+
var localVarPath, localVarUrlObj, baseOptions, localVarRequestOptions, localVarHeaderParameter, localVarQueryParameter, headersFromBaseOptions;
|
|
454
|
+
return __generator(this, function (_a) {
|
|
455
|
+
// verify required parameter 'accessProfileBulkDeleteRequest' is not null or undefined
|
|
456
|
+
assertParamExists('deleteAccessProfilesInBulkV2', 'accessProfileBulkDeleteRequest', accessProfileBulkDeleteRequest);
|
|
457
|
+
if (xSailPointExperimental === undefined) {
|
|
458
|
+
xSailPointExperimental = 'true';
|
|
459
|
+
}
|
|
460
|
+
localVarPath = "/access-profiles/v2/bulk-delete";
|
|
461
|
+
localVarUrlObj = new URL(localVarPath, DUMMY_BASE_URL);
|
|
462
|
+
if (configuration) {
|
|
463
|
+
baseOptions = configuration.baseOptions;
|
|
464
|
+
}
|
|
465
|
+
localVarRequestOptions = __assign(__assign({ method: 'POST' }, baseOptions), axiosOptions);
|
|
466
|
+
localVarHeaderParameter = {};
|
|
467
|
+
localVarQueryParameter = {};
|
|
468
|
+
localVarHeaderParameter['Content-Type'] = 'application/json';
|
|
469
|
+
if (xSailPointExperimental != null) {
|
|
470
|
+
localVarHeaderParameter['X-SailPoint-Experimental'] = String(xSailPointExperimental);
|
|
471
|
+
}
|
|
472
|
+
setSearchParams(localVarUrlObj, localVarQueryParameter);
|
|
473
|
+
headersFromBaseOptions = baseOptions && baseOptions.headers ? baseOptions.headers : {};
|
|
474
|
+
localVarRequestOptions.headers = __assign(__assign(__assign({}, localVarHeaderParameter), headersFromBaseOptions), axiosOptions.headers);
|
|
475
|
+
localVarRequestOptions.data = serializeDataIfNeeded(accessProfileBulkDeleteRequest, localVarRequestOptions, configuration);
|
|
476
|
+
return [2 /*return*/, {
|
|
477
|
+
url: toPathString(localVarUrlObj),
|
|
478
|
+
axiosOptions: localVarRequestOptions,
|
|
479
|
+
}];
|
|
480
|
+
});
|
|
481
|
+
});
|
|
482
|
+
},
|
|
299
483
|
/**
|
|
300
484
|
* This API removes a single Access Model Metadata value from an access profile by attribute key and attribute value.
|
|
301
485
|
* @summary Remove metadata from access profile
|
|
@@ -390,6 +574,70 @@ export var AccessProfilesApiAxiosParamCreator = function (configuration) {
|
|
|
390
574
|
});
|
|
391
575
|
});
|
|
392
576
|
},
|
|
577
|
+
/**
|
|
578
|
+
* Get a list of an access profile\'s entitlements. This version reads from Search Lite and returns a superset of the entitlement returned by [List Access Profile\'s Entitlements V1](https://developer.sailpoint.com/docs/api/get-access-profile-entitlements-v-1), adding the entitlement\'s `tags` and calculated `privilegeLevel`. It also supports opaque cursor pagination through the `cursor` parameter and `X-Next-Cursor` response header. A SOURCE_SUBADMIN user must have access to the source associated with the specified access profile.
|
|
579
|
+
* @summary List access profile\'s entitlements
|
|
580
|
+
* @param {string} id ID of the access profile containing the entitlements.
|
|
581
|
+
* @param {string} [xSailPointExperimental] Use this header to enable this experimental API.
|
|
582
|
+
* @param {number} [limit] Max number of results to return. See [API Standard Collection Parameters](https://developer.sailpoint.com/docs/api/standard-collection-parameters) for more information.
|
|
583
|
+
* @param {number} [offset] Offset into the full result set. Usually specified with *limit* to paginate through the results. Must be 0 when you supply a `cursor`, and `offset` plus `limit` must not exceed 10000. See [API Standard Collection Parameters](https://developer.sailpoint.com/docs/api/standard-collection-parameters) for more information.
|
|
584
|
+
* @param {boolean} [count] If *true* it will populate the *X-Total-Count* response header with the number of results that would be returned if *limit* and *offset* were ignored. Since requesting a total count can have a performance impact, it is recommended not to send **count=true** if that value will not be used. See [API Standard Collection Parameters](https://developer.sailpoint.com/docs/api/standard-collection-parameters) for more information.
|
|
585
|
+
* @param {string} [filters] Filter results using the standard syntax described in [API Standard Collection Parameters](https://developer.sailpoint.com/docs/api/standard-collection-parameters#filtering-results) Filtering is supported for the following fields and operators: **id**: *eq, in* **name**: *eq, in, co* **attribute**: *eq, co* **value**: *eq, co* **created**: *lt, le, gt, ge* **modified**: *lt, le, gt, ge* **privilegeLevel.effective**: *eq, in* Results are automatically scoped to entitlements belonging to the access profile.
|
|
586
|
+
* @param {string} [sorters] Sort results using the standard syntax described in [API Standard Collection Parameters](https://developer.sailpoint.com/docs/api/standard-collection-parameters#sorting-results) Sorting is supported for the following fields: **name, attribute, value, created, modified, id, privilegeLevel.effective** Defaults to **created** ascending when omitted.
|
|
587
|
+
* @param {string} [cursor] Opaque cursor taken from the `X-Next-Cursor` header of a previous response, used to retrieve the next page of results. When you supply a cursor, `offset` must be 0.
|
|
588
|
+
* @param {*} [axiosOptions] Override http request option.
|
|
589
|
+
* @throws {RequiredError}
|
|
590
|
+
*/
|
|
591
|
+
getAccessProfileEntitlementsV2: function (id, xSailPointExperimental, limit, offset, count, filters, sorters, cursor, axiosOptions) {
|
|
592
|
+
if (axiosOptions === void 0) { axiosOptions = {}; }
|
|
593
|
+
return __awaiter(_this, void 0, void 0, function () {
|
|
594
|
+
var localVarPath, localVarUrlObj, baseOptions, localVarRequestOptions, localVarHeaderParameter, localVarQueryParameter, headersFromBaseOptions;
|
|
595
|
+
return __generator(this, function (_a) {
|
|
596
|
+
// verify required parameter 'id' is not null or undefined
|
|
597
|
+
assertParamExists('getAccessProfileEntitlementsV2', 'id', id);
|
|
598
|
+
if (xSailPointExperimental === undefined) {
|
|
599
|
+
xSailPointExperimental = 'true';
|
|
600
|
+
}
|
|
601
|
+
localVarPath = "/access-profiles/v2/{id}/entitlements"
|
|
602
|
+
.replace("{".concat("id", "}"), encodeURIComponent(String(id)));
|
|
603
|
+
localVarUrlObj = new URL(localVarPath, DUMMY_BASE_URL);
|
|
604
|
+
if (configuration) {
|
|
605
|
+
baseOptions = configuration.baseOptions;
|
|
606
|
+
}
|
|
607
|
+
localVarRequestOptions = __assign(__assign({ method: 'GET' }, baseOptions), axiosOptions);
|
|
608
|
+
localVarHeaderParameter = {};
|
|
609
|
+
localVarQueryParameter = {};
|
|
610
|
+
if (limit !== undefined) {
|
|
611
|
+
localVarQueryParameter['limit'] = limit;
|
|
612
|
+
}
|
|
613
|
+
if (offset !== undefined) {
|
|
614
|
+
localVarQueryParameter['offset'] = offset;
|
|
615
|
+
}
|
|
616
|
+
if (count !== undefined) {
|
|
617
|
+
localVarQueryParameter['count'] = count;
|
|
618
|
+
}
|
|
619
|
+
if (filters !== undefined) {
|
|
620
|
+
localVarQueryParameter['filters'] = filters;
|
|
621
|
+
}
|
|
622
|
+
if (sorters !== undefined) {
|
|
623
|
+
localVarQueryParameter['sorters'] = sorters;
|
|
624
|
+
}
|
|
625
|
+
if (cursor !== undefined) {
|
|
626
|
+
localVarQueryParameter['cursor'] = cursor;
|
|
627
|
+
}
|
|
628
|
+
if (xSailPointExperimental != null) {
|
|
629
|
+
localVarHeaderParameter['X-SailPoint-Experimental'] = String(xSailPointExperimental);
|
|
630
|
+
}
|
|
631
|
+
setSearchParams(localVarUrlObj, localVarQueryParameter);
|
|
632
|
+
headersFromBaseOptions = baseOptions && baseOptions.headers ? baseOptions.headers : {};
|
|
633
|
+
localVarRequestOptions.headers = __assign(__assign(__assign({}, localVarHeaderParameter), headersFromBaseOptions), axiosOptions.headers);
|
|
634
|
+
return [2 /*return*/, {
|
|
635
|
+
url: toPathString(localVarUrlObj),
|
|
636
|
+
axiosOptions: localVarRequestOptions,
|
|
637
|
+
}];
|
|
638
|
+
});
|
|
639
|
+
});
|
|
640
|
+
},
|
|
393
641
|
/**
|
|
394
642
|
* This API returns an Access Profile by its ID. The `accessRequestConfig.formDefinitionId` field associates an optional custom form with access profile access requests.
|
|
395
643
|
* @summary Get an access profile
|
|
@@ -423,6 +671,46 @@ export var AccessProfilesApiAxiosParamCreator = function (configuration) {
|
|
|
423
671
|
});
|
|
424
672
|
});
|
|
425
673
|
},
|
|
674
|
+
/**
|
|
675
|
+
* Get an access profile by its ID. This version reads from Search Lite and returns the same access profile shape as [Get Access Profile V1](https://developer.sailpoint.com/docs/api/get-access-profile-v-1), with the calculated `privilegeLevel` field added.
|
|
676
|
+
* @summary Get an access profile
|
|
677
|
+
* @param {string} id ID of the Access Profile
|
|
678
|
+
* @param {string} [xSailPointExperimental] Use this header to enable this experimental API.
|
|
679
|
+
* @param {*} [axiosOptions] Override http request option.
|
|
680
|
+
* @throws {RequiredError}
|
|
681
|
+
*/
|
|
682
|
+
getAccessProfileV2: function (id, xSailPointExperimental, axiosOptions) {
|
|
683
|
+
if (axiosOptions === void 0) { axiosOptions = {}; }
|
|
684
|
+
return __awaiter(_this, void 0, void 0, function () {
|
|
685
|
+
var localVarPath, localVarUrlObj, baseOptions, localVarRequestOptions, localVarHeaderParameter, localVarQueryParameter, headersFromBaseOptions;
|
|
686
|
+
return __generator(this, function (_a) {
|
|
687
|
+
// verify required parameter 'id' is not null or undefined
|
|
688
|
+
assertParamExists('getAccessProfileV2', 'id', id);
|
|
689
|
+
if (xSailPointExperimental === undefined) {
|
|
690
|
+
xSailPointExperimental = 'true';
|
|
691
|
+
}
|
|
692
|
+
localVarPath = "/access-profiles/v2/{id}"
|
|
693
|
+
.replace("{".concat("id", "}"), encodeURIComponent(String(id)));
|
|
694
|
+
localVarUrlObj = new URL(localVarPath, DUMMY_BASE_URL);
|
|
695
|
+
if (configuration) {
|
|
696
|
+
baseOptions = configuration.baseOptions;
|
|
697
|
+
}
|
|
698
|
+
localVarRequestOptions = __assign(__assign({ method: 'GET' }, baseOptions), axiosOptions);
|
|
699
|
+
localVarHeaderParameter = {};
|
|
700
|
+
localVarQueryParameter = {};
|
|
701
|
+
if (xSailPointExperimental != null) {
|
|
702
|
+
localVarHeaderParameter['X-SailPoint-Experimental'] = String(xSailPointExperimental);
|
|
703
|
+
}
|
|
704
|
+
setSearchParams(localVarUrlObj, localVarQueryParameter);
|
|
705
|
+
headersFromBaseOptions = baseOptions && baseOptions.headers ? baseOptions.headers : {};
|
|
706
|
+
localVarRequestOptions.headers = __assign(__assign(__assign({}, localVarHeaderParameter), headersFromBaseOptions), axiosOptions.headers);
|
|
707
|
+
return [2 /*return*/, {
|
|
708
|
+
url: toPathString(localVarUrlObj),
|
|
709
|
+
axiosOptions: localVarRequestOptions,
|
|
710
|
+
}];
|
|
711
|
+
});
|
|
712
|
+
});
|
|
713
|
+
},
|
|
426
714
|
/**
|
|
427
715
|
* Get a list of access profiles. >**Note:** When you filter for access profiles that have the \'+\' symbol in their names, the response is blank.
|
|
428
716
|
* @summary List access profiles
|
|
@@ -484,6 +772,78 @@ export var AccessProfilesApiAxiosParamCreator = function (configuration) {
|
|
|
484
772
|
});
|
|
485
773
|
});
|
|
486
774
|
},
|
|
775
|
+
/**
|
|
776
|
+
* Get a list of access profiles. This version reads from Search Lite and returns the same access profile shape as [List Access Profiles V1](https://developer.sailpoint.com/docs/api/list-access-profiles-v-1), with two additions: the calculated `privilegeLevel` field, and opaque cursor pagination through the `cursor` parameter and `X-Next-Cursor` response header. >**Note:** When you omit `sorters`, results are sorted by `created` ascending. For deterministic ordering across pages, always specify explicit sorters. When you use cursor pagination, include `id` in `sorters`; the service appends it automatically if you omit it. >**Note:** `offset` and `cursor` are mutually exclusive. Use `offset=0` along with a cursor value taken from a prior response\'s `X-Next-Cursor` header.
|
|
777
|
+
* @summary List access profiles
|
|
778
|
+
* @param {string} [xSailPointExperimental] Use this header to enable this experimental API.
|
|
779
|
+
* @param {string} [forSubadmin] Filters the returned list according to what is visible to the indicated ROLE_SUBADMIN or SOURCE_SUBADMIN identity. The value of the parameter is either an identity ID or the special value **me**, which is shorthand for the calling identity\'s ID. If you specify an identity that isn\'t a subadmin, the API returns a 400 Bad Request error.
|
|
780
|
+
* @param {number} [limit] Max number of results to return. See [API Standard Collection Parameters](https://developer.sailpoint.com/docs/api/standard-collection-parameters) for more information.
|
|
781
|
+
* @param {number} [offset] Offset into the full result set. Usually specified with *limit* to paginate through the results. Must be 0 when you supply a `cursor`, and `offset` plus `limit` must not exceed 10000. See [API Standard Collection Parameters](https://developer.sailpoint.com/docs/api/standard-collection-parameters) for more information.
|
|
782
|
+
* @param {boolean} [count] If *true* it will populate the *X-Total-Count* response header with the number of results that would be returned if *limit* and *offset* were ignored. Since requesting a total count can have a performance impact, it is recommended not to send **count=true** if that value will not be used. See [API Standard Collection Parameters](https://developer.sailpoint.com/docs/api/standard-collection-parameters) for more information.
|
|
783
|
+
* @param {string} [filters] Filter results using the standard syntax described in [API Standard Collection Parameters](https://developer.sailpoint.com/docs/api/standard-collection-parameters#filtering-results) Filtering is supported for the following fields and operators: **id**: *eq, in* **name**: *eq, in, co* **created**: *lt, le, gt, ge* **modified**: *lt, le, gt, ge* **requestable**: *eq* **source.id**: *eq, in* **owner.id**: *eq, in* **additionalOwners.id**: *eq, in* **dimensional**: *eq* **entitlement.id**: *eq, in* **entitlement.name**: *eq, co* **privilegeLevel.effective**: *eq, in* Supported composite operators are *and, or*
|
|
784
|
+
* @param {string} [sorters] Sort results using the standard syntax described in [API Standard Collection Parameters](https://developer.sailpoint.com/docs/api/standard-collection-parameters#sorting-results) Sorting is supported for the following fields: **name, created, modified, id, privilegeLevel.effective** Defaults to **created** ascending when omitted.
|
|
785
|
+
* @param {string} [forSegmentIds] Filters access profiles to only those assigned to the segment(s) with the specified IDs. If segmentation is currently unavailable, specifying this parameter results in an error.
|
|
786
|
+
* @param {boolean} [includeUnsegmented] Indicates whether the response list should contain unsegmented access profiles. If `for-segment-ids` is absent or empty, specifying *include-unsegmented* as `false` results in an error.
|
|
787
|
+
* @param {string} [cursor] Opaque cursor taken from the `X-Next-Cursor` header of a previous response, used to retrieve the next page of results. When you supply a cursor, `offset` must be 0.
|
|
788
|
+
* @param {*} [axiosOptions] Override http request option.
|
|
789
|
+
* @throws {RequiredError}
|
|
790
|
+
*/
|
|
791
|
+
listAccessProfilesV2: function (xSailPointExperimental, forSubadmin, limit, offset, count, filters, sorters, forSegmentIds, includeUnsegmented, cursor, axiosOptions) {
|
|
792
|
+
if (axiosOptions === void 0) { axiosOptions = {}; }
|
|
793
|
+
return __awaiter(_this, void 0, void 0, function () {
|
|
794
|
+
var localVarPath, localVarUrlObj, baseOptions, localVarRequestOptions, localVarHeaderParameter, localVarQueryParameter, headersFromBaseOptions;
|
|
795
|
+
return __generator(this, function (_a) {
|
|
796
|
+
if (xSailPointExperimental === undefined) {
|
|
797
|
+
xSailPointExperimental = 'true';
|
|
798
|
+
}
|
|
799
|
+
localVarPath = "/access-profiles/v2";
|
|
800
|
+
localVarUrlObj = new URL(localVarPath, DUMMY_BASE_URL);
|
|
801
|
+
if (configuration) {
|
|
802
|
+
baseOptions = configuration.baseOptions;
|
|
803
|
+
}
|
|
804
|
+
localVarRequestOptions = __assign(__assign({ method: 'GET' }, baseOptions), axiosOptions);
|
|
805
|
+
localVarHeaderParameter = {};
|
|
806
|
+
localVarQueryParameter = {};
|
|
807
|
+
if (forSubadmin !== undefined) {
|
|
808
|
+
localVarQueryParameter['for-subadmin'] = forSubadmin;
|
|
809
|
+
}
|
|
810
|
+
if (limit !== undefined) {
|
|
811
|
+
localVarQueryParameter['limit'] = limit;
|
|
812
|
+
}
|
|
813
|
+
if (offset !== undefined) {
|
|
814
|
+
localVarQueryParameter['offset'] = offset;
|
|
815
|
+
}
|
|
816
|
+
if (count !== undefined) {
|
|
817
|
+
localVarQueryParameter['count'] = count;
|
|
818
|
+
}
|
|
819
|
+
if (filters !== undefined) {
|
|
820
|
+
localVarQueryParameter['filters'] = filters;
|
|
821
|
+
}
|
|
822
|
+
if (sorters !== undefined) {
|
|
823
|
+
localVarQueryParameter['sorters'] = sorters;
|
|
824
|
+
}
|
|
825
|
+
if (forSegmentIds !== undefined) {
|
|
826
|
+
localVarQueryParameter['for-segment-ids'] = forSegmentIds;
|
|
827
|
+
}
|
|
828
|
+
if (includeUnsegmented !== undefined) {
|
|
829
|
+
localVarQueryParameter['include-unsegmented'] = includeUnsegmented;
|
|
830
|
+
}
|
|
831
|
+
if (cursor !== undefined) {
|
|
832
|
+
localVarQueryParameter['cursor'] = cursor;
|
|
833
|
+
}
|
|
834
|
+
if (xSailPointExperimental != null) {
|
|
835
|
+
localVarHeaderParameter['X-SailPoint-Experimental'] = String(xSailPointExperimental);
|
|
836
|
+
}
|
|
837
|
+
setSearchParams(localVarUrlObj, localVarQueryParameter);
|
|
838
|
+
headersFromBaseOptions = baseOptions && baseOptions.headers ? baseOptions.headers : {};
|
|
839
|
+
localVarRequestOptions.headers = __assign(__assign(__assign({}, localVarHeaderParameter), headersFromBaseOptions), axiosOptions.headers);
|
|
840
|
+
return [2 /*return*/, {
|
|
841
|
+
url: toPathString(localVarUrlObj),
|
|
842
|
+
axiosOptions: localVarRequestOptions,
|
|
843
|
+
}];
|
|
844
|
+
});
|
|
845
|
+
});
|
|
846
|
+
},
|
|
487
847
|
/**
|
|
488
848
|
* This API updates an existing Access Profile. The following fields are patchable: **name** **description** **enabled** **owner** **additionalOwners** **requestable** **accessRequestConfig** **revokeRequestConfig** **segments** **entitlements** **provisioningCriteria** **source** (must be updated with entitlements belonging to new source in the same API call) If you need to change the `source` of the access profile, you can do so only if you update the `entitlements` in the same API call. The new entitlements can only come from the target source that you want to change to. Look for the example \"Replace Source\" in the examples dropdown. Set `accessRequestConfig.formDefinitionId` to associate an optional custom form with access profile access requests. A user with SOURCE_SUBADMIN may only use this API to patch Access Profiles which are associated with Sources they are able to administer. > The maximum supported length for the description field is 2000 characters. Longer descriptions will be preserved for existing access profiles, however, any new access profiles as well as any updates to existing descriptions will be limited to 2000 characters. > You can only add or replace **entitlements** that exist on the source that the access profile is attached to. You can use the **list entitlements** endpoint with the **filters** query parameter to get a list of available entitlements on the access profile\'s source.
|
|
489
849
|
* @summary Patch a specified access profile
|
|
@@ -522,6 +882,51 @@ export var AccessProfilesApiAxiosParamCreator = function (configuration) {
|
|
|
522
882
|
});
|
|
523
883
|
});
|
|
524
884
|
},
|
|
885
|
+
/**
|
|
886
|
+
* This API updates an existing Access Profile. This version patches the same fields as [Patch a Specified Access Profile V1](https://developer.sailpoint.com/docs/api/patch-access-profile-v-1). It returns the v2 access profile shape, which adds the read-only `privilegeLevel` field. The following fields are patchable: **name** **description** **enabled** **owner** **additionalOwners** **requestable** **accessRequestConfig** **revocationRequestConfig** **segments** **entitlements** **provisioningCriteria** **source** (must be updated with entitlements belonging to new source in the same API call) If you need to change the `source` of the access profile, you can do so only if you update the `entitlements` in the same API call. The new entitlements can only come from the target source that you want to change to. Look for the example \"Replace Source\" in the examples dropdown. A user with SOURCE_SUBADMIN may only use this API to patch Access Profiles which are associated with Sources they are able to administer. > The maximum supported length for the description field is 2000 characters. Longer descriptions will be preserved for existing access profiles, however, any new access profiles as well as any updates to existing descriptions will be limited to 2000 characters. > You can only add or replace **entitlements** that exist on the source that the access profile is attached to. You can use the **list entitlements** endpoint with the **filters** query parameter to get a list of available entitlements on the access profile\'s source. >**Note:** `privilegeLevel` is read-only and cannot be patched. Changing the access profile\'s entitlements recalculates it asynchronously, so the patch response may still show the previous value.
|
|
887
|
+
* @summary Patch a specified access profile
|
|
888
|
+
* @param {string} id ID of the Access Profile to patch
|
|
889
|
+
* @param {Array<JsonPatchOperation>} jsonPatchOperation
|
|
890
|
+
* @param {string} [xSailPointExperimental] Use this header to enable this experimental API.
|
|
891
|
+
* @param {*} [axiosOptions] Override http request option.
|
|
892
|
+
* @throws {RequiredError}
|
|
893
|
+
*/
|
|
894
|
+
patchAccessProfileV2: function (id, jsonPatchOperation, xSailPointExperimental, axiosOptions) {
|
|
895
|
+
if (axiosOptions === void 0) { axiosOptions = {}; }
|
|
896
|
+
return __awaiter(_this, void 0, void 0, function () {
|
|
897
|
+
var localVarPath, localVarUrlObj, baseOptions, localVarRequestOptions, localVarHeaderParameter, localVarQueryParameter, headersFromBaseOptions;
|
|
898
|
+
return __generator(this, function (_a) {
|
|
899
|
+
// verify required parameter 'id' is not null or undefined
|
|
900
|
+
assertParamExists('patchAccessProfileV2', 'id', id);
|
|
901
|
+
// verify required parameter 'jsonPatchOperation' is not null or undefined
|
|
902
|
+
assertParamExists('patchAccessProfileV2', 'jsonPatchOperation', jsonPatchOperation);
|
|
903
|
+
if (xSailPointExperimental === undefined) {
|
|
904
|
+
xSailPointExperimental = 'true';
|
|
905
|
+
}
|
|
906
|
+
localVarPath = "/access-profiles/v2/{id}"
|
|
907
|
+
.replace("{".concat("id", "}"), encodeURIComponent(String(id)));
|
|
908
|
+
localVarUrlObj = new URL(localVarPath, DUMMY_BASE_URL);
|
|
909
|
+
if (configuration) {
|
|
910
|
+
baseOptions = configuration.baseOptions;
|
|
911
|
+
}
|
|
912
|
+
localVarRequestOptions = __assign(__assign({ method: 'PATCH' }, baseOptions), axiosOptions);
|
|
913
|
+
localVarHeaderParameter = {};
|
|
914
|
+
localVarQueryParameter = {};
|
|
915
|
+
localVarHeaderParameter['Content-Type'] = 'application/json-patch+json';
|
|
916
|
+
if (xSailPointExperimental != null) {
|
|
917
|
+
localVarHeaderParameter['X-SailPoint-Experimental'] = String(xSailPointExperimental);
|
|
918
|
+
}
|
|
919
|
+
setSearchParams(localVarUrlObj, localVarQueryParameter);
|
|
920
|
+
headersFromBaseOptions = baseOptions && baseOptions.headers ? baseOptions.headers : {};
|
|
921
|
+
localVarRequestOptions.headers = __assign(__assign(__assign({}, localVarHeaderParameter), headersFromBaseOptions), axiosOptions.headers);
|
|
922
|
+
localVarRequestOptions.data = serializeDataIfNeeded(jsonPatchOperation, localVarRequestOptions, configuration);
|
|
923
|
+
return [2 /*return*/, {
|
|
924
|
+
url: toPathString(localVarUrlObj),
|
|
925
|
+
axiosOptions: localVarRequestOptions,
|
|
926
|
+
}];
|
|
927
|
+
});
|
|
928
|
+
});
|
|
929
|
+
},
|
|
525
930
|
/**
|
|
526
931
|
* Get a list of access profiles filtered by Access Model Metadata and by filter expression. Filtering is supported by filter expression, by metadata attribute key and values, or by both together.
|
|
527
932
|
* @summary Filter access profiles by metadata
|
|
@@ -584,6 +989,79 @@ export var AccessProfilesApiAxiosParamCreator = function (configuration) {
|
|
|
584
989
|
});
|
|
585
990
|
});
|
|
586
991
|
},
|
|
992
|
+
/**
|
|
993
|
+
* Get a list of access profiles, supplying the filter criteria and access model metadata key/values in the request body rather than as query parameters. Use this endpoint when you need to filter by access model metadata, or when your filter expression is too long to pass as a query parameter. Pagination, sorting, subadmin scoping, and segment scoping behave the same as [List Access Profiles V2](https://developer.sailpoint.com/docs/api/list-access-profiles-v-2), including opaque cursor pagination through the `cursor` parameter and `X-Next-Cursor` response header.
|
|
994
|
+
* @summary List access profiles by filter
|
|
995
|
+
* @param {AccessProfileListFilterV2} accessProfileListFilterV2
|
|
996
|
+
* @param {string} [xSailPointExperimental] Use this header to enable this experimental API.
|
|
997
|
+
* @param {string} [forSubadmin] Filters the returned list according to what is visible to the indicated ROLE_SUBADMIN or SOURCE_SUBADMIN identity. The value of the parameter is either an identity ID or the special value **me**, which is shorthand for the calling identity\'s ID. If you specify an identity that isn\'t a subadmin, the API returns a 400 Bad Request error.
|
|
998
|
+
* @param {number} [limit] Max number of results to return. See [API Standard Collection Parameters](https://developer.sailpoint.com/docs/api/standard-collection-parameters) for more information.
|
|
999
|
+
* @param {number} [offset] Offset into the full result set. Usually specified with *limit* to paginate through the results. Must be 0 when you supply a `cursor`, and `offset` plus `limit` must not exceed 10000. See [API Standard Collection Parameters](https://developer.sailpoint.com/docs/api/standard-collection-parameters) for more information.
|
|
1000
|
+
* @param {boolean} [count] If *true* it will populate the *X-Total-Count* response header with the number of results that would be returned if *limit* and *offset* were ignored. Since requesting a total count can have a performance impact, it is recommended not to send **count=true** if that value will not be used. See [API Standard Collection Parameters](https://developer.sailpoint.com/docs/api/standard-collection-parameters) for more information.
|
|
1001
|
+
* @param {string} [sorters] Sort results using the standard syntax described in [API Standard Collection Parameters](https://developer.sailpoint.com/docs/api/standard-collection-parameters#sorting-results) Sorting is supported for the following fields: **name, created, modified, id, privilegeLevel.effective** Defaults to **created** ascending when omitted.
|
|
1002
|
+
* @param {string} [forSegmentIds] Filters access profiles to only those assigned to the segment(s) with the specified IDs. If segmentation is currently unavailable, specifying this parameter results in an error.
|
|
1003
|
+
* @param {boolean} [includeUnsegmented] Indicates whether the response list should contain unsegmented access profiles. If `for-segment-ids` is absent or empty, specifying *include-unsegmented* as `false` results in an error.
|
|
1004
|
+
* @param {string} [cursor] Opaque cursor taken from the `X-Next-Cursor` header of a previous response, used to retrieve the next page of results. When you supply a cursor, `offset` must be 0.
|
|
1005
|
+
* @param {*} [axiosOptions] Override http request option.
|
|
1006
|
+
* @throws {RequiredError}
|
|
1007
|
+
*/
|
|
1008
|
+
searchAccessProfilesByFilterV2: function (accessProfileListFilterV2, xSailPointExperimental, forSubadmin, limit, offset, count, sorters, forSegmentIds, includeUnsegmented, cursor, axiosOptions) {
|
|
1009
|
+
if (axiosOptions === void 0) { axiosOptions = {}; }
|
|
1010
|
+
return __awaiter(_this, void 0, void 0, function () {
|
|
1011
|
+
var localVarPath, localVarUrlObj, baseOptions, localVarRequestOptions, localVarHeaderParameter, localVarQueryParameter, headersFromBaseOptions;
|
|
1012
|
+
return __generator(this, function (_a) {
|
|
1013
|
+
// verify required parameter 'accessProfileListFilterV2' is not null or undefined
|
|
1014
|
+
assertParamExists('searchAccessProfilesByFilterV2', 'accessProfileListFilterV2', accessProfileListFilterV2);
|
|
1015
|
+
if (xSailPointExperimental === undefined) {
|
|
1016
|
+
xSailPointExperimental = 'true';
|
|
1017
|
+
}
|
|
1018
|
+
localVarPath = "/access-profiles/v2/filter";
|
|
1019
|
+
localVarUrlObj = new URL(localVarPath, DUMMY_BASE_URL);
|
|
1020
|
+
if (configuration) {
|
|
1021
|
+
baseOptions = configuration.baseOptions;
|
|
1022
|
+
}
|
|
1023
|
+
localVarRequestOptions = __assign(__assign({ method: 'POST' }, baseOptions), axiosOptions);
|
|
1024
|
+
localVarHeaderParameter = {};
|
|
1025
|
+
localVarQueryParameter = {};
|
|
1026
|
+
if (forSubadmin !== undefined) {
|
|
1027
|
+
localVarQueryParameter['for-subadmin'] = forSubadmin;
|
|
1028
|
+
}
|
|
1029
|
+
if (limit !== undefined) {
|
|
1030
|
+
localVarQueryParameter['limit'] = limit;
|
|
1031
|
+
}
|
|
1032
|
+
if (offset !== undefined) {
|
|
1033
|
+
localVarQueryParameter['offset'] = offset;
|
|
1034
|
+
}
|
|
1035
|
+
if (count !== undefined) {
|
|
1036
|
+
localVarQueryParameter['count'] = count;
|
|
1037
|
+
}
|
|
1038
|
+
if (sorters !== undefined) {
|
|
1039
|
+
localVarQueryParameter['sorters'] = sorters;
|
|
1040
|
+
}
|
|
1041
|
+
if (forSegmentIds !== undefined) {
|
|
1042
|
+
localVarQueryParameter['for-segment-ids'] = forSegmentIds;
|
|
1043
|
+
}
|
|
1044
|
+
if (includeUnsegmented !== undefined) {
|
|
1045
|
+
localVarQueryParameter['include-unsegmented'] = includeUnsegmented;
|
|
1046
|
+
}
|
|
1047
|
+
if (cursor !== undefined) {
|
|
1048
|
+
localVarQueryParameter['cursor'] = cursor;
|
|
1049
|
+
}
|
|
1050
|
+
localVarHeaderParameter['Content-Type'] = 'application/json';
|
|
1051
|
+
if (xSailPointExperimental != null) {
|
|
1052
|
+
localVarHeaderParameter['X-SailPoint-Experimental'] = String(xSailPointExperimental);
|
|
1053
|
+
}
|
|
1054
|
+
setSearchParams(localVarUrlObj, localVarQueryParameter);
|
|
1055
|
+
headersFromBaseOptions = baseOptions && baseOptions.headers ? baseOptions.headers : {};
|
|
1056
|
+
localVarRequestOptions.headers = __assign(__assign(__assign({}, localVarHeaderParameter), headersFromBaseOptions), axiosOptions.headers);
|
|
1057
|
+
localVarRequestOptions.data = serializeDataIfNeeded(accessProfileListFilterV2, localVarRequestOptions, configuration);
|
|
1058
|
+
return [2 /*return*/, {
|
|
1059
|
+
url: toPathString(localVarUrlObj),
|
|
1060
|
+
axiosOptions: localVarRequestOptions,
|
|
1061
|
+
}];
|
|
1062
|
+
});
|
|
1063
|
+
});
|
|
1064
|
+
},
|
|
587
1065
|
/**
|
|
588
1066
|
* This API initiates a bulk update of field requestable for one or more Access Profiles. > If any of the indicated Access Profiles is exists in Organization,then those Access Profiles will be added in **updated** list of the response.Requestable field of these Access Profiles marked as **true** or **false**. > If any of the indicated Access Profiles is not does not exists in Organization,then those Access Profiles will be added in **notFound** list of the response. Access Profiles marked as **notFound** will not be updated. A SOURCE_SUBADMIN may only use this API to update Access Profiles which are associated with Sources they are able to administer.
|
|
589
1067
|
* @summary Update access profile(s) requestable field.
|
|
@@ -618,6 +1096,47 @@ export var AccessProfilesApiAxiosParamCreator = function (configuration) {
|
|
|
618
1096
|
});
|
|
619
1097
|
});
|
|
620
1098
|
},
|
|
1099
|
+
/**
|
|
1100
|
+
* This API initiates a bulk update of field requestable for one or more Access Profiles. This version behaves identically to [Update Access Profile(s) Requestable Field V1](https://developer.sailpoint.com/docs/api/update-access-profiles-in-bulk-v-1). > If any of the indicated Access Profiles is exists in Organization,then those Access Profiles will be added in **updated** list of the response.Requestable field of these Access Profiles marked as **true** or **false**. > If any of the indicated Access Profiles is not does not exists in Organization,then those Access Profiles will be added in **notFound** list of the response. Access Profiles marked as **notFound** will not be updated. A SOURCE_SUBADMIN may only use this API to update Access Profiles which are associated with Sources they are able to administer.
|
|
1101
|
+
* @summary Update access profile(s) requestable field.
|
|
1102
|
+
* @param {Array<AccessProfileBulkUpdateRequestInner>} accessProfileBulkUpdateRequestInner
|
|
1103
|
+
* @param {string} [xSailPointExperimental] Use this header to enable this experimental API.
|
|
1104
|
+
* @param {*} [axiosOptions] Override http request option.
|
|
1105
|
+
* @throws {RequiredError}
|
|
1106
|
+
*/
|
|
1107
|
+
updateAccessProfilesInBulkV2: function (accessProfileBulkUpdateRequestInner, xSailPointExperimental, axiosOptions) {
|
|
1108
|
+
if (axiosOptions === void 0) { axiosOptions = {}; }
|
|
1109
|
+
return __awaiter(_this, void 0, void 0, function () {
|
|
1110
|
+
var localVarPath, localVarUrlObj, baseOptions, localVarRequestOptions, localVarHeaderParameter, localVarQueryParameter, headersFromBaseOptions;
|
|
1111
|
+
return __generator(this, function (_a) {
|
|
1112
|
+
// verify required parameter 'accessProfileBulkUpdateRequestInner' is not null or undefined
|
|
1113
|
+
assertParamExists('updateAccessProfilesInBulkV2', 'accessProfileBulkUpdateRequestInner', accessProfileBulkUpdateRequestInner);
|
|
1114
|
+
if (xSailPointExperimental === undefined) {
|
|
1115
|
+
xSailPointExperimental = 'true';
|
|
1116
|
+
}
|
|
1117
|
+
localVarPath = "/access-profiles/v2/bulk-update-requestable";
|
|
1118
|
+
localVarUrlObj = new URL(localVarPath, DUMMY_BASE_URL);
|
|
1119
|
+
if (configuration) {
|
|
1120
|
+
baseOptions = configuration.baseOptions;
|
|
1121
|
+
}
|
|
1122
|
+
localVarRequestOptions = __assign(__assign({ method: 'POST' }, baseOptions), axiosOptions);
|
|
1123
|
+
localVarHeaderParameter = {};
|
|
1124
|
+
localVarQueryParameter = {};
|
|
1125
|
+
localVarHeaderParameter['Content-Type'] = 'application/json';
|
|
1126
|
+
if (xSailPointExperimental != null) {
|
|
1127
|
+
localVarHeaderParameter['X-SailPoint-Experimental'] = String(xSailPointExperimental);
|
|
1128
|
+
}
|
|
1129
|
+
setSearchParams(localVarUrlObj, localVarQueryParameter);
|
|
1130
|
+
headersFromBaseOptions = baseOptions && baseOptions.headers ? baseOptions.headers : {};
|
|
1131
|
+
localVarRequestOptions.headers = __assign(__assign(__assign({}, localVarHeaderParameter), headersFromBaseOptions), axiosOptions.headers);
|
|
1132
|
+
localVarRequestOptions.data = serializeDataIfNeeded(accessProfileBulkUpdateRequestInner, localVarRequestOptions, configuration);
|
|
1133
|
+
return [2 /*return*/, {
|
|
1134
|
+
url: toPathString(localVarUrlObj),
|
|
1135
|
+
axiosOptions: localVarRequestOptions,
|
|
1136
|
+
}];
|
|
1137
|
+
});
|
|
1138
|
+
});
|
|
1139
|
+
},
|
|
621
1140
|
/**
|
|
622
1141
|
* This API initiates a bulk update of Access Model Metadata for every access profile matching the supplied filter expression. The update is processed asynchronously. The response returns the ID of the task performing the update. A single access profile cannot be assigned more than 25 metadata values. Adding or replacing custom metadata requires a suite license.
|
|
623
1142
|
* @summary Bulk-update metadata by filter
|
|
@@ -793,6 +1312,30 @@ export var AccessProfilesApiFp = function (configuration) {
|
|
|
793
1312
|
});
|
|
794
1313
|
});
|
|
795
1314
|
},
|
|
1315
|
+
/**
|
|
1316
|
+
* Create an access profile. This version accepts the same request body and applies the same validation as [Create Access Profile V1](https://developer.sailpoint.com/docs/api/create-access-profile-v-1). It returns the v2 access profile shape, which adds the read-only `privilegeLevel` field. A user with `ROLE_SUBADMIN` or `SOURCE_SUBADMIN` authority must be associated with the access profile\'s source. The maximum supported length for the description field is 2000 characters. Longer descriptions will be preserved for existing access profiles. However, any new access profiles as well as any updates to existing descriptions are limited to 2000 characters. >**Note:** To use this endpoint, you need all the listed scopes. >**Note:** `privilegeLevel` is read-only and is ignored if supplied in the request body. It is calculated asynchronously from the access profile\'s entitlements, so it is typically absent from the create response.
|
|
1317
|
+
* @summary Create access profile
|
|
1318
|
+
* @param {Accessprofilev2} accessprofilev2
|
|
1319
|
+
* @param {string} [xSailPointExperimental] Use this header to enable this experimental API.
|
|
1320
|
+
* @param {*} [axiosOptions] Override http request option.
|
|
1321
|
+
* @throws {RequiredError}
|
|
1322
|
+
*/
|
|
1323
|
+
createAccessProfileV2: function (accessprofilev2, xSailPointExperimental, axiosOptions) {
|
|
1324
|
+
var _a, _b, _c;
|
|
1325
|
+
return __awaiter(this, void 0, void 0, function () {
|
|
1326
|
+
var localVarAxiosArgs, localVarOperationServerIndex, localVarOperationServerBasePath;
|
|
1327
|
+
return __generator(this, function (_d) {
|
|
1328
|
+
switch (_d.label) {
|
|
1329
|
+
case 0: return [4 /*yield*/, localVarAxiosParamCreator.createAccessProfileV2(accessprofilev2, xSailPointExperimental, axiosOptions)];
|
|
1330
|
+
case 1:
|
|
1331
|
+
localVarAxiosArgs = _d.sent();
|
|
1332
|
+
localVarOperationServerIndex = (_a = configuration === null || configuration === void 0 ? void 0 : configuration.serverIndex) !== null && _a !== void 0 ? _a : 0;
|
|
1333
|
+
localVarOperationServerBasePath = (_c = (_b = operationServerMap['AccessProfilesApi.createAccessProfileV2']) === null || _b === void 0 ? void 0 : _b[localVarOperationServerIndex]) === null || _c === void 0 ? void 0 : _c.url;
|
|
1334
|
+
return [2 /*return*/, function (axios, basePath) { return createRequestFunction(localVarAxiosArgs, globalAxios, BASE_PATH, configuration)(axios, localVarOperationServerBasePath || basePath); }];
|
|
1335
|
+
}
|
|
1336
|
+
});
|
|
1337
|
+
});
|
|
1338
|
+
},
|
|
796
1339
|
/**
|
|
797
1340
|
* This API deletes an existing Access Profile. The Access Profile must not be in use, for example, Access Profile can not be deleted if they belong to an Application, Life Cycle State or a Role. If it is, a 400 error is returned. A user with SOURCE_SUBADMIN must be able to administer the Source associated with the Access Profile.
|
|
798
1341
|
* @summary Delete the specified access profile
|
|
@@ -810,30 +1353,78 @@ export var AccessProfilesApiFp = function (configuration) {
|
|
|
810
1353
|
case 1:
|
|
811
1354
|
localVarAxiosArgs = _d.sent();
|
|
812
1355
|
localVarOperationServerIndex = (_a = configuration === null || configuration === void 0 ? void 0 : configuration.serverIndex) !== null && _a !== void 0 ? _a : 0;
|
|
813
|
-
localVarOperationServerBasePath = (_c = (_b = operationServerMap['AccessProfilesApi.deleteAccessProfileV1']) === null || _b === void 0 ? void 0 : _b[localVarOperationServerIndex]) === null || _c === void 0 ? void 0 : _c.url;
|
|
1356
|
+
localVarOperationServerBasePath = (_c = (_b = operationServerMap['AccessProfilesApi.deleteAccessProfileV1']) === null || _b === void 0 ? void 0 : _b[localVarOperationServerIndex]) === null || _c === void 0 ? void 0 : _c.url;
|
|
1357
|
+
return [2 /*return*/, function (axios, basePath) { return createRequestFunction(localVarAxiosArgs, globalAxios, BASE_PATH, configuration)(axios, localVarOperationServerBasePath || basePath); }];
|
|
1358
|
+
}
|
|
1359
|
+
});
|
|
1360
|
+
});
|
|
1361
|
+
},
|
|
1362
|
+
/**
|
|
1363
|
+
* This API deletes an existing Access Profile. This version behaves identically to [Delete the Specified Access Profile V1](https://developer.sailpoint.com/docs/api/delete-access-profile-v-1). The Access Profile must not be in use, for example, Access Profile can not be deleted if they belong to an Application, Life Cycle State or a Role. If it is, a 400 error is returned. A user with SOURCE_SUBADMIN must be able to administer the Source associated with the Access Profile.
|
|
1364
|
+
* @summary Delete the specified access profile
|
|
1365
|
+
* @param {string} id ID of the Access Profile to delete
|
|
1366
|
+
* @param {string} [xSailPointExperimental] Use this header to enable this experimental API.
|
|
1367
|
+
* @param {*} [axiosOptions] Override http request option.
|
|
1368
|
+
* @throws {RequiredError}
|
|
1369
|
+
*/
|
|
1370
|
+
deleteAccessProfileV2: function (id, xSailPointExperimental, axiosOptions) {
|
|
1371
|
+
var _a, _b, _c;
|
|
1372
|
+
return __awaiter(this, void 0, void 0, function () {
|
|
1373
|
+
var localVarAxiosArgs, localVarOperationServerIndex, localVarOperationServerBasePath;
|
|
1374
|
+
return __generator(this, function (_d) {
|
|
1375
|
+
switch (_d.label) {
|
|
1376
|
+
case 0: return [4 /*yield*/, localVarAxiosParamCreator.deleteAccessProfileV2(id, xSailPointExperimental, axiosOptions)];
|
|
1377
|
+
case 1:
|
|
1378
|
+
localVarAxiosArgs = _d.sent();
|
|
1379
|
+
localVarOperationServerIndex = (_a = configuration === null || configuration === void 0 ? void 0 : configuration.serverIndex) !== null && _a !== void 0 ? _a : 0;
|
|
1380
|
+
localVarOperationServerBasePath = (_c = (_b = operationServerMap['AccessProfilesApi.deleteAccessProfileV2']) === null || _b === void 0 ? void 0 : _b[localVarOperationServerIndex]) === null || _c === void 0 ? void 0 : _c.url;
|
|
1381
|
+
return [2 /*return*/, function (axios, basePath) { return createRequestFunction(localVarAxiosArgs, globalAxios, BASE_PATH, configuration)(axios, localVarOperationServerBasePath || basePath); }];
|
|
1382
|
+
}
|
|
1383
|
+
});
|
|
1384
|
+
});
|
|
1385
|
+
},
|
|
1386
|
+
/**
|
|
1387
|
+
* This endpoint initiates a bulk deletion of one or more access profiles. When the request is successful, the endpoint returns the bulk delete\'s task result ID. To follow the task, you can use [Get Task Status by ID](https://developer.sailpoint.com/docs/api/get-task-status-v-1), which will return the task result\'s status and information. This endpoint can only bulk delete up to a limit of 50 access profiles per request. By default, if any of the indicated access profiles are in use, no deletions will be performed and the **inUse** field of the response indicates the usages that must be removed first. If the request field **bestEffortOnly** is **true**, however, usages are reported in the **inUse** response field but all other indicated access profiles will be deleted. A SOURCE_SUBADMIN user can only use this endpoint to delete access profiles associated with sources they\'re able to administer.
|
|
1388
|
+
* @summary Delete access profile(s)
|
|
1389
|
+
* @param {AccessProfileBulkDeleteRequest} accessProfileBulkDeleteRequest
|
|
1390
|
+
* @param {*} [axiosOptions] Override http request option.
|
|
1391
|
+
* @throws {RequiredError}
|
|
1392
|
+
*/
|
|
1393
|
+
deleteAccessProfilesInBulkV1: function (accessProfileBulkDeleteRequest, axiosOptions) {
|
|
1394
|
+
var _a, _b, _c;
|
|
1395
|
+
return __awaiter(this, void 0, void 0, function () {
|
|
1396
|
+
var localVarAxiosArgs, localVarOperationServerIndex, localVarOperationServerBasePath;
|
|
1397
|
+
return __generator(this, function (_d) {
|
|
1398
|
+
switch (_d.label) {
|
|
1399
|
+
case 0: return [4 /*yield*/, localVarAxiosParamCreator.deleteAccessProfilesInBulkV1(accessProfileBulkDeleteRequest, axiosOptions)];
|
|
1400
|
+
case 1:
|
|
1401
|
+
localVarAxiosArgs = _d.sent();
|
|
1402
|
+
localVarOperationServerIndex = (_a = configuration === null || configuration === void 0 ? void 0 : configuration.serverIndex) !== null && _a !== void 0 ? _a : 0;
|
|
1403
|
+
localVarOperationServerBasePath = (_c = (_b = operationServerMap['AccessProfilesApi.deleteAccessProfilesInBulkV1']) === null || _b === void 0 ? void 0 : _b[localVarOperationServerIndex]) === null || _c === void 0 ? void 0 : _c.url;
|
|
814
1404
|
return [2 /*return*/, function (axios, basePath) { return createRequestFunction(localVarAxiosArgs, globalAxios, BASE_PATH, configuration)(axios, localVarOperationServerBasePath || basePath); }];
|
|
815
1405
|
}
|
|
816
1406
|
});
|
|
817
1407
|
});
|
|
818
1408
|
},
|
|
819
1409
|
/**
|
|
820
|
-
* This endpoint initiates a bulk deletion of one or more access profiles. When the request is successful, the endpoint returns the bulk delete\'s task result ID. To follow the task, you can use [Get Task Status by ID](https://developer.sailpoint.com/docs/api/get-task-status-v-1), which will return the task result\'s status and information. This endpoint can only bulk delete up to a limit of 50 access profiles per request. By default, if any of the indicated access profiles are in use, no deletions will be performed and the **inUse** field of the response indicates the usages that must be removed first. If the request field **bestEffortOnly** is **true**, however, usages are reported in the **inUse** response field but all other indicated access profiles will be deleted. A SOURCE_SUBADMIN user can only use this endpoint to delete access profiles associated with sources they\'re able to administer.
|
|
1410
|
+
* This endpoint initiates a bulk deletion of one or more access profiles. This version behaves identically to [Delete Access Profile(s) V1](https://developer.sailpoint.com/docs/api/delete-access-profiles-in-bulk-v-1). When the request is successful, the endpoint returns the bulk delete\'s task result ID. To follow the task, you can use [Get Task Status by ID](https://developer.sailpoint.com/docs/api/get-task-status-v-1), which will return the task result\'s status and information. This endpoint can only bulk delete up to a limit of 50 access profiles per request. By default, if any of the indicated access profiles are in use, no deletions will be performed and the **inUse** field of the response indicates the usages that must be removed first. If the request field **bestEffortOnly** is **true**, however, usages are reported in the **inUse** response field but all other indicated access profiles will be deleted. A SOURCE_SUBADMIN user can only use this endpoint to delete access profiles associated with sources they\'re able to administer.
|
|
821
1411
|
* @summary Delete access profile(s)
|
|
822
1412
|
* @param {AccessProfileBulkDeleteRequest} accessProfileBulkDeleteRequest
|
|
1413
|
+
* @param {string} [xSailPointExperimental] Use this header to enable this experimental API.
|
|
823
1414
|
* @param {*} [axiosOptions] Override http request option.
|
|
824
1415
|
* @throws {RequiredError}
|
|
825
1416
|
*/
|
|
826
|
-
|
|
1417
|
+
deleteAccessProfilesInBulkV2: function (accessProfileBulkDeleteRequest, xSailPointExperimental, axiosOptions) {
|
|
827
1418
|
var _a, _b, _c;
|
|
828
1419
|
return __awaiter(this, void 0, void 0, function () {
|
|
829
1420
|
var localVarAxiosArgs, localVarOperationServerIndex, localVarOperationServerBasePath;
|
|
830
1421
|
return __generator(this, function (_d) {
|
|
831
1422
|
switch (_d.label) {
|
|
832
|
-
case 0: return [4 /*yield*/, localVarAxiosParamCreator.
|
|
1423
|
+
case 0: return [4 /*yield*/, localVarAxiosParamCreator.deleteAccessProfilesInBulkV2(accessProfileBulkDeleteRequest, xSailPointExperimental, axiosOptions)];
|
|
833
1424
|
case 1:
|
|
834
1425
|
localVarAxiosArgs = _d.sent();
|
|
835
1426
|
localVarOperationServerIndex = (_a = configuration === null || configuration === void 0 ? void 0 : configuration.serverIndex) !== null && _a !== void 0 ? _a : 0;
|
|
836
|
-
localVarOperationServerBasePath = (_c = (_b = operationServerMap['AccessProfilesApi.
|
|
1427
|
+
localVarOperationServerBasePath = (_c = (_b = operationServerMap['AccessProfilesApi.deleteAccessProfilesInBulkV2']) === null || _b === void 0 ? void 0 : _b[localVarOperationServerIndex]) === null || _c === void 0 ? void 0 : _c.url;
|
|
837
1428
|
return [2 /*return*/, function (axios, basePath) { return createRequestFunction(localVarAxiosArgs, globalAxios, BASE_PATH, configuration)(axios, localVarOperationServerBasePath || basePath); }];
|
|
838
1429
|
}
|
|
839
1430
|
});
|
|
@@ -892,6 +1483,36 @@ export var AccessProfilesApiFp = function (configuration) {
|
|
|
892
1483
|
});
|
|
893
1484
|
});
|
|
894
1485
|
},
|
|
1486
|
+
/**
|
|
1487
|
+
* Get a list of an access profile\'s entitlements. This version reads from Search Lite and returns a superset of the entitlement returned by [List Access Profile\'s Entitlements V1](https://developer.sailpoint.com/docs/api/get-access-profile-entitlements-v-1), adding the entitlement\'s `tags` and calculated `privilegeLevel`. It also supports opaque cursor pagination through the `cursor` parameter and `X-Next-Cursor` response header. A SOURCE_SUBADMIN user must have access to the source associated with the specified access profile.
|
|
1488
|
+
* @summary List access profile\'s entitlements
|
|
1489
|
+
* @param {string} id ID of the access profile containing the entitlements.
|
|
1490
|
+
* @param {string} [xSailPointExperimental] Use this header to enable this experimental API.
|
|
1491
|
+
* @param {number} [limit] Max number of results to return. See [API Standard Collection Parameters](https://developer.sailpoint.com/docs/api/standard-collection-parameters) for more information.
|
|
1492
|
+
* @param {number} [offset] Offset into the full result set. Usually specified with *limit* to paginate through the results. Must be 0 when you supply a `cursor`, and `offset` plus `limit` must not exceed 10000. See [API Standard Collection Parameters](https://developer.sailpoint.com/docs/api/standard-collection-parameters) for more information.
|
|
1493
|
+
* @param {boolean} [count] If *true* it will populate the *X-Total-Count* response header with the number of results that would be returned if *limit* and *offset* were ignored. Since requesting a total count can have a performance impact, it is recommended not to send **count=true** if that value will not be used. See [API Standard Collection Parameters](https://developer.sailpoint.com/docs/api/standard-collection-parameters) for more information.
|
|
1494
|
+
* @param {string} [filters] Filter results using the standard syntax described in [API Standard Collection Parameters](https://developer.sailpoint.com/docs/api/standard-collection-parameters#filtering-results) Filtering is supported for the following fields and operators: **id**: *eq, in* **name**: *eq, in, co* **attribute**: *eq, co* **value**: *eq, co* **created**: *lt, le, gt, ge* **modified**: *lt, le, gt, ge* **privilegeLevel.effective**: *eq, in* Results are automatically scoped to entitlements belonging to the access profile.
|
|
1495
|
+
* @param {string} [sorters] Sort results using the standard syntax described in [API Standard Collection Parameters](https://developer.sailpoint.com/docs/api/standard-collection-parameters#sorting-results) Sorting is supported for the following fields: **name, attribute, value, created, modified, id, privilegeLevel.effective** Defaults to **created** ascending when omitted.
|
|
1496
|
+
* @param {string} [cursor] Opaque cursor taken from the `X-Next-Cursor` header of a previous response, used to retrieve the next page of results. When you supply a cursor, `offset` must be 0.
|
|
1497
|
+
* @param {*} [axiosOptions] Override http request option.
|
|
1498
|
+
* @throws {RequiredError}
|
|
1499
|
+
*/
|
|
1500
|
+
getAccessProfileEntitlementsV2: function (id, xSailPointExperimental, limit, offset, count, filters, sorters, cursor, axiosOptions) {
|
|
1501
|
+
var _a, _b, _c;
|
|
1502
|
+
return __awaiter(this, void 0, void 0, function () {
|
|
1503
|
+
var localVarAxiosArgs, localVarOperationServerIndex, localVarOperationServerBasePath;
|
|
1504
|
+
return __generator(this, function (_d) {
|
|
1505
|
+
switch (_d.label) {
|
|
1506
|
+
case 0: return [4 /*yield*/, localVarAxiosParamCreator.getAccessProfileEntitlementsV2(id, xSailPointExperimental, limit, offset, count, filters, sorters, cursor, axiosOptions)];
|
|
1507
|
+
case 1:
|
|
1508
|
+
localVarAxiosArgs = _d.sent();
|
|
1509
|
+
localVarOperationServerIndex = (_a = configuration === null || configuration === void 0 ? void 0 : configuration.serverIndex) !== null && _a !== void 0 ? _a : 0;
|
|
1510
|
+
localVarOperationServerBasePath = (_c = (_b = operationServerMap['AccessProfilesApi.getAccessProfileEntitlementsV2']) === null || _b === void 0 ? void 0 : _b[localVarOperationServerIndex]) === null || _c === void 0 ? void 0 : _c.url;
|
|
1511
|
+
return [2 /*return*/, function (axios, basePath) { return createRequestFunction(localVarAxiosArgs, globalAxios, BASE_PATH, configuration)(axios, localVarOperationServerBasePath || basePath); }];
|
|
1512
|
+
}
|
|
1513
|
+
});
|
|
1514
|
+
});
|
|
1515
|
+
},
|
|
895
1516
|
/**
|
|
896
1517
|
* This API returns an Access Profile by its ID. The `accessRequestConfig.formDefinitionId` field associates an optional custom form with access profile access requests.
|
|
897
1518
|
* @summary Get an access profile
|
|
@@ -915,6 +1536,30 @@ export var AccessProfilesApiFp = function (configuration) {
|
|
|
915
1536
|
});
|
|
916
1537
|
});
|
|
917
1538
|
},
|
|
1539
|
+
/**
|
|
1540
|
+
* Get an access profile by its ID. This version reads from Search Lite and returns the same access profile shape as [Get Access Profile V1](https://developer.sailpoint.com/docs/api/get-access-profile-v-1), with the calculated `privilegeLevel` field added.
|
|
1541
|
+
* @summary Get an access profile
|
|
1542
|
+
* @param {string} id ID of the Access Profile
|
|
1543
|
+
* @param {string} [xSailPointExperimental] Use this header to enable this experimental API.
|
|
1544
|
+
* @param {*} [axiosOptions] Override http request option.
|
|
1545
|
+
* @throws {RequiredError}
|
|
1546
|
+
*/
|
|
1547
|
+
getAccessProfileV2: function (id, xSailPointExperimental, axiosOptions) {
|
|
1548
|
+
var _a, _b, _c;
|
|
1549
|
+
return __awaiter(this, void 0, void 0, function () {
|
|
1550
|
+
var localVarAxiosArgs, localVarOperationServerIndex, localVarOperationServerBasePath;
|
|
1551
|
+
return __generator(this, function (_d) {
|
|
1552
|
+
switch (_d.label) {
|
|
1553
|
+
case 0: return [4 /*yield*/, localVarAxiosParamCreator.getAccessProfileV2(id, xSailPointExperimental, axiosOptions)];
|
|
1554
|
+
case 1:
|
|
1555
|
+
localVarAxiosArgs = _d.sent();
|
|
1556
|
+
localVarOperationServerIndex = (_a = configuration === null || configuration === void 0 ? void 0 : configuration.serverIndex) !== null && _a !== void 0 ? _a : 0;
|
|
1557
|
+
localVarOperationServerBasePath = (_c = (_b = operationServerMap['AccessProfilesApi.getAccessProfileV2']) === null || _b === void 0 ? void 0 : _b[localVarOperationServerIndex]) === null || _c === void 0 ? void 0 : _c.url;
|
|
1558
|
+
return [2 /*return*/, function (axios, basePath) { return createRequestFunction(localVarAxiosArgs, globalAxios, BASE_PATH, configuration)(axios, localVarOperationServerBasePath || basePath); }];
|
|
1559
|
+
}
|
|
1560
|
+
});
|
|
1561
|
+
});
|
|
1562
|
+
},
|
|
918
1563
|
/**
|
|
919
1564
|
* Get a list of access profiles. >**Note:** When you filter for access profiles that have the \'+\' symbol in their names, the response is blank.
|
|
920
1565
|
* @summary List access profiles
|
|
@@ -945,6 +1590,38 @@ export var AccessProfilesApiFp = function (configuration) {
|
|
|
945
1590
|
});
|
|
946
1591
|
});
|
|
947
1592
|
},
|
|
1593
|
+
/**
|
|
1594
|
+
* Get a list of access profiles. This version reads from Search Lite and returns the same access profile shape as [List Access Profiles V1](https://developer.sailpoint.com/docs/api/list-access-profiles-v-1), with two additions: the calculated `privilegeLevel` field, and opaque cursor pagination through the `cursor` parameter and `X-Next-Cursor` response header. >**Note:** When you omit `sorters`, results are sorted by `created` ascending. For deterministic ordering across pages, always specify explicit sorters. When you use cursor pagination, include `id` in `sorters`; the service appends it automatically if you omit it. >**Note:** `offset` and `cursor` are mutually exclusive. Use `offset=0` along with a cursor value taken from a prior response\'s `X-Next-Cursor` header.
|
|
1595
|
+
* @summary List access profiles
|
|
1596
|
+
* @param {string} [xSailPointExperimental] Use this header to enable this experimental API.
|
|
1597
|
+
* @param {string} [forSubadmin] Filters the returned list according to what is visible to the indicated ROLE_SUBADMIN or SOURCE_SUBADMIN identity. The value of the parameter is either an identity ID or the special value **me**, which is shorthand for the calling identity\'s ID. If you specify an identity that isn\'t a subadmin, the API returns a 400 Bad Request error.
|
|
1598
|
+
* @param {number} [limit] Max number of results to return. See [API Standard Collection Parameters](https://developer.sailpoint.com/docs/api/standard-collection-parameters) for more information.
|
|
1599
|
+
* @param {number} [offset] Offset into the full result set. Usually specified with *limit* to paginate through the results. Must be 0 when you supply a `cursor`, and `offset` plus `limit` must not exceed 10000. See [API Standard Collection Parameters](https://developer.sailpoint.com/docs/api/standard-collection-parameters) for more information.
|
|
1600
|
+
* @param {boolean} [count] If *true* it will populate the *X-Total-Count* response header with the number of results that would be returned if *limit* and *offset* were ignored. Since requesting a total count can have a performance impact, it is recommended not to send **count=true** if that value will not be used. See [API Standard Collection Parameters](https://developer.sailpoint.com/docs/api/standard-collection-parameters) for more information.
|
|
1601
|
+
* @param {string} [filters] Filter results using the standard syntax described in [API Standard Collection Parameters](https://developer.sailpoint.com/docs/api/standard-collection-parameters#filtering-results) Filtering is supported for the following fields and operators: **id**: *eq, in* **name**: *eq, in, co* **created**: *lt, le, gt, ge* **modified**: *lt, le, gt, ge* **requestable**: *eq* **source.id**: *eq, in* **owner.id**: *eq, in* **additionalOwners.id**: *eq, in* **dimensional**: *eq* **entitlement.id**: *eq, in* **entitlement.name**: *eq, co* **privilegeLevel.effective**: *eq, in* Supported composite operators are *and, or*
|
|
1602
|
+
* @param {string} [sorters] Sort results using the standard syntax described in [API Standard Collection Parameters](https://developer.sailpoint.com/docs/api/standard-collection-parameters#sorting-results) Sorting is supported for the following fields: **name, created, modified, id, privilegeLevel.effective** Defaults to **created** ascending when omitted.
|
|
1603
|
+
* @param {string} [forSegmentIds] Filters access profiles to only those assigned to the segment(s) with the specified IDs. If segmentation is currently unavailable, specifying this parameter results in an error.
|
|
1604
|
+
* @param {boolean} [includeUnsegmented] Indicates whether the response list should contain unsegmented access profiles. If `for-segment-ids` is absent or empty, specifying *include-unsegmented* as `false` results in an error.
|
|
1605
|
+
* @param {string} [cursor] Opaque cursor taken from the `X-Next-Cursor` header of a previous response, used to retrieve the next page of results. When you supply a cursor, `offset` must be 0.
|
|
1606
|
+
* @param {*} [axiosOptions] Override http request option.
|
|
1607
|
+
* @throws {RequiredError}
|
|
1608
|
+
*/
|
|
1609
|
+
listAccessProfilesV2: function (xSailPointExperimental, forSubadmin, limit, offset, count, filters, sorters, forSegmentIds, includeUnsegmented, cursor, axiosOptions) {
|
|
1610
|
+
var _a, _b, _c;
|
|
1611
|
+
return __awaiter(this, void 0, void 0, function () {
|
|
1612
|
+
var localVarAxiosArgs, localVarOperationServerIndex, localVarOperationServerBasePath;
|
|
1613
|
+
return __generator(this, function (_d) {
|
|
1614
|
+
switch (_d.label) {
|
|
1615
|
+
case 0: return [4 /*yield*/, localVarAxiosParamCreator.listAccessProfilesV2(xSailPointExperimental, forSubadmin, limit, offset, count, filters, sorters, forSegmentIds, includeUnsegmented, cursor, axiosOptions)];
|
|
1616
|
+
case 1:
|
|
1617
|
+
localVarAxiosArgs = _d.sent();
|
|
1618
|
+
localVarOperationServerIndex = (_a = configuration === null || configuration === void 0 ? void 0 : configuration.serverIndex) !== null && _a !== void 0 ? _a : 0;
|
|
1619
|
+
localVarOperationServerBasePath = (_c = (_b = operationServerMap['AccessProfilesApi.listAccessProfilesV2']) === null || _b === void 0 ? void 0 : _b[localVarOperationServerIndex]) === null || _c === void 0 ? void 0 : _c.url;
|
|
1620
|
+
return [2 /*return*/, function (axios, basePath) { return createRequestFunction(localVarAxiosArgs, globalAxios, BASE_PATH, configuration)(axios, localVarOperationServerBasePath || basePath); }];
|
|
1621
|
+
}
|
|
1622
|
+
});
|
|
1623
|
+
});
|
|
1624
|
+
},
|
|
948
1625
|
/**
|
|
949
1626
|
* This API updates an existing Access Profile. The following fields are patchable: **name** **description** **enabled** **owner** **additionalOwners** **requestable** **accessRequestConfig** **revokeRequestConfig** **segments** **entitlements** **provisioningCriteria** **source** (must be updated with entitlements belonging to new source in the same API call) If you need to change the `source` of the access profile, you can do so only if you update the `entitlements` in the same API call. The new entitlements can only come from the target source that you want to change to. Look for the example \"Replace Source\" in the examples dropdown. Set `accessRequestConfig.formDefinitionId` to associate an optional custom form with access profile access requests. A user with SOURCE_SUBADMIN may only use this API to patch Access Profiles which are associated with Sources they are able to administer. > The maximum supported length for the description field is 2000 characters. Longer descriptions will be preserved for existing access profiles, however, any new access profiles as well as any updates to existing descriptions will be limited to 2000 characters. > You can only add or replace **entitlements** that exist on the source that the access profile is attached to. You can use the **list entitlements** endpoint with the **filters** query parameter to get a list of available entitlements on the access profile\'s source.
|
|
950
1627
|
* @summary Patch a specified access profile
|
|
@@ -969,6 +1646,31 @@ export var AccessProfilesApiFp = function (configuration) {
|
|
|
969
1646
|
});
|
|
970
1647
|
});
|
|
971
1648
|
},
|
|
1649
|
+
/**
|
|
1650
|
+
* This API updates an existing Access Profile. This version patches the same fields as [Patch a Specified Access Profile V1](https://developer.sailpoint.com/docs/api/patch-access-profile-v-1). It returns the v2 access profile shape, which adds the read-only `privilegeLevel` field. The following fields are patchable: **name** **description** **enabled** **owner** **additionalOwners** **requestable** **accessRequestConfig** **revocationRequestConfig** **segments** **entitlements** **provisioningCriteria** **source** (must be updated with entitlements belonging to new source in the same API call) If you need to change the `source` of the access profile, you can do so only if you update the `entitlements` in the same API call. The new entitlements can only come from the target source that you want to change to. Look for the example \"Replace Source\" in the examples dropdown. A user with SOURCE_SUBADMIN may only use this API to patch Access Profiles which are associated with Sources they are able to administer. > The maximum supported length for the description field is 2000 characters. Longer descriptions will be preserved for existing access profiles, however, any new access profiles as well as any updates to existing descriptions will be limited to 2000 characters. > You can only add or replace **entitlements** that exist on the source that the access profile is attached to. You can use the **list entitlements** endpoint with the **filters** query parameter to get a list of available entitlements on the access profile\'s source. >**Note:** `privilegeLevel` is read-only and cannot be patched. Changing the access profile\'s entitlements recalculates it asynchronously, so the patch response may still show the previous value.
|
|
1651
|
+
* @summary Patch a specified access profile
|
|
1652
|
+
* @param {string} id ID of the Access Profile to patch
|
|
1653
|
+
* @param {Array<JsonPatchOperation>} jsonPatchOperation
|
|
1654
|
+
* @param {string} [xSailPointExperimental] Use this header to enable this experimental API.
|
|
1655
|
+
* @param {*} [axiosOptions] Override http request option.
|
|
1656
|
+
* @throws {RequiredError}
|
|
1657
|
+
*/
|
|
1658
|
+
patchAccessProfileV2: function (id, jsonPatchOperation, xSailPointExperimental, axiosOptions) {
|
|
1659
|
+
var _a, _b, _c;
|
|
1660
|
+
return __awaiter(this, void 0, void 0, function () {
|
|
1661
|
+
var localVarAxiosArgs, localVarOperationServerIndex, localVarOperationServerBasePath;
|
|
1662
|
+
return __generator(this, function (_d) {
|
|
1663
|
+
switch (_d.label) {
|
|
1664
|
+
case 0: return [4 /*yield*/, localVarAxiosParamCreator.patchAccessProfileV2(id, jsonPatchOperation, xSailPointExperimental, axiosOptions)];
|
|
1665
|
+
case 1:
|
|
1666
|
+
localVarAxiosArgs = _d.sent();
|
|
1667
|
+
localVarOperationServerIndex = (_a = configuration === null || configuration === void 0 ? void 0 : configuration.serverIndex) !== null && _a !== void 0 ? _a : 0;
|
|
1668
|
+
localVarOperationServerBasePath = (_c = (_b = operationServerMap['AccessProfilesApi.patchAccessProfileV2']) === null || _b === void 0 ? void 0 : _b[localVarOperationServerIndex]) === null || _c === void 0 ? void 0 : _c.url;
|
|
1669
|
+
return [2 /*return*/, function (axios, basePath) { return createRequestFunction(localVarAxiosArgs, globalAxios, BASE_PATH, configuration)(axios, localVarOperationServerBasePath || basePath); }];
|
|
1670
|
+
}
|
|
1671
|
+
});
|
|
1672
|
+
});
|
|
1673
|
+
},
|
|
972
1674
|
/**
|
|
973
1675
|
* Get a list of access profiles filtered by Access Model Metadata and by filter expression. Filtering is supported by filter expression, by metadata attribute key and values, or by both together.
|
|
974
1676
|
* @summary Filter access profiles by metadata
|
|
@@ -999,6 +1701,38 @@ export var AccessProfilesApiFp = function (configuration) {
|
|
|
999
1701
|
});
|
|
1000
1702
|
});
|
|
1001
1703
|
},
|
|
1704
|
+
/**
|
|
1705
|
+
* Get a list of access profiles, supplying the filter criteria and access model metadata key/values in the request body rather than as query parameters. Use this endpoint when you need to filter by access model metadata, or when your filter expression is too long to pass as a query parameter. Pagination, sorting, subadmin scoping, and segment scoping behave the same as [List Access Profiles V2](https://developer.sailpoint.com/docs/api/list-access-profiles-v-2), including opaque cursor pagination through the `cursor` parameter and `X-Next-Cursor` response header.
|
|
1706
|
+
* @summary List access profiles by filter
|
|
1707
|
+
* @param {AccessProfileListFilterV2} accessProfileListFilterV2
|
|
1708
|
+
* @param {string} [xSailPointExperimental] Use this header to enable this experimental API.
|
|
1709
|
+
* @param {string} [forSubadmin] Filters the returned list according to what is visible to the indicated ROLE_SUBADMIN or SOURCE_SUBADMIN identity. The value of the parameter is either an identity ID or the special value **me**, which is shorthand for the calling identity\'s ID. If you specify an identity that isn\'t a subadmin, the API returns a 400 Bad Request error.
|
|
1710
|
+
* @param {number} [limit] Max number of results to return. See [API Standard Collection Parameters](https://developer.sailpoint.com/docs/api/standard-collection-parameters) for more information.
|
|
1711
|
+
* @param {number} [offset] Offset into the full result set. Usually specified with *limit* to paginate through the results. Must be 0 when you supply a `cursor`, and `offset` plus `limit` must not exceed 10000. See [API Standard Collection Parameters](https://developer.sailpoint.com/docs/api/standard-collection-parameters) for more information.
|
|
1712
|
+
* @param {boolean} [count] If *true* it will populate the *X-Total-Count* response header with the number of results that would be returned if *limit* and *offset* were ignored. Since requesting a total count can have a performance impact, it is recommended not to send **count=true** if that value will not be used. See [API Standard Collection Parameters](https://developer.sailpoint.com/docs/api/standard-collection-parameters) for more information.
|
|
1713
|
+
* @param {string} [sorters] Sort results using the standard syntax described in [API Standard Collection Parameters](https://developer.sailpoint.com/docs/api/standard-collection-parameters#sorting-results) Sorting is supported for the following fields: **name, created, modified, id, privilegeLevel.effective** Defaults to **created** ascending when omitted.
|
|
1714
|
+
* @param {string} [forSegmentIds] Filters access profiles to only those assigned to the segment(s) with the specified IDs. If segmentation is currently unavailable, specifying this parameter results in an error.
|
|
1715
|
+
* @param {boolean} [includeUnsegmented] Indicates whether the response list should contain unsegmented access profiles. If `for-segment-ids` is absent or empty, specifying *include-unsegmented* as `false` results in an error.
|
|
1716
|
+
* @param {string} [cursor] Opaque cursor taken from the `X-Next-Cursor` header of a previous response, used to retrieve the next page of results. When you supply a cursor, `offset` must be 0.
|
|
1717
|
+
* @param {*} [axiosOptions] Override http request option.
|
|
1718
|
+
* @throws {RequiredError}
|
|
1719
|
+
*/
|
|
1720
|
+
searchAccessProfilesByFilterV2: function (accessProfileListFilterV2, xSailPointExperimental, forSubadmin, limit, offset, count, sorters, forSegmentIds, includeUnsegmented, cursor, axiosOptions) {
|
|
1721
|
+
var _a, _b, _c;
|
|
1722
|
+
return __awaiter(this, void 0, void 0, function () {
|
|
1723
|
+
var localVarAxiosArgs, localVarOperationServerIndex, localVarOperationServerBasePath;
|
|
1724
|
+
return __generator(this, function (_d) {
|
|
1725
|
+
switch (_d.label) {
|
|
1726
|
+
case 0: return [4 /*yield*/, localVarAxiosParamCreator.searchAccessProfilesByFilterV2(accessProfileListFilterV2, xSailPointExperimental, forSubadmin, limit, offset, count, sorters, forSegmentIds, includeUnsegmented, cursor, axiosOptions)];
|
|
1727
|
+
case 1:
|
|
1728
|
+
localVarAxiosArgs = _d.sent();
|
|
1729
|
+
localVarOperationServerIndex = (_a = configuration === null || configuration === void 0 ? void 0 : configuration.serverIndex) !== null && _a !== void 0 ? _a : 0;
|
|
1730
|
+
localVarOperationServerBasePath = (_c = (_b = operationServerMap['AccessProfilesApi.searchAccessProfilesByFilterV2']) === null || _b === void 0 ? void 0 : _b[localVarOperationServerIndex]) === null || _c === void 0 ? void 0 : _c.url;
|
|
1731
|
+
return [2 /*return*/, function (axios, basePath) { return createRequestFunction(localVarAxiosArgs, globalAxios, BASE_PATH, configuration)(axios, localVarOperationServerBasePath || basePath); }];
|
|
1732
|
+
}
|
|
1733
|
+
});
|
|
1734
|
+
});
|
|
1735
|
+
},
|
|
1002
1736
|
/**
|
|
1003
1737
|
* This API initiates a bulk update of field requestable for one or more Access Profiles. > If any of the indicated Access Profiles is exists in Organization,then those Access Profiles will be added in **updated** list of the response.Requestable field of these Access Profiles marked as **true** or **false**. > If any of the indicated Access Profiles is not does not exists in Organization,then those Access Profiles will be added in **notFound** list of the response. Access Profiles marked as **notFound** will not be updated. A SOURCE_SUBADMIN may only use this API to update Access Profiles which are associated with Sources they are able to administer.
|
|
1004
1738
|
* @summary Update access profile(s) requestable field.
|
|
@@ -1022,6 +1756,30 @@ export var AccessProfilesApiFp = function (configuration) {
|
|
|
1022
1756
|
});
|
|
1023
1757
|
});
|
|
1024
1758
|
},
|
|
1759
|
+
/**
|
|
1760
|
+
* This API initiates a bulk update of field requestable for one or more Access Profiles. This version behaves identically to [Update Access Profile(s) Requestable Field V1](https://developer.sailpoint.com/docs/api/update-access-profiles-in-bulk-v-1). > If any of the indicated Access Profiles is exists in Organization,then those Access Profiles will be added in **updated** list of the response.Requestable field of these Access Profiles marked as **true** or **false**. > If any of the indicated Access Profiles is not does not exists in Organization,then those Access Profiles will be added in **notFound** list of the response. Access Profiles marked as **notFound** will not be updated. A SOURCE_SUBADMIN may only use this API to update Access Profiles which are associated with Sources they are able to administer.
|
|
1761
|
+
* @summary Update access profile(s) requestable field.
|
|
1762
|
+
* @param {Array<AccessProfileBulkUpdateRequestInner>} accessProfileBulkUpdateRequestInner
|
|
1763
|
+
* @param {string} [xSailPointExperimental] Use this header to enable this experimental API.
|
|
1764
|
+
* @param {*} [axiosOptions] Override http request option.
|
|
1765
|
+
* @throws {RequiredError}
|
|
1766
|
+
*/
|
|
1767
|
+
updateAccessProfilesInBulkV2: function (accessProfileBulkUpdateRequestInner, xSailPointExperimental, axiosOptions) {
|
|
1768
|
+
var _a, _b, _c;
|
|
1769
|
+
return __awaiter(this, void 0, void 0, function () {
|
|
1770
|
+
var localVarAxiosArgs, localVarOperationServerIndex, localVarOperationServerBasePath;
|
|
1771
|
+
return __generator(this, function (_d) {
|
|
1772
|
+
switch (_d.label) {
|
|
1773
|
+
case 0: return [4 /*yield*/, localVarAxiosParamCreator.updateAccessProfilesInBulkV2(accessProfileBulkUpdateRequestInner, xSailPointExperimental, axiosOptions)];
|
|
1774
|
+
case 1:
|
|
1775
|
+
localVarAxiosArgs = _d.sent();
|
|
1776
|
+
localVarOperationServerIndex = (_a = configuration === null || configuration === void 0 ? void 0 : configuration.serverIndex) !== null && _a !== void 0 ? _a : 0;
|
|
1777
|
+
localVarOperationServerBasePath = (_c = (_b = operationServerMap['AccessProfilesApi.updateAccessProfilesInBulkV2']) === null || _b === void 0 ? void 0 : _b[localVarOperationServerIndex]) === null || _c === void 0 ? void 0 : _c.url;
|
|
1778
|
+
return [2 /*return*/, function (axios, basePath) { return createRequestFunction(localVarAxiosArgs, globalAxios, BASE_PATH, configuration)(axios, localVarOperationServerBasePath || basePath); }];
|
|
1779
|
+
}
|
|
1780
|
+
});
|
|
1781
|
+
});
|
|
1782
|
+
},
|
|
1025
1783
|
/**
|
|
1026
1784
|
* This API initiates a bulk update of Access Model Metadata for every access profile matching the supplied filter expression. The update is processed asynchronously. The response returns the ID of the task performing the update. A single access profile cannot be assigned more than 25 metadata values. Adding or replacing custom metadata requires a suite license.
|
|
1027
1785
|
* @summary Bulk-update metadata by filter
|
|
@@ -1135,6 +1893,16 @@ export var AccessProfilesApiFactory = function (configuration, basePath, axios)
|
|
|
1135
1893
|
createAccessProfileV1: function (requestParameters, axiosOptions) {
|
|
1136
1894
|
return localVarFp.createAccessProfileV1(requestParameters.accessProfile, axiosOptions).then(function (request) { return request(axios, basePath); });
|
|
1137
1895
|
},
|
|
1896
|
+
/**
|
|
1897
|
+
* Create an access profile. This version accepts the same request body and applies the same validation as [Create Access Profile V1](https://developer.sailpoint.com/docs/api/create-access-profile-v-1). It returns the v2 access profile shape, which adds the read-only `privilegeLevel` field. A user with `ROLE_SUBADMIN` or `SOURCE_SUBADMIN` authority must be associated with the access profile\'s source. The maximum supported length for the description field is 2000 characters. Longer descriptions will be preserved for existing access profiles. However, any new access profiles as well as any updates to existing descriptions are limited to 2000 characters. >**Note:** To use this endpoint, you need all the listed scopes. >**Note:** `privilegeLevel` is read-only and is ignored if supplied in the request body. It is calculated asynchronously from the access profile\'s entitlements, so it is typically absent from the create response.
|
|
1898
|
+
* @summary Create access profile
|
|
1899
|
+
* @param {AccessProfilesApiCreateAccessProfileV2Request} requestParameters Request parameters.
|
|
1900
|
+
* @param {*} [axiosOptions] Override http request option.
|
|
1901
|
+
* @throws {RequiredError}
|
|
1902
|
+
*/
|
|
1903
|
+
createAccessProfileV2: function (requestParameters, axiosOptions) {
|
|
1904
|
+
return localVarFp.createAccessProfileV2(requestParameters.accessprofilev2, requestParameters.xSailPointExperimental, axiosOptions).then(function (request) { return request(axios, basePath); });
|
|
1905
|
+
},
|
|
1138
1906
|
/**
|
|
1139
1907
|
* This API deletes an existing Access Profile. The Access Profile must not be in use, for example, Access Profile can not be deleted if they belong to an Application, Life Cycle State or a Role. If it is, a 400 error is returned. A user with SOURCE_SUBADMIN must be able to administer the Source associated with the Access Profile.
|
|
1140
1908
|
* @summary Delete the specified access profile
|
|
@@ -1145,6 +1913,16 @@ export var AccessProfilesApiFactory = function (configuration, basePath, axios)
|
|
|
1145
1913
|
deleteAccessProfileV1: function (requestParameters, axiosOptions) {
|
|
1146
1914
|
return localVarFp.deleteAccessProfileV1(requestParameters.id, axiosOptions).then(function (request) { return request(axios, basePath); });
|
|
1147
1915
|
},
|
|
1916
|
+
/**
|
|
1917
|
+
* This API deletes an existing Access Profile. This version behaves identically to [Delete the Specified Access Profile V1](https://developer.sailpoint.com/docs/api/delete-access-profile-v-1). The Access Profile must not be in use, for example, Access Profile can not be deleted if they belong to an Application, Life Cycle State or a Role. If it is, a 400 error is returned. A user with SOURCE_SUBADMIN must be able to administer the Source associated with the Access Profile.
|
|
1918
|
+
* @summary Delete the specified access profile
|
|
1919
|
+
* @param {AccessProfilesApiDeleteAccessProfileV2Request} requestParameters Request parameters.
|
|
1920
|
+
* @param {*} [axiosOptions] Override http request option.
|
|
1921
|
+
* @throws {RequiredError}
|
|
1922
|
+
*/
|
|
1923
|
+
deleteAccessProfileV2: function (requestParameters, axiosOptions) {
|
|
1924
|
+
return localVarFp.deleteAccessProfileV2(requestParameters.id, requestParameters.xSailPointExperimental, axiosOptions).then(function (request) { return request(axios, basePath); });
|
|
1925
|
+
},
|
|
1148
1926
|
/**
|
|
1149
1927
|
* This endpoint initiates a bulk deletion of one or more access profiles. When the request is successful, the endpoint returns the bulk delete\'s task result ID. To follow the task, you can use [Get Task Status by ID](https://developer.sailpoint.com/docs/api/get-task-status-v-1), which will return the task result\'s status and information. This endpoint can only bulk delete up to a limit of 50 access profiles per request. By default, if any of the indicated access profiles are in use, no deletions will be performed and the **inUse** field of the response indicates the usages that must be removed first. If the request field **bestEffortOnly** is **true**, however, usages are reported in the **inUse** response field but all other indicated access profiles will be deleted. A SOURCE_SUBADMIN user can only use this endpoint to delete access profiles associated with sources they\'re able to administer.
|
|
1150
1928
|
* @summary Delete access profile(s)
|
|
@@ -1155,6 +1933,16 @@ export var AccessProfilesApiFactory = function (configuration, basePath, axios)
|
|
|
1155
1933
|
deleteAccessProfilesInBulkV1: function (requestParameters, axiosOptions) {
|
|
1156
1934
|
return localVarFp.deleteAccessProfilesInBulkV1(requestParameters.accessProfileBulkDeleteRequest, axiosOptions).then(function (request) { return request(axios, basePath); });
|
|
1157
1935
|
},
|
|
1936
|
+
/**
|
|
1937
|
+
* This endpoint initiates a bulk deletion of one or more access profiles. This version behaves identically to [Delete Access Profile(s) V1](https://developer.sailpoint.com/docs/api/delete-access-profiles-in-bulk-v-1). When the request is successful, the endpoint returns the bulk delete\'s task result ID. To follow the task, you can use [Get Task Status by ID](https://developer.sailpoint.com/docs/api/get-task-status-v-1), which will return the task result\'s status and information. This endpoint can only bulk delete up to a limit of 50 access profiles per request. By default, if any of the indicated access profiles are in use, no deletions will be performed and the **inUse** field of the response indicates the usages that must be removed first. If the request field **bestEffortOnly** is **true**, however, usages are reported in the **inUse** response field but all other indicated access profiles will be deleted. A SOURCE_SUBADMIN user can only use this endpoint to delete access profiles associated with sources they\'re able to administer.
|
|
1938
|
+
* @summary Delete access profile(s)
|
|
1939
|
+
* @param {AccessProfilesApiDeleteAccessProfilesInBulkV2Request} requestParameters Request parameters.
|
|
1940
|
+
* @param {*} [axiosOptions] Override http request option.
|
|
1941
|
+
* @throws {RequiredError}
|
|
1942
|
+
*/
|
|
1943
|
+
deleteAccessProfilesInBulkV2: function (requestParameters, axiosOptions) {
|
|
1944
|
+
return localVarFp.deleteAccessProfilesInBulkV2(requestParameters.accessProfileBulkDeleteRequest, requestParameters.xSailPointExperimental, axiosOptions).then(function (request) { return request(axios, basePath); });
|
|
1945
|
+
},
|
|
1158
1946
|
/**
|
|
1159
1947
|
* This API removes a single Access Model Metadata value from an access profile by attribute key and attribute value.
|
|
1160
1948
|
* @summary Remove metadata from access profile
|
|
@@ -1175,6 +1963,16 @@ export var AccessProfilesApiFactory = function (configuration, basePath, axios)
|
|
|
1175
1963
|
getAccessProfileEntitlementsV1: function (requestParameters, axiosOptions) {
|
|
1176
1964
|
return localVarFp.getAccessProfileEntitlementsV1(requestParameters.id, requestParameters.limit, requestParameters.offset, requestParameters.count, requestParameters.filters, requestParameters.sorters, axiosOptions).then(function (request) { return request(axios, basePath); });
|
|
1177
1965
|
},
|
|
1966
|
+
/**
|
|
1967
|
+
* Get a list of an access profile\'s entitlements. This version reads from Search Lite and returns a superset of the entitlement returned by [List Access Profile\'s Entitlements V1](https://developer.sailpoint.com/docs/api/get-access-profile-entitlements-v-1), adding the entitlement\'s `tags` and calculated `privilegeLevel`. It also supports opaque cursor pagination through the `cursor` parameter and `X-Next-Cursor` response header. A SOURCE_SUBADMIN user must have access to the source associated with the specified access profile.
|
|
1968
|
+
* @summary List access profile\'s entitlements
|
|
1969
|
+
* @param {AccessProfilesApiGetAccessProfileEntitlementsV2Request} requestParameters Request parameters.
|
|
1970
|
+
* @param {*} [axiosOptions] Override http request option.
|
|
1971
|
+
* @throws {RequiredError}
|
|
1972
|
+
*/
|
|
1973
|
+
getAccessProfileEntitlementsV2: function (requestParameters, axiosOptions) {
|
|
1974
|
+
return localVarFp.getAccessProfileEntitlementsV2(requestParameters.id, requestParameters.xSailPointExperimental, requestParameters.limit, requestParameters.offset, requestParameters.count, requestParameters.filters, requestParameters.sorters, requestParameters.cursor, axiosOptions).then(function (request) { return request(axios, basePath); });
|
|
1975
|
+
},
|
|
1178
1976
|
/**
|
|
1179
1977
|
* This API returns an Access Profile by its ID. The `accessRequestConfig.formDefinitionId` field associates an optional custom form with access profile access requests.
|
|
1180
1978
|
* @summary Get an access profile
|
|
@@ -1185,6 +1983,16 @@ export var AccessProfilesApiFactory = function (configuration, basePath, axios)
|
|
|
1185
1983
|
getAccessProfileV1: function (requestParameters, axiosOptions) {
|
|
1186
1984
|
return localVarFp.getAccessProfileV1(requestParameters.id, axiosOptions).then(function (request) { return request(axios, basePath); });
|
|
1187
1985
|
},
|
|
1986
|
+
/**
|
|
1987
|
+
* Get an access profile by its ID. This version reads from Search Lite and returns the same access profile shape as [Get Access Profile V1](https://developer.sailpoint.com/docs/api/get-access-profile-v-1), with the calculated `privilegeLevel` field added.
|
|
1988
|
+
* @summary Get an access profile
|
|
1989
|
+
* @param {AccessProfilesApiGetAccessProfileV2Request} requestParameters Request parameters.
|
|
1990
|
+
* @param {*} [axiosOptions] Override http request option.
|
|
1991
|
+
* @throws {RequiredError}
|
|
1992
|
+
*/
|
|
1993
|
+
getAccessProfileV2: function (requestParameters, axiosOptions) {
|
|
1994
|
+
return localVarFp.getAccessProfileV2(requestParameters.id, requestParameters.xSailPointExperimental, axiosOptions).then(function (request) { return request(axios, basePath); });
|
|
1995
|
+
},
|
|
1188
1996
|
/**
|
|
1189
1997
|
* Get a list of access profiles. >**Note:** When you filter for access profiles that have the \'+\' symbol in their names, the response is blank.
|
|
1190
1998
|
* @summary List access profiles
|
|
@@ -1196,6 +2004,17 @@ export var AccessProfilesApiFactory = function (configuration, basePath, axios)
|
|
|
1196
2004
|
if (requestParameters === void 0) { requestParameters = {}; }
|
|
1197
2005
|
return localVarFp.listAccessProfilesV1(requestParameters.forSubadmin, requestParameters.limit, requestParameters.offset, requestParameters.count, requestParameters.filters, requestParameters.sorters, requestParameters.forSegmentIds, requestParameters.includeUnsegmented, axiosOptions).then(function (request) { return request(axios, basePath); });
|
|
1198
2006
|
},
|
|
2007
|
+
/**
|
|
2008
|
+
* Get a list of access profiles. This version reads from Search Lite and returns the same access profile shape as [List Access Profiles V1](https://developer.sailpoint.com/docs/api/list-access-profiles-v-1), with two additions: the calculated `privilegeLevel` field, and opaque cursor pagination through the `cursor` parameter and `X-Next-Cursor` response header. >**Note:** When you omit `sorters`, results are sorted by `created` ascending. For deterministic ordering across pages, always specify explicit sorters. When you use cursor pagination, include `id` in `sorters`; the service appends it automatically if you omit it. >**Note:** `offset` and `cursor` are mutually exclusive. Use `offset=0` along with a cursor value taken from a prior response\'s `X-Next-Cursor` header.
|
|
2009
|
+
* @summary List access profiles
|
|
2010
|
+
* @param {AccessProfilesApiListAccessProfilesV2Request} requestParameters Request parameters.
|
|
2011
|
+
* @param {*} [axiosOptions] Override http request option.
|
|
2012
|
+
* @throws {RequiredError}
|
|
2013
|
+
*/
|
|
2014
|
+
listAccessProfilesV2: function (requestParameters, axiosOptions) {
|
|
2015
|
+
if (requestParameters === void 0) { requestParameters = {}; }
|
|
2016
|
+
return localVarFp.listAccessProfilesV2(requestParameters.xSailPointExperimental, requestParameters.forSubadmin, requestParameters.limit, requestParameters.offset, requestParameters.count, requestParameters.filters, requestParameters.sorters, requestParameters.forSegmentIds, requestParameters.includeUnsegmented, requestParameters.cursor, axiosOptions).then(function (request) { return request(axios, basePath); });
|
|
2017
|
+
},
|
|
1199
2018
|
/**
|
|
1200
2019
|
* This API updates an existing Access Profile. The following fields are patchable: **name** **description** **enabled** **owner** **additionalOwners** **requestable** **accessRequestConfig** **revokeRequestConfig** **segments** **entitlements** **provisioningCriteria** **source** (must be updated with entitlements belonging to new source in the same API call) If you need to change the `source` of the access profile, you can do so only if you update the `entitlements` in the same API call. The new entitlements can only come from the target source that you want to change to. Look for the example \"Replace Source\" in the examples dropdown. Set `accessRequestConfig.formDefinitionId` to associate an optional custom form with access profile access requests. A user with SOURCE_SUBADMIN may only use this API to patch Access Profiles which are associated with Sources they are able to administer. > The maximum supported length for the description field is 2000 characters. Longer descriptions will be preserved for existing access profiles, however, any new access profiles as well as any updates to existing descriptions will be limited to 2000 characters. > You can only add or replace **entitlements** that exist on the source that the access profile is attached to. You can use the **list entitlements** endpoint with the **filters** query parameter to get a list of available entitlements on the access profile\'s source.
|
|
1201
2020
|
* @summary Patch a specified access profile
|
|
@@ -1206,6 +2025,16 @@ export var AccessProfilesApiFactory = function (configuration, basePath, axios)
|
|
|
1206
2025
|
patchAccessProfileV1: function (requestParameters, axiosOptions) {
|
|
1207
2026
|
return localVarFp.patchAccessProfileV1(requestParameters.id, requestParameters.jsonPatchOperation, axiosOptions).then(function (request) { return request(axios, basePath); });
|
|
1208
2027
|
},
|
|
2028
|
+
/**
|
|
2029
|
+
* This API updates an existing Access Profile. This version patches the same fields as [Patch a Specified Access Profile V1](https://developer.sailpoint.com/docs/api/patch-access-profile-v-1). It returns the v2 access profile shape, which adds the read-only `privilegeLevel` field. The following fields are patchable: **name** **description** **enabled** **owner** **additionalOwners** **requestable** **accessRequestConfig** **revocationRequestConfig** **segments** **entitlements** **provisioningCriteria** **source** (must be updated with entitlements belonging to new source in the same API call) If you need to change the `source` of the access profile, you can do so only if you update the `entitlements` in the same API call. The new entitlements can only come from the target source that you want to change to. Look for the example \"Replace Source\" in the examples dropdown. A user with SOURCE_SUBADMIN may only use this API to patch Access Profiles which are associated with Sources they are able to administer. > The maximum supported length for the description field is 2000 characters. Longer descriptions will be preserved for existing access profiles, however, any new access profiles as well as any updates to existing descriptions will be limited to 2000 characters. > You can only add or replace **entitlements** that exist on the source that the access profile is attached to. You can use the **list entitlements** endpoint with the **filters** query parameter to get a list of available entitlements on the access profile\'s source. >**Note:** `privilegeLevel` is read-only and cannot be patched. Changing the access profile\'s entitlements recalculates it asynchronously, so the patch response may still show the previous value.
|
|
2030
|
+
* @summary Patch a specified access profile
|
|
2031
|
+
* @param {AccessProfilesApiPatchAccessProfileV2Request} requestParameters Request parameters.
|
|
2032
|
+
* @param {*} [axiosOptions] Override http request option.
|
|
2033
|
+
* @throws {RequiredError}
|
|
2034
|
+
*/
|
|
2035
|
+
patchAccessProfileV2: function (requestParameters, axiosOptions) {
|
|
2036
|
+
return localVarFp.patchAccessProfileV2(requestParameters.id, requestParameters.jsonPatchOperation, requestParameters.xSailPointExperimental, axiosOptions).then(function (request) { return request(axios, basePath); });
|
|
2037
|
+
},
|
|
1209
2038
|
/**
|
|
1210
2039
|
* Get a list of access profiles filtered by Access Model Metadata and by filter expression. Filtering is supported by filter expression, by metadata attribute key and values, or by both together.
|
|
1211
2040
|
* @summary Filter access profiles by metadata
|
|
@@ -1216,6 +2045,16 @@ export var AccessProfilesApiFactory = function (configuration, basePath, axios)
|
|
|
1216
2045
|
searchAccessProfilesByFilterV1: function (requestParameters, axiosOptions) {
|
|
1217
2046
|
return localVarFp.searchAccessProfilesByFilterV1(requestParameters.accessProfileListFilterDTO, requestParameters.forSubadmin, requestParameters.limit, requestParameters.offset, requestParameters.count, requestParameters.sorters, requestParameters.forSegmentIds, requestParameters.includeUnsegmented, axiosOptions).then(function (request) { return request(axios, basePath); });
|
|
1218
2047
|
},
|
|
2048
|
+
/**
|
|
2049
|
+
* Get a list of access profiles, supplying the filter criteria and access model metadata key/values in the request body rather than as query parameters. Use this endpoint when you need to filter by access model metadata, or when your filter expression is too long to pass as a query parameter. Pagination, sorting, subadmin scoping, and segment scoping behave the same as [List Access Profiles V2](https://developer.sailpoint.com/docs/api/list-access-profiles-v-2), including opaque cursor pagination through the `cursor` parameter and `X-Next-Cursor` response header.
|
|
2050
|
+
* @summary List access profiles by filter
|
|
2051
|
+
* @param {AccessProfilesApiSearchAccessProfilesByFilterV2Request} requestParameters Request parameters.
|
|
2052
|
+
* @param {*} [axiosOptions] Override http request option.
|
|
2053
|
+
* @throws {RequiredError}
|
|
2054
|
+
*/
|
|
2055
|
+
searchAccessProfilesByFilterV2: function (requestParameters, axiosOptions) {
|
|
2056
|
+
return localVarFp.searchAccessProfilesByFilterV2(requestParameters.accessProfileListFilterV2, requestParameters.xSailPointExperimental, requestParameters.forSubadmin, requestParameters.limit, requestParameters.offset, requestParameters.count, requestParameters.sorters, requestParameters.forSegmentIds, requestParameters.includeUnsegmented, requestParameters.cursor, axiosOptions).then(function (request) { return request(axios, basePath); });
|
|
2057
|
+
},
|
|
1219
2058
|
/**
|
|
1220
2059
|
* This API initiates a bulk update of field requestable for one or more Access Profiles. > If any of the indicated Access Profiles is exists in Organization,then those Access Profiles will be added in **updated** list of the response.Requestable field of these Access Profiles marked as **true** or **false**. > If any of the indicated Access Profiles is not does not exists in Organization,then those Access Profiles will be added in **notFound** list of the response. Access Profiles marked as **notFound** will not be updated. A SOURCE_SUBADMIN may only use this API to update Access Profiles which are associated with Sources they are able to administer.
|
|
1221
2060
|
* @summary Update access profile(s) requestable field.
|
|
@@ -1226,6 +2065,16 @@ export var AccessProfilesApiFactory = function (configuration, basePath, axios)
|
|
|
1226
2065
|
updateAccessProfilesInBulkV1: function (requestParameters, axiosOptions) {
|
|
1227
2066
|
return localVarFp.updateAccessProfilesInBulkV1(requestParameters.accessProfileBulkUpdateRequestInner, axiosOptions).then(function (request) { return request(axios, basePath); });
|
|
1228
2067
|
},
|
|
2068
|
+
/**
|
|
2069
|
+
* This API initiates a bulk update of field requestable for one or more Access Profiles. This version behaves identically to [Update Access Profile(s) Requestable Field V1](https://developer.sailpoint.com/docs/api/update-access-profiles-in-bulk-v-1). > If any of the indicated Access Profiles is exists in Organization,then those Access Profiles will be added in **updated** list of the response.Requestable field of these Access Profiles marked as **true** or **false**. > If any of the indicated Access Profiles is not does not exists in Organization,then those Access Profiles will be added in **notFound** list of the response. Access Profiles marked as **notFound** will not be updated. A SOURCE_SUBADMIN may only use this API to update Access Profiles which are associated with Sources they are able to administer.
|
|
2070
|
+
* @summary Update access profile(s) requestable field.
|
|
2071
|
+
* @param {AccessProfilesApiUpdateAccessProfilesInBulkV2Request} requestParameters Request parameters.
|
|
2072
|
+
* @param {*} [axiosOptions] Override http request option.
|
|
2073
|
+
* @throws {RequiredError}
|
|
2074
|
+
*/
|
|
2075
|
+
updateAccessProfilesInBulkV2: function (requestParameters, axiosOptions) {
|
|
2076
|
+
return localVarFp.updateAccessProfilesInBulkV2(requestParameters.accessProfileBulkUpdateRequestInner, requestParameters.xSailPointExperimental, axiosOptions).then(function (request) { return request(axios, basePath); });
|
|
2077
|
+
},
|
|
1229
2078
|
/**
|
|
1230
2079
|
* This API initiates a bulk update of Access Model Metadata for every access profile matching the supplied filter expression. The update is processed asynchronously. The response returns the ID of the task performing the update. A single access profile cannot be assigned more than 25 metadata values. Adding or replacing custom metadata requires a suite license.
|
|
1231
2080
|
* @summary Bulk-update metadata by filter
|
|
@@ -1291,6 +2140,18 @@ var AccessProfilesApi = /** @class */ (function (_super) {
|
|
|
1291
2140
|
var _this = this;
|
|
1292
2141
|
return AccessProfilesApiFp(this.configuration).createAccessProfileV1(requestParameters.accessProfile, axiosOptions).then(function (request) { return request(_this.axios, _this.basePath); });
|
|
1293
2142
|
};
|
|
2143
|
+
/**
|
|
2144
|
+
* Create an access profile. This version accepts the same request body and applies the same validation as [Create Access Profile V1](https://developer.sailpoint.com/docs/api/create-access-profile-v-1). It returns the v2 access profile shape, which adds the read-only `privilegeLevel` field. A user with `ROLE_SUBADMIN` or `SOURCE_SUBADMIN` authority must be associated with the access profile\'s source. The maximum supported length for the description field is 2000 characters. Longer descriptions will be preserved for existing access profiles. However, any new access profiles as well as any updates to existing descriptions are limited to 2000 characters. >**Note:** To use this endpoint, you need all the listed scopes. >**Note:** `privilegeLevel` is read-only and is ignored if supplied in the request body. It is calculated asynchronously from the access profile\'s entitlements, so it is typically absent from the create response.
|
|
2145
|
+
* @summary Create access profile
|
|
2146
|
+
* @param {AccessProfilesApiCreateAccessProfileV2Request} requestParameters Request parameters.
|
|
2147
|
+
* @param {*} [axiosOptions] Override http request option.
|
|
2148
|
+
* @throws {RequiredError}
|
|
2149
|
+
* @memberof AccessProfilesApi
|
|
2150
|
+
*/
|
|
2151
|
+
AccessProfilesApi.prototype.createAccessProfileV2 = function (requestParameters, axiosOptions) {
|
|
2152
|
+
var _this = this;
|
|
2153
|
+
return AccessProfilesApiFp(this.configuration).createAccessProfileV2(requestParameters.accessprofilev2, requestParameters.xSailPointExperimental, axiosOptions).then(function (request) { return request(_this.axios, _this.basePath); });
|
|
2154
|
+
};
|
|
1294
2155
|
/**
|
|
1295
2156
|
* This API deletes an existing Access Profile. The Access Profile must not be in use, for example, Access Profile can not be deleted if they belong to an Application, Life Cycle State or a Role. If it is, a 400 error is returned. A user with SOURCE_SUBADMIN must be able to administer the Source associated with the Access Profile.
|
|
1296
2157
|
* @summary Delete the specified access profile
|
|
@@ -1303,6 +2164,18 @@ var AccessProfilesApi = /** @class */ (function (_super) {
|
|
|
1303
2164
|
var _this = this;
|
|
1304
2165
|
return AccessProfilesApiFp(this.configuration).deleteAccessProfileV1(requestParameters.id, axiosOptions).then(function (request) { return request(_this.axios, _this.basePath); });
|
|
1305
2166
|
};
|
|
2167
|
+
/**
|
|
2168
|
+
* This API deletes an existing Access Profile. This version behaves identically to [Delete the Specified Access Profile V1](https://developer.sailpoint.com/docs/api/delete-access-profile-v-1). The Access Profile must not be in use, for example, Access Profile can not be deleted if they belong to an Application, Life Cycle State or a Role. If it is, a 400 error is returned. A user with SOURCE_SUBADMIN must be able to administer the Source associated with the Access Profile.
|
|
2169
|
+
* @summary Delete the specified access profile
|
|
2170
|
+
* @param {AccessProfilesApiDeleteAccessProfileV2Request} requestParameters Request parameters.
|
|
2171
|
+
* @param {*} [axiosOptions] Override http request option.
|
|
2172
|
+
* @throws {RequiredError}
|
|
2173
|
+
* @memberof AccessProfilesApi
|
|
2174
|
+
*/
|
|
2175
|
+
AccessProfilesApi.prototype.deleteAccessProfileV2 = function (requestParameters, axiosOptions) {
|
|
2176
|
+
var _this = this;
|
|
2177
|
+
return AccessProfilesApiFp(this.configuration).deleteAccessProfileV2(requestParameters.id, requestParameters.xSailPointExperimental, axiosOptions).then(function (request) { return request(_this.axios, _this.basePath); });
|
|
2178
|
+
};
|
|
1306
2179
|
/**
|
|
1307
2180
|
* This endpoint initiates a bulk deletion of one or more access profiles. When the request is successful, the endpoint returns the bulk delete\'s task result ID. To follow the task, you can use [Get Task Status by ID](https://developer.sailpoint.com/docs/api/get-task-status-v-1), which will return the task result\'s status and information. This endpoint can only bulk delete up to a limit of 50 access profiles per request. By default, if any of the indicated access profiles are in use, no deletions will be performed and the **inUse** field of the response indicates the usages that must be removed first. If the request field **bestEffortOnly** is **true**, however, usages are reported in the **inUse** response field but all other indicated access profiles will be deleted. A SOURCE_SUBADMIN user can only use this endpoint to delete access profiles associated with sources they\'re able to administer.
|
|
1308
2181
|
* @summary Delete access profile(s)
|
|
@@ -1315,6 +2188,18 @@ var AccessProfilesApi = /** @class */ (function (_super) {
|
|
|
1315
2188
|
var _this = this;
|
|
1316
2189
|
return AccessProfilesApiFp(this.configuration).deleteAccessProfilesInBulkV1(requestParameters.accessProfileBulkDeleteRequest, axiosOptions).then(function (request) { return request(_this.axios, _this.basePath); });
|
|
1317
2190
|
};
|
|
2191
|
+
/**
|
|
2192
|
+
* This endpoint initiates a bulk deletion of one or more access profiles. This version behaves identically to [Delete Access Profile(s) V1](https://developer.sailpoint.com/docs/api/delete-access-profiles-in-bulk-v-1). When the request is successful, the endpoint returns the bulk delete\'s task result ID. To follow the task, you can use [Get Task Status by ID](https://developer.sailpoint.com/docs/api/get-task-status-v-1), which will return the task result\'s status and information. This endpoint can only bulk delete up to a limit of 50 access profiles per request. By default, if any of the indicated access profiles are in use, no deletions will be performed and the **inUse** field of the response indicates the usages that must be removed first. If the request field **bestEffortOnly** is **true**, however, usages are reported in the **inUse** response field but all other indicated access profiles will be deleted. A SOURCE_SUBADMIN user can only use this endpoint to delete access profiles associated with sources they\'re able to administer.
|
|
2193
|
+
* @summary Delete access profile(s)
|
|
2194
|
+
* @param {AccessProfilesApiDeleteAccessProfilesInBulkV2Request} requestParameters Request parameters.
|
|
2195
|
+
* @param {*} [axiosOptions] Override http request option.
|
|
2196
|
+
* @throws {RequiredError}
|
|
2197
|
+
* @memberof AccessProfilesApi
|
|
2198
|
+
*/
|
|
2199
|
+
AccessProfilesApi.prototype.deleteAccessProfilesInBulkV2 = function (requestParameters, axiosOptions) {
|
|
2200
|
+
var _this = this;
|
|
2201
|
+
return AccessProfilesApiFp(this.configuration).deleteAccessProfilesInBulkV2(requestParameters.accessProfileBulkDeleteRequest, requestParameters.xSailPointExperimental, axiosOptions).then(function (request) { return request(_this.axios, _this.basePath); });
|
|
2202
|
+
};
|
|
1318
2203
|
/**
|
|
1319
2204
|
* This API removes a single Access Model Metadata value from an access profile by attribute key and attribute value.
|
|
1320
2205
|
* @summary Remove metadata from access profile
|
|
@@ -1339,6 +2224,18 @@ var AccessProfilesApi = /** @class */ (function (_super) {
|
|
|
1339
2224
|
var _this = this;
|
|
1340
2225
|
return AccessProfilesApiFp(this.configuration).getAccessProfileEntitlementsV1(requestParameters.id, requestParameters.limit, requestParameters.offset, requestParameters.count, requestParameters.filters, requestParameters.sorters, axiosOptions).then(function (request) { return request(_this.axios, _this.basePath); });
|
|
1341
2226
|
};
|
|
2227
|
+
/**
|
|
2228
|
+
* Get a list of an access profile\'s entitlements. This version reads from Search Lite and returns a superset of the entitlement returned by [List Access Profile\'s Entitlements V1](https://developer.sailpoint.com/docs/api/get-access-profile-entitlements-v-1), adding the entitlement\'s `tags` and calculated `privilegeLevel`. It also supports opaque cursor pagination through the `cursor` parameter and `X-Next-Cursor` response header. A SOURCE_SUBADMIN user must have access to the source associated with the specified access profile.
|
|
2229
|
+
* @summary List access profile\'s entitlements
|
|
2230
|
+
* @param {AccessProfilesApiGetAccessProfileEntitlementsV2Request} requestParameters Request parameters.
|
|
2231
|
+
* @param {*} [axiosOptions] Override http request option.
|
|
2232
|
+
* @throws {RequiredError}
|
|
2233
|
+
* @memberof AccessProfilesApi
|
|
2234
|
+
*/
|
|
2235
|
+
AccessProfilesApi.prototype.getAccessProfileEntitlementsV2 = function (requestParameters, axiosOptions) {
|
|
2236
|
+
var _this = this;
|
|
2237
|
+
return AccessProfilesApiFp(this.configuration).getAccessProfileEntitlementsV2(requestParameters.id, requestParameters.xSailPointExperimental, requestParameters.limit, requestParameters.offset, requestParameters.count, requestParameters.filters, requestParameters.sorters, requestParameters.cursor, axiosOptions).then(function (request) { return request(_this.axios, _this.basePath); });
|
|
2238
|
+
};
|
|
1342
2239
|
/**
|
|
1343
2240
|
* This API returns an Access Profile by its ID. The `accessRequestConfig.formDefinitionId` field associates an optional custom form with access profile access requests.
|
|
1344
2241
|
* @summary Get an access profile
|
|
@@ -1351,6 +2248,18 @@ var AccessProfilesApi = /** @class */ (function (_super) {
|
|
|
1351
2248
|
var _this = this;
|
|
1352
2249
|
return AccessProfilesApiFp(this.configuration).getAccessProfileV1(requestParameters.id, axiosOptions).then(function (request) { return request(_this.axios, _this.basePath); });
|
|
1353
2250
|
};
|
|
2251
|
+
/**
|
|
2252
|
+
* Get an access profile by its ID. This version reads from Search Lite and returns the same access profile shape as [Get Access Profile V1](https://developer.sailpoint.com/docs/api/get-access-profile-v-1), with the calculated `privilegeLevel` field added.
|
|
2253
|
+
* @summary Get an access profile
|
|
2254
|
+
* @param {AccessProfilesApiGetAccessProfileV2Request} requestParameters Request parameters.
|
|
2255
|
+
* @param {*} [axiosOptions] Override http request option.
|
|
2256
|
+
* @throws {RequiredError}
|
|
2257
|
+
* @memberof AccessProfilesApi
|
|
2258
|
+
*/
|
|
2259
|
+
AccessProfilesApi.prototype.getAccessProfileV2 = function (requestParameters, axiosOptions) {
|
|
2260
|
+
var _this = this;
|
|
2261
|
+
return AccessProfilesApiFp(this.configuration).getAccessProfileV2(requestParameters.id, requestParameters.xSailPointExperimental, axiosOptions).then(function (request) { return request(_this.axios, _this.basePath); });
|
|
2262
|
+
};
|
|
1354
2263
|
/**
|
|
1355
2264
|
* Get a list of access profiles. >**Note:** When you filter for access profiles that have the \'+\' symbol in their names, the response is blank.
|
|
1356
2265
|
* @summary List access profiles
|
|
@@ -1364,6 +2273,19 @@ var AccessProfilesApi = /** @class */ (function (_super) {
|
|
|
1364
2273
|
if (requestParameters === void 0) { requestParameters = {}; }
|
|
1365
2274
|
return AccessProfilesApiFp(this.configuration).listAccessProfilesV1(requestParameters.forSubadmin, requestParameters.limit, requestParameters.offset, requestParameters.count, requestParameters.filters, requestParameters.sorters, requestParameters.forSegmentIds, requestParameters.includeUnsegmented, axiosOptions).then(function (request) { return request(_this.axios, _this.basePath); });
|
|
1366
2275
|
};
|
|
2276
|
+
/**
|
|
2277
|
+
* Get a list of access profiles. This version reads from Search Lite and returns the same access profile shape as [List Access Profiles V1](https://developer.sailpoint.com/docs/api/list-access-profiles-v-1), with two additions: the calculated `privilegeLevel` field, and opaque cursor pagination through the `cursor` parameter and `X-Next-Cursor` response header. >**Note:** When you omit `sorters`, results are sorted by `created` ascending. For deterministic ordering across pages, always specify explicit sorters. When you use cursor pagination, include `id` in `sorters`; the service appends it automatically if you omit it. >**Note:** `offset` and `cursor` are mutually exclusive. Use `offset=0` along with a cursor value taken from a prior response\'s `X-Next-Cursor` header.
|
|
2278
|
+
* @summary List access profiles
|
|
2279
|
+
* @param {AccessProfilesApiListAccessProfilesV2Request} requestParameters Request parameters.
|
|
2280
|
+
* @param {*} [axiosOptions] Override http request option.
|
|
2281
|
+
* @throws {RequiredError}
|
|
2282
|
+
* @memberof AccessProfilesApi
|
|
2283
|
+
*/
|
|
2284
|
+
AccessProfilesApi.prototype.listAccessProfilesV2 = function (requestParameters, axiosOptions) {
|
|
2285
|
+
var _this = this;
|
|
2286
|
+
if (requestParameters === void 0) { requestParameters = {}; }
|
|
2287
|
+
return AccessProfilesApiFp(this.configuration).listAccessProfilesV2(requestParameters.xSailPointExperimental, requestParameters.forSubadmin, requestParameters.limit, requestParameters.offset, requestParameters.count, requestParameters.filters, requestParameters.sorters, requestParameters.forSegmentIds, requestParameters.includeUnsegmented, requestParameters.cursor, axiosOptions).then(function (request) { return request(_this.axios, _this.basePath); });
|
|
2288
|
+
};
|
|
1367
2289
|
/**
|
|
1368
2290
|
* This API updates an existing Access Profile. The following fields are patchable: **name** **description** **enabled** **owner** **additionalOwners** **requestable** **accessRequestConfig** **revokeRequestConfig** **segments** **entitlements** **provisioningCriteria** **source** (must be updated with entitlements belonging to new source in the same API call) If you need to change the `source` of the access profile, you can do so only if you update the `entitlements` in the same API call. The new entitlements can only come from the target source that you want to change to. Look for the example \"Replace Source\" in the examples dropdown. Set `accessRequestConfig.formDefinitionId` to associate an optional custom form with access profile access requests. A user with SOURCE_SUBADMIN may only use this API to patch Access Profiles which are associated with Sources they are able to administer. > The maximum supported length for the description field is 2000 characters. Longer descriptions will be preserved for existing access profiles, however, any new access profiles as well as any updates to existing descriptions will be limited to 2000 characters. > You can only add or replace **entitlements** that exist on the source that the access profile is attached to. You can use the **list entitlements** endpoint with the **filters** query parameter to get a list of available entitlements on the access profile\'s source.
|
|
1369
2291
|
* @summary Patch a specified access profile
|
|
@@ -1376,6 +2298,18 @@ var AccessProfilesApi = /** @class */ (function (_super) {
|
|
|
1376
2298
|
var _this = this;
|
|
1377
2299
|
return AccessProfilesApiFp(this.configuration).patchAccessProfileV1(requestParameters.id, requestParameters.jsonPatchOperation, axiosOptions).then(function (request) { return request(_this.axios, _this.basePath); });
|
|
1378
2300
|
};
|
|
2301
|
+
/**
|
|
2302
|
+
* This API updates an existing Access Profile. This version patches the same fields as [Patch a Specified Access Profile V1](https://developer.sailpoint.com/docs/api/patch-access-profile-v-1). It returns the v2 access profile shape, which adds the read-only `privilegeLevel` field. The following fields are patchable: **name** **description** **enabled** **owner** **additionalOwners** **requestable** **accessRequestConfig** **revocationRequestConfig** **segments** **entitlements** **provisioningCriteria** **source** (must be updated with entitlements belonging to new source in the same API call) If you need to change the `source` of the access profile, you can do so only if you update the `entitlements` in the same API call. The new entitlements can only come from the target source that you want to change to. Look for the example \"Replace Source\" in the examples dropdown. A user with SOURCE_SUBADMIN may only use this API to patch Access Profiles which are associated with Sources they are able to administer. > The maximum supported length for the description field is 2000 characters. Longer descriptions will be preserved for existing access profiles, however, any new access profiles as well as any updates to existing descriptions will be limited to 2000 characters. > You can only add or replace **entitlements** that exist on the source that the access profile is attached to. You can use the **list entitlements** endpoint with the **filters** query parameter to get a list of available entitlements on the access profile\'s source. >**Note:** `privilegeLevel` is read-only and cannot be patched. Changing the access profile\'s entitlements recalculates it asynchronously, so the patch response may still show the previous value.
|
|
2303
|
+
* @summary Patch a specified access profile
|
|
2304
|
+
* @param {AccessProfilesApiPatchAccessProfileV2Request} requestParameters Request parameters.
|
|
2305
|
+
* @param {*} [axiosOptions] Override http request option.
|
|
2306
|
+
* @throws {RequiredError}
|
|
2307
|
+
* @memberof AccessProfilesApi
|
|
2308
|
+
*/
|
|
2309
|
+
AccessProfilesApi.prototype.patchAccessProfileV2 = function (requestParameters, axiosOptions) {
|
|
2310
|
+
var _this = this;
|
|
2311
|
+
return AccessProfilesApiFp(this.configuration).patchAccessProfileV2(requestParameters.id, requestParameters.jsonPatchOperation, requestParameters.xSailPointExperimental, axiosOptions).then(function (request) { return request(_this.axios, _this.basePath); });
|
|
2312
|
+
};
|
|
1379
2313
|
/**
|
|
1380
2314
|
* Get a list of access profiles filtered by Access Model Metadata and by filter expression. Filtering is supported by filter expression, by metadata attribute key and values, or by both together.
|
|
1381
2315
|
* @summary Filter access profiles by metadata
|
|
@@ -1388,6 +2322,18 @@ var AccessProfilesApi = /** @class */ (function (_super) {
|
|
|
1388
2322
|
var _this = this;
|
|
1389
2323
|
return AccessProfilesApiFp(this.configuration).searchAccessProfilesByFilterV1(requestParameters.accessProfileListFilterDTO, requestParameters.forSubadmin, requestParameters.limit, requestParameters.offset, requestParameters.count, requestParameters.sorters, requestParameters.forSegmentIds, requestParameters.includeUnsegmented, axiosOptions).then(function (request) { return request(_this.axios, _this.basePath); });
|
|
1390
2324
|
};
|
|
2325
|
+
/**
|
|
2326
|
+
* Get a list of access profiles, supplying the filter criteria and access model metadata key/values in the request body rather than as query parameters. Use this endpoint when you need to filter by access model metadata, or when your filter expression is too long to pass as a query parameter. Pagination, sorting, subadmin scoping, and segment scoping behave the same as [List Access Profiles V2](https://developer.sailpoint.com/docs/api/list-access-profiles-v-2), including opaque cursor pagination through the `cursor` parameter and `X-Next-Cursor` response header.
|
|
2327
|
+
* @summary List access profiles by filter
|
|
2328
|
+
* @param {AccessProfilesApiSearchAccessProfilesByFilterV2Request} requestParameters Request parameters.
|
|
2329
|
+
* @param {*} [axiosOptions] Override http request option.
|
|
2330
|
+
* @throws {RequiredError}
|
|
2331
|
+
* @memberof AccessProfilesApi
|
|
2332
|
+
*/
|
|
2333
|
+
AccessProfilesApi.prototype.searchAccessProfilesByFilterV2 = function (requestParameters, axiosOptions) {
|
|
2334
|
+
var _this = this;
|
|
2335
|
+
return AccessProfilesApiFp(this.configuration).searchAccessProfilesByFilterV2(requestParameters.accessProfileListFilterV2, requestParameters.xSailPointExperimental, requestParameters.forSubadmin, requestParameters.limit, requestParameters.offset, requestParameters.count, requestParameters.sorters, requestParameters.forSegmentIds, requestParameters.includeUnsegmented, requestParameters.cursor, axiosOptions).then(function (request) { return request(_this.axios, _this.basePath); });
|
|
2336
|
+
};
|
|
1391
2337
|
/**
|
|
1392
2338
|
* This API initiates a bulk update of field requestable for one or more Access Profiles. > If any of the indicated Access Profiles is exists in Organization,then those Access Profiles will be added in **updated** list of the response.Requestable field of these Access Profiles marked as **true** or **false**. > If any of the indicated Access Profiles is not does not exists in Organization,then those Access Profiles will be added in **notFound** list of the response. Access Profiles marked as **notFound** will not be updated. A SOURCE_SUBADMIN may only use this API to update Access Profiles which are associated with Sources they are able to administer.
|
|
1393
2339
|
* @summary Update access profile(s) requestable field.
|
|
@@ -1400,6 +2346,18 @@ var AccessProfilesApi = /** @class */ (function (_super) {
|
|
|
1400
2346
|
var _this = this;
|
|
1401
2347
|
return AccessProfilesApiFp(this.configuration).updateAccessProfilesInBulkV1(requestParameters.accessProfileBulkUpdateRequestInner, axiosOptions).then(function (request) { return request(_this.axios, _this.basePath); });
|
|
1402
2348
|
};
|
|
2349
|
+
/**
|
|
2350
|
+
* This API initiates a bulk update of field requestable for one or more Access Profiles. This version behaves identically to [Update Access Profile(s) Requestable Field V1](https://developer.sailpoint.com/docs/api/update-access-profiles-in-bulk-v-1). > If any of the indicated Access Profiles is exists in Organization,then those Access Profiles will be added in **updated** list of the response.Requestable field of these Access Profiles marked as **true** or **false**. > If any of the indicated Access Profiles is not does not exists in Organization,then those Access Profiles will be added in **notFound** list of the response. Access Profiles marked as **notFound** will not be updated. A SOURCE_SUBADMIN may only use this API to update Access Profiles which are associated with Sources they are able to administer.
|
|
2351
|
+
* @summary Update access profile(s) requestable field.
|
|
2352
|
+
* @param {AccessProfilesApiUpdateAccessProfilesInBulkV2Request} requestParameters Request parameters.
|
|
2353
|
+
* @param {*} [axiosOptions] Override http request option.
|
|
2354
|
+
* @throws {RequiredError}
|
|
2355
|
+
* @memberof AccessProfilesApi
|
|
2356
|
+
*/
|
|
2357
|
+
AccessProfilesApi.prototype.updateAccessProfilesInBulkV2 = function (requestParameters, axiosOptions) {
|
|
2358
|
+
var _this = this;
|
|
2359
|
+
return AccessProfilesApiFp(this.configuration).updateAccessProfilesInBulkV2(requestParameters.accessProfileBulkUpdateRequestInner, requestParameters.xSailPointExperimental, axiosOptions).then(function (request) { return request(_this.axios, _this.basePath); });
|
|
2360
|
+
};
|
|
1403
2361
|
/**
|
|
1404
2362
|
* This API initiates a bulk update of Access Model Metadata for every access profile matching the supplied filter expression. The update is processed asynchronously. The response returns the ID of the task performing the update. A single access profile cannot be assigned more than 25 metadata values. Adding or replacing custom metadata requires a suite license.
|
|
1405
2363
|
* @summary Bulk-update metadata by filter
|