@sailpoint/api-client 2.2.51 → 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/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/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/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/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 +325 -1
package/dist/esm/roles/api.js
CHANGED
|
@@ -144,12 +144,60 @@ export var DtoType = {
|
|
|
144
144
|
AccountActivity: 'ACCOUNT_ACTIVITY',
|
|
145
145
|
Workgroup: 'WORKGROUP'
|
|
146
146
|
};
|
|
147
|
-
export var
|
|
148
|
-
|
|
147
|
+
export var EntitlementPrivilegeLevelDirectEnum = {
|
|
148
|
+
High: 'HIGH',
|
|
149
|
+
Low: 'LOW',
|
|
150
|
+
Medium: 'MEDIUM',
|
|
151
|
+
None: 'NONE'
|
|
152
|
+
};
|
|
153
|
+
export var EntitlementPrivilegeLevelSetByTypeEnum = {
|
|
154
|
+
Override: 'OVERRIDE',
|
|
155
|
+
CustomCriteria: 'CUSTOM_CRITERIA',
|
|
156
|
+
ConnectorCriteria: 'CONNECTOR_CRITERIA',
|
|
157
|
+
SingleLevelCriteria: 'SINGLE_LEVEL_CRITERIA'
|
|
158
|
+
};
|
|
159
|
+
export var EntitlementPrivilegeLevelInheritedEnum = {
|
|
160
|
+
High: 'HIGH',
|
|
161
|
+
Low: 'LOW',
|
|
162
|
+
Medium: 'MEDIUM',
|
|
163
|
+
None: 'NONE'
|
|
164
|
+
};
|
|
165
|
+
export var EntitlementPrivilegeLevelEffectiveEnum = {
|
|
166
|
+
High: 'HIGH',
|
|
167
|
+
Low: 'LOW',
|
|
168
|
+
Medium: 'MEDIUM',
|
|
169
|
+
None: 'NONE'
|
|
149
170
|
};
|
|
150
171
|
export var EntitlementRefTypeEnum = {
|
|
151
172
|
Entitlement: 'ENTITLEMENT'
|
|
152
173
|
};
|
|
174
|
+
export var EntitlementV2OwnerTypeEnum = {
|
|
175
|
+
Identity: 'IDENTITY'
|
|
176
|
+
};
|
|
177
|
+
export var EntitlementV2PrivilegeLevelDirectEnum = {
|
|
178
|
+
High: 'HIGH',
|
|
179
|
+
Low: 'LOW',
|
|
180
|
+
Medium: 'MEDIUM',
|
|
181
|
+
None: 'NONE'
|
|
182
|
+
};
|
|
183
|
+
export var EntitlementV2PrivilegeLevelSetByTypeEnum = {
|
|
184
|
+
Override: 'OVERRIDE',
|
|
185
|
+
CustomCriteria: 'CUSTOM_CRITERIA',
|
|
186
|
+
ConnectorCriteria: 'CONNECTOR_CRITERIA',
|
|
187
|
+
SingleLevelCriteria: 'SINGLE_LEVEL_CRITERIA'
|
|
188
|
+
};
|
|
189
|
+
export var EntitlementV2PrivilegeLevelInheritedEnum = {
|
|
190
|
+
High: 'HIGH',
|
|
191
|
+
Low: 'LOW',
|
|
192
|
+
Medium: 'MEDIUM',
|
|
193
|
+
None: 'NONE'
|
|
194
|
+
};
|
|
195
|
+
export var EntitlementV2PrivilegeLevelEffectiveEnum = {
|
|
196
|
+
High: 'HIGH',
|
|
197
|
+
Low: 'LOW',
|
|
198
|
+
Medium: 'MEDIUM',
|
|
199
|
+
None: 'NONE'
|
|
200
|
+
};
|
|
153
201
|
export var JsonPatchOperationOpEnum = {
|
|
154
202
|
Add: 'add',
|
|
155
203
|
Remove: 'remove',
|
|
@@ -260,6 +308,13 @@ export var RoleMetadataBulkUpdateByQueryRequestReplaceScopeEnum = {
|
|
|
260
308
|
All: 'ALL',
|
|
261
309
|
Attribute: 'ATTRIBUTE'
|
|
262
310
|
};
|
|
311
|
+
export var RolePrivilegeLevelEffectiveEnum = {
|
|
312
|
+
None: 'NONE',
|
|
313
|
+
Low: 'LOW',
|
|
314
|
+
Medium: 'MEDIUM',
|
|
315
|
+
High: 'HIGH',
|
|
316
|
+
Undetermined: 'UNDETERMINED'
|
|
317
|
+
};
|
|
263
318
|
export var TaskResultDtoTypeEnum = {
|
|
264
319
|
TaskResult: 'TASK_RESULT'
|
|
265
320
|
};
|
|
@@ -580,6 +635,82 @@ export var RolesApiAxiosParamCreator = function (configuration) {
|
|
|
580
635
|
});
|
|
581
636
|
});
|
|
582
637
|
},
|
|
638
|
+
/**
|
|
639
|
+
* Get a list of entitlements assigned directly to a specified Role. Each entitlement includes its privilege level in `privilegeLevel`, with the direct, inherited, and effective levels. Use either offset pagination (`offset` and `limit`) or cursor pagination (`cursor` and `limit`). When more results are available, the `x-next-cursor` response header contains the cursor for the next page. You can\'t use `cursor` together with an `offset` greater than 0, and `offset` plus `limit` can\'t be greater than 10,000.
|
|
640
|
+
* @summary List role\'s entitlements
|
|
641
|
+
* @param {string} id Containing role\'s ID.
|
|
642
|
+
* @param {string} [xSailPointExperimental] Use this header to enable this experimental API.
|
|
643
|
+
* @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.
|
|
644
|
+
* @param {number} [offset] Offset into the full result set. Usually specified with *limit* to paginate through the results. Must be 0 or omitted when *cursor* is specified. See [API Standard Collection Parameters](https://developer.sailpoint.com/docs/api/standard-collection-parameters) for more information.
|
|
645
|
+
* @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.
|
|
646
|
+
* @param {string} [cursor] Opaque cursor returned in the `x-next-cursor` response header of the previous page. Pass it with the same `sorters` to get the next page of results. Can\'t be used with an *offset* greater than 0.
|
|
647
|
+
* @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, sw, co* **attribute**: *eq, sw, co* **value**: *eq, sw, co* **created**: *gt, lt, ge, le* **modified**: *gt, lt, ge, le* **privilegeLevel.effective**: *eq, in*
|
|
648
|
+
* @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: **id, name, attribute, value, created, modified, privilegeLevel.effective** The default sort is **created**. **id** is always added as the final sort field so that cursor pagination is stable.
|
|
649
|
+
* @param {string} [forSegmentIds] If present and not empty, filters entitlements to those assigned to the segment(s) with the specified IDs. Can\'t be used with *segmented-for-identity*.
|
|
650
|
+
* @param {string} [segmentedForIdentity] If present, filters entitlements to those in the segments visible to the specified identity. The value must be the calling identity\'s ID or the special value **me**. Can\'t be used with *for-segment-ids*.
|
|
651
|
+
* @param {boolean} [includeUnsegmented] Whether the response list should contain unsegmented entitlements. If *for-segment-ids* is absent or empty, specifying *include-unsegmented* as false results in an error.
|
|
652
|
+
* @param {*} [axiosOptions] Override http request option.
|
|
653
|
+
* @throws {RequiredError}
|
|
654
|
+
*/
|
|
655
|
+
getRoleEntitlementsV2: function (id, xSailPointExperimental, limit, offset, count, cursor, filters, sorters, forSegmentIds, segmentedForIdentity, includeUnsegmented, axiosOptions) {
|
|
656
|
+
if (axiosOptions === void 0) { axiosOptions = {}; }
|
|
657
|
+
return __awaiter(_this, void 0, void 0, function () {
|
|
658
|
+
var localVarPath, localVarUrlObj, baseOptions, localVarRequestOptions, localVarHeaderParameter, localVarQueryParameter, headersFromBaseOptions;
|
|
659
|
+
return __generator(this, function (_a) {
|
|
660
|
+
// verify required parameter 'id' is not null or undefined
|
|
661
|
+
assertParamExists('getRoleEntitlementsV2', 'id', id);
|
|
662
|
+
if (xSailPointExperimental === undefined) {
|
|
663
|
+
xSailPointExperimental = 'true';
|
|
664
|
+
}
|
|
665
|
+
localVarPath = "/roles/v2/{id}/entitlements"
|
|
666
|
+
.replace("{".concat("id", "}"), encodeURIComponent(String(id)));
|
|
667
|
+
localVarUrlObj = new URL(localVarPath, DUMMY_BASE_URL);
|
|
668
|
+
if (configuration) {
|
|
669
|
+
baseOptions = configuration.baseOptions;
|
|
670
|
+
}
|
|
671
|
+
localVarRequestOptions = __assign(__assign({ method: 'GET' }, baseOptions), axiosOptions);
|
|
672
|
+
localVarHeaderParameter = {};
|
|
673
|
+
localVarQueryParameter = {};
|
|
674
|
+
if (limit !== undefined) {
|
|
675
|
+
localVarQueryParameter['limit'] = limit;
|
|
676
|
+
}
|
|
677
|
+
if (offset !== undefined) {
|
|
678
|
+
localVarQueryParameter['offset'] = offset;
|
|
679
|
+
}
|
|
680
|
+
if (count !== undefined) {
|
|
681
|
+
localVarQueryParameter['count'] = count;
|
|
682
|
+
}
|
|
683
|
+
if (cursor !== undefined) {
|
|
684
|
+
localVarQueryParameter['cursor'] = cursor;
|
|
685
|
+
}
|
|
686
|
+
if (filters !== undefined) {
|
|
687
|
+
localVarQueryParameter['filters'] = filters;
|
|
688
|
+
}
|
|
689
|
+
if (sorters !== undefined) {
|
|
690
|
+
localVarQueryParameter['sorters'] = sorters;
|
|
691
|
+
}
|
|
692
|
+
if (forSegmentIds !== undefined) {
|
|
693
|
+
localVarQueryParameter['for-segment-ids'] = forSegmentIds;
|
|
694
|
+
}
|
|
695
|
+
if (segmentedForIdentity !== undefined) {
|
|
696
|
+
localVarQueryParameter['segmented-for-identity'] = segmentedForIdentity;
|
|
697
|
+
}
|
|
698
|
+
if (includeUnsegmented !== undefined) {
|
|
699
|
+
localVarQueryParameter['include-unsegmented'] = includeUnsegmented;
|
|
700
|
+
}
|
|
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
|
+
},
|
|
583
714
|
/**
|
|
584
715
|
* This API returns a Role by its ID. A token with API, ORG_ADMIN, ROLE_ADMIN, or ROLE_SUBADMIN authority is required to call this API. In addition, a token with ROLE_SUBADMIN authority may only call this API if all Access Profiles included in the Role are associated to Sources with management workgroups of which the ROLE_SUBADMIN is a member.
|
|
585
716
|
* @summary Get a role
|
|
@@ -613,6 +744,46 @@ export var RolesApiAxiosParamCreator = function (configuration) {
|
|
|
613
744
|
});
|
|
614
745
|
});
|
|
615
746
|
},
|
|
747
|
+
/**
|
|
748
|
+
* This API returns a Role by its ID. The response includes the Role\'s effective privilege level in `privilegeLevel.effective`, which is the highest effective privilege level among the entitlements assigned directly to the Role and the entitlements included in the Role\'s access profiles. A token with API, ORG_ADMIN, ROLE_ADMIN, or ROLE_SUBADMIN authority is required to call this API. In addition, a token with ROLE_SUBADMIN authority may only call this API if all Access Profiles included in the Role are associated to Sources with management workgroups of which the ROLE_SUBADMIN is a member.
|
|
749
|
+
* @summary Get a role
|
|
750
|
+
* @param {string} id ID of the Role
|
|
751
|
+
* @param {string} [xSailPointExperimental] Use this header to enable this experimental API.
|
|
752
|
+
* @param {*} [axiosOptions] Override http request option.
|
|
753
|
+
* @throws {RequiredError}
|
|
754
|
+
*/
|
|
755
|
+
getRoleV2: function (id, xSailPointExperimental, axiosOptions) {
|
|
756
|
+
if (axiosOptions === void 0) { axiosOptions = {}; }
|
|
757
|
+
return __awaiter(_this, void 0, void 0, function () {
|
|
758
|
+
var localVarPath, localVarUrlObj, baseOptions, localVarRequestOptions, localVarHeaderParameter, localVarQueryParameter, headersFromBaseOptions;
|
|
759
|
+
return __generator(this, function (_a) {
|
|
760
|
+
// verify required parameter 'id' is not null or undefined
|
|
761
|
+
assertParamExists('getRoleV2', 'id', id);
|
|
762
|
+
if (xSailPointExperimental === undefined) {
|
|
763
|
+
xSailPointExperimental = 'true';
|
|
764
|
+
}
|
|
765
|
+
localVarPath = "/roles/v2/{id}"
|
|
766
|
+
.replace("{".concat("id", "}"), encodeURIComponent(String(id)));
|
|
767
|
+
localVarUrlObj = new URL(localVarPath, DUMMY_BASE_URL);
|
|
768
|
+
if (configuration) {
|
|
769
|
+
baseOptions = configuration.baseOptions;
|
|
770
|
+
}
|
|
771
|
+
localVarRequestOptions = __assign(__assign({ method: 'GET' }, baseOptions), axiosOptions);
|
|
772
|
+
localVarHeaderParameter = {};
|
|
773
|
+
localVarQueryParameter = {};
|
|
774
|
+
if (xSailPointExperimental != null) {
|
|
775
|
+
localVarHeaderParameter['X-SailPoint-Experimental'] = String(xSailPointExperimental);
|
|
776
|
+
}
|
|
777
|
+
setSearchParams(localVarUrlObj, localVarQueryParameter);
|
|
778
|
+
headersFromBaseOptions = baseOptions && baseOptions.headers ? baseOptions.headers : {};
|
|
779
|
+
localVarRequestOptions.headers = __assign(__assign(__assign({}, localVarHeaderParameter), headersFromBaseOptions), axiosOptions.headers);
|
|
780
|
+
return [2 /*return*/, {
|
|
781
|
+
url: toPathString(localVarUrlObj),
|
|
782
|
+
axiosOptions: localVarRequestOptions,
|
|
783
|
+
}];
|
|
784
|
+
});
|
|
785
|
+
});
|
|
786
|
+
},
|
|
616
787
|
/**
|
|
617
788
|
* This API returns a list of Roles. A token with API, ORG_ADMIN, ROLE_ADMIN, or ROLE_SUBADMIN authority is required to call this API.
|
|
618
789
|
* @summary List roles
|
|
@@ -674,6 +845,78 @@ export var RolesApiAxiosParamCreator = function (configuration) {
|
|
|
674
845
|
});
|
|
675
846
|
});
|
|
676
847
|
},
|
|
848
|
+
/**
|
|
849
|
+
* This API returns a list of Roles. Each Role includes its effective privilege level in `privilegeLevel.effective`, which is the highest effective privilege level among the entitlements assigned directly to the Role and the entitlements included in the Role\'s access profiles. Use either offset pagination (`offset` and `limit`) or cursor pagination (`cursor` and `limit`). When more results are available, the `x-next-cursor` response header contains the cursor for the next page. Send that value in the `cursor` query parameter, with the same `sorters`, to get the next page. You can\'t use `cursor` together with an `offset` greater than 0, and `offset` plus `limit` can\'t be greater than 10,000. Use cursor pagination to page beyond 10,000 results. A token with API, ORG_ADMIN, ROLE_ADMIN, or ROLE_SUBADMIN authority is required to call this API.
|
|
850
|
+
* @summary List roles
|
|
851
|
+
* @param {string} [xSailPointExperimental] Use this header to enable this experimental API.
|
|
852
|
+
* @param {string} [forSubadmin] If provided, filters the returned list according to what is visible to the indicated ROLE_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. A 400 Bad Request error is returned if the **for-subadmin** parameter is specified for an Identity that is not a subadmin.
|
|
853
|
+
* @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.
|
|
854
|
+
* @param {number} [offset] Offset into the full result set. Usually specified with *limit* to paginate through the results. Must be 0 or omitted when *cursor* is specified. See [API Standard Collection Parameters](https://developer.sailpoint.com/docs/api/standard-collection-parameters) for more information.
|
|
855
|
+
* @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.
|
|
856
|
+
* @param {string} [cursor] Opaque cursor returned in the `x-next-cursor` response header of the previous page. Pass it with the same `sorters` to get the next page of results. Can\'t be used with an *offset* greater than 0.
|
|
857
|
+
* @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, sw, co* **created**: *gt, lt, ge, le* **modified**: *gt, lt, ge, le* **type**: *eq, in* **owner.id**: *eq, in* **additionalOwners.id**: *eq, in* **requestable**: *eq* **dimensional**: *eq* **source.id**: *eq, in* **entitlement.id**: *eq, in* **entitlement.name**: *eq, sw, co* **accessProfile.id**: *eq, in* **accessProfile.name**: *eq, sw, co* **privilegeLevel.effective**: *eq, in* Supported composite operators are *and, or*
|
|
858
|
+
* @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: **id, name, created, modified, privilegeLevel.effective** The default sort is **name**. **id** is always added as the final sort field so that cursor pagination is stable.
|
|
859
|
+
* @param {string} [forSegmentIds] If present and not empty, additionally filters Roles to those which are assigned to the Segment(s) with the specified IDs. If segmentation is currently unavailable, specifying this parameter results in an error.
|
|
860
|
+
* @param {boolean} [includeUnsegmented] Whether or not the response list should contain unsegmented Roles. If *for-segment-ids* is absent or empty, specifying *include-unsegmented* as false results in an error.
|
|
861
|
+
* @param {*} [axiosOptions] Override http request option.
|
|
862
|
+
* @throws {RequiredError}
|
|
863
|
+
*/
|
|
864
|
+
listRolesV2: function (xSailPointExperimental, forSubadmin, limit, offset, count, cursor, filters, sorters, forSegmentIds, includeUnsegmented, axiosOptions) {
|
|
865
|
+
if (axiosOptions === void 0) { axiosOptions = {}; }
|
|
866
|
+
return __awaiter(_this, void 0, void 0, function () {
|
|
867
|
+
var localVarPath, localVarUrlObj, baseOptions, localVarRequestOptions, localVarHeaderParameter, localVarQueryParameter, headersFromBaseOptions;
|
|
868
|
+
return __generator(this, function (_a) {
|
|
869
|
+
if (xSailPointExperimental === undefined) {
|
|
870
|
+
xSailPointExperimental = 'true';
|
|
871
|
+
}
|
|
872
|
+
localVarPath = "/roles/v2";
|
|
873
|
+
localVarUrlObj = new URL(localVarPath, DUMMY_BASE_URL);
|
|
874
|
+
if (configuration) {
|
|
875
|
+
baseOptions = configuration.baseOptions;
|
|
876
|
+
}
|
|
877
|
+
localVarRequestOptions = __assign(__assign({ method: 'GET' }, baseOptions), axiosOptions);
|
|
878
|
+
localVarHeaderParameter = {};
|
|
879
|
+
localVarQueryParameter = {};
|
|
880
|
+
if (forSubadmin !== undefined) {
|
|
881
|
+
localVarQueryParameter['for-subadmin'] = forSubadmin;
|
|
882
|
+
}
|
|
883
|
+
if (limit !== undefined) {
|
|
884
|
+
localVarQueryParameter['limit'] = limit;
|
|
885
|
+
}
|
|
886
|
+
if (offset !== undefined) {
|
|
887
|
+
localVarQueryParameter['offset'] = offset;
|
|
888
|
+
}
|
|
889
|
+
if (count !== undefined) {
|
|
890
|
+
localVarQueryParameter['count'] = count;
|
|
891
|
+
}
|
|
892
|
+
if (cursor !== undefined) {
|
|
893
|
+
localVarQueryParameter['cursor'] = cursor;
|
|
894
|
+
}
|
|
895
|
+
if (filters !== undefined) {
|
|
896
|
+
localVarQueryParameter['filters'] = filters;
|
|
897
|
+
}
|
|
898
|
+
if (sorters !== undefined) {
|
|
899
|
+
localVarQueryParameter['sorters'] = sorters;
|
|
900
|
+
}
|
|
901
|
+
if (forSegmentIds !== undefined) {
|
|
902
|
+
localVarQueryParameter['for-segment-ids'] = forSegmentIds;
|
|
903
|
+
}
|
|
904
|
+
if (includeUnsegmented !== undefined) {
|
|
905
|
+
localVarQueryParameter['include-unsegmented'] = includeUnsegmented;
|
|
906
|
+
}
|
|
907
|
+
if (xSailPointExperimental != null) {
|
|
908
|
+
localVarHeaderParameter['X-SailPoint-Experimental'] = String(xSailPointExperimental);
|
|
909
|
+
}
|
|
910
|
+
setSearchParams(localVarUrlObj, localVarQueryParameter);
|
|
911
|
+
headersFromBaseOptions = baseOptions && baseOptions.headers ? baseOptions.headers : {};
|
|
912
|
+
localVarRequestOptions.headers = __assign(__assign(__assign({}, localVarHeaderParameter), headersFromBaseOptions), axiosOptions.headers);
|
|
913
|
+
return [2 /*return*/, {
|
|
914
|
+
url: toPathString(localVarUrlObj),
|
|
915
|
+
axiosOptions: localVarRequestOptions,
|
|
916
|
+
}];
|
|
917
|
+
});
|
|
918
|
+
});
|
|
919
|
+
},
|
|
677
920
|
/**
|
|
678
921
|
* This API updates an existing role using [JSON Patch](https://tools.ietf.org/html/rfc6902) syntax. The following fields are patchable: * name * description * enabled * owner * additionalOwners * accessProfiles * entitlements * membership * requestable * accessRequestConfig * revokeRequestConfig * segments * accessModelMetadata A token with API, ORG_ADMIN, ROLE_ADMIN, or ROLE_SUBADMIN authority is required to call this API. In addition, a token with ROLE_SUBADMIN authority may only call this API if all access profiles included in the role are associated to Sources with management workgroups of which the ROLE_SUBADMIN is a member. The maximum supported length for the description field is 2000 characters. Longer descriptions will be preserved for existing roles, however, any new roles as well as any updates to existing descriptions will be limited to 2000 characters. When you use this API to modify a role\'s membership identities, you can only modify up to a limit of 500 membership identities at a time.
|
|
679
922
|
* @summary Patch a specified role
|
|
@@ -772,6 +1015,79 @@ export var RolesApiAxiosParamCreator = function (configuration) {
|
|
|
772
1015
|
});
|
|
773
1016
|
});
|
|
774
1017
|
},
|
|
1018
|
+
/**
|
|
1019
|
+
* This API returns a list of Roles 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. Each Role includes its effective privilege level in `privilegeLevel.effective`. The `filters` expression in the request body supports the same fields and operators as the `filters` query parameter of [List roles](#operation/listRolesV2), including **privilegeLevel.effective**: *eq, in*. Use either offset pagination (`offset` and `limit`) or cursor pagination (`cursor` and `limit`). When more results are available, the `x-next-cursor` response header contains the cursor for the next page. Send that value in the `cursor` query parameter, with the same request body and `sorters`, to get the next page. You can\'t use `cursor` together with an `offset` greater than 0, and `offset` plus `limit` can\'t be greater than 10,000.
|
|
1020
|
+
* @summary Filter roles by metadata
|
|
1021
|
+
* @param {Rolelistfilterdtov2} rolelistfilterdtov2
|
|
1022
|
+
* @param {string} [xSailPointExperimental] Use this header to enable this experimental API.
|
|
1023
|
+
* @param {string} [forSubadmin] If provided, filters the returned list according to what is visible to the indicated ROLE_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. A 400 Bad Request error is returned if the **for-subadmin** parameter is specified for an Identity that is not a subadmin.
|
|
1024
|
+
* @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.
|
|
1025
|
+
* @param {number} [offset] Offset into the full result set. Usually specified with *limit* to paginate through the results. Must be 0 or omitted when *cursor* is specified. See [API Standard Collection Parameters](https://developer.sailpoint.com/docs/api/standard-collection-parameters) for more information.
|
|
1026
|
+
* @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.
|
|
1027
|
+
* @param {string} [cursor] Opaque cursor returned in the `x-next-cursor` response header of the previous page. Pass it with the same request body and `sorters` to get the next page of results. Can\'t be used with an *offset* greater than 0.
|
|
1028
|
+
* @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: **id, name, created, modified, privilegeLevel.effective** The default sort is **name**. **id** is always added as the final sort field so that cursor pagination is stable.
|
|
1029
|
+
* @param {string} [forSegmentIds] If present and not empty, additionally filters Roles to those which are assigned to the Segment(s) with the specified IDs. If segmentation is currently unavailable, specifying this parameter results in an error.
|
|
1030
|
+
* @param {boolean} [includeUnsegmented] Whether or not the response list should contain unsegmented Roles. If *for-segment-ids* is absent or empty, specifying *include-unsegmented* as false results in an error.
|
|
1031
|
+
* @param {*} [axiosOptions] Override http request option.
|
|
1032
|
+
* @throws {RequiredError}
|
|
1033
|
+
*/
|
|
1034
|
+
searchRolesByFilterV2: function (rolelistfilterdtov2, xSailPointExperimental, forSubadmin, limit, offset, count, cursor, sorters, forSegmentIds, includeUnsegmented, axiosOptions) {
|
|
1035
|
+
if (axiosOptions === void 0) { axiosOptions = {}; }
|
|
1036
|
+
return __awaiter(_this, void 0, void 0, function () {
|
|
1037
|
+
var localVarPath, localVarUrlObj, baseOptions, localVarRequestOptions, localVarHeaderParameter, localVarQueryParameter, headersFromBaseOptions;
|
|
1038
|
+
return __generator(this, function (_a) {
|
|
1039
|
+
// verify required parameter 'rolelistfilterdtov2' is not null or undefined
|
|
1040
|
+
assertParamExists('searchRolesByFilterV2', 'rolelistfilterdtov2', rolelistfilterdtov2);
|
|
1041
|
+
if (xSailPointExperimental === undefined) {
|
|
1042
|
+
xSailPointExperimental = 'true';
|
|
1043
|
+
}
|
|
1044
|
+
localVarPath = "/roles/v2/filter";
|
|
1045
|
+
localVarUrlObj = new URL(localVarPath, DUMMY_BASE_URL);
|
|
1046
|
+
if (configuration) {
|
|
1047
|
+
baseOptions = configuration.baseOptions;
|
|
1048
|
+
}
|
|
1049
|
+
localVarRequestOptions = __assign(__assign({ method: 'POST' }, baseOptions), axiosOptions);
|
|
1050
|
+
localVarHeaderParameter = {};
|
|
1051
|
+
localVarQueryParameter = {};
|
|
1052
|
+
if (forSubadmin !== undefined) {
|
|
1053
|
+
localVarQueryParameter['for-subadmin'] = forSubadmin;
|
|
1054
|
+
}
|
|
1055
|
+
if (limit !== undefined) {
|
|
1056
|
+
localVarQueryParameter['limit'] = limit;
|
|
1057
|
+
}
|
|
1058
|
+
if (offset !== undefined) {
|
|
1059
|
+
localVarQueryParameter['offset'] = offset;
|
|
1060
|
+
}
|
|
1061
|
+
if (count !== undefined) {
|
|
1062
|
+
localVarQueryParameter['count'] = count;
|
|
1063
|
+
}
|
|
1064
|
+
if (cursor !== undefined) {
|
|
1065
|
+
localVarQueryParameter['cursor'] = cursor;
|
|
1066
|
+
}
|
|
1067
|
+
if (sorters !== undefined) {
|
|
1068
|
+
localVarQueryParameter['sorters'] = sorters;
|
|
1069
|
+
}
|
|
1070
|
+
if (forSegmentIds !== undefined) {
|
|
1071
|
+
localVarQueryParameter['for-segment-ids'] = forSegmentIds;
|
|
1072
|
+
}
|
|
1073
|
+
if (includeUnsegmented !== undefined) {
|
|
1074
|
+
localVarQueryParameter['include-unsegmented'] = includeUnsegmented;
|
|
1075
|
+
}
|
|
1076
|
+
localVarHeaderParameter['Content-Type'] = 'application/json';
|
|
1077
|
+
if (xSailPointExperimental != null) {
|
|
1078
|
+
localVarHeaderParameter['X-SailPoint-Experimental'] = String(xSailPointExperimental);
|
|
1079
|
+
}
|
|
1080
|
+
setSearchParams(localVarUrlObj, localVarQueryParameter);
|
|
1081
|
+
headersFromBaseOptions = baseOptions && baseOptions.headers ? baseOptions.headers : {};
|
|
1082
|
+
localVarRequestOptions.headers = __assign(__assign(__assign({}, localVarHeaderParameter), headersFromBaseOptions), axiosOptions.headers);
|
|
1083
|
+
localVarRequestOptions.data = serializeDataIfNeeded(rolelistfilterdtov2, localVarRequestOptions, configuration);
|
|
1084
|
+
return [2 /*return*/, {
|
|
1085
|
+
url: toPathString(localVarUrlObj),
|
|
1086
|
+
axiosOptions: localVarRequestOptions,
|
|
1087
|
+
}];
|
|
1088
|
+
});
|
|
1089
|
+
});
|
|
1090
|
+
},
|
|
775
1091
|
/**
|
|
776
1092
|
* This API initialize a request to add a single Access Model Metadata to a role by attribute key and attribute value. A token with ORG_ADMIN, ROLE_ADMIN ROLE_SUBADMIN authority is required to call this API. The maximum number of attributes in one role is 25. Custom metadata update, including ADD and REPLACE need suit licensed.
|
|
777
1093
|
* @summary Add a metadata to role.
|
|
@@ -1119,6 +1435,39 @@ export var RolesApiFp = function (configuration) {
|
|
|
1119
1435
|
});
|
|
1120
1436
|
});
|
|
1121
1437
|
},
|
|
1438
|
+
/**
|
|
1439
|
+
* Get a list of entitlements assigned directly to a specified Role. Each entitlement includes its privilege level in `privilegeLevel`, with the direct, inherited, and effective levels. Use either offset pagination (`offset` and `limit`) or cursor pagination (`cursor` and `limit`). When more results are available, the `x-next-cursor` response header contains the cursor for the next page. You can\'t use `cursor` together with an `offset` greater than 0, and `offset` plus `limit` can\'t be greater than 10,000.
|
|
1440
|
+
* @summary List role\'s entitlements
|
|
1441
|
+
* @param {string} id Containing role\'s ID.
|
|
1442
|
+
* @param {string} [xSailPointExperimental] Use this header to enable this experimental API.
|
|
1443
|
+
* @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.
|
|
1444
|
+
* @param {number} [offset] Offset into the full result set. Usually specified with *limit* to paginate through the results. Must be 0 or omitted when *cursor* is specified. See [API Standard Collection Parameters](https://developer.sailpoint.com/docs/api/standard-collection-parameters) for more information.
|
|
1445
|
+
* @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.
|
|
1446
|
+
* @param {string} [cursor] Opaque cursor returned in the `x-next-cursor` response header of the previous page. Pass it with the same `sorters` to get the next page of results. Can\'t be used with an *offset* greater than 0.
|
|
1447
|
+
* @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, sw, co* **attribute**: *eq, sw, co* **value**: *eq, sw, co* **created**: *gt, lt, ge, le* **modified**: *gt, lt, ge, le* **privilegeLevel.effective**: *eq, in*
|
|
1448
|
+
* @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: **id, name, attribute, value, created, modified, privilegeLevel.effective** The default sort is **created**. **id** is always added as the final sort field so that cursor pagination is stable.
|
|
1449
|
+
* @param {string} [forSegmentIds] If present and not empty, filters entitlements to those assigned to the segment(s) with the specified IDs. Can\'t be used with *segmented-for-identity*.
|
|
1450
|
+
* @param {string} [segmentedForIdentity] If present, filters entitlements to those in the segments visible to the specified identity. The value must be the calling identity\'s ID or the special value **me**. Can\'t be used with *for-segment-ids*.
|
|
1451
|
+
* @param {boolean} [includeUnsegmented] Whether the response list should contain unsegmented entitlements. If *for-segment-ids* is absent or empty, specifying *include-unsegmented* as false results in an error.
|
|
1452
|
+
* @param {*} [axiosOptions] Override http request option.
|
|
1453
|
+
* @throws {RequiredError}
|
|
1454
|
+
*/
|
|
1455
|
+
getRoleEntitlementsV2: function (id, xSailPointExperimental, limit, offset, count, cursor, filters, sorters, forSegmentIds, segmentedForIdentity, includeUnsegmented, axiosOptions) {
|
|
1456
|
+
var _a, _b, _c;
|
|
1457
|
+
return __awaiter(this, void 0, void 0, function () {
|
|
1458
|
+
var localVarAxiosArgs, localVarOperationServerIndex, localVarOperationServerBasePath;
|
|
1459
|
+
return __generator(this, function (_d) {
|
|
1460
|
+
switch (_d.label) {
|
|
1461
|
+
case 0: return [4 /*yield*/, localVarAxiosParamCreator.getRoleEntitlementsV2(id, xSailPointExperimental, limit, offset, count, cursor, filters, sorters, forSegmentIds, segmentedForIdentity, includeUnsegmented, axiosOptions)];
|
|
1462
|
+
case 1:
|
|
1463
|
+
localVarAxiosArgs = _d.sent();
|
|
1464
|
+
localVarOperationServerIndex = (_a = configuration === null || configuration === void 0 ? void 0 : configuration.serverIndex) !== null && _a !== void 0 ? _a : 0;
|
|
1465
|
+
localVarOperationServerBasePath = (_c = (_b = operationServerMap['RolesApi.getRoleEntitlementsV2']) === null || _b === void 0 ? void 0 : _b[localVarOperationServerIndex]) === null || _c === void 0 ? void 0 : _c.url;
|
|
1466
|
+
return [2 /*return*/, function (axios, basePath) { return createRequestFunction(localVarAxiosArgs, globalAxios, BASE_PATH, configuration)(axios, localVarOperationServerBasePath || basePath); }];
|
|
1467
|
+
}
|
|
1468
|
+
});
|
|
1469
|
+
});
|
|
1470
|
+
},
|
|
1122
1471
|
/**
|
|
1123
1472
|
* This API returns a Role by its ID. A token with API, ORG_ADMIN, ROLE_ADMIN, or ROLE_SUBADMIN authority is required to call this API. In addition, a token with ROLE_SUBADMIN authority may only call this API if all Access Profiles included in the Role are associated to Sources with management workgroups of which the ROLE_SUBADMIN is a member.
|
|
1124
1473
|
* @summary Get a role
|
|
@@ -1142,6 +1491,30 @@ export var RolesApiFp = function (configuration) {
|
|
|
1142
1491
|
});
|
|
1143
1492
|
});
|
|
1144
1493
|
},
|
|
1494
|
+
/**
|
|
1495
|
+
* This API returns a Role by its ID. The response includes the Role\'s effective privilege level in `privilegeLevel.effective`, which is the highest effective privilege level among the entitlements assigned directly to the Role and the entitlements included in the Role\'s access profiles. A token with API, ORG_ADMIN, ROLE_ADMIN, or ROLE_SUBADMIN authority is required to call this API. In addition, a token with ROLE_SUBADMIN authority may only call this API if all Access Profiles included in the Role are associated to Sources with management workgroups of which the ROLE_SUBADMIN is a member.
|
|
1496
|
+
* @summary Get a role
|
|
1497
|
+
* @param {string} id ID of the Role
|
|
1498
|
+
* @param {string} [xSailPointExperimental] Use this header to enable this experimental API.
|
|
1499
|
+
* @param {*} [axiosOptions] Override http request option.
|
|
1500
|
+
* @throws {RequiredError}
|
|
1501
|
+
*/
|
|
1502
|
+
getRoleV2: function (id, xSailPointExperimental, axiosOptions) {
|
|
1503
|
+
var _a, _b, _c;
|
|
1504
|
+
return __awaiter(this, void 0, void 0, function () {
|
|
1505
|
+
var localVarAxiosArgs, localVarOperationServerIndex, localVarOperationServerBasePath;
|
|
1506
|
+
return __generator(this, function (_d) {
|
|
1507
|
+
switch (_d.label) {
|
|
1508
|
+
case 0: return [4 /*yield*/, localVarAxiosParamCreator.getRoleV2(id, xSailPointExperimental, axiosOptions)];
|
|
1509
|
+
case 1:
|
|
1510
|
+
localVarAxiosArgs = _d.sent();
|
|
1511
|
+
localVarOperationServerIndex = (_a = configuration === null || configuration === void 0 ? void 0 : configuration.serverIndex) !== null && _a !== void 0 ? _a : 0;
|
|
1512
|
+
localVarOperationServerBasePath = (_c = (_b = operationServerMap['RolesApi.getRoleV2']) === null || _b === void 0 ? void 0 : _b[localVarOperationServerIndex]) === null || _c === void 0 ? void 0 : _c.url;
|
|
1513
|
+
return [2 /*return*/, function (axios, basePath) { return createRequestFunction(localVarAxiosArgs, globalAxios, BASE_PATH, configuration)(axios, localVarOperationServerBasePath || basePath); }];
|
|
1514
|
+
}
|
|
1515
|
+
});
|
|
1516
|
+
});
|
|
1517
|
+
},
|
|
1145
1518
|
/**
|
|
1146
1519
|
* This API returns a list of Roles. A token with API, ORG_ADMIN, ROLE_ADMIN, or ROLE_SUBADMIN authority is required to call this API.
|
|
1147
1520
|
* @summary List roles
|
|
@@ -1172,6 +1545,38 @@ export var RolesApiFp = function (configuration) {
|
|
|
1172
1545
|
});
|
|
1173
1546
|
});
|
|
1174
1547
|
},
|
|
1548
|
+
/**
|
|
1549
|
+
* This API returns a list of Roles. Each Role includes its effective privilege level in `privilegeLevel.effective`, which is the highest effective privilege level among the entitlements assigned directly to the Role and the entitlements included in the Role\'s access profiles. Use either offset pagination (`offset` and `limit`) or cursor pagination (`cursor` and `limit`). When more results are available, the `x-next-cursor` response header contains the cursor for the next page. Send that value in the `cursor` query parameter, with the same `sorters`, to get the next page. You can\'t use `cursor` together with an `offset` greater than 0, and `offset` plus `limit` can\'t be greater than 10,000. Use cursor pagination to page beyond 10,000 results. A token with API, ORG_ADMIN, ROLE_ADMIN, or ROLE_SUBADMIN authority is required to call this API.
|
|
1550
|
+
* @summary List roles
|
|
1551
|
+
* @param {string} [xSailPointExperimental] Use this header to enable this experimental API.
|
|
1552
|
+
* @param {string} [forSubadmin] If provided, filters the returned list according to what is visible to the indicated ROLE_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. A 400 Bad Request error is returned if the **for-subadmin** parameter is specified for an Identity that is not a subadmin.
|
|
1553
|
+
* @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.
|
|
1554
|
+
* @param {number} [offset] Offset into the full result set. Usually specified with *limit* to paginate through the results. Must be 0 or omitted when *cursor* is specified. See [API Standard Collection Parameters](https://developer.sailpoint.com/docs/api/standard-collection-parameters) for more information.
|
|
1555
|
+
* @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.
|
|
1556
|
+
* @param {string} [cursor] Opaque cursor returned in the `x-next-cursor` response header of the previous page. Pass it with the same `sorters` to get the next page of results. Can\'t be used with an *offset* greater than 0.
|
|
1557
|
+
* @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, sw, co* **created**: *gt, lt, ge, le* **modified**: *gt, lt, ge, le* **type**: *eq, in* **owner.id**: *eq, in* **additionalOwners.id**: *eq, in* **requestable**: *eq* **dimensional**: *eq* **source.id**: *eq, in* **entitlement.id**: *eq, in* **entitlement.name**: *eq, sw, co* **accessProfile.id**: *eq, in* **accessProfile.name**: *eq, sw, co* **privilegeLevel.effective**: *eq, in* Supported composite operators are *and, or*
|
|
1558
|
+
* @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: **id, name, created, modified, privilegeLevel.effective** The default sort is **name**. **id** is always added as the final sort field so that cursor pagination is stable.
|
|
1559
|
+
* @param {string} [forSegmentIds] If present and not empty, additionally filters Roles to those which are assigned to the Segment(s) with the specified IDs. If segmentation is currently unavailable, specifying this parameter results in an error.
|
|
1560
|
+
* @param {boolean} [includeUnsegmented] Whether or not the response list should contain unsegmented Roles. If *for-segment-ids* is absent or empty, specifying *include-unsegmented* as false results in an error.
|
|
1561
|
+
* @param {*} [axiosOptions] Override http request option.
|
|
1562
|
+
* @throws {RequiredError}
|
|
1563
|
+
*/
|
|
1564
|
+
listRolesV2: function (xSailPointExperimental, forSubadmin, limit, offset, count, cursor, filters, sorters, forSegmentIds, includeUnsegmented, axiosOptions) {
|
|
1565
|
+
var _a, _b, _c;
|
|
1566
|
+
return __awaiter(this, void 0, void 0, function () {
|
|
1567
|
+
var localVarAxiosArgs, localVarOperationServerIndex, localVarOperationServerBasePath;
|
|
1568
|
+
return __generator(this, function (_d) {
|
|
1569
|
+
switch (_d.label) {
|
|
1570
|
+
case 0: return [4 /*yield*/, localVarAxiosParamCreator.listRolesV2(xSailPointExperimental, forSubadmin, limit, offset, count, cursor, filters, sorters, forSegmentIds, includeUnsegmented, axiosOptions)];
|
|
1571
|
+
case 1:
|
|
1572
|
+
localVarAxiosArgs = _d.sent();
|
|
1573
|
+
localVarOperationServerIndex = (_a = configuration === null || configuration === void 0 ? void 0 : configuration.serverIndex) !== null && _a !== void 0 ? _a : 0;
|
|
1574
|
+
localVarOperationServerBasePath = (_c = (_b = operationServerMap['RolesApi.listRolesV2']) === null || _b === void 0 ? void 0 : _b[localVarOperationServerIndex]) === null || _c === void 0 ? void 0 : _c.url;
|
|
1575
|
+
return [2 /*return*/, function (axios, basePath) { return createRequestFunction(localVarAxiosArgs, globalAxios, BASE_PATH, configuration)(axios, localVarOperationServerBasePath || basePath); }];
|
|
1576
|
+
}
|
|
1577
|
+
});
|
|
1578
|
+
});
|
|
1579
|
+
},
|
|
1175
1580
|
/**
|
|
1176
1581
|
* This API updates an existing role using [JSON Patch](https://tools.ietf.org/html/rfc6902) syntax. The following fields are patchable: * name * description * enabled * owner * additionalOwners * accessProfiles * entitlements * membership * requestable * accessRequestConfig * revokeRequestConfig * segments * accessModelMetadata A token with API, ORG_ADMIN, ROLE_ADMIN, or ROLE_SUBADMIN authority is required to call this API. In addition, a token with ROLE_SUBADMIN authority may only call this API if all access profiles included in the role are associated to Sources with management workgroups of which the ROLE_SUBADMIN is a member. The maximum supported length for the description field is 2000 characters. Longer descriptions will be preserved for existing roles, however, any new roles as well as any updates to existing descriptions will be limited to 2000 characters. When you use this API to modify a role\'s membership identities, you can only modify up to a limit of 500 membership identities at a time.
|
|
1177
1582
|
* @summary Patch a specified role
|
|
@@ -1226,6 +1631,38 @@ export var RolesApiFp = function (configuration) {
|
|
|
1226
1631
|
});
|
|
1227
1632
|
});
|
|
1228
1633
|
},
|
|
1634
|
+
/**
|
|
1635
|
+
* This API returns a list of Roles 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. Each Role includes its effective privilege level in `privilegeLevel.effective`. The `filters` expression in the request body supports the same fields and operators as the `filters` query parameter of [List roles](#operation/listRolesV2), including **privilegeLevel.effective**: *eq, in*. Use either offset pagination (`offset` and `limit`) or cursor pagination (`cursor` and `limit`). When more results are available, the `x-next-cursor` response header contains the cursor for the next page. Send that value in the `cursor` query parameter, with the same request body and `sorters`, to get the next page. You can\'t use `cursor` together with an `offset` greater than 0, and `offset` plus `limit` can\'t be greater than 10,000.
|
|
1636
|
+
* @summary Filter roles by metadata
|
|
1637
|
+
* @param {Rolelistfilterdtov2} rolelistfilterdtov2
|
|
1638
|
+
* @param {string} [xSailPointExperimental] Use this header to enable this experimental API.
|
|
1639
|
+
* @param {string} [forSubadmin] If provided, filters the returned list according to what is visible to the indicated ROLE_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. A 400 Bad Request error is returned if the **for-subadmin** parameter is specified for an Identity that is not a subadmin.
|
|
1640
|
+
* @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.
|
|
1641
|
+
* @param {number} [offset] Offset into the full result set. Usually specified with *limit* to paginate through the results. Must be 0 or omitted when *cursor* is specified. See [API Standard Collection Parameters](https://developer.sailpoint.com/docs/api/standard-collection-parameters) for more information.
|
|
1642
|
+
* @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.
|
|
1643
|
+
* @param {string} [cursor] Opaque cursor returned in the `x-next-cursor` response header of the previous page. Pass it with the same request body and `sorters` to get the next page of results. Can\'t be used with an *offset* greater than 0.
|
|
1644
|
+
* @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: **id, name, created, modified, privilegeLevel.effective** The default sort is **name**. **id** is always added as the final sort field so that cursor pagination is stable.
|
|
1645
|
+
* @param {string} [forSegmentIds] If present and not empty, additionally filters Roles to those which are assigned to the Segment(s) with the specified IDs. If segmentation is currently unavailable, specifying this parameter results in an error.
|
|
1646
|
+
* @param {boolean} [includeUnsegmented] Whether or not the response list should contain unsegmented Roles. If *for-segment-ids* is absent or empty, specifying *include-unsegmented* as false results in an error.
|
|
1647
|
+
* @param {*} [axiosOptions] Override http request option.
|
|
1648
|
+
* @throws {RequiredError}
|
|
1649
|
+
*/
|
|
1650
|
+
searchRolesByFilterV2: function (rolelistfilterdtov2, xSailPointExperimental, forSubadmin, limit, offset, count, cursor, sorters, forSegmentIds, includeUnsegmented, axiosOptions) {
|
|
1651
|
+
var _a, _b, _c;
|
|
1652
|
+
return __awaiter(this, void 0, void 0, function () {
|
|
1653
|
+
var localVarAxiosArgs, localVarOperationServerIndex, localVarOperationServerBasePath;
|
|
1654
|
+
return __generator(this, function (_d) {
|
|
1655
|
+
switch (_d.label) {
|
|
1656
|
+
case 0: return [4 /*yield*/, localVarAxiosParamCreator.searchRolesByFilterV2(rolelistfilterdtov2, xSailPointExperimental, forSubadmin, limit, offset, count, cursor, sorters, forSegmentIds, includeUnsegmented, axiosOptions)];
|
|
1657
|
+
case 1:
|
|
1658
|
+
localVarAxiosArgs = _d.sent();
|
|
1659
|
+
localVarOperationServerIndex = (_a = configuration === null || configuration === void 0 ? void 0 : configuration.serverIndex) !== null && _a !== void 0 ? _a : 0;
|
|
1660
|
+
localVarOperationServerBasePath = (_c = (_b = operationServerMap['RolesApi.searchRolesByFilterV2']) === null || _b === void 0 ? void 0 : _b[localVarOperationServerIndex]) === null || _c === void 0 ? void 0 : _c.url;
|
|
1661
|
+
return [2 /*return*/, function (axios, basePath) { return createRequestFunction(localVarAxiosArgs, globalAxios, BASE_PATH, configuration)(axios, localVarOperationServerBasePath || basePath); }];
|
|
1662
|
+
}
|
|
1663
|
+
});
|
|
1664
|
+
});
|
|
1665
|
+
},
|
|
1229
1666
|
/**
|
|
1230
1667
|
* This API initialize a request to add a single Access Model Metadata to a role by attribute key and attribute value. A token with ORG_ADMIN, ROLE_ADMIN ROLE_SUBADMIN authority is required to call this API. The maximum number of attributes in one role is 25. Custom metadata update, including ADD and REPLACE need suit licensed.
|
|
1231
1668
|
* @summary Add a metadata to role.
|
|
@@ -1408,6 +1845,16 @@ export var RolesApiFactory = function (configuration, basePath, axios) {
|
|
|
1408
1845
|
getRoleEntitlementsV1: function (requestParameters, axiosOptions) {
|
|
1409
1846
|
return localVarFp.getRoleEntitlementsV1(requestParameters.id, requestParameters.limit, requestParameters.offset, requestParameters.count, requestParameters.filters, requestParameters.sorters, axiosOptions).then(function (request) { return request(axios, basePath); });
|
|
1410
1847
|
},
|
|
1848
|
+
/**
|
|
1849
|
+
* Get a list of entitlements assigned directly to a specified Role. Each entitlement includes its privilege level in `privilegeLevel`, with the direct, inherited, and effective levels. Use either offset pagination (`offset` and `limit`) or cursor pagination (`cursor` and `limit`). When more results are available, the `x-next-cursor` response header contains the cursor for the next page. You can\'t use `cursor` together with an `offset` greater than 0, and `offset` plus `limit` can\'t be greater than 10,000.
|
|
1850
|
+
* @summary List role\'s entitlements
|
|
1851
|
+
* @param {RolesApiGetRoleEntitlementsV2Request} requestParameters Request parameters.
|
|
1852
|
+
* @param {*} [axiosOptions] Override http request option.
|
|
1853
|
+
* @throws {RequiredError}
|
|
1854
|
+
*/
|
|
1855
|
+
getRoleEntitlementsV2: function (requestParameters, axiosOptions) {
|
|
1856
|
+
return localVarFp.getRoleEntitlementsV2(requestParameters.id, requestParameters.xSailPointExperimental, requestParameters.limit, requestParameters.offset, requestParameters.count, requestParameters.cursor, requestParameters.filters, requestParameters.sorters, requestParameters.forSegmentIds, requestParameters.segmentedForIdentity, requestParameters.includeUnsegmented, axiosOptions).then(function (request) { return request(axios, basePath); });
|
|
1857
|
+
},
|
|
1411
1858
|
/**
|
|
1412
1859
|
* This API returns a Role by its ID. A token with API, ORG_ADMIN, ROLE_ADMIN, or ROLE_SUBADMIN authority is required to call this API. In addition, a token with ROLE_SUBADMIN authority may only call this API if all Access Profiles included in the Role are associated to Sources with management workgroups of which the ROLE_SUBADMIN is a member.
|
|
1413
1860
|
* @summary Get a role
|
|
@@ -1418,6 +1865,16 @@ export var RolesApiFactory = function (configuration, basePath, axios) {
|
|
|
1418
1865
|
getRoleV1: function (requestParameters, axiosOptions) {
|
|
1419
1866
|
return localVarFp.getRoleV1(requestParameters.id, axiosOptions).then(function (request) { return request(axios, basePath); });
|
|
1420
1867
|
},
|
|
1868
|
+
/**
|
|
1869
|
+
* This API returns a Role by its ID. The response includes the Role\'s effective privilege level in `privilegeLevel.effective`, which is the highest effective privilege level among the entitlements assigned directly to the Role and the entitlements included in the Role\'s access profiles. A token with API, ORG_ADMIN, ROLE_ADMIN, or ROLE_SUBADMIN authority is required to call this API. In addition, a token with ROLE_SUBADMIN authority may only call this API if all Access Profiles included in the Role are associated to Sources with management workgroups of which the ROLE_SUBADMIN is a member.
|
|
1870
|
+
* @summary Get a role
|
|
1871
|
+
* @param {RolesApiGetRoleV2Request} requestParameters Request parameters.
|
|
1872
|
+
* @param {*} [axiosOptions] Override http request option.
|
|
1873
|
+
* @throws {RequiredError}
|
|
1874
|
+
*/
|
|
1875
|
+
getRoleV2: function (requestParameters, axiosOptions) {
|
|
1876
|
+
return localVarFp.getRoleV2(requestParameters.id, requestParameters.xSailPointExperimental, axiosOptions).then(function (request) { return request(axios, basePath); });
|
|
1877
|
+
},
|
|
1421
1878
|
/**
|
|
1422
1879
|
* This API returns a list of Roles. A token with API, ORG_ADMIN, ROLE_ADMIN, or ROLE_SUBADMIN authority is required to call this API.
|
|
1423
1880
|
* @summary List roles
|
|
@@ -1429,6 +1886,17 @@ export var RolesApiFactory = function (configuration, basePath, axios) {
|
|
|
1429
1886
|
if (requestParameters === void 0) { requestParameters = {}; }
|
|
1430
1887
|
return localVarFp.listRolesV1(requestParameters.forSubadmin, requestParameters.limit, requestParameters.offset, requestParameters.count, requestParameters.filters, requestParameters.sorters, requestParameters.forSegmentIds, requestParameters.includeUnsegmented, axiosOptions).then(function (request) { return request(axios, basePath); });
|
|
1431
1888
|
},
|
|
1889
|
+
/**
|
|
1890
|
+
* This API returns a list of Roles. Each Role includes its effective privilege level in `privilegeLevel.effective`, which is the highest effective privilege level among the entitlements assigned directly to the Role and the entitlements included in the Role\'s access profiles. Use either offset pagination (`offset` and `limit`) or cursor pagination (`cursor` and `limit`). When more results are available, the `x-next-cursor` response header contains the cursor for the next page. Send that value in the `cursor` query parameter, with the same `sorters`, to get the next page. You can\'t use `cursor` together with an `offset` greater than 0, and `offset` plus `limit` can\'t be greater than 10,000. Use cursor pagination to page beyond 10,000 results. A token with API, ORG_ADMIN, ROLE_ADMIN, or ROLE_SUBADMIN authority is required to call this API.
|
|
1891
|
+
* @summary List roles
|
|
1892
|
+
* @param {RolesApiListRolesV2Request} requestParameters Request parameters.
|
|
1893
|
+
* @param {*} [axiosOptions] Override http request option.
|
|
1894
|
+
* @throws {RequiredError}
|
|
1895
|
+
*/
|
|
1896
|
+
listRolesV2: function (requestParameters, axiosOptions) {
|
|
1897
|
+
if (requestParameters === void 0) { requestParameters = {}; }
|
|
1898
|
+
return localVarFp.listRolesV2(requestParameters.xSailPointExperimental, requestParameters.forSubadmin, requestParameters.limit, requestParameters.offset, requestParameters.count, requestParameters.cursor, requestParameters.filters, requestParameters.sorters, requestParameters.forSegmentIds, requestParameters.includeUnsegmented, axiosOptions).then(function (request) { return request(axios, basePath); });
|
|
1899
|
+
},
|
|
1432
1900
|
/**
|
|
1433
1901
|
* This API updates an existing role using [JSON Patch](https://tools.ietf.org/html/rfc6902) syntax. The following fields are patchable: * name * description * enabled * owner * additionalOwners * accessProfiles * entitlements * membership * requestable * accessRequestConfig * revokeRequestConfig * segments * accessModelMetadata A token with API, ORG_ADMIN, ROLE_ADMIN, or ROLE_SUBADMIN authority is required to call this API. In addition, a token with ROLE_SUBADMIN authority may only call this API if all access profiles included in the role are associated to Sources with management workgroups of which the ROLE_SUBADMIN is a member. The maximum supported length for the description field is 2000 characters. Longer descriptions will be preserved for existing roles, however, any new roles as well as any updates to existing descriptions will be limited to 2000 characters. When you use this API to modify a role\'s membership identities, you can only modify up to a limit of 500 membership identities at a time.
|
|
1434
1902
|
* @summary Patch a specified role
|
|
@@ -1450,6 +1918,16 @@ export var RolesApiFactory = function (configuration, basePath, axios) {
|
|
|
1450
1918
|
if (requestParameters === void 0) { requestParameters = {}; }
|
|
1451
1919
|
return localVarFp.searchRolesByFilterV1(requestParameters.forSubadmin, requestParameters.limit, requestParameters.offset, requestParameters.count, requestParameters.sorters, requestParameters.forSegmentIds, requestParameters.includeUnsegmented, requestParameters.roleListFilterDTO, axiosOptions).then(function (request) { return request(axios, basePath); });
|
|
1452
1920
|
},
|
|
1921
|
+
/**
|
|
1922
|
+
* This API returns a list of Roles 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. Each Role includes its effective privilege level in `privilegeLevel.effective`. The `filters` expression in the request body supports the same fields and operators as the `filters` query parameter of [List roles](#operation/listRolesV2), including **privilegeLevel.effective**: *eq, in*. Use either offset pagination (`offset` and `limit`) or cursor pagination (`cursor` and `limit`). When more results are available, the `x-next-cursor` response header contains the cursor for the next page. Send that value in the `cursor` query parameter, with the same request body and `sorters`, to get the next page. You can\'t use `cursor` together with an `offset` greater than 0, and `offset` plus `limit` can\'t be greater than 10,000.
|
|
1923
|
+
* @summary Filter roles by metadata
|
|
1924
|
+
* @param {RolesApiSearchRolesByFilterV2Request} requestParameters Request parameters.
|
|
1925
|
+
* @param {*} [axiosOptions] Override http request option.
|
|
1926
|
+
* @throws {RequiredError}
|
|
1927
|
+
*/
|
|
1928
|
+
searchRolesByFilterV2: function (requestParameters, axiosOptions) {
|
|
1929
|
+
return localVarFp.searchRolesByFilterV2(requestParameters.rolelistfilterdtov2, requestParameters.xSailPointExperimental, requestParameters.forSubadmin, requestParameters.limit, requestParameters.offset, requestParameters.count, requestParameters.cursor, requestParameters.sorters, requestParameters.forSegmentIds, requestParameters.includeUnsegmented, axiosOptions).then(function (request) { return request(axios, basePath); });
|
|
1930
|
+
},
|
|
1453
1931
|
/**
|
|
1454
1932
|
* This API initialize a request to add a single Access Model Metadata to a role by attribute key and attribute value. A token with ORG_ADMIN, ROLE_ADMIN ROLE_SUBADMIN authority is required to call this API. The maximum number of attributes in one role is 25. Custom metadata update, including ADD and REPLACE need suit licensed.
|
|
1455
1933
|
* @summary Add a metadata to role.
|
|
@@ -1598,6 +2076,18 @@ var RolesApi = /** @class */ (function (_super) {
|
|
|
1598
2076
|
var _this = this;
|
|
1599
2077
|
return RolesApiFp(this.configuration).getRoleEntitlementsV1(requestParameters.id, requestParameters.limit, requestParameters.offset, requestParameters.count, requestParameters.filters, requestParameters.sorters, axiosOptions).then(function (request) { return request(_this.axios, _this.basePath); });
|
|
1600
2078
|
};
|
|
2079
|
+
/**
|
|
2080
|
+
* Get a list of entitlements assigned directly to a specified Role. Each entitlement includes its privilege level in `privilegeLevel`, with the direct, inherited, and effective levels. Use either offset pagination (`offset` and `limit`) or cursor pagination (`cursor` and `limit`). When more results are available, the `x-next-cursor` response header contains the cursor for the next page. You can\'t use `cursor` together with an `offset` greater than 0, and `offset` plus `limit` can\'t be greater than 10,000.
|
|
2081
|
+
* @summary List role\'s entitlements
|
|
2082
|
+
* @param {RolesApiGetRoleEntitlementsV2Request} requestParameters Request parameters.
|
|
2083
|
+
* @param {*} [axiosOptions] Override http request option.
|
|
2084
|
+
* @throws {RequiredError}
|
|
2085
|
+
* @memberof RolesApi
|
|
2086
|
+
*/
|
|
2087
|
+
RolesApi.prototype.getRoleEntitlementsV2 = function (requestParameters, axiosOptions) {
|
|
2088
|
+
var _this = this;
|
|
2089
|
+
return RolesApiFp(this.configuration).getRoleEntitlementsV2(requestParameters.id, requestParameters.xSailPointExperimental, requestParameters.limit, requestParameters.offset, requestParameters.count, requestParameters.cursor, requestParameters.filters, requestParameters.sorters, requestParameters.forSegmentIds, requestParameters.segmentedForIdentity, requestParameters.includeUnsegmented, axiosOptions).then(function (request) { return request(_this.axios, _this.basePath); });
|
|
2090
|
+
};
|
|
1601
2091
|
/**
|
|
1602
2092
|
* This API returns a Role by its ID. A token with API, ORG_ADMIN, ROLE_ADMIN, or ROLE_SUBADMIN authority is required to call this API. In addition, a token with ROLE_SUBADMIN authority may only call this API if all Access Profiles included in the Role are associated to Sources with management workgroups of which the ROLE_SUBADMIN is a member.
|
|
1603
2093
|
* @summary Get a role
|
|
@@ -1610,6 +2100,18 @@ var RolesApi = /** @class */ (function (_super) {
|
|
|
1610
2100
|
var _this = this;
|
|
1611
2101
|
return RolesApiFp(this.configuration).getRoleV1(requestParameters.id, axiosOptions).then(function (request) { return request(_this.axios, _this.basePath); });
|
|
1612
2102
|
};
|
|
2103
|
+
/**
|
|
2104
|
+
* This API returns a Role by its ID. The response includes the Role\'s effective privilege level in `privilegeLevel.effective`, which is the highest effective privilege level among the entitlements assigned directly to the Role and the entitlements included in the Role\'s access profiles. A token with API, ORG_ADMIN, ROLE_ADMIN, or ROLE_SUBADMIN authority is required to call this API. In addition, a token with ROLE_SUBADMIN authority may only call this API if all Access Profiles included in the Role are associated to Sources with management workgroups of which the ROLE_SUBADMIN is a member.
|
|
2105
|
+
* @summary Get a role
|
|
2106
|
+
* @param {RolesApiGetRoleV2Request} requestParameters Request parameters.
|
|
2107
|
+
* @param {*} [axiosOptions] Override http request option.
|
|
2108
|
+
* @throws {RequiredError}
|
|
2109
|
+
* @memberof RolesApi
|
|
2110
|
+
*/
|
|
2111
|
+
RolesApi.prototype.getRoleV2 = function (requestParameters, axiosOptions) {
|
|
2112
|
+
var _this = this;
|
|
2113
|
+
return RolesApiFp(this.configuration).getRoleV2(requestParameters.id, requestParameters.xSailPointExperimental, axiosOptions).then(function (request) { return request(_this.axios, _this.basePath); });
|
|
2114
|
+
};
|
|
1613
2115
|
/**
|
|
1614
2116
|
* This API returns a list of Roles. A token with API, ORG_ADMIN, ROLE_ADMIN, or ROLE_SUBADMIN authority is required to call this API.
|
|
1615
2117
|
* @summary List roles
|
|
@@ -1623,6 +2125,19 @@ var RolesApi = /** @class */ (function (_super) {
|
|
|
1623
2125
|
if (requestParameters === void 0) { requestParameters = {}; }
|
|
1624
2126
|
return RolesApiFp(this.configuration).listRolesV1(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); });
|
|
1625
2127
|
};
|
|
2128
|
+
/**
|
|
2129
|
+
* This API returns a list of Roles. Each Role includes its effective privilege level in `privilegeLevel.effective`, which is the highest effective privilege level among the entitlements assigned directly to the Role and the entitlements included in the Role\'s access profiles. Use either offset pagination (`offset` and `limit`) or cursor pagination (`cursor` and `limit`). When more results are available, the `x-next-cursor` response header contains the cursor for the next page. Send that value in the `cursor` query parameter, with the same `sorters`, to get the next page. You can\'t use `cursor` together with an `offset` greater than 0, and `offset` plus `limit` can\'t be greater than 10,000. Use cursor pagination to page beyond 10,000 results. A token with API, ORG_ADMIN, ROLE_ADMIN, or ROLE_SUBADMIN authority is required to call this API.
|
|
2130
|
+
* @summary List roles
|
|
2131
|
+
* @param {RolesApiListRolesV2Request} requestParameters Request parameters.
|
|
2132
|
+
* @param {*} [axiosOptions] Override http request option.
|
|
2133
|
+
* @throws {RequiredError}
|
|
2134
|
+
* @memberof RolesApi
|
|
2135
|
+
*/
|
|
2136
|
+
RolesApi.prototype.listRolesV2 = function (requestParameters, axiosOptions) {
|
|
2137
|
+
var _this = this;
|
|
2138
|
+
if (requestParameters === void 0) { requestParameters = {}; }
|
|
2139
|
+
return RolesApiFp(this.configuration).listRolesV2(requestParameters.xSailPointExperimental, requestParameters.forSubadmin, requestParameters.limit, requestParameters.offset, requestParameters.count, requestParameters.cursor, requestParameters.filters, requestParameters.sorters, requestParameters.forSegmentIds, requestParameters.includeUnsegmented, axiosOptions).then(function (request) { return request(_this.axios, _this.basePath); });
|
|
2140
|
+
};
|
|
1626
2141
|
/**
|
|
1627
2142
|
* This API updates an existing role using [JSON Patch](https://tools.ietf.org/html/rfc6902) syntax. The following fields are patchable: * name * description * enabled * owner * additionalOwners * accessProfiles * entitlements * membership * requestable * accessRequestConfig * revokeRequestConfig * segments * accessModelMetadata A token with API, ORG_ADMIN, ROLE_ADMIN, or ROLE_SUBADMIN authority is required to call this API. In addition, a token with ROLE_SUBADMIN authority may only call this API if all access profiles included in the role are associated to Sources with management workgroups of which the ROLE_SUBADMIN is a member. The maximum supported length for the description field is 2000 characters. Longer descriptions will be preserved for existing roles, however, any new roles as well as any updates to existing descriptions will be limited to 2000 characters. When you use this API to modify a role\'s membership identities, you can only modify up to a limit of 500 membership identities at a time.
|
|
1628
2143
|
* @summary Patch a specified role
|
|
@@ -1648,6 +2163,18 @@ var RolesApi = /** @class */ (function (_super) {
|
|
|
1648
2163
|
if (requestParameters === void 0) { requestParameters = {}; }
|
|
1649
2164
|
return RolesApiFp(this.configuration).searchRolesByFilterV1(requestParameters.forSubadmin, requestParameters.limit, requestParameters.offset, requestParameters.count, requestParameters.sorters, requestParameters.forSegmentIds, requestParameters.includeUnsegmented, requestParameters.roleListFilterDTO, axiosOptions).then(function (request) { return request(_this.axios, _this.basePath); });
|
|
1650
2165
|
};
|
|
2166
|
+
/**
|
|
2167
|
+
* This API returns a list of Roles 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. Each Role includes its effective privilege level in `privilegeLevel.effective`. The `filters` expression in the request body supports the same fields and operators as the `filters` query parameter of [List roles](#operation/listRolesV2), including **privilegeLevel.effective**: *eq, in*. Use either offset pagination (`offset` and `limit`) or cursor pagination (`cursor` and `limit`). When more results are available, the `x-next-cursor` response header contains the cursor for the next page. Send that value in the `cursor` query parameter, with the same request body and `sorters`, to get the next page. You can\'t use `cursor` together with an `offset` greater than 0, and `offset` plus `limit` can\'t be greater than 10,000.
|
|
2168
|
+
* @summary Filter roles by metadata
|
|
2169
|
+
* @param {RolesApiSearchRolesByFilterV2Request} requestParameters Request parameters.
|
|
2170
|
+
* @param {*} [axiosOptions] Override http request option.
|
|
2171
|
+
* @throws {RequiredError}
|
|
2172
|
+
* @memberof RolesApi
|
|
2173
|
+
*/
|
|
2174
|
+
RolesApi.prototype.searchRolesByFilterV2 = function (requestParameters, axiosOptions) {
|
|
2175
|
+
var _this = this;
|
|
2176
|
+
return RolesApiFp(this.configuration).searchRolesByFilterV2(requestParameters.rolelistfilterdtov2, requestParameters.xSailPointExperimental, requestParameters.forSubadmin, requestParameters.limit, requestParameters.offset, requestParameters.count, requestParameters.cursor, requestParameters.sorters, requestParameters.forSegmentIds, requestParameters.includeUnsegmented, axiosOptions).then(function (request) { return request(_this.axios, _this.basePath); });
|
|
2177
|
+
};
|
|
1651
2178
|
/**
|
|
1652
2179
|
* This API initialize a request to add a single Access Model Metadata to a role by attribute key and attribute value. A token with ORG_ADMIN, ROLE_ADMIN ROLE_SUBADMIN authority is required to call this API. The maximum number of attributes in one role is 25. Custom metadata update, including ADD and REPLACE need suit licensed.
|
|
1653
2180
|
* @summary Add a metadata to role.
|