@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/roles/api.js
CHANGED
|
@@ -78,7 +78,7 @@ var __importDefault = (this && this.__importDefault) || function (mod) {
|
|
|
78
78
|
return (mod && mod.__esModule) ? mod : { "default": mod };
|
|
79
79
|
};
|
|
80
80
|
Object.defineProperty(exports, "__esModule", { value: true });
|
|
81
|
-
exports.RolesApi = exports.RolesApiFactory = exports.RolesApiFp = exports.RolesApiAxiosParamCreator = exports.TaskResultDtoTypeEnum = exports.RoleMetadataBulkUpdateByQueryRequestReplaceScopeEnum = exports.RoleMetadataBulkUpdateByQueryRequestOperationEnum = exports.RoleMetadataBulkUpdateByIdRequestReplaceScopeEnum = exports.RoleMetadataBulkUpdateByIdRequestOperationEnum = exports.RoleMetadataBulkUpdateByFilterRequestReplaceScopeEnum = exports.RoleMetadataBulkUpdateByFilterRequestOperationEnum = exports.RoleMembershipSelectorType = exports.RoleGetAllBulkUpdateResponseStatusEnum = exports.RoleCriteriaOperation = exports.RoleCriteriaKeyType = exports.RoleBulkUpdateResponseStatusEnum = exports.RoleAssignmentSourceType = exports.OwnerReferenceTypeEnum = exports.LocaleOrigin = exports.JsonPatchOperationOpEnum = exports.EntitlementRefTypeEnum = exports.
|
|
81
|
+
exports.RolesApi = exports.RolesApiFactory = exports.RolesApiFp = exports.RolesApiAxiosParamCreator = exports.TaskResultDtoTypeEnum = exports.RolePrivilegeLevelEffectiveEnum = exports.RoleMetadataBulkUpdateByQueryRequestReplaceScopeEnum = exports.RoleMetadataBulkUpdateByQueryRequestOperationEnum = exports.RoleMetadataBulkUpdateByIdRequestReplaceScopeEnum = exports.RoleMetadataBulkUpdateByIdRequestOperationEnum = exports.RoleMetadataBulkUpdateByFilterRequestReplaceScopeEnum = exports.RoleMetadataBulkUpdateByFilterRequestOperationEnum = exports.RoleMembershipSelectorType = exports.RoleGetAllBulkUpdateResponseStatusEnum = exports.RoleCriteriaOperation = exports.RoleCriteriaKeyType = exports.RoleBulkUpdateResponseStatusEnum = exports.RoleAssignmentSourceType = exports.OwnerReferenceTypeEnum = exports.LocaleOrigin = exports.JsonPatchOperationOpEnum = exports.EntitlementV2PrivilegeLevelEffectiveEnum = exports.EntitlementV2PrivilegeLevelInheritedEnum = exports.EntitlementV2PrivilegeLevelSetByTypeEnum = exports.EntitlementV2PrivilegeLevelDirectEnum = exports.EntitlementV2OwnerTypeEnum = exports.EntitlementRefTypeEnum = exports.EntitlementPrivilegeLevelEffectiveEnum = exports.EntitlementPrivilegeLevelInheritedEnum = exports.EntitlementPrivilegeLevelSetByTypeEnum = exports.EntitlementPrivilegeLevelDirectEnum = exports.DtoType = exports.DimensionRefTypeEnum = exports.AttributeValueDTOTypeEnum = exports.ApprovalSchemeForRoleApproverTypeEnum = exports.AdditionalOwnerRefTypeEnum = exports.AccessProfileRefTypeEnum = exports.AccessDurationTimeUnitEnum = void 0;
|
|
82
82
|
var axios_1 = __importDefault(require("axios"));
|
|
83
83
|
// Some imports not used depending on template conditions
|
|
84
84
|
// @ts-ignore
|
|
@@ -150,12 +150,60 @@ exports.DtoType = {
|
|
|
150
150
|
AccountActivity: 'ACCOUNT_ACTIVITY',
|
|
151
151
|
Workgroup: 'WORKGROUP'
|
|
152
152
|
};
|
|
153
|
-
exports.
|
|
154
|
-
|
|
153
|
+
exports.EntitlementPrivilegeLevelDirectEnum = {
|
|
154
|
+
High: 'HIGH',
|
|
155
|
+
Low: 'LOW',
|
|
156
|
+
Medium: 'MEDIUM',
|
|
157
|
+
None: 'NONE'
|
|
158
|
+
};
|
|
159
|
+
exports.EntitlementPrivilegeLevelSetByTypeEnum = {
|
|
160
|
+
Override: 'OVERRIDE',
|
|
161
|
+
CustomCriteria: 'CUSTOM_CRITERIA',
|
|
162
|
+
ConnectorCriteria: 'CONNECTOR_CRITERIA',
|
|
163
|
+
SingleLevelCriteria: 'SINGLE_LEVEL_CRITERIA'
|
|
164
|
+
};
|
|
165
|
+
exports.EntitlementPrivilegeLevelInheritedEnum = {
|
|
166
|
+
High: 'HIGH',
|
|
167
|
+
Low: 'LOW',
|
|
168
|
+
Medium: 'MEDIUM',
|
|
169
|
+
None: 'NONE'
|
|
170
|
+
};
|
|
171
|
+
exports.EntitlementPrivilegeLevelEffectiveEnum = {
|
|
172
|
+
High: 'HIGH',
|
|
173
|
+
Low: 'LOW',
|
|
174
|
+
Medium: 'MEDIUM',
|
|
175
|
+
None: 'NONE'
|
|
155
176
|
};
|
|
156
177
|
exports.EntitlementRefTypeEnum = {
|
|
157
178
|
Entitlement: 'ENTITLEMENT'
|
|
158
179
|
};
|
|
180
|
+
exports.EntitlementV2OwnerTypeEnum = {
|
|
181
|
+
Identity: 'IDENTITY'
|
|
182
|
+
};
|
|
183
|
+
exports.EntitlementV2PrivilegeLevelDirectEnum = {
|
|
184
|
+
High: 'HIGH',
|
|
185
|
+
Low: 'LOW',
|
|
186
|
+
Medium: 'MEDIUM',
|
|
187
|
+
None: 'NONE'
|
|
188
|
+
};
|
|
189
|
+
exports.EntitlementV2PrivilegeLevelSetByTypeEnum = {
|
|
190
|
+
Override: 'OVERRIDE',
|
|
191
|
+
CustomCriteria: 'CUSTOM_CRITERIA',
|
|
192
|
+
ConnectorCriteria: 'CONNECTOR_CRITERIA',
|
|
193
|
+
SingleLevelCriteria: 'SINGLE_LEVEL_CRITERIA'
|
|
194
|
+
};
|
|
195
|
+
exports.EntitlementV2PrivilegeLevelInheritedEnum = {
|
|
196
|
+
High: 'HIGH',
|
|
197
|
+
Low: 'LOW',
|
|
198
|
+
Medium: 'MEDIUM',
|
|
199
|
+
None: 'NONE'
|
|
200
|
+
};
|
|
201
|
+
exports.EntitlementV2PrivilegeLevelEffectiveEnum = {
|
|
202
|
+
High: 'HIGH',
|
|
203
|
+
Low: 'LOW',
|
|
204
|
+
Medium: 'MEDIUM',
|
|
205
|
+
None: 'NONE'
|
|
206
|
+
};
|
|
159
207
|
exports.JsonPatchOperationOpEnum = {
|
|
160
208
|
Add: 'add',
|
|
161
209
|
Remove: 'remove',
|
|
@@ -266,6 +314,13 @@ exports.RoleMetadataBulkUpdateByQueryRequestReplaceScopeEnum = {
|
|
|
266
314
|
All: 'ALL',
|
|
267
315
|
Attribute: 'ATTRIBUTE'
|
|
268
316
|
};
|
|
317
|
+
exports.RolePrivilegeLevelEffectiveEnum = {
|
|
318
|
+
None: 'NONE',
|
|
319
|
+
Low: 'LOW',
|
|
320
|
+
Medium: 'MEDIUM',
|
|
321
|
+
High: 'HIGH',
|
|
322
|
+
Undetermined: 'UNDETERMINED'
|
|
323
|
+
};
|
|
269
324
|
exports.TaskResultDtoTypeEnum = {
|
|
270
325
|
TaskResult: 'TASK_RESULT'
|
|
271
326
|
};
|
|
@@ -586,6 +641,82 @@ var RolesApiAxiosParamCreator = function (configuration) {
|
|
|
586
641
|
});
|
|
587
642
|
});
|
|
588
643
|
},
|
|
644
|
+
/**
|
|
645
|
+
* 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.
|
|
646
|
+
* @summary List role\'s entitlements
|
|
647
|
+
* @param {string} id Containing role\'s ID.
|
|
648
|
+
* @param {string} [xSailPointExperimental] Use this header to enable this experimental API.
|
|
649
|
+
* @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.
|
|
650
|
+
* @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.
|
|
651
|
+
* @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.
|
|
652
|
+
* @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.
|
|
653
|
+
* @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*
|
|
654
|
+
* @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.
|
|
655
|
+
* @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*.
|
|
656
|
+
* @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*.
|
|
657
|
+
* @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.
|
|
658
|
+
* @param {*} [axiosOptions] Override http request option.
|
|
659
|
+
* @throws {RequiredError}
|
|
660
|
+
*/
|
|
661
|
+
getRoleEntitlementsV2: function (id, xSailPointExperimental, limit, offset, count, cursor, filters, sorters, forSegmentIds, segmentedForIdentity, includeUnsegmented, axiosOptions) {
|
|
662
|
+
if (axiosOptions === void 0) { axiosOptions = {}; }
|
|
663
|
+
return __awaiter(_this, void 0, void 0, function () {
|
|
664
|
+
var localVarPath, localVarUrlObj, baseOptions, localVarRequestOptions, localVarHeaderParameter, localVarQueryParameter, headersFromBaseOptions;
|
|
665
|
+
return __generator(this, function (_a) {
|
|
666
|
+
// verify required parameter 'id' is not null or undefined
|
|
667
|
+
(0, common_1.assertParamExists)('getRoleEntitlementsV2', 'id', id);
|
|
668
|
+
if (xSailPointExperimental === undefined) {
|
|
669
|
+
xSailPointExperimental = 'true';
|
|
670
|
+
}
|
|
671
|
+
localVarPath = "/roles/v2/{id}/entitlements"
|
|
672
|
+
.replace("{".concat("id", "}"), encodeURIComponent(String(id)));
|
|
673
|
+
localVarUrlObj = new URL(localVarPath, common_1.DUMMY_BASE_URL);
|
|
674
|
+
if (configuration) {
|
|
675
|
+
baseOptions = configuration.baseOptions;
|
|
676
|
+
}
|
|
677
|
+
localVarRequestOptions = __assign(__assign({ method: 'GET' }, baseOptions), axiosOptions);
|
|
678
|
+
localVarHeaderParameter = {};
|
|
679
|
+
localVarQueryParameter = {};
|
|
680
|
+
if (limit !== undefined) {
|
|
681
|
+
localVarQueryParameter['limit'] = limit;
|
|
682
|
+
}
|
|
683
|
+
if (offset !== undefined) {
|
|
684
|
+
localVarQueryParameter['offset'] = offset;
|
|
685
|
+
}
|
|
686
|
+
if (count !== undefined) {
|
|
687
|
+
localVarQueryParameter['count'] = count;
|
|
688
|
+
}
|
|
689
|
+
if (cursor !== undefined) {
|
|
690
|
+
localVarQueryParameter['cursor'] = cursor;
|
|
691
|
+
}
|
|
692
|
+
if (filters !== undefined) {
|
|
693
|
+
localVarQueryParameter['filters'] = filters;
|
|
694
|
+
}
|
|
695
|
+
if (sorters !== undefined) {
|
|
696
|
+
localVarQueryParameter['sorters'] = sorters;
|
|
697
|
+
}
|
|
698
|
+
if (forSegmentIds !== undefined) {
|
|
699
|
+
localVarQueryParameter['for-segment-ids'] = forSegmentIds;
|
|
700
|
+
}
|
|
701
|
+
if (segmentedForIdentity !== undefined) {
|
|
702
|
+
localVarQueryParameter['segmented-for-identity'] = segmentedForIdentity;
|
|
703
|
+
}
|
|
704
|
+
if (includeUnsegmented !== undefined) {
|
|
705
|
+
localVarQueryParameter['include-unsegmented'] = includeUnsegmented;
|
|
706
|
+
}
|
|
707
|
+
if (xSailPointExperimental != null) {
|
|
708
|
+
localVarHeaderParameter['X-SailPoint-Experimental'] = String(xSailPointExperimental);
|
|
709
|
+
}
|
|
710
|
+
(0, common_1.setSearchParams)(localVarUrlObj, localVarQueryParameter);
|
|
711
|
+
headersFromBaseOptions = baseOptions && baseOptions.headers ? baseOptions.headers : {};
|
|
712
|
+
localVarRequestOptions.headers = __assign(__assign(__assign({}, localVarHeaderParameter), headersFromBaseOptions), axiosOptions.headers);
|
|
713
|
+
return [2 /*return*/, {
|
|
714
|
+
url: (0, common_1.toPathString)(localVarUrlObj),
|
|
715
|
+
axiosOptions: localVarRequestOptions,
|
|
716
|
+
}];
|
|
717
|
+
});
|
|
718
|
+
});
|
|
719
|
+
},
|
|
589
720
|
/**
|
|
590
721
|
* 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.
|
|
591
722
|
* @summary Get a role
|
|
@@ -619,6 +750,46 @@ var RolesApiAxiosParamCreator = function (configuration) {
|
|
|
619
750
|
});
|
|
620
751
|
});
|
|
621
752
|
},
|
|
753
|
+
/**
|
|
754
|
+
* 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.
|
|
755
|
+
* @summary Get a role
|
|
756
|
+
* @param {string} id ID of the Role
|
|
757
|
+
* @param {string} [xSailPointExperimental] Use this header to enable this experimental API.
|
|
758
|
+
* @param {*} [axiosOptions] Override http request option.
|
|
759
|
+
* @throws {RequiredError}
|
|
760
|
+
*/
|
|
761
|
+
getRoleV2: function (id, xSailPointExperimental, axiosOptions) {
|
|
762
|
+
if (axiosOptions === void 0) { axiosOptions = {}; }
|
|
763
|
+
return __awaiter(_this, void 0, void 0, function () {
|
|
764
|
+
var localVarPath, localVarUrlObj, baseOptions, localVarRequestOptions, localVarHeaderParameter, localVarQueryParameter, headersFromBaseOptions;
|
|
765
|
+
return __generator(this, function (_a) {
|
|
766
|
+
// verify required parameter 'id' is not null or undefined
|
|
767
|
+
(0, common_1.assertParamExists)('getRoleV2', 'id', id);
|
|
768
|
+
if (xSailPointExperimental === undefined) {
|
|
769
|
+
xSailPointExperimental = 'true';
|
|
770
|
+
}
|
|
771
|
+
localVarPath = "/roles/v2/{id}"
|
|
772
|
+
.replace("{".concat("id", "}"), encodeURIComponent(String(id)));
|
|
773
|
+
localVarUrlObj = new URL(localVarPath, common_1.DUMMY_BASE_URL);
|
|
774
|
+
if (configuration) {
|
|
775
|
+
baseOptions = configuration.baseOptions;
|
|
776
|
+
}
|
|
777
|
+
localVarRequestOptions = __assign(__assign({ method: 'GET' }, baseOptions), axiosOptions);
|
|
778
|
+
localVarHeaderParameter = {};
|
|
779
|
+
localVarQueryParameter = {};
|
|
780
|
+
if (xSailPointExperimental != null) {
|
|
781
|
+
localVarHeaderParameter['X-SailPoint-Experimental'] = String(xSailPointExperimental);
|
|
782
|
+
}
|
|
783
|
+
(0, common_1.setSearchParams)(localVarUrlObj, localVarQueryParameter);
|
|
784
|
+
headersFromBaseOptions = baseOptions && baseOptions.headers ? baseOptions.headers : {};
|
|
785
|
+
localVarRequestOptions.headers = __assign(__assign(__assign({}, localVarHeaderParameter), headersFromBaseOptions), axiosOptions.headers);
|
|
786
|
+
return [2 /*return*/, {
|
|
787
|
+
url: (0, common_1.toPathString)(localVarUrlObj),
|
|
788
|
+
axiosOptions: localVarRequestOptions,
|
|
789
|
+
}];
|
|
790
|
+
});
|
|
791
|
+
});
|
|
792
|
+
},
|
|
622
793
|
/**
|
|
623
794
|
* 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.
|
|
624
795
|
* @summary List roles
|
|
@@ -680,6 +851,78 @@ var RolesApiAxiosParamCreator = function (configuration) {
|
|
|
680
851
|
});
|
|
681
852
|
});
|
|
682
853
|
},
|
|
854
|
+
/**
|
|
855
|
+
* 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.
|
|
856
|
+
* @summary List roles
|
|
857
|
+
* @param {string} [xSailPointExperimental] Use this header to enable this experimental API.
|
|
858
|
+
* @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.
|
|
859
|
+
* @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.
|
|
860
|
+
* @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.
|
|
861
|
+
* @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.
|
|
862
|
+
* @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.
|
|
863
|
+
* @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*
|
|
864
|
+
* @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.
|
|
865
|
+
* @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.
|
|
866
|
+
* @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.
|
|
867
|
+
* @param {*} [axiosOptions] Override http request option.
|
|
868
|
+
* @throws {RequiredError}
|
|
869
|
+
*/
|
|
870
|
+
listRolesV2: function (xSailPointExperimental, forSubadmin, limit, offset, count, cursor, filters, sorters, forSegmentIds, includeUnsegmented, axiosOptions) {
|
|
871
|
+
if (axiosOptions === void 0) { axiosOptions = {}; }
|
|
872
|
+
return __awaiter(_this, void 0, void 0, function () {
|
|
873
|
+
var localVarPath, localVarUrlObj, baseOptions, localVarRequestOptions, localVarHeaderParameter, localVarQueryParameter, headersFromBaseOptions;
|
|
874
|
+
return __generator(this, function (_a) {
|
|
875
|
+
if (xSailPointExperimental === undefined) {
|
|
876
|
+
xSailPointExperimental = 'true';
|
|
877
|
+
}
|
|
878
|
+
localVarPath = "/roles/v2";
|
|
879
|
+
localVarUrlObj = new URL(localVarPath, common_1.DUMMY_BASE_URL);
|
|
880
|
+
if (configuration) {
|
|
881
|
+
baseOptions = configuration.baseOptions;
|
|
882
|
+
}
|
|
883
|
+
localVarRequestOptions = __assign(__assign({ method: 'GET' }, baseOptions), axiosOptions);
|
|
884
|
+
localVarHeaderParameter = {};
|
|
885
|
+
localVarQueryParameter = {};
|
|
886
|
+
if (forSubadmin !== undefined) {
|
|
887
|
+
localVarQueryParameter['for-subadmin'] = forSubadmin;
|
|
888
|
+
}
|
|
889
|
+
if (limit !== undefined) {
|
|
890
|
+
localVarQueryParameter['limit'] = limit;
|
|
891
|
+
}
|
|
892
|
+
if (offset !== undefined) {
|
|
893
|
+
localVarQueryParameter['offset'] = offset;
|
|
894
|
+
}
|
|
895
|
+
if (count !== undefined) {
|
|
896
|
+
localVarQueryParameter['count'] = count;
|
|
897
|
+
}
|
|
898
|
+
if (cursor !== undefined) {
|
|
899
|
+
localVarQueryParameter['cursor'] = cursor;
|
|
900
|
+
}
|
|
901
|
+
if (filters !== undefined) {
|
|
902
|
+
localVarQueryParameter['filters'] = filters;
|
|
903
|
+
}
|
|
904
|
+
if (sorters !== undefined) {
|
|
905
|
+
localVarQueryParameter['sorters'] = sorters;
|
|
906
|
+
}
|
|
907
|
+
if (forSegmentIds !== undefined) {
|
|
908
|
+
localVarQueryParameter['for-segment-ids'] = forSegmentIds;
|
|
909
|
+
}
|
|
910
|
+
if (includeUnsegmented !== undefined) {
|
|
911
|
+
localVarQueryParameter['include-unsegmented'] = includeUnsegmented;
|
|
912
|
+
}
|
|
913
|
+
if (xSailPointExperimental != null) {
|
|
914
|
+
localVarHeaderParameter['X-SailPoint-Experimental'] = String(xSailPointExperimental);
|
|
915
|
+
}
|
|
916
|
+
(0, common_1.setSearchParams)(localVarUrlObj, localVarQueryParameter);
|
|
917
|
+
headersFromBaseOptions = baseOptions && baseOptions.headers ? baseOptions.headers : {};
|
|
918
|
+
localVarRequestOptions.headers = __assign(__assign(__assign({}, localVarHeaderParameter), headersFromBaseOptions), axiosOptions.headers);
|
|
919
|
+
return [2 /*return*/, {
|
|
920
|
+
url: (0, common_1.toPathString)(localVarUrlObj),
|
|
921
|
+
axiosOptions: localVarRequestOptions,
|
|
922
|
+
}];
|
|
923
|
+
});
|
|
924
|
+
});
|
|
925
|
+
},
|
|
683
926
|
/**
|
|
684
927
|
* 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.
|
|
685
928
|
* @summary Patch a specified role
|
|
@@ -778,6 +1021,79 @@ var RolesApiAxiosParamCreator = function (configuration) {
|
|
|
778
1021
|
});
|
|
779
1022
|
});
|
|
780
1023
|
},
|
|
1024
|
+
/**
|
|
1025
|
+
* 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.
|
|
1026
|
+
* @summary Filter roles by metadata
|
|
1027
|
+
* @param {Rolelistfilterdtov2} rolelistfilterdtov2
|
|
1028
|
+
* @param {string} [xSailPointExperimental] Use this header to enable this experimental API.
|
|
1029
|
+
* @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.
|
|
1030
|
+
* @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.
|
|
1031
|
+
* @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.
|
|
1032
|
+
* @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.
|
|
1033
|
+
* @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.
|
|
1034
|
+
* @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.
|
|
1035
|
+
* @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.
|
|
1036
|
+
* @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.
|
|
1037
|
+
* @param {*} [axiosOptions] Override http request option.
|
|
1038
|
+
* @throws {RequiredError}
|
|
1039
|
+
*/
|
|
1040
|
+
searchRolesByFilterV2: function (rolelistfilterdtov2, xSailPointExperimental, forSubadmin, limit, offset, count, cursor, sorters, forSegmentIds, includeUnsegmented, axiosOptions) {
|
|
1041
|
+
if (axiosOptions === void 0) { axiosOptions = {}; }
|
|
1042
|
+
return __awaiter(_this, void 0, void 0, function () {
|
|
1043
|
+
var localVarPath, localVarUrlObj, baseOptions, localVarRequestOptions, localVarHeaderParameter, localVarQueryParameter, headersFromBaseOptions;
|
|
1044
|
+
return __generator(this, function (_a) {
|
|
1045
|
+
// verify required parameter 'rolelistfilterdtov2' is not null or undefined
|
|
1046
|
+
(0, common_1.assertParamExists)('searchRolesByFilterV2', 'rolelistfilterdtov2', rolelistfilterdtov2);
|
|
1047
|
+
if (xSailPointExperimental === undefined) {
|
|
1048
|
+
xSailPointExperimental = 'true';
|
|
1049
|
+
}
|
|
1050
|
+
localVarPath = "/roles/v2/filter";
|
|
1051
|
+
localVarUrlObj = new URL(localVarPath, common_1.DUMMY_BASE_URL);
|
|
1052
|
+
if (configuration) {
|
|
1053
|
+
baseOptions = configuration.baseOptions;
|
|
1054
|
+
}
|
|
1055
|
+
localVarRequestOptions = __assign(__assign({ method: 'POST' }, baseOptions), axiosOptions);
|
|
1056
|
+
localVarHeaderParameter = {};
|
|
1057
|
+
localVarQueryParameter = {};
|
|
1058
|
+
if (forSubadmin !== undefined) {
|
|
1059
|
+
localVarQueryParameter['for-subadmin'] = forSubadmin;
|
|
1060
|
+
}
|
|
1061
|
+
if (limit !== undefined) {
|
|
1062
|
+
localVarQueryParameter['limit'] = limit;
|
|
1063
|
+
}
|
|
1064
|
+
if (offset !== undefined) {
|
|
1065
|
+
localVarQueryParameter['offset'] = offset;
|
|
1066
|
+
}
|
|
1067
|
+
if (count !== undefined) {
|
|
1068
|
+
localVarQueryParameter['count'] = count;
|
|
1069
|
+
}
|
|
1070
|
+
if (cursor !== undefined) {
|
|
1071
|
+
localVarQueryParameter['cursor'] = cursor;
|
|
1072
|
+
}
|
|
1073
|
+
if (sorters !== undefined) {
|
|
1074
|
+
localVarQueryParameter['sorters'] = sorters;
|
|
1075
|
+
}
|
|
1076
|
+
if (forSegmentIds !== undefined) {
|
|
1077
|
+
localVarQueryParameter['for-segment-ids'] = forSegmentIds;
|
|
1078
|
+
}
|
|
1079
|
+
if (includeUnsegmented !== undefined) {
|
|
1080
|
+
localVarQueryParameter['include-unsegmented'] = includeUnsegmented;
|
|
1081
|
+
}
|
|
1082
|
+
localVarHeaderParameter['Content-Type'] = 'application/json';
|
|
1083
|
+
if (xSailPointExperimental != null) {
|
|
1084
|
+
localVarHeaderParameter['X-SailPoint-Experimental'] = String(xSailPointExperimental);
|
|
1085
|
+
}
|
|
1086
|
+
(0, common_1.setSearchParams)(localVarUrlObj, localVarQueryParameter);
|
|
1087
|
+
headersFromBaseOptions = baseOptions && baseOptions.headers ? baseOptions.headers : {};
|
|
1088
|
+
localVarRequestOptions.headers = __assign(__assign(__assign({}, localVarHeaderParameter), headersFromBaseOptions), axiosOptions.headers);
|
|
1089
|
+
localVarRequestOptions.data = (0, common_1.serializeDataIfNeeded)(rolelistfilterdtov2, localVarRequestOptions, configuration);
|
|
1090
|
+
return [2 /*return*/, {
|
|
1091
|
+
url: (0, common_1.toPathString)(localVarUrlObj),
|
|
1092
|
+
axiosOptions: localVarRequestOptions,
|
|
1093
|
+
}];
|
|
1094
|
+
});
|
|
1095
|
+
});
|
|
1096
|
+
},
|
|
781
1097
|
/**
|
|
782
1098
|
* 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.
|
|
783
1099
|
* @summary Add a metadata to role.
|
|
@@ -1126,6 +1442,39 @@ var RolesApiFp = function (configuration) {
|
|
|
1126
1442
|
});
|
|
1127
1443
|
});
|
|
1128
1444
|
},
|
|
1445
|
+
/**
|
|
1446
|
+
* 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.
|
|
1447
|
+
* @summary List role\'s entitlements
|
|
1448
|
+
* @param {string} id Containing role\'s ID.
|
|
1449
|
+
* @param {string} [xSailPointExperimental] Use this header to enable this experimental API.
|
|
1450
|
+
* @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.
|
|
1451
|
+
* @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.
|
|
1452
|
+
* @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.
|
|
1453
|
+
* @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.
|
|
1454
|
+
* @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*
|
|
1455
|
+
* @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.
|
|
1456
|
+
* @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*.
|
|
1457
|
+
* @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*.
|
|
1458
|
+
* @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.
|
|
1459
|
+
* @param {*} [axiosOptions] Override http request option.
|
|
1460
|
+
* @throws {RequiredError}
|
|
1461
|
+
*/
|
|
1462
|
+
getRoleEntitlementsV2: function (id, xSailPointExperimental, limit, offset, count, cursor, filters, sorters, forSegmentIds, segmentedForIdentity, includeUnsegmented, axiosOptions) {
|
|
1463
|
+
var _a, _b, _c;
|
|
1464
|
+
return __awaiter(this, void 0, void 0, function () {
|
|
1465
|
+
var localVarAxiosArgs, localVarOperationServerIndex, localVarOperationServerBasePath;
|
|
1466
|
+
return __generator(this, function (_d) {
|
|
1467
|
+
switch (_d.label) {
|
|
1468
|
+
case 0: return [4 /*yield*/, localVarAxiosParamCreator.getRoleEntitlementsV2(id, xSailPointExperimental, limit, offset, count, cursor, filters, sorters, forSegmentIds, segmentedForIdentity, includeUnsegmented, axiosOptions)];
|
|
1469
|
+
case 1:
|
|
1470
|
+
localVarAxiosArgs = _d.sent();
|
|
1471
|
+
localVarOperationServerIndex = (_a = configuration === null || configuration === void 0 ? void 0 : configuration.serverIndex) !== null && _a !== void 0 ? _a : 0;
|
|
1472
|
+
localVarOperationServerBasePath = (_c = (_b = base_1.operationServerMap['RolesApi.getRoleEntitlementsV2']) === null || _b === void 0 ? void 0 : _b[localVarOperationServerIndex]) === null || _c === void 0 ? void 0 : _c.url;
|
|
1473
|
+
return [2 /*return*/, function (axios, basePath) { return (0, common_1.createRequestFunction)(localVarAxiosArgs, axios_1.default, base_1.BASE_PATH, configuration)(axios, localVarOperationServerBasePath || basePath); }];
|
|
1474
|
+
}
|
|
1475
|
+
});
|
|
1476
|
+
});
|
|
1477
|
+
},
|
|
1129
1478
|
/**
|
|
1130
1479
|
* 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.
|
|
1131
1480
|
* @summary Get a role
|
|
@@ -1149,6 +1498,30 @@ var RolesApiFp = function (configuration) {
|
|
|
1149
1498
|
});
|
|
1150
1499
|
});
|
|
1151
1500
|
},
|
|
1501
|
+
/**
|
|
1502
|
+
* 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.
|
|
1503
|
+
* @summary Get a role
|
|
1504
|
+
* @param {string} id ID of the Role
|
|
1505
|
+
* @param {string} [xSailPointExperimental] Use this header to enable this experimental API.
|
|
1506
|
+
* @param {*} [axiosOptions] Override http request option.
|
|
1507
|
+
* @throws {RequiredError}
|
|
1508
|
+
*/
|
|
1509
|
+
getRoleV2: function (id, xSailPointExperimental, axiosOptions) {
|
|
1510
|
+
var _a, _b, _c;
|
|
1511
|
+
return __awaiter(this, void 0, void 0, function () {
|
|
1512
|
+
var localVarAxiosArgs, localVarOperationServerIndex, localVarOperationServerBasePath;
|
|
1513
|
+
return __generator(this, function (_d) {
|
|
1514
|
+
switch (_d.label) {
|
|
1515
|
+
case 0: return [4 /*yield*/, localVarAxiosParamCreator.getRoleV2(id, xSailPointExperimental, axiosOptions)];
|
|
1516
|
+
case 1:
|
|
1517
|
+
localVarAxiosArgs = _d.sent();
|
|
1518
|
+
localVarOperationServerIndex = (_a = configuration === null || configuration === void 0 ? void 0 : configuration.serverIndex) !== null && _a !== void 0 ? _a : 0;
|
|
1519
|
+
localVarOperationServerBasePath = (_c = (_b = base_1.operationServerMap['RolesApi.getRoleV2']) === null || _b === void 0 ? void 0 : _b[localVarOperationServerIndex]) === null || _c === void 0 ? void 0 : _c.url;
|
|
1520
|
+
return [2 /*return*/, function (axios, basePath) { return (0, common_1.createRequestFunction)(localVarAxiosArgs, axios_1.default, base_1.BASE_PATH, configuration)(axios, localVarOperationServerBasePath || basePath); }];
|
|
1521
|
+
}
|
|
1522
|
+
});
|
|
1523
|
+
});
|
|
1524
|
+
},
|
|
1152
1525
|
/**
|
|
1153
1526
|
* 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.
|
|
1154
1527
|
* @summary List roles
|
|
@@ -1179,6 +1552,38 @@ var RolesApiFp = function (configuration) {
|
|
|
1179
1552
|
});
|
|
1180
1553
|
});
|
|
1181
1554
|
},
|
|
1555
|
+
/**
|
|
1556
|
+
* 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.
|
|
1557
|
+
* @summary List roles
|
|
1558
|
+
* @param {string} [xSailPointExperimental] Use this header to enable this experimental API.
|
|
1559
|
+
* @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.
|
|
1560
|
+
* @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.
|
|
1561
|
+
* @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.
|
|
1562
|
+
* @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.
|
|
1563
|
+
* @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.
|
|
1564
|
+
* @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*
|
|
1565
|
+
* @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.
|
|
1566
|
+
* @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.
|
|
1567
|
+
* @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.
|
|
1568
|
+
* @param {*} [axiosOptions] Override http request option.
|
|
1569
|
+
* @throws {RequiredError}
|
|
1570
|
+
*/
|
|
1571
|
+
listRolesV2: function (xSailPointExperimental, forSubadmin, limit, offset, count, cursor, filters, sorters, forSegmentIds, includeUnsegmented, axiosOptions) {
|
|
1572
|
+
var _a, _b, _c;
|
|
1573
|
+
return __awaiter(this, void 0, void 0, function () {
|
|
1574
|
+
var localVarAxiosArgs, localVarOperationServerIndex, localVarOperationServerBasePath;
|
|
1575
|
+
return __generator(this, function (_d) {
|
|
1576
|
+
switch (_d.label) {
|
|
1577
|
+
case 0: return [4 /*yield*/, localVarAxiosParamCreator.listRolesV2(xSailPointExperimental, forSubadmin, limit, offset, count, cursor, filters, sorters, forSegmentIds, includeUnsegmented, axiosOptions)];
|
|
1578
|
+
case 1:
|
|
1579
|
+
localVarAxiosArgs = _d.sent();
|
|
1580
|
+
localVarOperationServerIndex = (_a = configuration === null || configuration === void 0 ? void 0 : configuration.serverIndex) !== null && _a !== void 0 ? _a : 0;
|
|
1581
|
+
localVarOperationServerBasePath = (_c = (_b = base_1.operationServerMap['RolesApi.listRolesV2']) === null || _b === void 0 ? void 0 : _b[localVarOperationServerIndex]) === null || _c === void 0 ? void 0 : _c.url;
|
|
1582
|
+
return [2 /*return*/, function (axios, basePath) { return (0, common_1.createRequestFunction)(localVarAxiosArgs, axios_1.default, base_1.BASE_PATH, configuration)(axios, localVarOperationServerBasePath || basePath); }];
|
|
1583
|
+
}
|
|
1584
|
+
});
|
|
1585
|
+
});
|
|
1586
|
+
},
|
|
1182
1587
|
/**
|
|
1183
1588
|
* 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.
|
|
1184
1589
|
* @summary Patch a specified role
|
|
@@ -1233,6 +1638,38 @@ var RolesApiFp = function (configuration) {
|
|
|
1233
1638
|
});
|
|
1234
1639
|
});
|
|
1235
1640
|
},
|
|
1641
|
+
/**
|
|
1642
|
+
* 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.
|
|
1643
|
+
* @summary Filter roles by metadata
|
|
1644
|
+
* @param {Rolelistfilterdtov2} rolelistfilterdtov2
|
|
1645
|
+
* @param {string} [xSailPointExperimental] Use this header to enable this experimental API.
|
|
1646
|
+
* @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.
|
|
1647
|
+
* @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.
|
|
1648
|
+
* @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.
|
|
1649
|
+
* @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.
|
|
1650
|
+
* @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.
|
|
1651
|
+
* @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.
|
|
1652
|
+
* @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.
|
|
1653
|
+
* @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.
|
|
1654
|
+
* @param {*} [axiosOptions] Override http request option.
|
|
1655
|
+
* @throws {RequiredError}
|
|
1656
|
+
*/
|
|
1657
|
+
searchRolesByFilterV2: function (rolelistfilterdtov2, xSailPointExperimental, forSubadmin, limit, offset, count, cursor, sorters, forSegmentIds, includeUnsegmented, axiosOptions) {
|
|
1658
|
+
var _a, _b, _c;
|
|
1659
|
+
return __awaiter(this, void 0, void 0, function () {
|
|
1660
|
+
var localVarAxiosArgs, localVarOperationServerIndex, localVarOperationServerBasePath;
|
|
1661
|
+
return __generator(this, function (_d) {
|
|
1662
|
+
switch (_d.label) {
|
|
1663
|
+
case 0: return [4 /*yield*/, localVarAxiosParamCreator.searchRolesByFilterV2(rolelistfilterdtov2, xSailPointExperimental, forSubadmin, limit, offset, count, cursor, sorters, forSegmentIds, includeUnsegmented, axiosOptions)];
|
|
1664
|
+
case 1:
|
|
1665
|
+
localVarAxiosArgs = _d.sent();
|
|
1666
|
+
localVarOperationServerIndex = (_a = configuration === null || configuration === void 0 ? void 0 : configuration.serverIndex) !== null && _a !== void 0 ? _a : 0;
|
|
1667
|
+
localVarOperationServerBasePath = (_c = (_b = base_1.operationServerMap['RolesApi.searchRolesByFilterV2']) === null || _b === void 0 ? void 0 : _b[localVarOperationServerIndex]) === null || _c === void 0 ? void 0 : _c.url;
|
|
1668
|
+
return [2 /*return*/, function (axios, basePath) { return (0, common_1.createRequestFunction)(localVarAxiosArgs, axios_1.default, base_1.BASE_PATH, configuration)(axios, localVarOperationServerBasePath || basePath); }];
|
|
1669
|
+
}
|
|
1670
|
+
});
|
|
1671
|
+
});
|
|
1672
|
+
},
|
|
1236
1673
|
/**
|
|
1237
1674
|
* 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.
|
|
1238
1675
|
* @summary Add a metadata to role.
|
|
@@ -1416,6 +1853,16 @@ var RolesApiFactory = function (configuration, basePath, axios) {
|
|
|
1416
1853
|
getRoleEntitlementsV1: function (requestParameters, axiosOptions) {
|
|
1417
1854
|
return localVarFp.getRoleEntitlementsV1(requestParameters.id, requestParameters.limit, requestParameters.offset, requestParameters.count, requestParameters.filters, requestParameters.sorters, axiosOptions).then(function (request) { return request(axios, basePath); });
|
|
1418
1855
|
},
|
|
1856
|
+
/**
|
|
1857
|
+
* 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.
|
|
1858
|
+
* @summary List role\'s entitlements
|
|
1859
|
+
* @param {RolesApiGetRoleEntitlementsV2Request} requestParameters Request parameters.
|
|
1860
|
+
* @param {*} [axiosOptions] Override http request option.
|
|
1861
|
+
* @throws {RequiredError}
|
|
1862
|
+
*/
|
|
1863
|
+
getRoleEntitlementsV2: function (requestParameters, axiosOptions) {
|
|
1864
|
+
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); });
|
|
1865
|
+
},
|
|
1419
1866
|
/**
|
|
1420
1867
|
* 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.
|
|
1421
1868
|
* @summary Get a role
|
|
@@ -1426,6 +1873,16 @@ var RolesApiFactory = function (configuration, basePath, axios) {
|
|
|
1426
1873
|
getRoleV1: function (requestParameters, axiosOptions) {
|
|
1427
1874
|
return localVarFp.getRoleV1(requestParameters.id, axiosOptions).then(function (request) { return request(axios, basePath); });
|
|
1428
1875
|
},
|
|
1876
|
+
/**
|
|
1877
|
+
* 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.
|
|
1878
|
+
* @summary Get a role
|
|
1879
|
+
* @param {RolesApiGetRoleV2Request} requestParameters Request parameters.
|
|
1880
|
+
* @param {*} [axiosOptions] Override http request option.
|
|
1881
|
+
* @throws {RequiredError}
|
|
1882
|
+
*/
|
|
1883
|
+
getRoleV2: function (requestParameters, axiosOptions) {
|
|
1884
|
+
return localVarFp.getRoleV2(requestParameters.id, requestParameters.xSailPointExperimental, axiosOptions).then(function (request) { return request(axios, basePath); });
|
|
1885
|
+
},
|
|
1429
1886
|
/**
|
|
1430
1887
|
* 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.
|
|
1431
1888
|
* @summary List roles
|
|
@@ -1437,6 +1894,17 @@ var RolesApiFactory = function (configuration, basePath, axios) {
|
|
|
1437
1894
|
if (requestParameters === void 0) { requestParameters = {}; }
|
|
1438
1895
|
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); });
|
|
1439
1896
|
},
|
|
1897
|
+
/**
|
|
1898
|
+
* 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.
|
|
1899
|
+
* @summary List roles
|
|
1900
|
+
* @param {RolesApiListRolesV2Request} requestParameters Request parameters.
|
|
1901
|
+
* @param {*} [axiosOptions] Override http request option.
|
|
1902
|
+
* @throws {RequiredError}
|
|
1903
|
+
*/
|
|
1904
|
+
listRolesV2: function (requestParameters, axiosOptions) {
|
|
1905
|
+
if (requestParameters === void 0) { requestParameters = {}; }
|
|
1906
|
+
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); });
|
|
1907
|
+
},
|
|
1440
1908
|
/**
|
|
1441
1909
|
* 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.
|
|
1442
1910
|
* @summary Patch a specified role
|
|
@@ -1458,6 +1926,16 @@ var RolesApiFactory = function (configuration, basePath, axios) {
|
|
|
1458
1926
|
if (requestParameters === void 0) { requestParameters = {}; }
|
|
1459
1927
|
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); });
|
|
1460
1928
|
},
|
|
1929
|
+
/**
|
|
1930
|
+
* 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.
|
|
1931
|
+
* @summary Filter roles by metadata
|
|
1932
|
+
* @param {RolesApiSearchRolesByFilterV2Request} requestParameters Request parameters.
|
|
1933
|
+
* @param {*} [axiosOptions] Override http request option.
|
|
1934
|
+
* @throws {RequiredError}
|
|
1935
|
+
*/
|
|
1936
|
+
searchRolesByFilterV2: function (requestParameters, axiosOptions) {
|
|
1937
|
+
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); });
|
|
1938
|
+
},
|
|
1461
1939
|
/**
|
|
1462
1940
|
* 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.
|
|
1463
1941
|
* @summary Add a metadata to role.
|
|
@@ -1607,6 +2085,18 @@ var RolesApi = /** @class */ (function (_super) {
|
|
|
1607
2085
|
var _this = this;
|
|
1608
2086
|
return (0, exports.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); });
|
|
1609
2087
|
};
|
|
2088
|
+
/**
|
|
2089
|
+
* 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.
|
|
2090
|
+
* @summary List role\'s entitlements
|
|
2091
|
+
* @param {RolesApiGetRoleEntitlementsV2Request} requestParameters Request parameters.
|
|
2092
|
+
* @param {*} [axiosOptions] Override http request option.
|
|
2093
|
+
* @throws {RequiredError}
|
|
2094
|
+
* @memberof RolesApi
|
|
2095
|
+
*/
|
|
2096
|
+
RolesApi.prototype.getRoleEntitlementsV2 = function (requestParameters, axiosOptions) {
|
|
2097
|
+
var _this = this;
|
|
2098
|
+
return (0, exports.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); });
|
|
2099
|
+
};
|
|
1610
2100
|
/**
|
|
1611
2101
|
* 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.
|
|
1612
2102
|
* @summary Get a role
|
|
@@ -1619,6 +2109,18 @@ var RolesApi = /** @class */ (function (_super) {
|
|
|
1619
2109
|
var _this = this;
|
|
1620
2110
|
return (0, exports.RolesApiFp)(this.configuration).getRoleV1(requestParameters.id, axiosOptions).then(function (request) { return request(_this.axios, _this.basePath); });
|
|
1621
2111
|
};
|
|
2112
|
+
/**
|
|
2113
|
+
* 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.
|
|
2114
|
+
* @summary Get a role
|
|
2115
|
+
* @param {RolesApiGetRoleV2Request} requestParameters Request parameters.
|
|
2116
|
+
* @param {*} [axiosOptions] Override http request option.
|
|
2117
|
+
* @throws {RequiredError}
|
|
2118
|
+
* @memberof RolesApi
|
|
2119
|
+
*/
|
|
2120
|
+
RolesApi.prototype.getRoleV2 = function (requestParameters, axiosOptions) {
|
|
2121
|
+
var _this = this;
|
|
2122
|
+
return (0, exports.RolesApiFp)(this.configuration).getRoleV2(requestParameters.id, requestParameters.xSailPointExperimental, axiosOptions).then(function (request) { return request(_this.axios, _this.basePath); });
|
|
2123
|
+
};
|
|
1622
2124
|
/**
|
|
1623
2125
|
* 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.
|
|
1624
2126
|
* @summary List roles
|
|
@@ -1632,6 +2134,19 @@ var RolesApi = /** @class */ (function (_super) {
|
|
|
1632
2134
|
if (requestParameters === void 0) { requestParameters = {}; }
|
|
1633
2135
|
return (0, exports.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); });
|
|
1634
2136
|
};
|
|
2137
|
+
/**
|
|
2138
|
+
* 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.
|
|
2139
|
+
* @summary List roles
|
|
2140
|
+
* @param {RolesApiListRolesV2Request} requestParameters Request parameters.
|
|
2141
|
+
* @param {*} [axiosOptions] Override http request option.
|
|
2142
|
+
* @throws {RequiredError}
|
|
2143
|
+
* @memberof RolesApi
|
|
2144
|
+
*/
|
|
2145
|
+
RolesApi.prototype.listRolesV2 = function (requestParameters, axiosOptions) {
|
|
2146
|
+
var _this = this;
|
|
2147
|
+
if (requestParameters === void 0) { requestParameters = {}; }
|
|
2148
|
+
return (0, exports.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); });
|
|
2149
|
+
};
|
|
1635
2150
|
/**
|
|
1636
2151
|
* 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.
|
|
1637
2152
|
* @summary Patch a specified role
|
|
@@ -1657,6 +2172,18 @@ var RolesApi = /** @class */ (function (_super) {
|
|
|
1657
2172
|
if (requestParameters === void 0) { requestParameters = {}; }
|
|
1658
2173
|
return (0, exports.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); });
|
|
1659
2174
|
};
|
|
2175
|
+
/**
|
|
2176
|
+
* 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.
|
|
2177
|
+
* @summary Filter roles by metadata
|
|
2178
|
+
* @param {RolesApiSearchRolesByFilterV2Request} requestParameters Request parameters.
|
|
2179
|
+
* @param {*} [axiosOptions] Override http request option.
|
|
2180
|
+
* @throws {RequiredError}
|
|
2181
|
+
* @memberof RolesApi
|
|
2182
|
+
*/
|
|
2183
|
+
RolesApi.prototype.searchRolesByFilterV2 = function (requestParameters, axiosOptions) {
|
|
2184
|
+
var _this = this;
|
|
2185
|
+
return (0, exports.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); });
|
|
2186
|
+
};
|
|
1660
2187
|
/**
|
|
1661
2188
|
* 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.
|
|
1662
2189
|
* @summary Add a metadata to role.
|