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/dist/v3/api.d.ts
CHANGED
|
@@ -362,43 +362,43 @@ export interface AccessModelMetadataValuesInner {
|
|
|
362
362
|
'status'?: string;
|
|
363
363
|
}
|
|
364
364
|
/**
|
|
365
|
-
* Access
|
|
365
|
+
* Access profile.
|
|
366
366
|
* @export
|
|
367
367
|
* @interface AccessProfile
|
|
368
368
|
*/
|
|
369
369
|
export interface AccessProfile {
|
|
370
370
|
/**
|
|
371
|
-
*
|
|
371
|
+
* Access profile ID.
|
|
372
372
|
* @type {string}
|
|
373
373
|
* @memberof AccessProfile
|
|
374
374
|
*/
|
|
375
375
|
'id'?: string;
|
|
376
376
|
/**
|
|
377
|
-
*
|
|
377
|
+
* Access profile name.
|
|
378
378
|
* @type {string}
|
|
379
379
|
* @memberof AccessProfile
|
|
380
380
|
*/
|
|
381
381
|
'name': string;
|
|
382
382
|
/**
|
|
383
|
-
*
|
|
383
|
+
* Access profile description.
|
|
384
384
|
* @type {string}
|
|
385
385
|
* @memberof AccessProfile
|
|
386
386
|
*/
|
|
387
387
|
'description'?: string | null;
|
|
388
388
|
/**
|
|
389
|
-
* Date the
|
|
389
|
+
* Date and time when the access profile was created.
|
|
390
390
|
* @type {string}
|
|
391
391
|
* @memberof AccessProfile
|
|
392
392
|
*/
|
|
393
393
|
'created'?: string;
|
|
394
394
|
/**
|
|
395
|
-
* Date the
|
|
395
|
+
* Date and time when the access profile was last modified.
|
|
396
396
|
* @type {string}
|
|
397
397
|
* @memberof AccessProfile
|
|
398
398
|
*/
|
|
399
399
|
'modified'?: string;
|
|
400
400
|
/**
|
|
401
|
-
*
|
|
401
|
+
* Indicates whether the access profile is enabled. If it\'s enabled, you must include at least one entitlement.
|
|
402
402
|
* @type {boolean}
|
|
403
403
|
* @memberof AccessProfile
|
|
404
404
|
*/
|
|
@@ -416,13 +416,13 @@ export interface AccessProfile {
|
|
|
416
416
|
*/
|
|
417
417
|
'source': AccessProfileSourceRef;
|
|
418
418
|
/**
|
|
419
|
-
*
|
|
419
|
+
* List of entitlements associated with the access profile. If `enabled` is false, this can be empty. Otherwise, it must contain at least one entitlement.
|
|
420
420
|
* @type {Array<EntitlementRef>}
|
|
421
421
|
* @memberof AccessProfile
|
|
422
422
|
*/
|
|
423
423
|
'entitlements'?: Array<EntitlementRef> | null;
|
|
424
424
|
/**
|
|
425
|
-
*
|
|
425
|
+
* 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.
|
|
426
426
|
* @type {boolean}
|
|
427
427
|
* @memberof AccessProfile
|
|
428
428
|
*/
|
|
@@ -440,7 +440,7 @@ export interface AccessProfile {
|
|
|
440
440
|
*/
|
|
441
441
|
'revocationRequestConfig'?: Revocability | null;
|
|
442
442
|
/**
|
|
443
|
-
* List of IDs
|
|
443
|
+
* List of segment IDs, if any, that the access profile is assigned to.
|
|
444
444
|
* @type {Array<string>}
|
|
445
445
|
* @memberof AccessProfile
|
|
446
446
|
*/
|
|
@@ -459,13 +459,13 @@ export interface AccessProfile {
|
|
|
459
459
|
*/
|
|
460
460
|
export interface AccessProfileApprovalScheme {
|
|
461
461
|
/**
|
|
462
|
-
* Describes the individual or group that is responsible for an approval step.
|
|
462
|
+
* 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
|
|
463
463
|
* @type {string}
|
|
464
464
|
* @memberof AccessProfileApprovalScheme
|
|
465
465
|
*/
|
|
466
466
|
'approverType'?: AccessProfileApprovalSchemeApproverTypeV3;
|
|
467
467
|
/**
|
|
468
|
-
*
|
|
468
|
+
* Specific approver ID. Only use this when the `approverType` is `GOVERNANCE_GROUP`.
|
|
469
469
|
* @type {string}
|
|
470
470
|
* @memberof AccessProfileApprovalScheme
|
|
471
471
|
*/
|
|
@@ -948,19 +948,19 @@ export interface AccessProfileRole {
|
|
|
948
948
|
*/
|
|
949
949
|
export interface AccessProfileSourceRef {
|
|
950
950
|
/**
|
|
951
|
-
*
|
|
951
|
+
* ID of the source the access profile is associated with.
|
|
952
952
|
* @type {string}
|
|
953
953
|
* @memberof AccessProfileSourceRef
|
|
954
954
|
*/
|
|
955
955
|
'id'?: string;
|
|
956
956
|
/**
|
|
957
|
-
*
|
|
957
|
+
* Source\'s DTO type.
|
|
958
958
|
* @type {string}
|
|
959
959
|
* @memberof AccessProfileSourceRef
|
|
960
960
|
*/
|
|
961
961
|
'type'?: AccessProfileSourceRefTypeV3;
|
|
962
962
|
/**
|
|
963
|
-
*
|
|
963
|
+
* Source name.
|
|
964
964
|
* @type {string}
|
|
965
965
|
* @memberof AccessProfileSourceRef
|
|
966
966
|
*/
|
|
@@ -14715,7 +14715,7 @@ export declare const OwnerDtoTypeV3: {
|
|
|
14715
14715
|
};
|
|
14716
14716
|
export type OwnerDtoTypeV3 = typeof OwnerDtoTypeV3[keyof typeof OwnerDtoTypeV3];
|
|
14717
14717
|
/**
|
|
14718
|
-
*
|
|
14718
|
+
* Owner of the object.
|
|
14719
14719
|
* @export
|
|
14720
14720
|
* @interface OwnerReference
|
|
14721
14721
|
*/
|
|
@@ -14727,13 +14727,13 @@ export interface OwnerReference {
|
|
|
14727
14727
|
*/
|
|
14728
14728
|
'type'?: OwnerReferenceTypeV3;
|
|
14729
14729
|
/**
|
|
14730
|
-
*
|
|
14730
|
+
* Owner\'s identity ID.
|
|
14731
14731
|
* @type {string}
|
|
14732
14732
|
* @memberof OwnerReference
|
|
14733
14733
|
*/
|
|
14734
14734
|
'id'?: string;
|
|
14735
14735
|
/**
|
|
14736
|
-
*
|
|
14736
|
+
* 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.
|
|
14737
14737
|
* @type {string}
|
|
14738
14738
|
* @memberof OwnerReference
|
|
14739
14739
|
*/
|
|
@@ -15297,19 +15297,6 @@ export declare const PatOwnerTypeV3: {
|
|
|
15297
15297
|
readonly Identity: "IDENTITY";
|
|
15298
15298
|
};
|
|
15299
15299
|
export type PatOwnerTypeV3 = typeof PatOwnerTypeV3[keyof typeof PatOwnerTypeV3];
|
|
15300
|
-
/**
|
|
15301
|
-
* A JSONPatch document as defined by [RFC 6902 - JSON Patch](https://tools.ietf.org/html/rfc6902). Only `replace` operations are accepted by this endpoint.
|
|
15302
|
-
* @export
|
|
15303
|
-
* @interface PatchServiceDeskIntegrationRequest
|
|
15304
|
-
*/
|
|
15305
|
-
export interface PatchServiceDeskIntegrationRequest {
|
|
15306
|
-
/**
|
|
15307
|
-
* Operations to be applied
|
|
15308
|
-
* @type {Array<JsonPatchOperation>}
|
|
15309
|
-
* @memberof PatchServiceDeskIntegrationRequest
|
|
15310
|
-
*/
|
|
15311
|
-
'operations'?: Array<JsonPatchOperation>;
|
|
15312
|
-
}
|
|
15313
15300
|
/**
|
|
15314
15301
|
*
|
|
15315
15302
|
* @export
|
|
@@ -15628,7 +15615,7 @@ export interface ProvisioningConfigPlanInitializerScript {
|
|
|
15628
15615
|
'source'?: string;
|
|
15629
15616
|
}
|
|
15630
15617
|
/**
|
|
15631
|
-
* Defines matching criteria for an
|
|
15618
|
+
* Defines matching criteria for an account to be provisioned with a specific access profile.
|
|
15632
15619
|
* @export
|
|
15633
15620
|
* @interface ProvisioningCriteriaLevel1
|
|
15634
15621
|
*/
|
|
@@ -15640,26 +15627,26 @@ export interface ProvisioningCriteriaLevel1 {
|
|
|
15640
15627
|
*/
|
|
15641
15628
|
'operation'?: ProvisioningCriteriaOperation;
|
|
15642
15629
|
/**
|
|
15643
|
-
* Name of the
|
|
15630
|
+
* 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.
|
|
15644
15631
|
* @type {string}
|
|
15645
15632
|
* @memberof ProvisioningCriteriaLevel1
|
|
15646
15633
|
*/
|
|
15647
15634
|
'attribute'?: string | null;
|
|
15648
15635
|
/**
|
|
15649
|
-
* String value to test the
|
|
15636
|
+
* 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.
|
|
15650
15637
|
* @type {string}
|
|
15651
15638
|
* @memberof ProvisioningCriteriaLevel1
|
|
15652
15639
|
*/
|
|
15653
15640
|
'value'?: string | null;
|
|
15654
15641
|
/**
|
|
15655
|
-
* Array of child criteria.
|
|
15642
|
+
* 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.
|
|
15656
15643
|
* @type {Array<ProvisioningCriteriaLevel2>}
|
|
15657
15644
|
* @memberof ProvisioningCriteriaLevel1
|
|
15658
15645
|
*/
|
|
15659
15646
|
'children'?: Array<ProvisioningCriteriaLevel2> | null;
|
|
15660
15647
|
}
|
|
15661
15648
|
/**
|
|
15662
|
-
* Defines matching criteria for an
|
|
15649
|
+
* Defines matching criteria for an account to be provisioned with a specific access profile.
|
|
15663
15650
|
* @export
|
|
15664
15651
|
* @interface ProvisioningCriteriaLevel2
|
|
15665
15652
|
*/
|
|
@@ -15671,26 +15658,26 @@ export interface ProvisioningCriteriaLevel2 {
|
|
|
15671
15658
|
*/
|
|
15672
15659
|
'operation'?: ProvisioningCriteriaOperation;
|
|
15673
15660
|
/**
|
|
15674
|
-
* Name of the
|
|
15661
|
+
* 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.
|
|
15675
15662
|
* @type {string}
|
|
15676
15663
|
* @memberof ProvisioningCriteriaLevel2
|
|
15677
15664
|
*/
|
|
15678
15665
|
'attribute'?: string | null;
|
|
15679
15666
|
/**
|
|
15680
|
-
* String value to test the
|
|
15667
|
+
* 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.
|
|
15681
15668
|
* @type {string}
|
|
15682
15669
|
* @memberof ProvisioningCriteriaLevel2
|
|
15683
15670
|
*/
|
|
15684
15671
|
'value'?: string | null;
|
|
15685
15672
|
/**
|
|
15686
|
-
* Array of child criteria.
|
|
15673
|
+
* 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.
|
|
15687
15674
|
* @type {Array<ProvisioningCriteriaLevel3>}
|
|
15688
15675
|
* @memberof ProvisioningCriteriaLevel2
|
|
15689
15676
|
*/
|
|
15690
15677
|
'children'?: Array<ProvisioningCriteriaLevel3> | null;
|
|
15691
15678
|
}
|
|
15692
15679
|
/**
|
|
15693
|
-
* Defines matching criteria for an
|
|
15680
|
+
* Defines matching criteria for an account to be provisioned with a specific access profile.
|
|
15694
15681
|
* @export
|
|
15695
15682
|
* @interface ProvisioningCriteriaLevel3
|
|
15696
15683
|
*/
|
|
@@ -15702,26 +15689,26 @@ export interface ProvisioningCriteriaLevel3 {
|
|
|
15702
15689
|
*/
|
|
15703
15690
|
'operation'?: ProvisioningCriteriaOperation;
|
|
15704
15691
|
/**
|
|
15705
|
-
* Name of the
|
|
15692
|
+
* 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.
|
|
15706
15693
|
* @type {string}
|
|
15707
15694
|
* @memberof ProvisioningCriteriaLevel3
|
|
15708
15695
|
*/
|
|
15709
15696
|
'attribute'?: string | null;
|
|
15710
15697
|
/**
|
|
15711
|
-
* String value to test the
|
|
15698
|
+
* 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.
|
|
15712
15699
|
* @type {string}
|
|
15713
15700
|
* @memberof ProvisioningCriteriaLevel3
|
|
15714
15701
|
*/
|
|
15715
|
-
'value'?: string;
|
|
15702
|
+
'value'?: string | null;
|
|
15716
15703
|
/**
|
|
15717
|
-
* Array of child criteria.
|
|
15704
|
+
* 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.
|
|
15718
15705
|
* @type {string}
|
|
15719
15706
|
* @memberof ProvisioningCriteriaLevel3
|
|
15720
15707
|
*/
|
|
15721
15708
|
'children'?: string | null;
|
|
15722
15709
|
}
|
|
15723
15710
|
/**
|
|
15724
|
-
* Supported operations on ProvisioningCriteria
|
|
15711
|
+
* Supported operations on `ProvisioningCriteria`.
|
|
15725
15712
|
* @export
|
|
15726
15713
|
* @enum {string}
|
|
15727
15714
|
*/
|
|
@@ -16771,19 +16758,25 @@ export interface RequestOnBehalfOfConfig {
|
|
|
16771
16758
|
*/
|
|
16772
16759
|
export interface Requestability {
|
|
16773
16760
|
/**
|
|
16774
|
-
*
|
|
16761
|
+
* Indicates whether the requester of the containing object must provide comments justifying the request.
|
|
16775
16762
|
* @type {boolean}
|
|
16776
16763
|
* @memberof Requestability
|
|
16777
16764
|
*/
|
|
16778
16765
|
'commentsRequired'?: boolean | null;
|
|
16779
16766
|
/**
|
|
16780
|
-
*
|
|
16767
|
+
* Indicates whether an approver must provide comments when denying the request.
|
|
16781
16768
|
* @type {boolean}
|
|
16782
16769
|
* @memberof Requestability
|
|
16783
16770
|
*/
|
|
16784
16771
|
'denialCommentsRequired'?: boolean | null;
|
|
16785
16772
|
/**
|
|
16786
|
-
*
|
|
16773
|
+
* Indicates whether reauthorization is required for the request.
|
|
16774
|
+
* @type {boolean}
|
|
16775
|
+
* @memberof Requestability
|
|
16776
|
+
*/
|
|
16777
|
+
'reauthorizationRequired'?: boolean | null;
|
|
16778
|
+
/**
|
|
16779
|
+
* List describing the steps involved in approving the request.
|
|
16787
16780
|
* @type {Array<AccessProfileApprovalScheme>}
|
|
16788
16781
|
* @memberof Requestability
|
|
16789
16782
|
*/
|
|
@@ -16807,6 +16800,12 @@ export interface RequestabilityForRole {
|
|
|
16807
16800
|
* @memberof RequestabilityForRole
|
|
16808
16801
|
*/
|
|
16809
16802
|
'denialCommentsRequired'?: boolean | null;
|
|
16803
|
+
/**
|
|
16804
|
+
* Indicates whether reauthorization is required for the request.
|
|
16805
|
+
* @type {boolean}
|
|
16806
|
+
* @memberof RequestabilityForRole
|
|
16807
|
+
*/
|
|
16808
|
+
'reauthorizationRequired'?: boolean | null;
|
|
16810
16809
|
/**
|
|
16811
16810
|
* List describing the steps in approving the request
|
|
16812
16811
|
* @type {Array<ApprovalSchemeForRole>}
|
|
@@ -17935,7 +17934,7 @@ export type ReviewerTypeV3 = typeof ReviewerTypeV3[keyof typeof ReviewerTypeV3];
|
|
|
17935
17934
|
*/
|
|
17936
17935
|
export interface Revocability {
|
|
17937
17936
|
/**
|
|
17938
|
-
* List describing the steps in approving the revocation request
|
|
17937
|
+
* List describing the steps involved in approving the revocation request.
|
|
17939
17938
|
* @type {Array<AccessProfileApprovalScheme>}
|
|
17940
17939
|
* @memberof Revocability
|
|
17941
17940
|
*/
|
|
@@ -24032,6 +24031,7 @@ export declare const WorkflowExecutionStatusV3: {
|
|
|
24032
24031
|
readonly Completed: "Completed";
|
|
24033
24032
|
readonly Failed: "Failed";
|
|
24034
24033
|
readonly Canceled: "Canceled";
|
|
24034
|
+
readonly Queued: "Queued";
|
|
24035
24035
|
readonly Running: "Running";
|
|
24036
24036
|
};
|
|
24037
24037
|
export type WorkflowExecutionStatusV3 = typeof WorkflowExecutionStatusV3[keyof typeof WorkflowExecutionStatusV3];
|
|
@@ -24565,7 +24565,7 @@ export type WorkflowTriggerAttributesFrequencyV3 = typeof WorkflowTriggerAttribu
|
|
|
24565
24565
|
*/
|
|
24566
24566
|
export declare const AccessProfilesApiAxiosParamCreator: (configuration?: Configuration) => {
|
|
24567
24567
|
/**
|
|
24568
|
-
* Create an access profile. A user with
|
|
24568
|
+
* 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.
|
|
24569
24569
|
* @summary Create Access Profile
|
|
24570
24570
|
* @param {AccessProfile} accessProfile
|
|
24571
24571
|
* @param {*} [axiosOptions] Override http request option.
|
|
@@ -24610,13 +24610,13 @@ export declare const AccessProfilesApiAxiosParamCreator: (configuration?: Config
|
|
|
24610
24610
|
*/
|
|
24611
24611
|
getAccessProfileEntitlements: (id: string, limit?: number, offset?: number, count?: boolean, filters?: string, sorters?: string, axiosOptions?: RawAxiosRequestConfig) => Promise<RequestArgs>;
|
|
24612
24612
|
/**
|
|
24613
|
-
* Get a list of access profiles.
|
|
24613
|
+
* Get a list of access profiles. >**Note:** When you filter for access profiles that have the \'+\' symbol in their names, the response is blank.
|
|
24614
24614
|
* @summary List Access Profiles
|
|
24615
24615
|
* @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.
|
|
24616
24616
|
* @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.
|
|
24617
24617
|
* @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.
|
|
24618
24618
|
* @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.
|
|
24619
|
-
* @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,
|
|
24619
|
+
* @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.
|
|
24620
24620
|
* @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**
|
|
24621
24621
|
* @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.
|
|
24622
24622
|
* @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.
|
|
@@ -24640,7 +24640,7 @@ export declare const AccessProfilesApiAxiosParamCreator: (configuration?: Config
|
|
|
24640
24640
|
*/
|
|
24641
24641
|
export declare const AccessProfilesApiFp: (configuration?: Configuration) => {
|
|
24642
24642
|
/**
|
|
24643
|
-
* Create an access profile. A user with
|
|
24643
|
+
* 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.
|
|
24644
24644
|
* @summary Create Access Profile
|
|
24645
24645
|
* @param {AccessProfile} accessProfile
|
|
24646
24646
|
* @param {*} [axiosOptions] Override http request option.
|
|
@@ -24685,13 +24685,13 @@ export declare const AccessProfilesApiFp: (configuration?: Configuration) => {
|
|
|
24685
24685
|
*/
|
|
24686
24686
|
getAccessProfileEntitlements(id: string, limit?: number, offset?: number, count?: boolean, filters?: string, sorters?: string, axiosOptions?: RawAxiosRequestConfig): Promise<(axios?: AxiosInstance, basePath?: string) => AxiosPromise<Array<Entitlement>>>;
|
|
24687
24687
|
/**
|
|
24688
|
-
* Get a list of access profiles.
|
|
24688
|
+
* Get a list of access profiles. >**Note:** When you filter for access profiles that have the \'+\' symbol in their names, the response is blank.
|
|
24689
24689
|
* @summary List Access Profiles
|
|
24690
24690
|
* @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.
|
|
24691
24691
|
* @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.
|
|
24692
24692
|
* @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.
|
|
24693
24693
|
* @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.
|
|
24694
|
-
* @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,
|
|
24694
|
+
* @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.
|
|
24695
24695
|
* @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**
|
|
24696
24696
|
* @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.
|
|
24697
24697
|
* @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.
|
|
@@ -24715,7 +24715,7 @@ export declare const AccessProfilesApiFp: (configuration?: Configuration) => {
|
|
|
24715
24715
|
*/
|
|
24716
24716
|
export declare const AccessProfilesApiFactory: (configuration?: Configuration, basePath?: string, axios?: AxiosInstance) => {
|
|
24717
24717
|
/**
|
|
24718
|
-
* Create an access profile. A user with
|
|
24718
|
+
* 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.
|
|
24719
24719
|
* @summary Create Access Profile
|
|
24720
24720
|
* @param {AccessProfilesApiCreateAccessProfileRequest} requestParameters Request parameters.
|
|
24721
24721
|
* @param {*} [axiosOptions] Override http request option.
|
|
@@ -24755,7 +24755,7 @@ export declare const AccessProfilesApiFactory: (configuration?: Configuration, b
|
|
|
24755
24755
|
*/
|
|
24756
24756
|
getAccessProfileEntitlements(requestParameters: AccessProfilesApiGetAccessProfileEntitlementsRequest, axiosOptions?: RawAxiosRequestConfig): AxiosPromise<Array<Entitlement>>;
|
|
24757
24757
|
/**
|
|
24758
|
-
* Get a list of access profiles.
|
|
24758
|
+
* Get a list of access profiles. >**Note:** When you filter for access profiles that have the \'+\' symbol in their names, the response is blank.
|
|
24759
24759
|
* @summary List Access Profiles
|
|
24760
24760
|
* @param {AccessProfilesApiListAccessProfilesRequest} requestParameters Request parameters.
|
|
24761
24761
|
* @param {*} [axiosOptions] Override http request option.
|
|
@@ -24897,7 +24897,7 @@ export interface AccessProfilesApiListAccessProfilesRequest {
|
|
|
24897
24897
|
*/
|
|
24898
24898
|
readonly count?: boolean;
|
|
24899
24899
|
/**
|
|
24900
|
-
* 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,
|
|
24900
|
+
* 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.
|
|
24901
24901
|
* @type {string}
|
|
24902
24902
|
* @memberof AccessProfilesApiListAccessProfiles
|
|
24903
24903
|
*/
|
|
@@ -24948,7 +24948,7 @@ export interface AccessProfilesApiPatchAccessProfileRequest {
|
|
|
24948
24948
|
*/
|
|
24949
24949
|
export declare class AccessProfilesApi extends BaseAPI {
|
|
24950
24950
|
/**
|
|
24951
|
-
* Create an access profile. A user with
|
|
24951
|
+
* 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.
|
|
24952
24952
|
* @summary Create Access Profile
|
|
24953
24953
|
* @param {AccessProfilesApiCreateAccessProfileRequest} requestParameters Request parameters.
|
|
24954
24954
|
* @param {*} [axiosOptions] Override http request option.
|
|
@@ -24993,7 +24993,7 @@ export declare class AccessProfilesApi extends BaseAPI {
|
|
|
24993
24993
|
*/
|
|
24994
24994
|
getAccessProfileEntitlements(requestParameters: AccessProfilesApiGetAccessProfileEntitlementsRequest, axiosOptions?: RawAxiosRequestConfig): Promise<import("axios").AxiosResponse<Entitlement[], any>>;
|
|
24995
24995
|
/**
|
|
24996
|
-
* Get a list of access profiles.
|
|
24996
|
+
* Get a list of access profiles. >**Note:** When you filter for access profiles that have the \'+\' symbol in their names, the response is blank.
|
|
24997
24997
|
* @summary List Access Profiles
|
|
24998
24998
|
* @param {AccessProfilesApiListAccessProfilesRequest} requestParameters Request parameters.
|
|
24999
24999
|
* @param {*} [axiosOptions] Override http request option.
|
|
@@ -25063,7 +25063,7 @@ export declare const AccessRequestApprovalsApiAxiosParamCreator: (configuration?
|
|
|
25063
25063
|
* @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.
|
|
25064
25064
|
* @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.
|
|
25065
25065
|
* @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.
|
|
25066
|
-
* @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*
|
|
25066
|
+
* @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*
|
|
25067
25067
|
* @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**
|
|
25068
25068
|
* @param {*} [axiosOptions] Override http request option.
|
|
25069
25069
|
* @throws {RequiredError}
|
|
@@ -25131,7 +25131,7 @@ export declare const AccessRequestApprovalsApiFp: (configuration?: Configuration
|
|
|
25131
25131
|
* @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.
|
|
25132
25132
|
* @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.
|
|
25133
25133
|
* @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.
|
|
25134
|
-
* @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*
|
|
25134
|
+
* @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*
|
|
25135
25135
|
* @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**
|
|
25136
25136
|
* @param {*} [axiosOptions] Override http request option.
|
|
25137
25137
|
* @throws {RequiredError}
|
|
@@ -25332,7 +25332,7 @@ export interface AccessRequestApprovalsApiListPendingApprovalsRequest {
|
|
|
25332
25332
|
*/
|
|
25333
25333
|
readonly count?: boolean;
|
|
25334
25334
|
/**
|
|
25335
|
-
* 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*
|
|
25335
|
+
* 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*
|
|
25336
25336
|
* @type {string}
|
|
25337
25337
|
* @memberof AccessRequestApprovalsApiListPendingApprovals
|
|
25338
25338
|
*/
|
|
@@ -37692,17 +37692,17 @@ export declare const RolesApiAxiosParamCreator: (configuration?: Configuration)
|
|
|
37692
37692
|
*/
|
|
37693
37693
|
deleteBulkRoles: (roleBulkDeleteRequest: RoleBulkDeleteRequest, axiosOptions?: RawAxiosRequestConfig) => Promise<RequestArgs>;
|
|
37694
37694
|
/**
|
|
37695
|
-
*
|
|
37696
|
-
* @summary Delete
|
|
37697
|
-
* @param {string} id ID
|
|
37695
|
+
* 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.
|
|
37696
|
+
* @summary Delete Role
|
|
37697
|
+
* @param {string} id Role ID.
|
|
37698
37698
|
* @param {*} [axiosOptions] Override http request option.
|
|
37699
37699
|
* @throws {RequiredError}
|
|
37700
37700
|
*/
|
|
37701
37701
|
deleteRole: (id: string, axiosOptions?: RawAxiosRequestConfig) => Promise<RequestArgs>;
|
|
37702
37702
|
/**
|
|
37703
|
-
*
|
|
37704
|
-
* @summary Get
|
|
37705
|
-
* @param {string} id ID
|
|
37703
|
+
* 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.
|
|
37704
|
+
* @summary Get Role
|
|
37705
|
+
* @param {string} id Role ID.
|
|
37706
37706
|
* @param {*} [axiosOptions] Override http request option.
|
|
37707
37707
|
* @throws {RequiredError}
|
|
37708
37708
|
*/
|
|
@@ -37727,7 +37727,7 @@ export declare const RolesApiAxiosParamCreator: (configuration?: Configuration)
|
|
|
37727
37727
|
* @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.
|
|
37728
37728
|
* @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.
|
|
37729
37729
|
* @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.
|
|
37730
|
-
* @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,
|
|
37730
|
+
* @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*
|
|
37731
37731
|
* @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**
|
|
37732
37732
|
* @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.
|
|
37733
37733
|
* @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.
|
|
@@ -37736,9 +37736,9 @@ export declare const RolesApiAxiosParamCreator: (configuration?: Configuration)
|
|
|
37736
37736
|
*/
|
|
37737
37737
|
listRoles: (forSubadmin?: string, limit?: number, offset?: number, count?: boolean, filters?: string, sorters?: string, forSegmentIds?: string, includeUnsegmented?: boolean, axiosOptions?: RawAxiosRequestConfig) => Promise<RequestArgs>;
|
|
37738
37738
|
/**
|
|
37739
|
-
*
|
|
37740
|
-
* @summary Patch
|
|
37741
|
-
* @param {string} id ID
|
|
37739
|
+
* 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.
|
|
37740
|
+
* @summary Patch Role
|
|
37741
|
+
* @param {string} id Role ID to patch
|
|
37742
37742
|
* @param {Array<JsonPatchOperation>} jsonPatchOperation
|
|
37743
37743
|
* @param {*} [axiosOptions] Override http request option.
|
|
37744
37744
|
* @throws {RequiredError}
|
|
@@ -37767,17 +37767,17 @@ export declare const RolesApiFp: (configuration?: Configuration) => {
|
|
|
37767
37767
|
*/
|
|
37768
37768
|
deleteBulkRoles(roleBulkDeleteRequest: RoleBulkDeleteRequest, axiosOptions?: RawAxiosRequestConfig): Promise<(axios?: AxiosInstance, basePath?: string) => AxiosPromise<TaskResultDto>>;
|
|
37769
37769
|
/**
|
|
37770
|
-
*
|
|
37771
|
-
* @summary Delete
|
|
37772
|
-
* @param {string} id ID
|
|
37770
|
+
* 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.
|
|
37771
|
+
* @summary Delete Role
|
|
37772
|
+
* @param {string} id Role ID.
|
|
37773
37773
|
* @param {*} [axiosOptions] Override http request option.
|
|
37774
37774
|
* @throws {RequiredError}
|
|
37775
37775
|
*/
|
|
37776
37776
|
deleteRole(id: string, axiosOptions?: RawAxiosRequestConfig): Promise<(axios?: AxiosInstance, basePath?: string) => AxiosPromise<void>>;
|
|
37777
37777
|
/**
|
|
37778
|
-
*
|
|
37779
|
-
* @summary Get
|
|
37780
|
-
* @param {string} id ID
|
|
37778
|
+
* 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.
|
|
37779
|
+
* @summary Get Role
|
|
37780
|
+
* @param {string} id Role ID.
|
|
37781
37781
|
* @param {*} [axiosOptions] Override http request option.
|
|
37782
37782
|
* @throws {RequiredError}
|
|
37783
37783
|
*/
|
|
@@ -37802,7 +37802,7 @@ export declare const RolesApiFp: (configuration?: Configuration) => {
|
|
|
37802
37802
|
* @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.
|
|
37803
37803
|
* @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.
|
|
37804
37804
|
* @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.
|
|
37805
|
-
* @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,
|
|
37805
|
+
* @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*
|
|
37806
37806
|
* @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**
|
|
37807
37807
|
* @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.
|
|
37808
37808
|
* @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.
|
|
@@ -37811,9 +37811,9 @@ export declare const RolesApiFp: (configuration?: Configuration) => {
|
|
|
37811
37811
|
*/
|
|
37812
37812
|
listRoles(forSubadmin?: string, limit?: number, offset?: number, count?: boolean, filters?: string, sorters?: string, forSegmentIds?: string, includeUnsegmented?: boolean, axiosOptions?: RawAxiosRequestConfig): Promise<(axios?: AxiosInstance, basePath?: string) => AxiosPromise<Array<Role>>>;
|
|
37813
37813
|
/**
|
|
37814
|
-
*
|
|
37815
|
-
* @summary Patch
|
|
37816
|
-
* @param {string} id ID
|
|
37814
|
+
* 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.
|
|
37815
|
+
* @summary Patch Role
|
|
37816
|
+
* @param {string} id Role ID to patch
|
|
37817
37817
|
* @param {Array<JsonPatchOperation>} jsonPatchOperation
|
|
37818
37818
|
* @param {*} [axiosOptions] Override http request option.
|
|
37819
37819
|
* @throws {RequiredError}
|
|
@@ -37842,16 +37842,16 @@ export declare const RolesApiFactory: (configuration?: Configuration, basePath?:
|
|
|
37842
37842
|
*/
|
|
37843
37843
|
deleteBulkRoles(requestParameters: RolesApiDeleteBulkRolesRequest, axiosOptions?: RawAxiosRequestConfig): AxiosPromise<TaskResultDto>;
|
|
37844
37844
|
/**
|
|
37845
|
-
*
|
|
37846
|
-
* @summary Delete
|
|
37845
|
+
* 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.
|
|
37846
|
+
* @summary Delete Role
|
|
37847
37847
|
* @param {RolesApiDeleteRoleRequest} requestParameters Request parameters.
|
|
37848
37848
|
* @param {*} [axiosOptions] Override http request option.
|
|
37849
37849
|
* @throws {RequiredError}
|
|
37850
37850
|
*/
|
|
37851
37851
|
deleteRole(requestParameters: RolesApiDeleteRoleRequest, axiosOptions?: RawAxiosRequestConfig): AxiosPromise<void>;
|
|
37852
37852
|
/**
|
|
37853
|
-
*
|
|
37854
|
-
* @summary Get
|
|
37853
|
+
* 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.
|
|
37854
|
+
* @summary Get Role
|
|
37855
37855
|
* @param {RolesApiGetRoleRequest} requestParameters Request parameters.
|
|
37856
37856
|
* @param {*} [axiosOptions] Override http request option.
|
|
37857
37857
|
* @throws {RequiredError}
|
|
@@ -37874,8 +37874,8 @@ export declare const RolesApiFactory: (configuration?: Configuration, basePath?:
|
|
|
37874
37874
|
*/
|
|
37875
37875
|
listRoles(requestParameters?: RolesApiListRolesRequest, axiosOptions?: RawAxiosRequestConfig): AxiosPromise<Array<Role>>;
|
|
37876
37876
|
/**
|
|
37877
|
-
*
|
|
37878
|
-
* @summary Patch
|
|
37877
|
+
* 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.
|
|
37878
|
+
* @summary Patch Role
|
|
37879
37879
|
* @param {RolesApiPatchRoleRequest} requestParameters Request parameters.
|
|
37880
37880
|
* @param {*} [axiosOptions] Override http request option.
|
|
37881
37881
|
* @throws {RequiredError}
|
|
@@ -37915,7 +37915,7 @@ export interface RolesApiDeleteBulkRolesRequest {
|
|
|
37915
37915
|
*/
|
|
37916
37916
|
export interface RolesApiDeleteRoleRequest {
|
|
37917
37917
|
/**
|
|
37918
|
-
* ID
|
|
37918
|
+
* Role ID.
|
|
37919
37919
|
* @type {string}
|
|
37920
37920
|
* @memberof RolesApiDeleteRole
|
|
37921
37921
|
*/
|
|
@@ -37928,7 +37928,7 @@ export interface RolesApiDeleteRoleRequest {
|
|
|
37928
37928
|
*/
|
|
37929
37929
|
export interface RolesApiGetRoleRequest {
|
|
37930
37930
|
/**
|
|
37931
|
-
* ID
|
|
37931
|
+
* Role ID.
|
|
37932
37932
|
* @type {string}
|
|
37933
37933
|
* @memberof RolesApiGetRole
|
|
37934
37934
|
*/
|
|
@@ -38008,7 +38008,7 @@ export interface RolesApiListRolesRequest {
|
|
|
38008
38008
|
*/
|
|
38009
38009
|
readonly count?: boolean;
|
|
38010
38010
|
/**
|
|
38011
|
-
* 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,
|
|
38011
|
+
* 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*
|
|
38012
38012
|
* @type {string}
|
|
38013
38013
|
* @memberof RolesApiListRoles
|
|
38014
38014
|
*/
|
|
@@ -38039,7 +38039,7 @@ export interface RolesApiListRolesRequest {
|
|
|
38039
38039
|
*/
|
|
38040
38040
|
export interface RolesApiPatchRoleRequest {
|
|
38041
38041
|
/**
|
|
38042
|
-
* ID
|
|
38042
|
+
* Role ID to patch
|
|
38043
38043
|
* @type {string}
|
|
38044
38044
|
* @memberof RolesApiPatchRole
|
|
38045
38045
|
*/
|
|
@@ -38077,8 +38077,8 @@ export declare class RolesApi extends BaseAPI {
|
|
|
38077
38077
|
*/
|
|
38078
38078
|
deleteBulkRoles(requestParameters: RolesApiDeleteBulkRolesRequest, axiosOptions?: RawAxiosRequestConfig): Promise<import("axios").AxiosResponse<TaskResultDto, any>>;
|
|
38079
38079
|
/**
|
|
38080
|
-
*
|
|
38081
|
-
* @summary Delete
|
|
38080
|
+
* 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.
|
|
38081
|
+
* @summary Delete Role
|
|
38082
38082
|
* @param {RolesApiDeleteRoleRequest} requestParameters Request parameters.
|
|
38083
38083
|
* @param {*} [axiosOptions] Override http request option.
|
|
38084
38084
|
* @throws {RequiredError}
|
|
@@ -38086,8 +38086,8 @@ export declare class RolesApi extends BaseAPI {
|
|
|
38086
38086
|
*/
|
|
38087
38087
|
deleteRole(requestParameters: RolesApiDeleteRoleRequest, axiosOptions?: RawAxiosRequestConfig): Promise<import("axios").AxiosResponse<void, any>>;
|
|
38088
38088
|
/**
|
|
38089
|
-
*
|
|
38090
|
-
* @summary Get
|
|
38089
|
+
* 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.
|
|
38090
|
+
* @summary Get Role
|
|
38091
38091
|
* @param {RolesApiGetRoleRequest} requestParameters Request parameters.
|
|
38092
38092
|
* @param {*} [axiosOptions] Override http request option.
|
|
38093
38093
|
* @throws {RequiredError}
|
|
@@ -38113,8 +38113,8 @@ export declare class RolesApi extends BaseAPI {
|
|
|
38113
38113
|
*/
|
|
38114
38114
|
listRoles(requestParameters?: RolesApiListRolesRequest, axiosOptions?: RawAxiosRequestConfig): Promise<import("axios").AxiosResponse<Role[], any>>;
|
|
38115
38115
|
/**
|
|
38116
|
-
*
|
|
38117
|
-
* @summary Patch
|
|
38116
|
+
* 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.
|
|
38117
|
+
* @summary Patch Role
|
|
38118
38118
|
* @param {RolesApiPatchRoleRequest} requestParameters Request parameters.
|
|
38119
38119
|
* @param {*} [axiosOptions] Override http request option.
|
|
38120
38120
|
* @throws {RequiredError}
|
|
@@ -40684,11 +40684,11 @@ export declare const ServiceDeskIntegrationApiAxiosParamCreator: (configuration?
|
|
|
40684
40684
|
* Update an existing Service Desk integration by ID with a PATCH request.
|
|
40685
40685
|
* @summary Patch a Service Desk Integration
|
|
40686
40686
|
* @param {string} id ID of the Service Desk integration to update
|
|
40687
|
-
* @param {
|
|
40687
|
+
* @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.
|
|
40688
40688
|
* @param {*} [axiosOptions] Override http request option.
|
|
40689
40689
|
* @throws {RequiredError}
|
|
40690
40690
|
*/
|
|
40691
|
-
patchServiceDeskIntegration: (id: string,
|
|
40691
|
+
patchServiceDeskIntegration: (id: string, jsonPatchOperation: Array<JsonPatchOperation>, axiosOptions?: RawAxiosRequestConfig) => Promise<RequestArgs>;
|
|
40692
40692
|
/**
|
|
40693
40693
|
* Update an existing Service Desk integration by ID.
|
|
40694
40694
|
* @summary Update a Service Desk integration
|
|
@@ -40774,11 +40774,11 @@ export declare const ServiceDeskIntegrationApiFp: (configuration?: Configuration
|
|
|
40774
40774
|
* Update an existing Service Desk integration by ID with a PATCH request.
|
|
40775
40775
|
* @summary Patch a Service Desk Integration
|
|
40776
40776
|
* @param {string} id ID of the Service Desk integration to update
|
|
40777
|
-
* @param {
|
|
40777
|
+
* @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.
|
|
40778
40778
|
* @param {*} [axiosOptions] Override http request option.
|
|
40779
40779
|
* @throws {RequiredError}
|
|
40780
40780
|
*/
|
|
40781
|
-
patchServiceDeskIntegration(id: string,
|
|
40781
|
+
patchServiceDeskIntegration(id: string, jsonPatchOperation: Array<JsonPatchOperation>, axiosOptions?: RawAxiosRequestConfig): Promise<(axios?: AxiosInstance, basePath?: string) => AxiosPromise<ServiceDeskIntegrationDto>>;
|
|
40782
40782
|
/**
|
|
40783
40783
|
* Update an existing Service Desk integration by ID.
|
|
40784
40784
|
* @summary Update a Service Desk integration
|
|
@@ -40984,10 +40984,10 @@ export interface ServiceDeskIntegrationApiPatchServiceDeskIntegrationRequest {
|
|
|
40984
40984
|
readonly id: string;
|
|
40985
40985
|
/**
|
|
40986
40986
|
* 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.
|
|
40987
|
-
* @type {
|
|
40987
|
+
* @type {Array<JsonPatchOperation>}
|
|
40988
40988
|
* @memberof ServiceDeskIntegrationApiPatchServiceDeskIntegration
|
|
40989
40989
|
*/
|
|
40990
|
-
readonly
|
|
40990
|
+
readonly jsonPatchOperation: Array<JsonPatchOperation>;
|
|
40991
40991
|
}
|
|
40992
40992
|
/**
|
|
40993
40993
|
* Request parameters for putServiceDeskIntegration operation in ServiceDeskIntegrationApi.
|
|
@@ -44500,7 +44500,7 @@ export declare const WorkflowsApiAxiosParamCreator: (configuration?: Configurati
|
|
|
44500
44500
|
*/
|
|
44501
44501
|
getWorkflow: (id: string, workflowMetrics?: boolean, axiosOptions?: RawAxiosRequestConfig) => Promise<RequestArgs>;
|
|
44502
44502
|
/**
|
|
44503
|
-
*
|
|
44503
|
+
* 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.
|
|
44504
44504
|
* @summary Get Workflow Execution
|
|
44505
44505
|
* @param {string} id Workflow execution ID.
|
|
44506
44506
|
* @param {*} [axiosOptions] Override http request option.
|
|
@@ -44667,7 +44667,7 @@ export declare const WorkflowsApiFp: (configuration?: Configuration) => {
|
|
|
44667
44667
|
*/
|
|
44668
44668
|
getWorkflow(id: string, workflowMetrics?: boolean, axiosOptions?: RawAxiosRequestConfig): Promise<(axios?: AxiosInstance, basePath?: string) => AxiosPromise<Workflow>>;
|
|
44669
44669
|
/**
|
|
44670
|
-
*
|
|
44670
|
+
* 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.
|
|
44671
44671
|
* @summary Get Workflow Execution
|
|
44672
44672
|
* @param {string} id Workflow execution ID.
|
|
44673
44673
|
* @param {*} [axiosOptions] Override http request option.
|
|
@@ -44832,7 +44832,7 @@ export declare const WorkflowsApiFactory: (configuration?: Configuration, basePa
|
|
|
44832
44832
|
*/
|
|
44833
44833
|
getWorkflow(requestParameters: WorkflowsApiGetWorkflowRequest, axiosOptions?: RawAxiosRequestConfig): AxiosPromise<Workflow>;
|
|
44834
44834
|
/**
|
|
44835
|
-
*
|
|
44835
|
+
* 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.
|
|
44836
44836
|
* @summary Get Workflow Execution
|
|
44837
44837
|
* @param {WorkflowsApiGetWorkflowExecutionRequest} requestParameters Request parameters.
|
|
44838
44838
|
* @param {*} [axiosOptions] Override http request option.
|
|
@@ -45318,7 +45318,7 @@ export declare class WorkflowsApi extends BaseAPI {
|
|
|
45318
45318
|
*/
|
|
45319
45319
|
getWorkflow(requestParameters: WorkflowsApiGetWorkflowRequest, axiosOptions?: RawAxiosRequestConfig): Promise<import("axios").AxiosResponse<Workflow, any>>;
|
|
45320
45320
|
/**
|
|
45321
|
-
*
|
|
45321
|
+
* 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.
|
|
45322
45322
|
* @summary Get Workflow Execution
|
|
45323
45323
|
* @param {WorkflowsApiGetWorkflowExecutionRequest} requestParameters Request parameters.
|
|
45324
45324
|
* @param {*} [axiosOptions] Override http request option.
|