sailpoint-api-client 1.6.0 → 1.6.1
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/beta/README.md +2 -2
- package/beta/api.ts +64 -65
- package/beta/common.ts +2 -2
- package/beta/package.json +1 -1
- package/dist/beta/api.d.ts +58 -59
- package/dist/beta/api.js +15 -15
- package/dist/beta/api.js.map +1 -1
- package/dist/beta/common.js +1 -1
- package/dist/v2024/api.d.ts +14 -26
- package/dist/v2024/api.js +17 -16
- package/dist/v2024/api.js.map +1 -1
- package/dist/v2024/common.js +1 -1
- package/dist/v2025/api.d.ts +16 -36
- package/dist/v2025/api.js +23 -30
- package/dist/v2025/api.js.map +1 -1
- package/dist/v2025/common.js +1 -1
- package/dist/v3/api.d.ts +109 -109
- package/dist/v3/api.js +60 -59
- package/dist/v3/api.js.map +1 -1
- package/dist/v3/common.js +1 -1
- package/package.json +1 -1
- package/v2024/README.md +2 -2
- package/v2024/api.ts +20 -32
- package/v2024/common.ts +2 -2
- package/v2024/package.json +1 -1
- package/v2025/README.md +2 -2
- package/v2025/api.ts +26 -54
- package/v2025/common.ts +2 -2
- package/v2025/package.json +1 -1
- package/v3/README.md +2 -2
- package/v3/api.ts +115 -115
- package/v3/common.ts +2 -2
- package/v3/package.json +1 -1
package/v3/api.ts
CHANGED
|
@@ -391,43 +391,43 @@ export interface AccessModelMetadataValuesInner {
|
|
|
391
391
|
'status'?: string;
|
|
392
392
|
}
|
|
393
393
|
/**
|
|
394
|
-
* Access
|
|
394
|
+
* Access profile.
|
|
395
395
|
* @export
|
|
396
396
|
* @interface AccessProfile
|
|
397
397
|
*/
|
|
398
398
|
export interface AccessProfile {
|
|
399
399
|
/**
|
|
400
|
-
*
|
|
400
|
+
* Access profile ID.
|
|
401
401
|
* @type {string}
|
|
402
402
|
* @memberof AccessProfile
|
|
403
403
|
*/
|
|
404
404
|
'id'?: string;
|
|
405
405
|
/**
|
|
406
|
-
*
|
|
406
|
+
* Access profile name.
|
|
407
407
|
* @type {string}
|
|
408
408
|
* @memberof AccessProfile
|
|
409
409
|
*/
|
|
410
410
|
'name': string;
|
|
411
411
|
/**
|
|
412
|
-
*
|
|
412
|
+
* Access profile description.
|
|
413
413
|
* @type {string}
|
|
414
414
|
* @memberof AccessProfile
|
|
415
415
|
*/
|
|
416
416
|
'description'?: string | null;
|
|
417
417
|
/**
|
|
418
|
-
* Date the
|
|
418
|
+
* Date and time when the access profile was created.
|
|
419
419
|
* @type {string}
|
|
420
420
|
* @memberof AccessProfile
|
|
421
421
|
*/
|
|
422
422
|
'created'?: string;
|
|
423
423
|
/**
|
|
424
|
-
* Date the
|
|
424
|
+
* Date and time when the access profile was last modified.
|
|
425
425
|
* @type {string}
|
|
426
426
|
* @memberof AccessProfile
|
|
427
427
|
*/
|
|
428
428
|
'modified'?: string;
|
|
429
429
|
/**
|
|
430
|
-
*
|
|
430
|
+
* Indicates whether the access profile is enabled. If it\'s enabled, you must include at least one entitlement.
|
|
431
431
|
* @type {boolean}
|
|
432
432
|
* @memberof AccessProfile
|
|
433
433
|
*/
|
|
@@ -445,13 +445,13 @@ export interface AccessProfile {
|
|
|
445
445
|
*/
|
|
446
446
|
'source': AccessProfileSourceRef;
|
|
447
447
|
/**
|
|
448
|
-
*
|
|
448
|
+
* List of entitlements associated with the access profile. If `enabled` is false, this can be empty. Otherwise, it must contain at least one entitlement.
|
|
449
449
|
* @type {Array<EntitlementRef>}
|
|
450
450
|
* @memberof AccessProfile
|
|
451
451
|
*/
|
|
452
452
|
'entitlements'?: Array<EntitlementRef> | null;
|
|
453
453
|
/**
|
|
454
|
-
*
|
|
454
|
+
* Indicates whether the access profile is requestable by access request. Currently, making an access profile non-requestable is only supported for customers enabled with the new Request Center. Otherwise, attempting to create an access profile with a value **false** in this field results in a 400 error.
|
|
455
455
|
* @type {boolean}
|
|
456
456
|
* @memberof AccessProfile
|
|
457
457
|
*/
|
|
@@ -469,7 +469,7 @@ export interface AccessProfile {
|
|
|
469
469
|
*/
|
|
470
470
|
'revocationRequestConfig'?: Revocability | null;
|
|
471
471
|
/**
|
|
472
|
-
* List of IDs
|
|
472
|
+
* List of segment IDs, if any, that the access profile is assigned to.
|
|
473
473
|
* @type {Array<string>}
|
|
474
474
|
* @memberof AccessProfile
|
|
475
475
|
*/
|
|
@@ -488,13 +488,13 @@ export interface AccessProfile {
|
|
|
488
488
|
*/
|
|
489
489
|
export interface AccessProfileApprovalScheme {
|
|
490
490
|
/**
|
|
491
|
-
* Describes the individual or group that is responsible for an approval step.
|
|
491
|
+
* Describes the individual or group that is responsible for an approval step. These are the possible values: **APP_OWNER**: The owner of the Application **OWNER**: Owner of the associated Access Profile or Role **SOURCE_OWNER**: Owner of the Source associated with an Access Profile **MANAGER**: Manager of the Identity making the request **GOVERNANCE_GROUP**: A Governance Group, the ID of which is specified by the **approverId** field
|
|
492
492
|
* @type {string}
|
|
493
493
|
* @memberof AccessProfileApprovalScheme
|
|
494
494
|
*/
|
|
495
495
|
'approverType'?: AccessProfileApprovalSchemeApproverTypeV3;
|
|
496
496
|
/**
|
|
497
|
-
*
|
|
497
|
+
* Specific approver ID. Only use this when the `approverType` is `GOVERNANCE_GROUP`.
|
|
498
498
|
* @type {string}
|
|
499
499
|
* @memberof AccessProfileApprovalScheme
|
|
500
500
|
*/
|
|
@@ -985,19 +985,19 @@ export interface AccessProfileRole {
|
|
|
985
985
|
*/
|
|
986
986
|
export interface AccessProfileSourceRef {
|
|
987
987
|
/**
|
|
988
|
-
*
|
|
988
|
+
* ID of the source the access profile is associated with.
|
|
989
989
|
* @type {string}
|
|
990
990
|
* @memberof AccessProfileSourceRef
|
|
991
991
|
*/
|
|
992
992
|
'id'?: string;
|
|
993
993
|
/**
|
|
994
|
-
*
|
|
994
|
+
* Source\'s DTO type.
|
|
995
995
|
* @type {string}
|
|
996
996
|
* @memberof AccessProfileSourceRef
|
|
997
997
|
*/
|
|
998
998
|
'type'?: AccessProfileSourceRefTypeV3;
|
|
999
999
|
/**
|
|
1000
|
-
*
|
|
1000
|
+
* Source name.
|
|
1001
1001
|
* @type {string}
|
|
1002
1002
|
* @memberof AccessProfileSourceRef
|
|
1003
1003
|
*/
|
|
@@ -15098,7 +15098,7 @@ export const OwnerDtoTypeV3 = {
|
|
|
15098
15098
|
export type OwnerDtoTypeV3 = typeof OwnerDtoTypeV3[keyof typeof OwnerDtoTypeV3];
|
|
15099
15099
|
|
|
15100
15100
|
/**
|
|
15101
|
-
*
|
|
15101
|
+
* Owner of the object.
|
|
15102
15102
|
* @export
|
|
15103
15103
|
* @interface OwnerReference
|
|
15104
15104
|
*/
|
|
@@ -15110,13 +15110,13 @@ export interface OwnerReference {
|
|
|
15110
15110
|
*/
|
|
15111
15111
|
'type'?: OwnerReferenceTypeV3;
|
|
15112
15112
|
/**
|
|
15113
|
-
*
|
|
15113
|
+
* Owner\'s identity ID.
|
|
15114
15114
|
* @type {string}
|
|
15115
15115
|
* @memberof OwnerReference
|
|
15116
15116
|
*/
|
|
15117
15117
|
'id'?: string;
|
|
15118
15118
|
/**
|
|
15119
|
-
*
|
|
15119
|
+
* Owner\'s name. It may be left null or omitted in a POST or PATCH. If set, it must match the current value of the owner\'s display name, otherwise a 400 Bad Request error will result.
|
|
15120
15120
|
* @type {string}
|
|
15121
15121
|
* @memberof OwnerReference
|
|
15122
15122
|
*/
|
|
@@ -15695,19 +15695,6 @@ export const PatOwnerTypeV3 = {
|
|
|
15695
15695
|
|
|
15696
15696
|
export type PatOwnerTypeV3 = typeof PatOwnerTypeV3[keyof typeof PatOwnerTypeV3];
|
|
15697
15697
|
|
|
15698
|
-
/**
|
|
15699
|
-
* A JSONPatch document as defined by [RFC 6902 - JSON Patch](https://tools.ietf.org/html/rfc6902). Only `replace` operations are accepted by this endpoint.
|
|
15700
|
-
* @export
|
|
15701
|
-
* @interface PatchServiceDeskIntegrationRequest
|
|
15702
|
-
*/
|
|
15703
|
-
export interface PatchServiceDeskIntegrationRequest {
|
|
15704
|
-
/**
|
|
15705
|
-
* Operations to be applied
|
|
15706
|
-
* @type {Array<JsonPatchOperation>}
|
|
15707
|
-
* @memberof PatchServiceDeskIntegrationRequest
|
|
15708
|
-
*/
|
|
15709
|
-
'operations'?: Array<JsonPatchOperation>;
|
|
15710
|
-
}
|
|
15711
15698
|
/**
|
|
15712
15699
|
*
|
|
15713
15700
|
* @export
|
|
@@ -16036,7 +16023,7 @@ export interface ProvisioningConfigPlanInitializerScript {
|
|
|
16036
16023
|
'source'?: string;
|
|
16037
16024
|
}
|
|
16038
16025
|
/**
|
|
16039
|
-
* Defines matching criteria for an
|
|
16026
|
+
* Defines matching criteria for an account to be provisioned with a specific access profile.
|
|
16040
16027
|
* @export
|
|
16041
16028
|
* @interface ProvisioningCriteriaLevel1
|
|
16042
16029
|
*/
|
|
@@ -16048,19 +16035,19 @@ export interface ProvisioningCriteriaLevel1 {
|
|
|
16048
16035
|
*/
|
|
16049
16036
|
'operation'?: ProvisioningCriteriaOperation;
|
|
16050
16037
|
/**
|
|
16051
|
-
* Name of the
|
|
16038
|
+
* Name of the account attribute to be tested. If **operation** is one of `EQUALS`, `NOT_EQUALS`, `CONTAINS`, or `HAS`, this field is required. Otherwise, specifying it results in an error.
|
|
16052
16039
|
* @type {string}
|
|
16053
16040
|
* @memberof ProvisioningCriteriaLevel1
|
|
16054
16041
|
*/
|
|
16055
16042
|
'attribute'?: string | null;
|
|
16056
16043
|
/**
|
|
16057
|
-
* String value to test the
|
|
16044
|
+
* String value to test the account attribute w/r/t the specified operation. If the operation is one of `EQUALS`, `NOT_EQUALS`, or `CONTAINS`, this field is required. Otherwise, specifying it results in an error. If the attribute is not string-typed, the API will convert it to the appropriate type.
|
|
16058
16045
|
* @type {string}
|
|
16059
16046
|
* @memberof ProvisioningCriteriaLevel1
|
|
16060
16047
|
*/
|
|
16061
16048
|
'value'?: string | null;
|
|
16062
16049
|
/**
|
|
16063
|
-
* Array of child criteria.
|
|
16050
|
+
* Array of child criteria. This field is required if the operation is `AND` or `OR`. Otherwise, it must be left null. A maximum of three levels of criteria are supported, including leaf nodes.
|
|
16064
16051
|
* @type {Array<ProvisioningCriteriaLevel2>}
|
|
16065
16052
|
* @memberof ProvisioningCriteriaLevel1
|
|
16066
16053
|
*/
|
|
@@ -16069,7 +16056,7 @@ export interface ProvisioningCriteriaLevel1 {
|
|
|
16069
16056
|
|
|
16070
16057
|
|
|
16071
16058
|
/**
|
|
16072
|
-
* Defines matching criteria for an
|
|
16059
|
+
* Defines matching criteria for an account to be provisioned with a specific access profile.
|
|
16073
16060
|
* @export
|
|
16074
16061
|
* @interface ProvisioningCriteriaLevel2
|
|
16075
16062
|
*/
|
|
@@ -16081,19 +16068,19 @@ export interface ProvisioningCriteriaLevel2 {
|
|
|
16081
16068
|
*/
|
|
16082
16069
|
'operation'?: ProvisioningCriteriaOperation;
|
|
16083
16070
|
/**
|
|
16084
|
-
* Name of the
|
|
16071
|
+
* Name of the account attribute to be tested. If **operation** is one of `EQUALS`, `NOT_EQUALS`, `CONTAINS`, or `HAS`, this field is required. Otherwise, specifying it results in an error.
|
|
16085
16072
|
* @type {string}
|
|
16086
16073
|
* @memberof ProvisioningCriteriaLevel2
|
|
16087
16074
|
*/
|
|
16088
16075
|
'attribute'?: string | null;
|
|
16089
16076
|
/**
|
|
16090
|
-
* String value to test the
|
|
16077
|
+
* String value to test the account attribute w/r/t the specified operation. If the operation is one of `EQUALS`, `NOT_EQUALS`, or `CONTAINS`, this field is required. Otherwise, specifying it results in an error. If the attribute is not string-typed, the API will convert it to the appropriate type.
|
|
16091
16078
|
* @type {string}
|
|
16092
16079
|
* @memberof ProvisioningCriteriaLevel2
|
|
16093
16080
|
*/
|
|
16094
16081
|
'value'?: string | null;
|
|
16095
16082
|
/**
|
|
16096
|
-
* Array of child criteria.
|
|
16083
|
+
* Array of child criteria. This field is required if the operation is `AND` or `OR`. Otherwise, it must be left null. A maximum of three levels of criteria are supported, including leaf nodes.
|
|
16097
16084
|
* @type {Array<ProvisioningCriteriaLevel3>}
|
|
16098
16085
|
* @memberof ProvisioningCriteriaLevel2
|
|
16099
16086
|
*/
|
|
@@ -16102,7 +16089,7 @@ export interface ProvisioningCriteriaLevel2 {
|
|
|
16102
16089
|
|
|
16103
16090
|
|
|
16104
16091
|
/**
|
|
16105
|
-
* Defines matching criteria for an
|
|
16092
|
+
* Defines matching criteria for an account to be provisioned with a specific access profile.
|
|
16106
16093
|
* @export
|
|
16107
16094
|
* @interface ProvisioningCriteriaLevel3
|
|
16108
16095
|
*/
|
|
@@ -16114,19 +16101,19 @@ export interface ProvisioningCriteriaLevel3 {
|
|
|
16114
16101
|
*/
|
|
16115
16102
|
'operation'?: ProvisioningCriteriaOperation;
|
|
16116
16103
|
/**
|
|
16117
|
-
* Name of the
|
|
16104
|
+
* Name of the account attribute to be tested. If **operation** is one of `EQUALS`, `NOT_EQUALS`, `CONTAINS`, or `HAS`, this field is required. Otherwise, specifying it results in an error.
|
|
16118
16105
|
* @type {string}
|
|
16119
16106
|
* @memberof ProvisioningCriteriaLevel3
|
|
16120
16107
|
*/
|
|
16121
16108
|
'attribute'?: string | null;
|
|
16122
16109
|
/**
|
|
16123
|
-
* String value to test the
|
|
16110
|
+
* String value to test the account attribute w/r/t the specified operation. If the operation is one of `EQUALS`, `NOT_EQUALS`, or `CONTAINS`, this field is required. Otherwise, specifying it results in an error. If the attribute is not string-typed, the API will convert it to the appropriate type.
|
|
16124
16111
|
* @type {string}
|
|
16125
16112
|
* @memberof ProvisioningCriteriaLevel3
|
|
16126
16113
|
*/
|
|
16127
|
-
'value'?: string;
|
|
16114
|
+
'value'?: string | null;
|
|
16128
16115
|
/**
|
|
16129
|
-
* Array of child criteria.
|
|
16116
|
+
* Array of child criteria. This field is required if the operation is `AND` or `OR`. Otherwise, it must be left null. A maximum of three levels of criteria are supported, including leaf nodes.
|
|
16130
16117
|
* @type {string}
|
|
16131
16118
|
* @memberof ProvisioningCriteriaLevel3
|
|
16132
16119
|
*/
|
|
@@ -16135,7 +16122,7 @@ export interface ProvisioningCriteriaLevel3 {
|
|
|
16135
16122
|
|
|
16136
16123
|
|
|
16137
16124
|
/**
|
|
16138
|
-
* Supported operations on ProvisioningCriteria
|
|
16125
|
+
* Supported operations on `ProvisioningCriteria`.
|
|
16139
16126
|
* @export
|
|
16140
16127
|
* @enum {string}
|
|
16141
16128
|
*/
|
|
@@ -17226,19 +17213,25 @@ export interface RequestOnBehalfOfConfig {
|
|
|
17226
17213
|
*/
|
|
17227
17214
|
export interface Requestability {
|
|
17228
17215
|
/**
|
|
17229
|
-
*
|
|
17216
|
+
* Indicates whether the requester of the containing object must provide comments justifying the request.
|
|
17230
17217
|
* @type {boolean}
|
|
17231
17218
|
* @memberof Requestability
|
|
17232
17219
|
*/
|
|
17233
17220
|
'commentsRequired'?: boolean | null;
|
|
17234
17221
|
/**
|
|
17235
|
-
*
|
|
17222
|
+
* Indicates whether an approver must provide comments when denying the request.
|
|
17236
17223
|
* @type {boolean}
|
|
17237
17224
|
* @memberof Requestability
|
|
17238
17225
|
*/
|
|
17239
17226
|
'denialCommentsRequired'?: boolean | null;
|
|
17240
17227
|
/**
|
|
17241
|
-
*
|
|
17228
|
+
* Indicates whether reauthorization is required for the request.
|
|
17229
|
+
* @type {boolean}
|
|
17230
|
+
* @memberof Requestability
|
|
17231
|
+
*/
|
|
17232
|
+
'reauthorizationRequired'?: boolean | null;
|
|
17233
|
+
/**
|
|
17234
|
+
* List describing the steps involved in approving the request.
|
|
17242
17235
|
* @type {Array<AccessProfileApprovalScheme>}
|
|
17243
17236
|
* @memberof Requestability
|
|
17244
17237
|
*/
|
|
@@ -17262,6 +17255,12 @@ export interface RequestabilityForRole {
|
|
|
17262
17255
|
* @memberof RequestabilityForRole
|
|
17263
17256
|
*/
|
|
17264
17257
|
'denialCommentsRequired'?: boolean | null;
|
|
17258
|
+
/**
|
|
17259
|
+
* Indicates whether reauthorization is required for the request.
|
|
17260
|
+
* @type {boolean}
|
|
17261
|
+
* @memberof RequestabilityForRole
|
|
17262
|
+
*/
|
|
17263
|
+
'reauthorizationRequired'?: boolean | null;
|
|
17265
17264
|
/**
|
|
17266
17265
|
* List describing the steps in approving the request
|
|
17267
17266
|
* @type {Array<ApprovalSchemeForRole>}
|
|
@@ -18433,7 +18432,7 @@ export type ReviewerTypeV3 = typeof ReviewerTypeV3[keyof typeof ReviewerTypeV3];
|
|
|
18433
18432
|
*/
|
|
18434
18433
|
export interface Revocability {
|
|
18435
18434
|
/**
|
|
18436
|
-
* List describing the steps in approving the revocation request
|
|
18435
|
+
* List describing the steps involved in approving the revocation request.
|
|
18437
18436
|
* @type {Array<AccessProfileApprovalScheme>}
|
|
18438
18437
|
* @memberof Revocability
|
|
18439
18438
|
*/
|
|
@@ -24745,6 +24744,7 @@ export const WorkflowExecutionStatusV3 = {
|
|
|
24745
24744
|
Completed: 'Completed',
|
|
24746
24745
|
Failed: 'Failed',
|
|
24747
24746
|
Canceled: 'Canceled',
|
|
24747
|
+
Queued: 'Queued',
|
|
24748
24748
|
Running: 'Running'
|
|
24749
24749
|
} as const;
|
|
24750
24750
|
|
|
@@ -25301,7 +25301,7 @@ export type WorkflowTriggerAttributesFrequencyV3 = typeof WorkflowTriggerAttribu
|
|
|
25301
25301
|
export const AccessProfilesApiAxiosParamCreator = function (configuration?: Configuration) {
|
|
25302
25302
|
return {
|
|
25303
25303
|
/**
|
|
25304
|
-
* Create an access profile. A user with
|
|
25304
|
+
* Create an access profile. A user with `ROLE_SUBADMIN` or `SOURCE_SUBADMIN` authority must be associated with the access profile\'s source. The maximum supported length for the description field is 2000 characters. Longer descriptions will be preserved for existing access profiles. However, any new access profiles as well as any updates to existing descriptions are limited to 2000 characters. >**Note:** To use this endpoint, you need all the listed scopes.
|
|
25305
25305
|
* @summary Create Access Profile
|
|
25306
25306
|
* @param {AccessProfile} accessProfile
|
|
25307
25307
|
* @param {*} [axiosOptions] Override http request option.
|
|
@@ -25560,13 +25560,13 @@ export const AccessProfilesApiAxiosParamCreator = function (configuration?: Conf
|
|
|
25560
25560
|
};
|
|
25561
25561
|
},
|
|
25562
25562
|
/**
|
|
25563
|
-
* Get a list of access profiles.
|
|
25563
|
+
* Get a list of access profiles. >**Note:** When you filter for access profiles that have the \'+\' symbol in their names, the response is blank.
|
|
25564
25564
|
* @summary List Access Profiles
|
|
25565
25565
|
* @param {string} [forSubadmin] Filters the returned list according to what is visible to the indicated ROLE_SUBADMIN or SOURCE_SUBADMIN identity. The value of the parameter is either an identity ID or the special value **me**, which is shorthand for the calling identity\'s ID. If you specify an identity that isn\'t a subadmin, the API returns a 400 Bad Request error.
|
|
25566
25566
|
* @param {number} [limit] Max number of results to return. See [V3 API Standard Collection Parameters](https://developer.sailpoint.com/idn/api/standard-collection-parameters) for more information.
|
|
25567
25567
|
* @param {number} [offset] Offset into the full result set. Usually specified with *limit* to paginate through the results. See [V3 API Standard Collection Parameters](https://developer.sailpoint.com/idn/api/standard-collection-parameters) for more information.
|
|
25568
25568
|
* @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 [V3 API Standard Collection Parameters](https://developer.sailpoint.com/idn/api/standard-collection-parameters) for more information.
|
|
25569
|
-
* @param {string} [filters] Filter results using the standard syntax described in [V3 API Standard Collection Parameters](https://developer.sailpoint.com/idn/api/standard-collection-parameters#filtering-results) Filtering is supported for the following fields and operators: **id**: *eq, in* **name**: *eq, sw* **created**: *gt,
|
|
25569
|
+
* @param {string} [filters] Filter results using the standard syntax described in [V3 API Standard Collection Parameters](https://developer.sailpoint.com/idn/api/standard-collection-parameters#filtering-results) Filtering is supported for the following fields and operators: **id**: *eq, in* **name**: *eq, sw* **created**: *gt, ge, le* **modified**: *gt, lt, ge, le* **owner.id**: *eq, in* **requestable**: *eq* **source.id**: *eq, in* Supported composite operators are *and, or* Filtering is not supported for access profiles and entitlements that have the \'+\' symbol in their names.
|
|
25570
25570
|
* @param {string} [sorters] Sort results using the standard syntax described in [V3 API Standard Collection Parameters](https://developer.sailpoint.com/idn/api/standard-collection-parameters#sorting-results) Sorting is supported for the following fields: **name, created, modified**
|
|
25571
25571
|
* @param {string} [forSegmentIds] Filters access profiles to only those assigned to the segment(s) with the specified IDs. If segmentation is currently unavailable, specifying this parameter results in an error.
|
|
25572
25572
|
* @param {boolean} [includeUnsegmented] Indicates whether the response list should contain unsegmented access profiles. If `for-segment-ids` is absent or empty, specifying *include-unsegmented* as `false` results in an error.
|
|
@@ -25704,7 +25704,7 @@ export const AccessProfilesApiFp = function(configuration?: Configuration) {
|
|
|
25704
25704
|
const localVarAxiosParamCreator = AccessProfilesApiAxiosParamCreator(configuration)
|
|
25705
25705
|
return {
|
|
25706
25706
|
/**
|
|
25707
|
-
* Create an access profile. A user with
|
|
25707
|
+
* Create an access profile. A user with `ROLE_SUBADMIN` or `SOURCE_SUBADMIN` authority must be associated with the access profile\'s source. The maximum supported length for the description field is 2000 characters. Longer descriptions will be preserved for existing access profiles. However, any new access profiles as well as any updates to existing descriptions are limited to 2000 characters. >**Note:** To use this endpoint, you need all the listed scopes.
|
|
25708
25708
|
* @summary Create Access Profile
|
|
25709
25709
|
* @param {AccessProfile} accessProfile
|
|
25710
25710
|
* @param {*} [axiosOptions] Override http request option.
|
|
@@ -25774,13 +25774,13 @@ export const AccessProfilesApiFp = function(configuration?: Configuration) {
|
|
|
25774
25774
|
return (axios, basePath) => createRequestFunction(localVarAxiosArgs, globalAxios, BASE_PATH, configuration)(axios, localVarOperationServerBasePath || basePath);
|
|
25775
25775
|
},
|
|
25776
25776
|
/**
|
|
25777
|
-
* Get a list of access profiles.
|
|
25777
|
+
* Get a list of access profiles. >**Note:** When you filter for access profiles that have the \'+\' symbol in their names, the response is blank.
|
|
25778
25778
|
* @summary List Access Profiles
|
|
25779
25779
|
* @param {string} [forSubadmin] Filters the returned list according to what is visible to the indicated ROLE_SUBADMIN or SOURCE_SUBADMIN identity. The value of the parameter is either an identity ID or the special value **me**, which is shorthand for the calling identity\'s ID. If you specify an identity that isn\'t a subadmin, the API returns a 400 Bad Request error.
|
|
25780
25780
|
* @param {number} [limit] Max number of results to return. See [V3 API Standard Collection Parameters](https://developer.sailpoint.com/idn/api/standard-collection-parameters) for more information.
|
|
25781
25781
|
* @param {number} [offset] Offset into the full result set. Usually specified with *limit* to paginate through the results. See [V3 API Standard Collection Parameters](https://developer.sailpoint.com/idn/api/standard-collection-parameters) for more information.
|
|
25782
25782
|
* @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 [V3 API Standard Collection Parameters](https://developer.sailpoint.com/idn/api/standard-collection-parameters) for more information.
|
|
25783
|
-
* @param {string} [filters] Filter results using the standard syntax described in [V3 API Standard Collection Parameters](https://developer.sailpoint.com/idn/api/standard-collection-parameters#filtering-results) Filtering is supported for the following fields and operators: **id**: *eq, in* **name**: *eq, sw* **created**: *gt,
|
|
25783
|
+
* @param {string} [filters] Filter results using the standard syntax described in [V3 API Standard Collection Parameters](https://developer.sailpoint.com/idn/api/standard-collection-parameters#filtering-results) Filtering is supported for the following fields and operators: **id**: *eq, in* **name**: *eq, sw* **created**: *gt, ge, le* **modified**: *gt, lt, ge, le* **owner.id**: *eq, in* **requestable**: *eq* **source.id**: *eq, in* Supported composite operators are *and, or* Filtering is not supported for access profiles and entitlements that have the \'+\' symbol in their names.
|
|
25784
25784
|
* @param {string} [sorters] Sort results using the standard syntax described in [V3 API Standard Collection Parameters](https://developer.sailpoint.com/idn/api/standard-collection-parameters#sorting-results) Sorting is supported for the following fields: **name, created, modified**
|
|
25785
25785
|
* @param {string} [forSegmentIds] Filters access profiles to only those assigned to the segment(s) with the specified IDs. If segmentation is currently unavailable, specifying this parameter results in an error.
|
|
25786
25786
|
* @param {boolean} [includeUnsegmented] Indicates whether the response list should contain unsegmented access profiles. If `for-segment-ids` is absent or empty, specifying *include-unsegmented* as `false` results in an error.
|
|
@@ -25818,7 +25818,7 @@ export const AccessProfilesApiFactory = function (configuration?: Configuration,
|
|
|
25818
25818
|
const localVarFp = AccessProfilesApiFp(configuration)
|
|
25819
25819
|
return {
|
|
25820
25820
|
/**
|
|
25821
|
-
* Create an access profile. A user with
|
|
25821
|
+
* Create an access profile. A user with `ROLE_SUBADMIN` or `SOURCE_SUBADMIN` authority must be associated with the access profile\'s source. The maximum supported length for the description field is 2000 characters. Longer descriptions will be preserved for existing access profiles. However, any new access profiles as well as any updates to existing descriptions are limited to 2000 characters. >**Note:** To use this endpoint, you need all the listed scopes.
|
|
25822
25822
|
* @summary Create Access Profile
|
|
25823
25823
|
* @param {AccessProfilesApiCreateAccessProfileRequest} requestParameters Request parameters.
|
|
25824
25824
|
* @param {*} [axiosOptions] Override http request option.
|
|
@@ -25868,7 +25868,7 @@ export const AccessProfilesApiFactory = function (configuration?: Configuration,
|
|
|
25868
25868
|
return localVarFp.getAccessProfileEntitlements(requestParameters.id, requestParameters.limit, requestParameters.offset, requestParameters.count, requestParameters.filters, requestParameters.sorters, axiosOptions).then((request) => request(axios, basePath));
|
|
25869
25869
|
},
|
|
25870
25870
|
/**
|
|
25871
|
-
* Get a list of access profiles.
|
|
25871
|
+
* Get a list of access profiles. >**Note:** When you filter for access profiles that have the \'+\' symbol in their names, the response is blank.
|
|
25872
25872
|
* @summary List Access Profiles
|
|
25873
25873
|
* @param {AccessProfilesApiListAccessProfilesRequest} requestParameters Request parameters.
|
|
25874
25874
|
* @param {*} [axiosOptions] Override http request option.
|
|
@@ -26030,7 +26030,7 @@ export interface AccessProfilesApiListAccessProfilesRequest {
|
|
|
26030
26030
|
readonly count?: boolean
|
|
26031
26031
|
|
|
26032
26032
|
/**
|
|
26033
|
-
* Filter results using the standard syntax described in [V3 API Standard Collection Parameters](https://developer.sailpoint.com/idn/api/standard-collection-parameters#filtering-results) Filtering is supported for the following fields and operators: **id**: *eq, in* **name**: *eq, sw* **created**: *gt,
|
|
26033
|
+
* Filter results using the standard syntax described in [V3 API Standard Collection Parameters](https://developer.sailpoint.com/idn/api/standard-collection-parameters#filtering-results) Filtering is supported for the following fields and operators: **id**: *eq, in* **name**: *eq, sw* **created**: *gt, ge, le* **modified**: *gt, lt, ge, le* **owner.id**: *eq, in* **requestable**: *eq* **source.id**: *eq, in* Supported composite operators are *and, or* Filtering is not supported for access profiles and entitlements that have the \'+\' symbol in their names.
|
|
26034
26034
|
* @type {string}
|
|
26035
26035
|
* @memberof AccessProfilesApiListAccessProfiles
|
|
26036
26036
|
*/
|
|
@@ -26087,7 +26087,7 @@ export interface AccessProfilesApiPatchAccessProfileRequest {
|
|
|
26087
26087
|
*/
|
|
26088
26088
|
export class AccessProfilesApi extends BaseAPI {
|
|
26089
26089
|
/**
|
|
26090
|
-
* Create an access profile. A user with
|
|
26090
|
+
* Create an access profile. A user with `ROLE_SUBADMIN` or `SOURCE_SUBADMIN` authority must be associated with the access profile\'s source. The maximum supported length for the description field is 2000 characters. Longer descriptions will be preserved for existing access profiles. However, any new access profiles as well as any updates to existing descriptions are limited to 2000 characters. >**Note:** To use this endpoint, you need all the listed scopes.
|
|
26091
26091
|
* @summary Create Access Profile
|
|
26092
26092
|
* @param {AccessProfilesApiCreateAccessProfileRequest} requestParameters Request parameters.
|
|
26093
26093
|
* @param {*} [axiosOptions] Override http request option.
|
|
@@ -26147,7 +26147,7 @@ export class AccessProfilesApi extends BaseAPI {
|
|
|
26147
26147
|
}
|
|
26148
26148
|
|
|
26149
26149
|
/**
|
|
26150
|
-
* Get a list of access profiles.
|
|
26150
|
+
* Get a list of access profiles. >**Note:** When you filter for access profiles that have the \'+\' symbol in their names, the response is blank.
|
|
26151
26151
|
* @summary List Access Profiles
|
|
26152
26152
|
* @param {AccessProfilesApiListAccessProfilesRequest} requestParameters Request parameters.
|
|
26153
26153
|
* @param {*} [axiosOptions] Override http request option.
|
|
@@ -26396,7 +26396,7 @@ export const AccessRequestApprovalsApiAxiosParamCreator = function (configuratio
|
|
|
26396
26396
|
* @param {number} [limit] Max number of results to return. See [V3 API Standard Collection Parameters](https://developer.sailpoint.com/idn/api/standard-collection-parameters) for more information.
|
|
26397
26397
|
* @param {number} [offset] Offset into the full result set. Usually specified with *limit* to paginate through the results. See [V3 API Standard Collection Parameters](https://developer.sailpoint.com/idn/api/standard-collection-parameters) for more information.
|
|
26398
26398
|
* @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 [V3 API Standard Collection Parameters](https://developer.sailpoint.com/idn/api/standard-collection-parameters) for more information.
|
|
26399
|
-
* @param {string} [filters] Filter results using the standard syntax described in [V3 API Standard Collection Parameters](https://developer.sailpoint.com/idn/api/standard-collection-parameters#filtering-results) Filtering is supported for the following fields and operators: **id**: *eq, in* **requestedFor.id**: *eq, in* **modified**: *gt, lt, ge, le, eq, in* **accessRequestId**: *eq, in*
|
|
26399
|
+
* @param {string} [filters] Filter results using the standard syntax described in [V3 API Standard Collection Parameters](https://developer.sailpoint.com/idn/api/standard-collection-parameters#filtering-results) Filtering is supported for the following fields and operators: **id**: *eq, in* **requestedFor.id**: *eq, in* **modified**: *gt, lt, ge, le, eq, in* **accessRequestId**: *eq, in* **created**: *gt, lt, ge, le, eq, in*
|
|
26400
26400
|
* @param {string} [sorters] Sort results using the standard syntax described in [V3 API Standard Collection Parameters](https://developer.sailpoint.com/idn/api/standard-collection-parameters#sorting-results) Sorting is supported for the following fields: **created, modified**
|
|
26401
26401
|
* @param {*} [axiosOptions] Override http request option.
|
|
26402
26402
|
* @throws {RequiredError}
|
|
@@ -26582,7 +26582,7 @@ export const AccessRequestApprovalsApiFp = function(configuration?: Configuratio
|
|
|
26582
26582
|
* @param {number} [limit] Max number of results to return. See [V3 API Standard Collection Parameters](https://developer.sailpoint.com/idn/api/standard-collection-parameters) for more information.
|
|
26583
26583
|
* @param {number} [offset] Offset into the full result set. Usually specified with *limit* to paginate through the results. See [V3 API Standard Collection Parameters](https://developer.sailpoint.com/idn/api/standard-collection-parameters) for more information.
|
|
26584
26584
|
* @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 [V3 API Standard Collection Parameters](https://developer.sailpoint.com/idn/api/standard-collection-parameters) for more information.
|
|
26585
|
-
* @param {string} [filters] Filter results using the standard syntax described in [V3 API Standard Collection Parameters](https://developer.sailpoint.com/idn/api/standard-collection-parameters#filtering-results) Filtering is supported for the following fields and operators: **id**: *eq, in* **requestedFor.id**: *eq, in* **modified**: *gt, lt, ge, le, eq, in* **accessRequestId**: *eq, in*
|
|
26585
|
+
* @param {string} [filters] Filter results using the standard syntax described in [V3 API Standard Collection Parameters](https://developer.sailpoint.com/idn/api/standard-collection-parameters#filtering-results) Filtering is supported for the following fields and operators: **id**: *eq, in* **requestedFor.id**: *eq, in* **modified**: *gt, lt, ge, le, eq, in* **accessRequestId**: *eq, in* **created**: *gt, lt, ge, le, eq, in*
|
|
26586
26586
|
* @param {string} [sorters] Sort results using the standard syntax described in [V3 API Standard Collection Parameters](https://developer.sailpoint.com/idn/api/standard-collection-parameters#sorting-results) Sorting is supported for the following fields: **created, modified**
|
|
26587
26587
|
* @param {*} [axiosOptions] Override http request option.
|
|
26588
26588
|
* @throws {RequiredError}
|
|
@@ -26827,7 +26827,7 @@ export interface AccessRequestApprovalsApiListPendingApprovalsRequest {
|
|
|
26827
26827
|
readonly count?: boolean
|
|
26828
26828
|
|
|
26829
26829
|
/**
|
|
26830
|
-
* Filter results using the standard syntax described in [V3 API Standard Collection Parameters](https://developer.sailpoint.com/idn/api/standard-collection-parameters#filtering-results) Filtering is supported for the following fields and operators: **id**: *eq, in* **requestedFor.id**: *eq, in* **modified**: *gt, lt, ge, le, eq, in* **accessRequestId**: *eq, in*
|
|
26830
|
+
* Filter results using the standard syntax described in [V3 API Standard Collection Parameters](https://developer.sailpoint.com/idn/api/standard-collection-parameters#filtering-results) Filtering is supported for the following fields and operators: **id**: *eq, in* **requestedFor.id**: *eq, in* **modified**: *gt, lt, ge, le, eq, in* **accessRequestId**: *eq, in* **created**: *gt, lt, ge, le, eq, in*
|
|
26831
26831
|
* @type {string}
|
|
26832
26832
|
* @memberof AccessRequestApprovalsApiListPendingApprovals
|
|
26833
26833
|
*/
|
|
@@ -50478,9 +50478,9 @@ export const RolesApiAxiosParamCreator = function (configuration?: Configuration
|
|
|
50478
50478
|
};
|
|
50479
50479
|
},
|
|
50480
50480
|
/**
|
|
50481
|
-
*
|
|
50482
|
-
* @summary Delete
|
|
50483
|
-
* @param {string} id ID
|
|
50481
|
+
* Delete a role by ID. A user with ROLE_SUBADMIN authority may only call this API if all access profiles included in the role are associated to sources with management workgroups the ROLE_SUBADMIN is a member of.
|
|
50482
|
+
* @summary Delete Role
|
|
50483
|
+
* @param {string} id Role ID.
|
|
50484
50484
|
* @param {*} [axiosOptions] Override http request option.
|
|
50485
50485
|
* @throws {RequiredError}
|
|
50486
50486
|
*/
|
|
@@ -50520,9 +50520,9 @@ export const RolesApiAxiosParamCreator = function (configuration?: Configuration
|
|
|
50520
50520
|
};
|
|
50521
50521
|
},
|
|
50522
50522
|
/**
|
|
50523
|
-
*
|
|
50524
|
-
* @summary Get
|
|
50525
|
-
* @param {string} id ID
|
|
50523
|
+
* Get a role by ID. A user 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 the ROLE_SUBADMIN is a member of.
|
|
50524
|
+
* @summary Get Role
|
|
50525
|
+
* @param {string} id Role ID.
|
|
50526
50526
|
* @param {*} [axiosOptions] Override http request option.
|
|
50527
50527
|
* @throws {RequiredError}
|
|
50528
50528
|
*/
|
|
@@ -50635,7 +50635,7 @@ export const RolesApiAxiosParamCreator = function (configuration?: Configuration
|
|
|
50635
50635
|
* @param {number} [limit] Note that for this API the maximum value for limit is 50. See [V3 API Standard Collection Parameters](https://developer.sailpoint.com/idn/api/standard-collection-parameters) for more information.
|
|
50636
50636
|
* @param {number} [offset] Offset into the full result set. Usually specified with *limit* to paginate through the results. See [V3 API Standard Collection Parameters](https://developer.sailpoint.com/idn/api/standard-collection-parameters) for more information.
|
|
50637
50637
|
* @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 [V3 API Standard Collection Parameters](https://developer.sailpoint.com/idn/api/standard-collection-parameters) for more information.
|
|
50638
|
-
* @param {string} [filters] Filter results using the standard syntax described in [V3 API Standard Collection Parameters](https://developer.sailpoint.com/idn/api/standard-collection-parameters#filtering-results) Filtering is supported for the following fields and operators: **id**: *eq, in* **name**: *eq, sw* **created**: *gt,
|
|
50638
|
+
* @param {string} [filters] Filter results using the standard syntax described in [V3 API Standard Collection Parameters](https://developer.sailpoint.com/idn/api/standard-collection-parameters#filtering-results) Filtering is supported for the following fields and operators: **id**: *eq, in* **name**: *eq, sw* **created**: *gt, ge, le* **modified**: *lt, ge, le* **owner.id**: *eq, in* **requestable**: *eq* **dimensional**: *eq*
|
|
50639
50639
|
* @param {string} [sorters] Sort results using the standard syntax described in [V3 API Standard Collection Parameters](https://developer.sailpoint.com/idn/api/standard-collection-parameters#sorting-results) Sorting is supported for the following fields: **name, created, modified**
|
|
50640
50640
|
* @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.
|
|
50641
50641
|
* @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.
|
|
@@ -50707,9 +50707,9 @@ export const RolesApiAxiosParamCreator = function (configuration?: Configuration
|
|
|
50707
50707
|
};
|
|
50708
50708
|
},
|
|
50709
50709
|
/**
|
|
50710
|
-
*
|
|
50711
|
-
* @summary Patch
|
|
50712
|
-
* @param {string} id ID
|
|
50710
|
+
* Update an existing role, using the [JSON Patch](https://tools.ietf.org/html/rfc6902) syntax. The following fields are patchable: * name * description * enabled * owner * accessProfiles * entitlements * membership * requestable * accessRequestConfig * revokeRequestConfig * segments * accessModelMetadata A user 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 the ROLE_SUBADMIN is a member of. The maximum supported length for the description field is 2000 characters. ISC preserves longer descriptions for existing roles. However, any new roles as well as any updates to existing descriptions are 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.
|
|
50711
|
+
* @summary Patch Role
|
|
50712
|
+
* @param {string} id Role ID to patch
|
|
50713
50713
|
* @param {Array<JsonPatchOperation>} jsonPatchOperation
|
|
50714
50714
|
* @param {*} [axiosOptions] Override http request option.
|
|
50715
50715
|
* @throws {RequiredError}
|
|
@@ -50791,9 +50791,9 @@ export const RolesApiFp = function(configuration?: Configuration) {
|
|
|
50791
50791
|
return (axios, basePath) => createRequestFunction(localVarAxiosArgs, globalAxios, BASE_PATH, configuration)(axios, localVarOperationServerBasePath || basePath);
|
|
50792
50792
|
},
|
|
50793
50793
|
/**
|
|
50794
|
-
*
|
|
50795
|
-
* @summary Delete
|
|
50796
|
-
* @param {string} id ID
|
|
50794
|
+
* Delete a role by ID. A user with ROLE_SUBADMIN authority may only call this API if all access profiles included in the role are associated to sources with management workgroups the ROLE_SUBADMIN is a member of.
|
|
50795
|
+
* @summary Delete Role
|
|
50796
|
+
* @param {string} id Role ID.
|
|
50797
50797
|
* @param {*} [axiosOptions] Override http request option.
|
|
50798
50798
|
* @throws {RequiredError}
|
|
50799
50799
|
*/
|
|
@@ -50804,9 +50804,9 @@ export const RolesApiFp = function(configuration?: Configuration) {
|
|
|
50804
50804
|
return (axios, basePath) => createRequestFunction(localVarAxiosArgs, globalAxios, BASE_PATH, configuration)(axios, localVarOperationServerBasePath || basePath);
|
|
50805
50805
|
},
|
|
50806
50806
|
/**
|
|
50807
|
-
*
|
|
50808
|
-
* @summary Get
|
|
50809
|
-
* @param {string} id ID
|
|
50807
|
+
* Get a role by ID. A user 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 the ROLE_SUBADMIN is a member of.
|
|
50808
|
+
* @summary Get Role
|
|
50809
|
+
* @param {string} id Role ID.
|
|
50810
50810
|
* @param {*} [axiosOptions] Override http request option.
|
|
50811
50811
|
* @throws {RequiredError}
|
|
50812
50812
|
*/
|
|
@@ -50841,7 +50841,7 @@ export const RolesApiFp = function(configuration?: Configuration) {
|
|
|
50841
50841
|
* @param {number} [limit] Note that for this API the maximum value for limit is 50. See [V3 API Standard Collection Parameters](https://developer.sailpoint.com/idn/api/standard-collection-parameters) for more information.
|
|
50842
50842
|
* @param {number} [offset] Offset into the full result set. Usually specified with *limit* to paginate through the results. See [V3 API Standard Collection Parameters](https://developer.sailpoint.com/idn/api/standard-collection-parameters) for more information.
|
|
50843
50843
|
* @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 [V3 API Standard Collection Parameters](https://developer.sailpoint.com/idn/api/standard-collection-parameters) for more information.
|
|
50844
|
-
* @param {string} [filters] Filter results using the standard syntax described in [V3 API Standard Collection Parameters](https://developer.sailpoint.com/idn/api/standard-collection-parameters#filtering-results) Filtering is supported for the following fields and operators: **id**: *eq, in* **name**: *eq, sw* **created**: *gt,
|
|
50844
|
+
* @param {string} [filters] Filter results using the standard syntax described in [V3 API Standard Collection Parameters](https://developer.sailpoint.com/idn/api/standard-collection-parameters#filtering-results) Filtering is supported for the following fields and operators: **id**: *eq, in* **name**: *eq, sw* **created**: *gt, ge, le* **modified**: *lt, ge, le* **owner.id**: *eq, in* **requestable**: *eq* **dimensional**: *eq*
|
|
50845
50845
|
* @param {string} [sorters] Sort results using the standard syntax described in [V3 API Standard Collection Parameters](https://developer.sailpoint.com/idn/api/standard-collection-parameters#sorting-results) Sorting is supported for the following fields: **name, created, modified**
|
|
50846
50846
|
* @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.
|
|
50847
50847
|
* @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.
|
|
@@ -50855,9 +50855,9 @@ export const RolesApiFp = function(configuration?: Configuration) {
|
|
|
50855
50855
|
return (axios, basePath) => createRequestFunction(localVarAxiosArgs, globalAxios, BASE_PATH, configuration)(axios, localVarOperationServerBasePath || basePath);
|
|
50856
50856
|
},
|
|
50857
50857
|
/**
|
|
50858
|
-
*
|
|
50859
|
-
* @summary Patch
|
|
50860
|
-
* @param {string} id ID
|
|
50858
|
+
* Update an existing role, using the [JSON Patch](https://tools.ietf.org/html/rfc6902) syntax. The following fields are patchable: * name * description * enabled * owner * accessProfiles * entitlements * membership * requestable * accessRequestConfig * revokeRequestConfig * segments * accessModelMetadata A user 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 the ROLE_SUBADMIN is a member of. The maximum supported length for the description field is 2000 characters. ISC preserves longer descriptions for existing roles. However, any new roles as well as any updates to existing descriptions are 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.
|
|
50859
|
+
* @summary Patch Role
|
|
50860
|
+
* @param {string} id Role ID to patch
|
|
50861
50861
|
* @param {Array<JsonPatchOperation>} jsonPatchOperation
|
|
50862
50862
|
* @param {*} [axiosOptions] Override http request option.
|
|
50863
50863
|
* @throws {RequiredError}
|
|
@@ -50899,8 +50899,8 @@ export const RolesApiFactory = function (configuration?: Configuration, basePath
|
|
|
50899
50899
|
return localVarFp.deleteBulkRoles(requestParameters.roleBulkDeleteRequest, axiosOptions).then((request) => request(axios, basePath));
|
|
50900
50900
|
},
|
|
50901
50901
|
/**
|
|
50902
|
-
*
|
|
50903
|
-
* @summary Delete
|
|
50902
|
+
* Delete a role by ID. A user with ROLE_SUBADMIN authority may only call this API if all access profiles included in the role are associated to sources with management workgroups the ROLE_SUBADMIN is a member of.
|
|
50903
|
+
* @summary Delete Role
|
|
50904
50904
|
* @param {RolesApiDeleteRoleRequest} requestParameters Request parameters.
|
|
50905
50905
|
* @param {*} [axiosOptions] Override http request option.
|
|
50906
50906
|
* @throws {RequiredError}
|
|
@@ -50909,8 +50909,8 @@ export const RolesApiFactory = function (configuration?: Configuration, basePath
|
|
|
50909
50909
|
return localVarFp.deleteRole(requestParameters.id, axiosOptions).then((request) => request(axios, basePath));
|
|
50910
50910
|
},
|
|
50911
50911
|
/**
|
|
50912
|
-
*
|
|
50913
|
-
* @summary Get
|
|
50912
|
+
* Get a role by ID. A user 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 the ROLE_SUBADMIN is a member of.
|
|
50913
|
+
* @summary Get Role
|
|
50914
50914
|
* @param {RolesApiGetRoleRequest} requestParameters Request parameters.
|
|
50915
50915
|
* @param {*} [axiosOptions] Override http request option.
|
|
50916
50916
|
* @throws {RequiredError}
|
|
@@ -50939,8 +50939,8 @@ export const RolesApiFactory = function (configuration?: Configuration, basePath
|
|
|
50939
50939
|
return localVarFp.listRoles(requestParameters.forSubadmin, requestParameters.limit, requestParameters.offset, requestParameters.count, requestParameters.filters, requestParameters.sorters, requestParameters.forSegmentIds, requestParameters.includeUnsegmented, axiosOptions).then((request) => request(axios, basePath));
|
|
50940
50940
|
},
|
|
50941
50941
|
/**
|
|
50942
|
-
*
|
|
50943
|
-
* @summary Patch
|
|
50942
|
+
* Update an existing role, using the [JSON Patch](https://tools.ietf.org/html/rfc6902) syntax. The following fields are patchable: * name * description * enabled * owner * accessProfiles * entitlements * membership * requestable * accessRequestConfig * revokeRequestConfig * segments * accessModelMetadata A user 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 the ROLE_SUBADMIN is a member of. The maximum supported length for the description field is 2000 characters. ISC preserves longer descriptions for existing roles. However, any new roles as well as any updates to existing descriptions are 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.
|
|
50943
|
+
* @summary Patch Role
|
|
50944
50944
|
* @param {RolesApiPatchRoleRequest} requestParameters Request parameters.
|
|
50945
50945
|
* @param {*} [axiosOptions] Override http request option.
|
|
50946
50946
|
* @throws {RequiredError}
|
|
@@ -50986,7 +50986,7 @@ export interface RolesApiDeleteBulkRolesRequest {
|
|
|
50986
50986
|
*/
|
|
50987
50987
|
export interface RolesApiDeleteRoleRequest {
|
|
50988
50988
|
/**
|
|
50989
|
-
* ID
|
|
50989
|
+
* Role ID.
|
|
50990
50990
|
* @type {string}
|
|
50991
50991
|
* @memberof RolesApiDeleteRole
|
|
50992
50992
|
*/
|
|
@@ -51000,7 +51000,7 @@ export interface RolesApiDeleteRoleRequest {
|
|
|
51000
51000
|
*/
|
|
51001
51001
|
export interface RolesApiGetRoleRequest {
|
|
51002
51002
|
/**
|
|
51003
|
-
* ID
|
|
51003
|
+
* Role ID.
|
|
51004
51004
|
* @type {string}
|
|
51005
51005
|
* @memberof RolesApiGetRole
|
|
51006
51006
|
*/
|
|
@@ -51091,7 +51091,7 @@ export interface RolesApiListRolesRequest {
|
|
|
51091
51091
|
readonly count?: boolean
|
|
51092
51092
|
|
|
51093
51093
|
/**
|
|
51094
|
-
* Filter results using the standard syntax described in [V3 API Standard Collection Parameters](https://developer.sailpoint.com/idn/api/standard-collection-parameters#filtering-results) Filtering is supported for the following fields and operators: **id**: *eq, in* **name**: *eq, sw* **created**: *gt,
|
|
51094
|
+
* Filter results using the standard syntax described in [V3 API Standard Collection Parameters](https://developer.sailpoint.com/idn/api/standard-collection-parameters#filtering-results) Filtering is supported for the following fields and operators: **id**: *eq, in* **name**: *eq, sw* **created**: *gt, ge, le* **modified**: *lt, ge, le* **owner.id**: *eq, in* **requestable**: *eq* **dimensional**: *eq*
|
|
51095
51095
|
* @type {string}
|
|
51096
51096
|
* @memberof RolesApiListRoles
|
|
51097
51097
|
*/
|
|
@@ -51126,7 +51126,7 @@ export interface RolesApiListRolesRequest {
|
|
|
51126
51126
|
*/
|
|
51127
51127
|
export interface RolesApiPatchRoleRequest {
|
|
51128
51128
|
/**
|
|
51129
|
-
* ID
|
|
51129
|
+
* Role ID to patch
|
|
51130
51130
|
* @type {string}
|
|
51131
51131
|
* @memberof RolesApiPatchRole
|
|
51132
51132
|
*/
|
|
@@ -51172,8 +51172,8 @@ export class RolesApi extends BaseAPI {
|
|
|
51172
51172
|
}
|
|
51173
51173
|
|
|
51174
51174
|
/**
|
|
51175
|
-
*
|
|
51176
|
-
* @summary Delete
|
|
51175
|
+
* Delete a role by ID. A user with ROLE_SUBADMIN authority may only call this API if all access profiles included in the role are associated to sources with management workgroups the ROLE_SUBADMIN is a member of.
|
|
51176
|
+
* @summary Delete Role
|
|
51177
51177
|
* @param {RolesApiDeleteRoleRequest} requestParameters Request parameters.
|
|
51178
51178
|
* @param {*} [axiosOptions] Override http request option.
|
|
51179
51179
|
* @throws {RequiredError}
|
|
@@ -51184,8 +51184,8 @@ export class RolesApi extends BaseAPI {
|
|
|
51184
51184
|
}
|
|
51185
51185
|
|
|
51186
51186
|
/**
|
|
51187
|
-
*
|
|
51188
|
-
* @summary Get
|
|
51187
|
+
* Get a role by ID. A user 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 the ROLE_SUBADMIN is a member of.
|
|
51188
|
+
* @summary Get Role
|
|
51189
51189
|
* @param {RolesApiGetRoleRequest} requestParameters Request parameters.
|
|
51190
51190
|
* @param {*} [axiosOptions] Override http request option.
|
|
51191
51191
|
* @throws {RequiredError}
|
|
@@ -51220,8 +51220,8 @@ export class RolesApi extends BaseAPI {
|
|
|
51220
51220
|
}
|
|
51221
51221
|
|
|
51222
51222
|
/**
|
|
51223
|
-
*
|
|
51224
|
-
* @summary Patch
|
|
51223
|
+
* Update an existing role, using the [JSON Patch](https://tools.ietf.org/html/rfc6902) syntax. The following fields are patchable: * name * description * enabled * owner * accessProfiles * entitlements * membership * requestable * accessRequestConfig * revokeRequestConfig * segments * accessModelMetadata A user 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 the ROLE_SUBADMIN is a member of. The maximum supported length for the description field is 2000 characters. ISC preserves longer descriptions for existing roles. However, any new roles as well as any updates to existing descriptions are 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.
|
|
51224
|
+
* @summary Patch Role
|
|
51225
51225
|
* @param {RolesApiPatchRoleRequest} requestParameters Request parameters.
|
|
51226
51226
|
* @param {*} [axiosOptions] Override http request option.
|
|
51227
51227
|
* @throws {RequiredError}
|
|
@@ -56379,15 +56379,15 @@ export const ServiceDeskIntegrationApiAxiosParamCreator = function (configuratio
|
|
|
56379
56379
|
* Update an existing Service Desk integration by ID with a PATCH request.
|
|
56380
56380
|
* @summary Patch a Service Desk Integration
|
|
56381
56381
|
* @param {string} id ID of the Service Desk integration to update
|
|
56382
|
-
* @param {
|
|
56382
|
+
* @param {Array<JsonPatchOperation>} jsonPatchOperation A list of SDIM update operations according to the [JSON Patch](https://tools.ietf.org/html/rfc6902) standard. Only `replace` operations are accepted by this endpoint. A 403 Forbidden Error indicates that a PATCH operation was attempted that is not allowed.
|
|
56383
56383
|
* @param {*} [axiosOptions] Override http request option.
|
|
56384
56384
|
* @throws {RequiredError}
|
|
56385
56385
|
*/
|
|
56386
|
-
patchServiceDeskIntegration: async (id: string,
|
|
56386
|
+
patchServiceDeskIntegration: async (id: string, jsonPatchOperation: Array<JsonPatchOperation>, axiosOptions: RawAxiosRequestConfig = {}): Promise<RequestArgs> => {
|
|
56387
56387
|
// verify required parameter 'id' is not null or undefined
|
|
56388
56388
|
assertParamExists('patchServiceDeskIntegration', 'id', id)
|
|
56389
|
-
// verify required parameter '
|
|
56390
|
-
assertParamExists('patchServiceDeskIntegration', '
|
|
56389
|
+
// verify required parameter 'jsonPatchOperation' is not null or undefined
|
|
56390
|
+
assertParamExists('patchServiceDeskIntegration', 'jsonPatchOperation', jsonPatchOperation)
|
|
56391
56391
|
const localVarPath = `/service-desk-integrations/{id}`
|
|
56392
56392
|
.replace(`{${"id"}}`, encodeURIComponent(String(id)));
|
|
56393
56393
|
// use dummy base URL string because the URL constructor only accepts absolute URLs.
|
|
@@ -56416,7 +56416,7 @@ export const ServiceDeskIntegrationApiAxiosParamCreator = function (configuratio
|
|
|
56416
56416
|
setSearchParams(localVarUrlObj, localVarQueryParameter);
|
|
56417
56417
|
let headersFromBaseOptions = baseOptions && baseOptions.headers ? baseOptions.headers : {};
|
|
56418
56418
|
localVarRequestOptions.headers = {...localVarHeaderParameter, ...headersFromBaseOptions, ...axiosOptions.headers};
|
|
56419
|
-
localVarRequestOptions.data = serializeDataIfNeeded(
|
|
56419
|
+
localVarRequestOptions.data = serializeDataIfNeeded(jsonPatchOperation, localVarRequestOptions, configuration)
|
|
56420
56420
|
|
|
56421
56421
|
return {
|
|
56422
56422
|
url: toPathString(localVarUrlObj),
|
|
@@ -56622,12 +56622,12 @@ export const ServiceDeskIntegrationApiFp = function(configuration?: Configuratio
|
|
|
56622
56622
|
* Update an existing Service Desk integration by ID with a PATCH request.
|
|
56623
56623
|
* @summary Patch a Service Desk Integration
|
|
56624
56624
|
* @param {string} id ID of the Service Desk integration to update
|
|
56625
|
-
* @param {
|
|
56625
|
+
* @param {Array<JsonPatchOperation>} jsonPatchOperation A list of SDIM update operations according to the [JSON Patch](https://tools.ietf.org/html/rfc6902) standard. Only `replace` operations are accepted by this endpoint. A 403 Forbidden Error indicates that a PATCH operation was attempted that is not allowed.
|
|
56626
56626
|
* @param {*} [axiosOptions] Override http request option.
|
|
56627
56627
|
* @throws {RequiredError}
|
|
56628
56628
|
*/
|
|
56629
|
-
async patchServiceDeskIntegration(id: string,
|
|
56630
|
-
const localVarAxiosArgs = await localVarAxiosParamCreator.patchServiceDeskIntegration(id,
|
|
56629
|
+
async patchServiceDeskIntegration(id: string, jsonPatchOperation: Array<JsonPatchOperation>, axiosOptions?: RawAxiosRequestConfig): Promise<(axios?: AxiosInstance, basePath?: string) => AxiosPromise<ServiceDeskIntegrationDto>> {
|
|
56630
|
+
const localVarAxiosArgs = await localVarAxiosParamCreator.patchServiceDeskIntegration(id, jsonPatchOperation, axiosOptions);
|
|
56631
56631
|
const localVarOperationServerIndex = configuration?.serverIndex ?? 0;
|
|
56632
56632
|
const localVarOperationServerBasePath = operationServerMap['ServiceDeskIntegrationApi.patchServiceDeskIntegration']?.[localVarOperationServerIndex]?.url;
|
|
56633
56633
|
return (axios, basePath) => createRequestFunction(localVarAxiosArgs, globalAxios, BASE_PATH, configuration)(axios, localVarOperationServerBasePath || basePath);
|
|
@@ -56745,7 +56745,7 @@ export const ServiceDeskIntegrationApiFactory = function (configuration?: Config
|
|
|
56745
56745
|
* @throws {RequiredError}
|
|
56746
56746
|
*/
|
|
56747
56747
|
patchServiceDeskIntegration(requestParameters: ServiceDeskIntegrationApiPatchServiceDeskIntegrationRequest, axiosOptions?: RawAxiosRequestConfig): AxiosPromise<ServiceDeskIntegrationDto> {
|
|
56748
|
-
return localVarFp.patchServiceDeskIntegration(requestParameters.id, requestParameters.
|
|
56748
|
+
return localVarFp.patchServiceDeskIntegration(requestParameters.id, requestParameters.jsonPatchOperation, axiosOptions).then((request) => request(axios, basePath));
|
|
56749
56749
|
},
|
|
56750
56750
|
/**
|
|
56751
56751
|
* Update an existing Service Desk integration by ID.
|
|
@@ -56883,10 +56883,10 @@ export interface ServiceDeskIntegrationApiPatchServiceDeskIntegrationRequest {
|
|
|
56883
56883
|
|
|
56884
56884
|
/**
|
|
56885
56885
|
* A list of SDIM update operations according to the [JSON Patch](https://tools.ietf.org/html/rfc6902) standard. Only `replace` operations are accepted by this endpoint. A 403 Forbidden Error indicates that a PATCH operation was attempted that is not allowed.
|
|
56886
|
-
* @type {
|
|
56886
|
+
* @type {Array<JsonPatchOperation>}
|
|
56887
56887
|
* @memberof ServiceDeskIntegrationApiPatchServiceDeskIntegration
|
|
56888
56888
|
*/
|
|
56889
|
-
readonly
|
|
56889
|
+
readonly jsonPatchOperation: Array<JsonPatchOperation>
|
|
56890
56890
|
}
|
|
56891
56891
|
|
|
56892
56892
|
/**
|
|
@@ -57022,7 +57022,7 @@ export class ServiceDeskIntegrationApi extends BaseAPI {
|
|
|
57022
57022
|
* @memberof ServiceDeskIntegrationApi
|
|
57023
57023
|
*/
|
|
57024
57024
|
public patchServiceDeskIntegration(requestParameters: ServiceDeskIntegrationApiPatchServiceDeskIntegrationRequest, axiosOptions?: RawAxiosRequestConfig) {
|
|
57025
|
-
return ServiceDeskIntegrationApiFp(this.configuration).patchServiceDeskIntegration(requestParameters.id, requestParameters.
|
|
57025
|
+
return ServiceDeskIntegrationApiFp(this.configuration).patchServiceDeskIntegration(requestParameters.id, requestParameters.jsonPatchOperation, axiosOptions).then((request) => request(this.axios, this.basePath));
|
|
57026
57026
|
}
|
|
57027
57027
|
|
|
57028
57028
|
/**
|
|
@@ -63659,7 +63659,7 @@ export const WorkflowsApiAxiosParamCreator = function (configuration?: Configura
|
|
|
63659
63659
|
};
|
|
63660
63660
|
},
|
|
63661
63661
|
/**
|
|
63662
|
-
*
|
|
63662
|
+
* Get a single workflow execution. Workflow executions are available for up to 90 days before being archived. If you attempt to access a workflow execution that has been archived, you will receive a \"404 Not Found\" response.
|
|
63663
63663
|
* @summary Get Workflow Execution
|
|
63664
63664
|
* @param {string} id Workflow execution ID.
|
|
63665
63665
|
* @param {*} [axiosOptions] Override http request option.
|
|
@@ -64335,7 +64335,7 @@ export const WorkflowsApiFp = function(configuration?: Configuration) {
|
|
|
64335
64335
|
return (axios, basePath) => createRequestFunction(localVarAxiosArgs, globalAxios, BASE_PATH, configuration)(axios, localVarOperationServerBasePath || basePath);
|
|
64336
64336
|
},
|
|
64337
64337
|
/**
|
|
64338
|
-
*
|
|
64338
|
+
* Get a single workflow execution. Workflow executions are available for up to 90 days before being archived. If you attempt to access a workflow execution that has been archived, you will receive a \"404 Not Found\" response.
|
|
64339
64339
|
* @summary Get Workflow Execution
|
|
64340
64340
|
* @param {string} id Workflow execution ID.
|
|
64341
64341
|
* @param {*} [axiosOptions] Override http request option.
|
|
@@ -64576,7 +64576,7 @@ export const WorkflowsApiFactory = function (configuration?: Configuration, base
|
|
|
64576
64576
|
return localVarFp.getWorkflow(requestParameters.id, requestParameters.workflowMetrics, axiosOptions).then((request) => request(axios, basePath));
|
|
64577
64577
|
},
|
|
64578
64578
|
/**
|
|
64579
|
-
*
|
|
64579
|
+
* Get a single workflow execution. Workflow executions are available for up to 90 days before being archived. If you attempt to access a workflow execution that has been archived, you will receive a \"404 Not Found\" response.
|
|
64580
64580
|
* @summary Get Workflow Execution
|
|
64581
64581
|
* @param {WorkflowsApiGetWorkflowExecutionRequest} requestParameters Request parameters.
|
|
64582
64582
|
* @param {*} [axiosOptions] Override http request option.
|
|
@@ -65141,7 +65141,7 @@ export class WorkflowsApi extends BaseAPI {
|
|
|
65141
65141
|
}
|
|
65142
65142
|
|
|
65143
65143
|
/**
|
|
65144
|
-
*
|
|
65144
|
+
* Get a single workflow execution. Workflow executions are available for up to 90 days before being archived. If you attempt to access a workflow execution that has been archived, you will receive a \"404 Not Found\" response.
|
|
65145
65145
|
* @summary Get Workflow Execution
|
|
65146
65146
|
* @param {WorkflowsApiGetWorkflowExecutionRequest} requestParameters Request parameters.
|
|
65147
65147
|
* @param {*} [axiosOptions] Override http request option.
|