sailpoint-api-client 1.5.0 → 1.6.0
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 +499 -109
- package/beta/common.ts +2 -2
- package/beta/package.json +1 -1
- package/dist/beta/api.d.ts +429 -70
- package/dist/beta/api.js +162 -99
- package/dist/beta/api.js.map +1 -1
- package/dist/beta/common.js +1 -1
- package/dist/v2024/api.d.ts +1186 -9
- package/dist/v2024/api.js +811 -87
- package/dist/v2024/api.js.map +1 -1
- package/dist/v2024/common.js +1 -1
- package/dist/v2025/api.d.ts +1452 -9
- package/dist/v2025/api.js +912 -72
- package/dist/v2025/api.js.map +1 -1
- package/dist/v2025/common.js +1 -1
- package/dist/v3/api.d.ts +502 -21
- package/dist/v3/api.js +95 -27
- 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 +1524 -10
- package/v2024/common.ts +2 -2
- package/v2024/package.json +1 -1
- package/v2025/README.md +2 -2
- package/v2025/api.ts +1908 -70
- package/v2025/common.ts +2 -2
- package/v2025/package.json +1 -1
- package/v3/README.md +2 -2
- package/v3/api.ts +543 -28
- package/v3/common.ts +2 -2
- package/v3/package.json +1 -1
package/dist/v3/api.d.ts
CHANGED
|
@@ -1105,6 +1105,12 @@ export interface AccessRequest {
|
|
|
1105
1105
|
'clientMetadata'?: {
|
|
1106
1106
|
[key: string]: string;
|
|
1107
1107
|
};
|
|
1108
|
+
/**
|
|
1109
|
+
* Additional submit data structure with requestedFor containing requestedItems allowing distinction for each request item and Identity. * Can only be used when \'requestedFor\' and \'requestedItems\' are not separately provided * Adds ability to specify which account the user wants the access on, in case they have multiple accounts on a source * Allows the ability to request items with different remove dates * Also allows different combinations of request items and identities in the same request
|
|
1110
|
+
* @type {Array<RequestedForDtoRef>}
|
|
1111
|
+
* @memberof AccessRequest
|
|
1112
|
+
*/
|
|
1113
|
+
'requestedForWithRequestedItems'?: Array<RequestedForDtoRef> | null;
|
|
1108
1114
|
}
|
|
1109
1115
|
/**
|
|
1110
1116
|
*
|
|
@@ -1187,6 +1193,18 @@ export interface AccessRequestItem {
|
|
|
1187
1193
|
* @memberof AccessRequestItem
|
|
1188
1194
|
*/
|
|
1189
1195
|
'removeDate'?: string;
|
|
1196
|
+
/**
|
|
1197
|
+
* The assignmentId for a specific role assignment on the identity. This id is used to revoke that specific roleAssignment on that identity. * For use with REVOKE_ACCESS requests for roles for identities with multiple accounts on a single source.
|
|
1198
|
+
* @type {string}
|
|
1199
|
+
* @memberof AccessRequestItem
|
|
1200
|
+
*/
|
|
1201
|
+
'assignmentId'?: string | null;
|
|
1202
|
+
/**
|
|
1203
|
+
* The \'distinguishedName\' field for an account on the identity, also called nativeIdentity. This nativeIdentity is used to revoke a specific attributeAssignment on the identity. * For use with REVOKE_ACCESS requests for entitlements for identities with multiple accounts on a single source.
|
|
1204
|
+
* @type {string}
|
|
1205
|
+
* @memberof AccessRequestItem
|
|
1206
|
+
*/
|
|
1207
|
+
'nativeIdentity'?: string | null;
|
|
1190
1208
|
}
|
|
1191
1209
|
export declare const AccessRequestItemTypeV3: {
|
|
1192
1210
|
readonly AccessProfile: "ACCESS_PROFILE";
|
|
@@ -2461,6 +2479,25 @@ export interface AccountAttributesCreateAttributes {
|
|
|
2461
2479
|
*/
|
|
2462
2480
|
'sourceId': string;
|
|
2463
2481
|
}
|
|
2482
|
+
/**
|
|
2483
|
+
*
|
|
2484
|
+
* @export
|
|
2485
|
+
* @interface AccountItemRef
|
|
2486
|
+
*/
|
|
2487
|
+
export interface AccountItemRef {
|
|
2488
|
+
/**
|
|
2489
|
+
* The uuid for the account, available under the \'objectguid\' attribute
|
|
2490
|
+
* @type {string}
|
|
2491
|
+
* @memberof AccountItemRef
|
|
2492
|
+
*/
|
|
2493
|
+
'accountUuid'?: string | null;
|
|
2494
|
+
/**
|
|
2495
|
+
* The \'distinguishedName\' attribute for the account
|
|
2496
|
+
* @type {string}
|
|
2497
|
+
* @memberof AccountItemRef
|
|
2498
|
+
*/
|
|
2499
|
+
'nativeIdentity'?: string;
|
|
2500
|
+
}
|
|
2464
2501
|
/**
|
|
2465
2502
|
*
|
|
2466
2503
|
* @export
|
|
@@ -3507,6 +3544,7 @@ export declare const AttributeDefinitionType: {
|
|
|
3507
3544
|
readonly Long: "LONG";
|
|
3508
3545
|
readonly Int: "INT";
|
|
3509
3546
|
readonly Boolean: "BOOLEAN";
|
|
3547
|
+
readonly Date: "DATE";
|
|
3510
3548
|
};
|
|
3511
3549
|
export type AttributeDefinitionType = typeof AttributeDefinitionType[keyof typeof AttributeDefinitionType];
|
|
3512
3550
|
/**
|
|
@@ -9558,6 +9596,182 @@ export declare const GetActiveCampaigns200ResponseInnerMandatoryCommentRequireme
|
|
|
9558
9596
|
readonly NoDecisions: "NO_DECISIONS";
|
|
9559
9597
|
};
|
|
9560
9598
|
export type GetActiveCampaigns200ResponseInnerMandatoryCommentRequirementV3 = typeof GetActiveCampaigns200ResponseInnerMandatoryCommentRequirementV3[keyof typeof GetActiveCampaigns200ResponseInnerMandatoryCommentRequirementV3];
|
|
9599
|
+
/**
|
|
9600
|
+
*
|
|
9601
|
+
* @export
|
|
9602
|
+
* @interface GetCampaign200Response
|
|
9603
|
+
*/
|
|
9604
|
+
export interface GetCampaign200Response {
|
|
9605
|
+
/**
|
|
9606
|
+
* Id of the campaign
|
|
9607
|
+
* @type {string}
|
|
9608
|
+
* @memberof GetCampaign200Response
|
|
9609
|
+
*/
|
|
9610
|
+
'id'?: string;
|
|
9611
|
+
/**
|
|
9612
|
+
* The campaign name. If this object is part of a template, special formatting applies; see the `/campaign-templates/{id}/generate` endpoint documentation for details.
|
|
9613
|
+
* @type {string}
|
|
9614
|
+
* @memberof GetCampaign200Response
|
|
9615
|
+
*/
|
|
9616
|
+
'name': string;
|
|
9617
|
+
/**
|
|
9618
|
+
* The campaign description. If this object is part of a template, special formatting applies; see the `/campaign-templates/{id}/generate` endpoint documentation for details.
|
|
9619
|
+
* @type {string}
|
|
9620
|
+
* @memberof GetCampaign200Response
|
|
9621
|
+
*/
|
|
9622
|
+
'description': string | null;
|
|
9623
|
+
/**
|
|
9624
|
+
* The campaign\'s completion deadline. This date must be in the future in order to activate the campaign. If you try to activate a campaign with a deadline of today or in the past, you will receive a 400 error response.
|
|
9625
|
+
* @type {string}
|
|
9626
|
+
* @memberof GetCampaign200Response
|
|
9627
|
+
*/
|
|
9628
|
+
'deadline'?: string;
|
|
9629
|
+
/**
|
|
9630
|
+
* The type of campaign. Could be extended in the future.
|
|
9631
|
+
* @type {string}
|
|
9632
|
+
* @memberof GetCampaign200Response
|
|
9633
|
+
*/
|
|
9634
|
+
'type': GetCampaign200ResponseTypeV3;
|
|
9635
|
+
/**
|
|
9636
|
+
* Enables email notification for this campaign
|
|
9637
|
+
* @type {boolean}
|
|
9638
|
+
* @memberof GetCampaign200Response
|
|
9639
|
+
*/
|
|
9640
|
+
'emailNotificationEnabled'?: boolean;
|
|
9641
|
+
/**
|
|
9642
|
+
* Allows auto revoke for this campaign
|
|
9643
|
+
* @type {boolean}
|
|
9644
|
+
* @memberof GetCampaign200Response
|
|
9645
|
+
*/
|
|
9646
|
+
'autoRevokeAllowed'?: boolean;
|
|
9647
|
+
/**
|
|
9648
|
+
* Enables IAI for this campaign. Accepts true even if the IAI product feature is off. If IAI is turned off then campaigns generated from this template will indicate false. The real value will then be returned if IAI is ever enabled for the org in the future.
|
|
9649
|
+
* @type {boolean}
|
|
9650
|
+
* @memberof GetCampaign200Response
|
|
9651
|
+
*/
|
|
9652
|
+
'recommendationsEnabled'?: boolean;
|
|
9653
|
+
/**
|
|
9654
|
+
* The campaign\'s current status.
|
|
9655
|
+
* @type {string}
|
|
9656
|
+
* @memberof GetCampaign200Response
|
|
9657
|
+
*/
|
|
9658
|
+
'status'?: GetCampaign200ResponseStatusV3;
|
|
9659
|
+
/**
|
|
9660
|
+
* The correlatedStatus of the campaign. Only SOURCE_OWNER campaigns can be Uncorrelated. An Uncorrelated certification campaign only includes Uncorrelated identities (An identity is uncorrelated if it has no accounts on an authoritative source).
|
|
9661
|
+
* @type {string}
|
|
9662
|
+
* @memberof GetCampaign200Response
|
|
9663
|
+
*/
|
|
9664
|
+
'correlatedStatus'?: GetCampaign200ResponseCorrelatedStatusV3;
|
|
9665
|
+
/**
|
|
9666
|
+
* Created time of the campaign
|
|
9667
|
+
* @type {string}
|
|
9668
|
+
* @memberof GetCampaign200Response
|
|
9669
|
+
*/
|
|
9670
|
+
'created'?: string;
|
|
9671
|
+
/**
|
|
9672
|
+
* The total number of certifications in this campaign.
|
|
9673
|
+
* @type {number}
|
|
9674
|
+
* @memberof GetCampaign200Response
|
|
9675
|
+
*/
|
|
9676
|
+
'totalCertifications'?: number;
|
|
9677
|
+
/**
|
|
9678
|
+
* The number of completed certifications in this campaign.
|
|
9679
|
+
* @type {number}
|
|
9680
|
+
* @memberof GetCampaign200Response
|
|
9681
|
+
*/
|
|
9682
|
+
'completedCertifications'?: number;
|
|
9683
|
+
/**
|
|
9684
|
+
* A list of errors and warnings that have accumulated.
|
|
9685
|
+
* @type {Array<CampaignAlert>}
|
|
9686
|
+
* @memberof GetCampaign200Response
|
|
9687
|
+
*/
|
|
9688
|
+
'alerts'?: Array<CampaignAlert>;
|
|
9689
|
+
/**
|
|
9690
|
+
* Modified time of the campaign
|
|
9691
|
+
* @type {string}
|
|
9692
|
+
* @memberof GetCampaign200Response
|
|
9693
|
+
*/
|
|
9694
|
+
'modified'?: string;
|
|
9695
|
+
/**
|
|
9696
|
+
*
|
|
9697
|
+
* @type {CampaignAllOfFilter}
|
|
9698
|
+
* @memberof GetCampaign200Response
|
|
9699
|
+
*/
|
|
9700
|
+
'filter'?: CampaignAllOfFilter;
|
|
9701
|
+
/**
|
|
9702
|
+
* Determines if comments on sunset date changes are required.
|
|
9703
|
+
* @type {boolean}
|
|
9704
|
+
* @memberof GetCampaign200Response
|
|
9705
|
+
*/
|
|
9706
|
+
'sunsetCommentsRequired'?: boolean;
|
|
9707
|
+
/**
|
|
9708
|
+
*
|
|
9709
|
+
* @type {CampaignAllOfSourceOwnerCampaignInfo}
|
|
9710
|
+
* @memberof GetCampaign200Response
|
|
9711
|
+
*/
|
|
9712
|
+
'sourceOwnerCampaignInfo'?: CampaignAllOfSourceOwnerCampaignInfo;
|
|
9713
|
+
/**
|
|
9714
|
+
*
|
|
9715
|
+
* @type {CampaignAllOfSearchCampaignInfo}
|
|
9716
|
+
* @memberof GetCampaign200Response
|
|
9717
|
+
*/
|
|
9718
|
+
'searchCampaignInfo'?: CampaignAllOfSearchCampaignInfo;
|
|
9719
|
+
/**
|
|
9720
|
+
*
|
|
9721
|
+
* @type {CampaignAllOfRoleCompositionCampaignInfo}
|
|
9722
|
+
* @memberof GetCampaign200Response
|
|
9723
|
+
*/
|
|
9724
|
+
'roleCompositionCampaignInfo'?: CampaignAllOfRoleCompositionCampaignInfo;
|
|
9725
|
+
/**
|
|
9726
|
+
*
|
|
9727
|
+
* @type {CampaignAllOfMachineAccountCampaignInfo}
|
|
9728
|
+
* @memberof GetCampaign200Response
|
|
9729
|
+
*/
|
|
9730
|
+
'machineAccountCampaignInfo'?: CampaignAllOfMachineAccountCampaignInfo;
|
|
9731
|
+
/**
|
|
9732
|
+
* A list of sources in the campaign that contain \\\"orphan entitlements\\\" (entitlements without a corresponding Managed Attribute). An empty list indicates the campaign has no orphan entitlements. Null indicates there may be unknown orphan entitlements in the campaign (the campaign was created before this feature was implemented).
|
|
9733
|
+
* @type {Array<CampaignAllOfSourcesWithOrphanEntitlements>}
|
|
9734
|
+
* @memberof GetCampaign200Response
|
|
9735
|
+
*/
|
|
9736
|
+
'sourcesWithOrphanEntitlements'?: Array<CampaignAllOfSourcesWithOrphanEntitlements>;
|
|
9737
|
+
/**
|
|
9738
|
+
* Determines whether comments are required for decisions during certification reviews. You can require comments for all decisions, revoke-only decisions, or no decisions. By default, comments are not required for decisions.
|
|
9739
|
+
* @type {string}
|
|
9740
|
+
* @memberof GetCampaign200Response
|
|
9741
|
+
*/
|
|
9742
|
+
'mandatoryCommentRequirement'?: GetCampaign200ResponseMandatoryCommentRequirementV3;
|
|
9743
|
+
}
|
|
9744
|
+
export declare const GetCampaign200ResponseTypeV3: {
|
|
9745
|
+
readonly Manager: "MANAGER";
|
|
9746
|
+
readonly SourceOwner: "SOURCE_OWNER";
|
|
9747
|
+
readonly Search: "SEARCH";
|
|
9748
|
+
readonly RoleComposition: "ROLE_COMPOSITION";
|
|
9749
|
+
readonly MachineAccount: "MACHINE_ACCOUNT";
|
|
9750
|
+
};
|
|
9751
|
+
export type GetCampaign200ResponseTypeV3 = typeof GetCampaign200ResponseTypeV3[keyof typeof GetCampaign200ResponseTypeV3];
|
|
9752
|
+
export declare const GetCampaign200ResponseStatusV3: {
|
|
9753
|
+
readonly Pending: "PENDING";
|
|
9754
|
+
readonly Staged: "STAGED";
|
|
9755
|
+
readonly Canceling: "CANCELING";
|
|
9756
|
+
readonly Activating: "ACTIVATING";
|
|
9757
|
+
readonly Active: "ACTIVE";
|
|
9758
|
+
readonly Completing: "COMPLETING";
|
|
9759
|
+
readonly Completed: "COMPLETED";
|
|
9760
|
+
readonly Error: "ERROR";
|
|
9761
|
+
readonly Archived: "ARCHIVED";
|
|
9762
|
+
};
|
|
9763
|
+
export type GetCampaign200ResponseStatusV3 = typeof GetCampaign200ResponseStatusV3[keyof typeof GetCampaign200ResponseStatusV3];
|
|
9764
|
+
export declare const GetCampaign200ResponseCorrelatedStatusV3: {
|
|
9765
|
+
readonly Correlated: "CORRELATED";
|
|
9766
|
+
readonly Uncorrelated: "UNCORRELATED";
|
|
9767
|
+
};
|
|
9768
|
+
export type GetCampaign200ResponseCorrelatedStatusV3 = typeof GetCampaign200ResponseCorrelatedStatusV3[keyof typeof GetCampaign200ResponseCorrelatedStatusV3];
|
|
9769
|
+
export declare const GetCampaign200ResponseMandatoryCommentRequirementV3: {
|
|
9770
|
+
readonly AllDecisions: "ALL_DECISIONS";
|
|
9771
|
+
readonly RevokeOnlyDecisions: "REVOKE_ONLY_DECISIONS";
|
|
9772
|
+
readonly NoDecisions: "NO_DECISIONS";
|
|
9773
|
+
};
|
|
9774
|
+
export type GetCampaign200ResponseMandatoryCommentRequirementV3 = typeof GetCampaign200ResponseMandatoryCommentRequirementV3[keyof typeof GetCampaign200ResponseMandatoryCommentRequirementV3];
|
|
9561
9775
|
/**
|
|
9562
9776
|
* @type GetDiscoveredApplications200ResponseInner
|
|
9563
9777
|
* @export
|
|
@@ -11286,7 +11500,7 @@ export interface IdpDetails {
|
|
|
11286
11500
|
* @type {string}
|
|
11287
11501
|
* @memberof IdpDetails
|
|
11288
11502
|
*/
|
|
11289
|
-
'
|
|
11503
|
+
'authnContext'?: string;
|
|
11290
11504
|
/**
|
|
11291
11505
|
* The IDP logout URL. Used with IDP configurations.
|
|
11292
11506
|
* @type {string}
|
|
@@ -11298,7 +11512,7 @@ export interface IdpDetails {
|
|
|
11298
11512
|
* @type {boolean}
|
|
11299
11513
|
* @memberof IdpDetails
|
|
11300
11514
|
*/
|
|
11301
|
-
'
|
|
11515
|
+
'includeAuthnContext'?: boolean;
|
|
11302
11516
|
/**
|
|
11303
11517
|
* The name id format to use. Used with IDP configurations.
|
|
11304
11518
|
* @type {string}
|
|
@@ -11334,7 +11548,7 @@ export interface IdpDetails {
|
|
|
11334
11548
|
* @type {string}
|
|
11335
11549
|
* @memberof IdpDetails
|
|
11336
11550
|
*/
|
|
11337
|
-
'mappingAttribute'
|
|
11551
|
+
'mappingAttribute': string;
|
|
11338
11552
|
/**
|
|
11339
11553
|
* The expiration date extracted from the certificate.
|
|
11340
11554
|
* @type {string}
|
|
@@ -11350,6 +11564,7 @@ export interface IdpDetails {
|
|
|
11350
11564
|
}
|
|
11351
11565
|
export declare const IdpDetailsRoleV3: {
|
|
11352
11566
|
readonly SamlIdp: "SAML_IDP";
|
|
11567
|
+
readonly SamlSp: "SAML_SP";
|
|
11353
11568
|
};
|
|
11354
11569
|
export type IdpDetailsRoleV3 = typeof IdpDetailsRoleV3[keyof typeof IdpDetailsRoleV3];
|
|
11355
11570
|
/**
|
|
@@ -15543,7 +15758,7 @@ export interface ProvisioningPolicy {
|
|
|
15543
15758
|
* @type {string}
|
|
15544
15759
|
* @memberof ProvisioningPolicy
|
|
15545
15760
|
*/
|
|
15546
|
-
'name': string;
|
|
15761
|
+
'name': string | null;
|
|
15547
15762
|
/**
|
|
15548
15763
|
* the description of the provisioning policy
|
|
15549
15764
|
* @type {string}
|
|
@@ -15574,7 +15789,7 @@ export interface ProvisioningPolicyDto {
|
|
|
15574
15789
|
* @type {string}
|
|
15575
15790
|
* @memberof ProvisioningPolicyDto
|
|
15576
15791
|
*/
|
|
15577
|
-
'name': string;
|
|
15792
|
+
'name': string | null;
|
|
15578
15793
|
/**
|
|
15579
15794
|
* the description of the provisioning policy
|
|
15580
15795
|
* @type {string}
|
|
@@ -16762,6 +16977,25 @@ export interface RequestedAccountRef {
|
|
|
16762
16977
|
*/
|
|
16763
16978
|
'sourceName'?: string;
|
|
16764
16979
|
}
|
|
16980
|
+
/**
|
|
16981
|
+
*
|
|
16982
|
+
* @export
|
|
16983
|
+
* @interface RequestedForDtoRef
|
|
16984
|
+
*/
|
|
16985
|
+
export interface RequestedForDtoRef {
|
|
16986
|
+
/**
|
|
16987
|
+
* The identity id for which the access is requested
|
|
16988
|
+
* @type {string}
|
|
16989
|
+
* @memberof RequestedForDtoRef
|
|
16990
|
+
*/
|
|
16991
|
+
'identityId': string;
|
|
16992
|
+
/**
|
|
16993
|
+
* the details for the access items that are requested for the identity
|
|
16994
|
+
* @type {Array<RequestedItemDtoRef>}
|
|
16995
|
+
* @memberof RequestedForDtoRef
|
|
16996
|
+
*/
|
|
16997
|
+
'requestedItems': Array<RequestedItemDtoRef>;
|
|
16998
|
+
}
|
|
16765
16999
|
/**
|
|
16766
17000
|
*
|
|
16767
17001
|
* @export
|
|
@@ -16787,6 +17021,69 @@ export declare const RequestedItemDetailsTypeV3: {
|
|
|
16787
17021
|
readonly Role: "ROLE";
|
|
16788
17022
|
};
|
|
16789
17023
|
export type RequestedItemDetailsTypeV3 = typeof RequestedItemDetailsTypeV3[keyof typeof RequestedItemDetailsTypeV3];
|
|
17024
|
+
/**
|
|
17025
|
+
*
|
|
17026
|
+
* @export
|
|
17027
|
+
* @interface RequestedItemDtoRef
|
|
17028
|
+
*/
|
|
17029
|
+
export interface RequestedItemDtoRef {
|
|
17030
|
+
/**
|
|
17031
|
+
* The type of the item being requested.
|
|
17032
|
+
* @type {string}
|
|
17033
|
+
* @memberof RequestedItemDtoRef
|
|
17034
|
+
*/
|
|
17035
|
+
'type': RequestedItemDtoRefTypeV3;
|
|
17036
|
+
/**
|
|
17037
|
+
* ID of Role, Access Profile or Entitlement being requested.
|
|
17038
|
+
* @type {string}
|
|
17039
|
+
* @memberof RequestedItemDtoRef
|
|
17040
|
+
*/
|
|
17041
|
+
'id': string;
|
|
17042
|
+
/**
|
|
17043
|
+
* Comment provided by requester. * Comment is required when the request is of type Revoke Access.
|
|
17044
|
+
* @type {string}
|
|
17045
|
+
* @memberof RequestedItemDtoRef
|
|
17046
|
+
*/
|
|
17047
|
+
'comment'?: string;
|
|
17048
|
+
/**
|
|
17049
|
+
* Arbitrary key-value pairs. They will never be processed by the IdentityNow system but will be returned on associated APIs such as /account-activities and /access-request-status.
|
|
17050
|
+
* @type {{ [key: string]: string; }}
|
|
17051
|
+
* @memberof RequestedItemDtoRef
|
|
17052
|
+
*/
|
|
17053
|
+
'clientMetadata'?: {
|
|
17054
|
+
[key: string]: string;
|
|
17055
|
+
};
|
|
17056
|
+
/**
|
|
17057
|
+
* The date the role or access profile or entitlement is no longer assigned to the specified identity. Also known as the expiration date. * Specify a date in the future. * The current SLA for the deprovisioning is 24 hours. * This date can be modified to either extend or decrease the duration of access item assignments for the specified identity. You can change the expiration date for requests for yourself or direct reports, but you cannot remove an expiration date on an already approved item. If the access request has not been approved, you can cancel it and submit a new one without the expiration. If it has already been approved, then you have to revoke the access and then re-request without the expiration.
|
|
17058
|
+
* @type {string}
|
|
17059
|
+
* @memberof RequestedItemDtoRef
|
|
17060
|
+
*/
|
|
17061
|
+
'removeDate'?: string;
|
|
17062
|
+
/**
|
|
17063
|
+
* The assignmentId for a specific role assignment on the identity. This id is used to revoke that specific roleAssignment on that identity. * For use with REVOKE_ACCESS requests for roles for identities with multiple accounts on a single source.
|
|
17064
|
+
* @type {string}
|
|
17065
|
+
* @memberof RequestedItemDtoRef
|
|
17066
|
+
*/
|
|
17067
|
+
'assignmentId'?: string | null;
|
|
17068
|
+
/**
|
|
17069
|
+
* The \'distinguishedName\' field for an account on the identity, also called nativeIdentity. This nativeIdentity is used to revoke a specific attributeAssignment on the identity. * For use with REVOKE_ACCESS requests for entitlements for identities with multiple accounts on a single source.
|
|
17070
|
+
* @type {string}
|
|
17071
|
+
* @memberof RequestedItemDtoRef
|
|
17072
|
+
*/
|
|
17073
|
+
'nativeIdentity'?: string | null;
|
|
17074
|
+
/**
|
|
17075
|
+
* The accounts where the access item will be provisioned to * Includes selections performed by the user in the event of multiple accounts existing on the same source * Also includes details for sources where user only has one account
|
|
17076
|
+
* @type {Array<SourceItemRef>}
|
|
17077
|
+
* @memberof RequestedItemDtoRef
|
|
17078
|
+
*/
|
|
17079
|
+
'accountSelection'?: Array<SourceItemRef> | null;
|
|
17080
|
+
}
|
|
17081
|
+
export declare const RequestedItemDtoRefTypeV3: {
|
|
17082
|
+
readonly AccessProfile: "ACCESS_PROFILE";
|
|
17083
|
+
readonly Role: "ROLE";
|
|
17084
|
+
readonly Entitlement: "ENTITLEMENT";
|
|
17085
|
+
};
|
|
17086
|
+
export type RequestedItemDtoRefTypeV3 = typeof RequestedItemDtoRefTypeV3[keyof typeof RequestedItemDtoRefTypeV3];
|
|
16790
17087
|
/**
|
|
16791
17088
|
*
|
|
16792
17089
|
* @export
|
|
@@ -20147,10 +20444,119 @@ export interface ServiceProviderConfiguration {
|
|
|
20147
20444
|
'federationProtocolDetails'?: Array<ServiceProviderConfigurationFederationProtocolDetailsInner>;
|
|
20148
20445
|
}
|
|
20149
20446
|
/**
|
|
20150
|
-
*
|
|
20447
|
+
*
|
|
20151
20448
|
* @export
|
|
20449
|
+
* @interface ServiceProviderConfigurationFederationProtocolDetailsInner
|
|
20152
20450
|
*/
|
|
20153
|
-
export
|
|
20451
|
+
export interface ServiceProviderConfigurationFederationProtocolDetailsInner {
|
|
20452
|
+
/**
|
|
20453
|
+
* Federation protocol role
|
|
20454
|
+
* @type {string}
|
|
20455
|
+
* @memberof ServiceProviderConfigurationFederationProtocolDetailsInner
|
|
20456
|
+
*/
|
|
20457
|
+
'role'?: ServiceProviderConfigurationFederationProtocolDetailsInnerRoleV3;
|
|
20458
|
+
/**
|
|
20459
|
+
* An entity ID is a globally unique name for a SAML entity, either an Identity Provider (IDP) or a Service Provider (SP).
|
|
20460
|
+
* @type {string}
|
|
20461
|
+
* @memberof ServiceProviderConfigurationFederationProtocolDetailsInner
|
|
20462
|
+
*/
|
|
20463
|
+
'entityId'?: string;
|
|
20464
|
+
/**
|
|
20465
|
+
* Defines the binding used for the SAML flow. Used with IDP configurations.
|
|
20466
|
+
* @type {string}
|
|
20467
|
+
* @memberof ServiceProviderConfigurationFederationProtocolDetailsInner
|
|
20468
|
+
*/
|
|
20469
|
+
'binding'?: string;
|
|
20470
|
+
/**
|
|
20471
|
+
* Specifies the SAML authentication method to use. Used with IDP configurations.
|
|
20472
|
+
* @type {string}
|
|
20473
|
+
* @memberof ServiceProviderConfigurationFederationProtocolDetailsInner
|
|
20474
|
+
*/
|
|
20475
|
+
'authnContext'?: string;
|
|
20476
|
+
/**
|
|
20477
|
+
* The IDP logout URL. Used with IDP configurations.
|
|
20478
|
+
* @type {string}
|
|
20479
|
+
* @memberof ServiceProviderConfigurationFederationProtocolDetailsInner
|
|
20480
|
+
*/
|
|
20481
|
+
'logoutUrl'?: string;
|
|
20482
|
+
/**
|
|
20483
|
+
* Determines if the configured AuthnContext should be used or the default. Used with IDP configurations.
|
|
20484
|
+
* @type {boolean}
|
|
20485
|
+
* @memberof ServiceProviderConfigurationFederationProtocolDetailsInner
|
|
20486
|
+
*/
|
|
20487
|
+
'includeAuthnContext'?: boolean;
|
|
20488
|
+
/**
|
|
20489
|
+
* The name id format to use. Used with IDP configurations.
|
|
20490
|
+
* @type {string}
|
|
20491
|
+
* @memberof ServiceProviderConfigurationFederationProtocolDetailsInner
|
|
20492
|
+
*/
|
|
20493
|
+
'nameId'?: string;
|
|
20494
|
+
/**
|
|
20495
|
+
*
|
|
20496
|
+
* @type {JITConfiguration}
|
|
20497
|
+
* @memberof ServiceProviderConfigurationFederationProtocolDetailsInner
|
|
20498
|
+
*/
|
|
20499
|
+
'jitConfiguration'?: JITConfiguration;
|
|
20500
|
+
/**
|
|
20501
|
+
* The Base64-encoded certificate used by the IDP. Used with IDP configurations.
|
|
20502
|
+
* @type {string}
|
|
20503
|
+
* @memberof ServiceProviderConfigurationFederationProtocolDetailsInner
|
|
20504
|
+
*/
|
|
20505
|
+
'cert'?: string;
|
|
20506
|
+
/**
|
|
20507
|
+
* The IDP POST URL, used with IDP HTTP-POST bindings for IDP-initiated logins. Used with IDP configurations.
|
|
20508
|
+
* @type {string}
|
|
20509
|
+
* @memberof ServiceProviderConfigurationFederationProtocolDetailsInner
|
|
20510
|
+
*/
|
|
20511
|
+
'loginUrlPost'?: string;
|
|
20512
|
+
/**
|
|
20513
|
+
* The IDP Redirect URL. Used with IDP configurations.
|
|
20514
|
+
* @type {string}
|
|
20515
|
+
* @memberof ServiceProviderConfigurationFederationProtocolDetailsInner
|
|
20516
|
+
*/
|
|
20517
|
+
'loginUrlRedirect'?: string;
|
|
20518
|
+
/**
|
|
20519
|
+
* Return the saml Id for the given user, based on the IDN as SP settings of the org. Used with IDP configurations.
|
|
20520
|
+
* @type {string}
|
|
20521
|
+
* @memberof ServiceProviderConfigurationFederationProtocolDetailsInner
|
|
20522
|
+
*/
|
|
20523
|
+
'mappingAttribute': string;
|
|
20524
|
+
/**
|
|
20525
|
+
* The expiration date extracted from the certificate.
|
|
20526
|
+
* @type {string}
|
|
20527
|
+
* @memberof ServiceProviderConfigurationFederationProtocolDetailsInner
|
|
20528
|
+
*/
|
|
20529
|
+
'certificateExpirationDate'?: string;
|
|
20530
|
+
/**
|
|
20531
|
+
* The name extracted from the certificate.
|
|
20532
|
+
* @type {string}
|
|
20533
|
+
* @memberof ServiceProviderConfigurationFederationProtocolDetailsInner
|
|
20534
|
+
*/
|
|
20535
|
+
'certificateName'?: string;
|
|
20536
|
+
/**
|
|
20537
|
+
* Unique alias used to identify the selected local service provider based on used URL. Used with SP configurations.
|
|
20538
|
+
* @type {string}
|
|
20539
|
+
* @memberof ServiceProviderConfigurationFederationProtocolDetailsInner
|
|
20540
|
+
*/
|
|
20541
|
+
'alias'?: string;
|
|
20542
|
+
/**
|
|
20543
|
+
* The allowed callback URL where users will be redirected to after authentication. Used with SP configurations.
|
|
20544
|
+
* @type {string}
|
|
20545
|
+
* @memberof ServiceProviderConfigurationFederationProtocolDetailsInner
|
|
20546
|
+
*/
|
|
20547
|
+
'callbackUrl': string;
|
|
20548
|
+
/**
|
|
20549
|
+
* The legacy ACS URL used for SAML authentication. Used with SP configurations.
|
|
20550
|
+
* @type {string}
|
|
20551
|
+
* @memberof ServiceProviderConfigurationFederationProtocolDetailsInner
|
|
20552
|
+
*/
|
|
20553
|
+
'legacyAcsUrl'?: string;
|
|
20554
|
+
}
|
|
20555
|
+
export declare const ServiceProviderConfigurationFederationProtocolDetailsInnerRoleV3: {
|
|
20556
|
+
readonly SamlIdp: "SAML_IDP";
|
|
20557
|
+
readonly SamlSp: "SAML_SP";
|
|
20558
|
+
};
|
|
20559
|
+
export type ServiceProviderConfigurationFederationProtocolDetailsInnerRoleV3 = typeof ServiceProviderConfigurationFederationProtocolDetailsInnerRoleV3[keyof typeof ServiceProviderConfigurationFederationProtocolDetailsInnerRoleV3];
|
|
20154
20560
|
/**
|
|
20155
20561
|
*
|
|
20156
20562
|
* @export
|
|
@@ -21381,6 +21787,25 @@ export declare const SourceHealthDtoStatusV3: {
|
|
|
21381
21787
|
readonly SourceStateUncheckedSourceNoAccounts: "SOURCE_STATE_UNCHECKED_SOURCE_NO_ACCOUNTS";
|
|
21382
21788
|
};
|
|
21383
21789
|
export type SourceHealthDtoStatusV3 = typeof SourceHealthDtoStatusV3[keyof typeof SourceHealthDtoStatusV3];
|
|
21790
|
+
/**
|
|
21791
|
+
*
|
|
21792
|
+
* @export
|
|
21793
|
+
* @interface SourceItemRef
|
|
21794
|
+
*/
|
|
21795
|
+
export interface SourceItemRef {
|
|
21796
|
+
/**
|
|
21797
|
+
* The id for the source on which account selections are made
|
|
21798
|
+
* @type {string}
|
|
21799
|
+
* @memberof SourceItemRef
|
|
21800
|
+
*/
|
|
21801
|
+
'sourceId'?: string | null;
|
|
21802
|
+
/**
|
|
21803
|
+
* A list of account selections on the source. Currently, only one selection per source is supported.
|
|
21804
|
+
* @type {Array<AccountItemRef>}
|
|
21805
|
+
* @memberof SourceItemRef
|
|
21806
|
+
*/
|
|
21807
|
+
'accounts'?: Array<AccountItemRef> | null;
|
|
21808
|
+
}
|
|
21384
21809
|
/**
|
|
21385
21810
|
* Reference to management workgroup for the source.
|
|
21386
21811
|
* @export
|
|
@@ -21638,9 +22063,16 @@ export interface SpDetails {
|
|
|
21638
22063
|
* @type {string}
|
|
21639
22064
|
* @memberof SpDetails
|
|
21640
22065
|
*/
|
|
21641
|
-
'callbackUrl'
|
|
22066
|
+
'callbackUrl': string;
|
|
22067
|
+
/**
|
|
22068
|
+
* The legacy ACS URL used for SAML authentication. Used with SP configurations.
|
|
22069
|
+
* @type {string}
|
|
22070
|
+
* @memberof SpDetails
|
|
22071
|
+
*/
|
|
22072
|
+
'legacyAcsUrl'?: string;
|
|
21642
22073
|
}
|
|
21643
22074
|
export declare const SpDetailsRoleV3: {
|
|
22075
|
+
readonly SamlIdp: "SAML_IDP";
|
|
21644
22076
|
readonly SamlSp: "SAML_SP";
|
|
21645
22077
|
};
|
|
21646
22078
|
export type SpDetailsRoleV3 = typeof SpDetailsRoleV3[keyof typeof SpDetailsRoleV3];
|
|
@@ -25007,7 +25439,7 @@ export declare const AccessRequestsApiAxiosParamCreator: (configuration?: Config
|
|
|
25007
25439
|
*/
|
|
25008
25440
|
cancelAccessRequest: (cancelAccessRequest: CancelAccessRequest, axiosOptions?: RawAxiosRequestConfig) => Promise<RequestArgs>;
|
|
25009
25441
|
/**
|
|
25010
|
-
* Use this API to submit an access request in Identity Security Cloud (ISC), where it follows any ISC approval processes. Access requests are processed asynchronously by ISC. A successful response from this endpoint means that the request has been submitted to ISC and is queued for processing. Because this endpoint is asynchronous, it doesn\'t return an error if you submit duplicate access requests in quick succession or submit an access request for access that is already in progress, approved, or rejected. It\'s best practice to check for any existing access requests that reference the same access items before submitting a new access request. This can be accomplished by using the [List Access Request Status](https://developer.sailpoint.com/idn/api/v3/list-access-request-status) or the [Pending Access Request Approvals](https://developer.sailpoint.com/idn/api/v3/list-pending-approvals) APIs. You can also use the [Search API](https://developer.sailpoint.com/idn/api/v3/search) to check the existing access items an identity has before submitting an access request to ensure that you aren\'t requesting access that is already granted. If you use this API to request access that an identity already has, the API will ignore the request. These ignored requests do not display when you use the [List Access Request Status](https://developer.sailpoint.com/idn/api/v3/list-access-request-status) API. There are two types of access request: __GRANT_ACCESS__ * Can be requested for multiple identities in a single request. * Supports self request and request on behalf of other users. Refer to the [Get Access Request Configuration](https://developer.sailpoint.com/idn/api/v3/get-access-request-config) endpoint for request configuration options. * Allows any authenticated token (except API) to call this endpoint to request to grant access to themselves. Depending on the configuration, a user can request access for others. * Roles, access profiles and entitlements can be requested. * While requesting entitlements, maximum of 25 entitlements and 10 recipients are allowed in a request. __REVOKE_ACCESS__ * Can only be requested for a single identity at a time. * You cannot use an access request to revoke access from an identity if that access has been granted by role membership or by birthright provisioning. * Does not support self request. Only manager can request to revoke access for their directly managed employees. * If a `removeDate` is specified, then the access will be removed on that date and time only for roles, access profiles and entitlements. * Roles, access profiles, and entitlements can be requested for revocation. * Revoke requests for entitlements are limited to 1 entitlement per access request currently. * You can specify a `removeDate` if the access doesn\'t already have a sunset date. The `removeDate` must be a future date, in the UTC timezone. * Allows a manager to request to revoke access for direct employees. A user with ORG_ADMIN authority can also request to revoke access from anyone.
|
|
25442
|
+
* Use this API to submit an access request in Identity Security Cloud (ISC), where it follows any ISC approval processes. Access requests are processed asynchronously by ISC. A successful response from this endpoint means that the request has been submitted to ISC and is queued for processing. Because this endpoint is asynchronous, it doesn\'t return an error if you submit duplicate access requests in quick succession or submit an access request for access that is already in progress, approved, or rejected. It\'s best practice to check for any existing access requests that reference the same access items before submitting a new access request. This can be accomplished by using the [List Access Request Status](https://developer.sailpoint.com/idn/api/v3/list-access-request-status) or the [Pending Access Request Approvals](https://developer.sailpoint.com/idn/api/v3/list-pending-approvals) APIs. You can also use the [Search API](https://developer.sailpoint.com/idn/api/v3/search) to check the existing access items an identity has before submitting an access request to ensure that you aren\'t requesting access that is already granted. If you use this API to request access that an identity already has, the API will ignore the request. These ignored requests do not display when you use the [List Access Request Status](https://developer.sailpoint.com/idn/api/v3/list-access-request-status) API. There are two types of access request: __GRANT_ACCESS__ * Can be requested for multiple identities in a single request. * Supports self request and request on behalf of other users. Refer to the [Get Access Request Configuration](https://developer.sailpoint.com/idn/api/v3/get-access-request-config) endpoint for request configuration options. * Allows any authenticated token (except API) to call this endpoint to request to grant access to themselves. Depending on the configuration, a user can request access for others. * Roles, access profiles and entitlements can be requested. * While requesting entitlements, maximum of 25 entitlements and 10 recipients are allowed in a request. * Now supports an alternate field \'requestedForWithRequestedItems\' for users to specify account selections while requesting items where they have more than one account on the source. __REVOKE_ACCESS__ * Can only be requested for a single identity at a time. * You cannot use an access request to revoke access from an identity if that access has been granted by role membership or by birthright provisioning. * Does not support self request. Only manager can request to revoke access for their directly managed employees. * If a `removeDate` is specified, then the access will be removed on that date and time only for roles, access profiles and entitlements. * Roles, access profiles, and entitlements can be requested for revocation. * Revoke requests for entitlements are limited to 1 entitlement per access request currently. * You can specify a `removeDate` if the access doesn\'t already have a sunset date. The `removeDate` must be a future date, in the UTC timezone. * Allows a manager to request to revoke access for direct employees. A user with ORG_ADMIN authority can also request to revoke access from anyone. * Now supports REVOKE_ACCESS requests for identities with multiple accounts on a single source, with the help of \'assignmentId\' and \'nativeIdentity\' fields.
|
|
25011
25443
|
* @summary Submit Access Request
|
|
25012
25444
|
* @param {AccessRequest} accessRequest
|
|
25013
25445
|
* @param {*} [axiosOptions] Override http request option.
|
|
@@ -25061,7 +25493,7 @@ export declare const AccessRequestsApiFp: (configuration?: Configuration) => {
|
|
|
25061
25493
|
*/
|
|
25062
25494
|
cancelAccessRequest(cancelAccessRequest: CancelAccessRequest, axiosOptions?: RawAxiosRequestConfig): Promise<(axios?: AxiosInstance, basePath?: string) => AxiosPromise<object>>;
|
|
25063
25495
|
/**
|
|
25064
|
-
* Use this API to submit an access request in Identity Security Cloud (ISC), where it follows any ISC approval processes. Access requests are processed asynchronously by ISC. A successful response from this endpoint means that the request has been submitted to ISC and is queued for processing. Because this endpoint is asynchronous, it doesn\'t return an error if you submit duplicate access requests in quick succession or submit an access request for access that is already in progress, approved, or rejected. It\'s best practice to check for any existing access requests that reference the same access items before submitting a new access request. This can be accomplished by using the [List Access Request Status](https://developer.sailpoint.com/idn/api/v3/list-access-request-status) or the [Pending Access Request Approvals](https://developer.sailpoint.com/idn/api/v3/list-pending-approvals) APIs. You can also use the [Search API](https://developer.sailpoint.com/idn/api/v3/search) to check the existing access items an identity has before submitting an access request to ensure that you aren\'t requesting access that is already granted. If you use this API to request access that an identity already has, the API will ignore the request. These ignored requests do not display when you use the [List Access Request Status](https://developer.sailpoint.com/idn/api/v3/list-access-request-status) API. There are two types of access request: __GRANT_ACCESS__ * Can be requested for multiple identities in a single request. * Supports self request and request on behalf of other users. Refer to the [Get Access Request Configuration](https://developer.sailpoint.com/idn/api/v3/get-access-request-config) endpoint for request configuration options. * Allows any authenticated token (except API) to call this endpoint to request to grant access to themselves. Depending on the configuration, a user can request access for others. * Roles, access profiles and entitlements can be requested. * While requesting entitlements, maximum of 25 entitlements and 10 recipients are allowed in a request. __REVOKE_ACCESS__ * Can only be requested for a single identity at a time. * You cannot use an access request to revoke access from an identity if that access has been granted by role membership or by birthright provisioning. * Does not support self request. Only manager can request to revoke access for their directly managed employees. * If a `removeDate` is specified, then the access will be removed on that date and time only for roles, access profiles and entitlements. * Roles, access profiles, and entitlements can be requested for revocation. * Revoke requests for entitlements are limited to 1 entitlement per access request currently. * You can specify a `removeDate` if the access doesn\'t already have a sunset date. The `removeDate` must be a future date, in the UTC timezone. * Allows a manager to request to revoke access for direct employees. A user with ORG_ADMIN authority can also request to revoke access from anyone.
|
|
25496
|
+
* Use this API to submit an access request in Identity Security Cloud (ISC), where it follows any ISC approval processes. Access requests are processed asynchronously by ISC. A successful response from this endpoint means that the request has been submitted to ISC and is queued for processing. Because this endpoint is asynchronous, it doesn\'t return an error if you submit duplicate access requests in quick succession or submit an access request for access that is already in progress, approved, or rejected. It\'s best practice to check for any existing access requests that reference the same access items before submitting a new access request. This can be accomplished by using the [List Access Request Status](https://developer.sailpoint.com/idn/api/v3/list-access-request-status) or the [Pending Access Request Approvals](https://developer.sailpoint.com/idn/api/v3/list-pending-approvals) APIs. You can also use the [Search API](https://developer.sailpoint.com/idn/api/v3/search) to check the existing access items an identity has before submitting an access request to ensure that you aren\'t requesting access that is already granted. If you use this API to request access that an identity already has, the API will ignore the request. These ignored requests do not display when you use the [List Access Request Status](https://developer.sailpoint.com/idn/api/v3/list-access-request-status) API. There are two types of access request: __GRANT_ACCESS__ * Can be requested for multiple identities in a single request. * Supports self request and request on behalf of other users. Refer to the [Get Access Request Configuration](https://developer.sailpoint.com/idn/api/v3/get-access-request-config) endpoint for request configuration options. * Allows any authenticated token (except API) to call this endpoint to request to grant access to themselves. Depending on the configuration, a user can request access for others. * Roles, access profiles and entitlements can be requested. * While requesting entitlements, maximum of 25 entitlements and 10 recipients are allowed in a request. * Now supports an alternate field \'requestedForWithRequestedItems\' for users to specify account selections while requesting items where they have more than one account on the source. __REVOKE_ACCESS__ * Can only be requested for a single identity at a time. * You cannot use an access request to revoke access from an identity if that access has been granted by role membership or by birthright provisioning. * Does not support self request. Only manager can request to revoke access for their directly managed employees. * If a `removeDate` is specified, then the access will be removed on that date and time only for roles, access profiles and entitlements. * Roles, access profiles, and entitlements can be requested for revocation. * Revoke requests for entitlements are limited to 1 entitlement per access request currently. * You can specify a `removeDate` if the access doesn\'t already have a sunset date. The `removeDate` must be a future date, in the UTC timezone. * Allows a manager to request to revoke access for direct employees. A user with ORG_ADMIN authority can also request to revoke access from anyone. * Now supports REVOKE_ACCESS requests for identities with multiple accounts on a single source, with the help of \'assignmentId\' and \'nativeIdentity\' fields.
|
|
25065
25497
|
* @summary Submit Access Request
|
|
25066
25498
|
* @param {AccessRequest} accessRequest
|
|
25067
25499
|
* @param {*} [axiosOptions] Override http request option.
|
|
@@ -25115,7 +25547,7 @@ export declare const AccessRequestsApiFactory: (configuration?: Configuration, b
|
|
|
25115
25547
|
*/
|
|
25116
25548
|
cancelAccessRequest(requestParameters: AccessRequestsApiCancelAccessRequestRequest, axiosOptions?: RawAxiosRequestConfig): AxiosPromise<object>;
|
|
25117
25549
|
/**
|
|
25118
|
-
* Use this API to submit an access request in Identity Security Cloud (ISC), where it follows any ISC approval processes. Access requests are processed asynchronously by ISC. A successful response from this endpoint means that the request has been submitted to ISC and is queued for processing. Because this endpoint is asynchronous, it doesn\'t return an error if you submit duplicate access requests in quick succession or submit an access request for access that is already in progress, approved, or rejected. It\'s best practice to check for any existing access requests that reference the same access items before submitting a new access request. This can be accomplished by using the [List Access Request Status](https://developer.sailpoint.com/idn/api/v3/list-access-request-status) or the [Pending Access Request Approvals](https://developer.sailpoint.com/idn/api/v3/list-pending-approvals) APIs. You can also use the [Search API](https://developer.sailpoint.com/idn/api/v3/search) to check the existing access items an identity has before submitting an access request to ensure that you aren\'t requesting access that is already granted. If you use this API to request access that an identity already has, the API will ignore the request. These ignored requests do not display when you use the [List Access Request Status](https://developer.sailpoint.com/idn/api/v3/list-access-request-status) API. There are two types of access request: __GRANT_ACCESS__ * Can be requested for multiple identities in a single request. * Supports self request and request on behalf of other users. Refer to the [Get Access Request Configuration](https://developer.sailpoint.com/idn/api/v3/get-access-request-config) endpoint for request configuration options. * Allows any authenticated token (except API) to call this endpoint to request to grant access to themselves. Depending on the configuration, a user can request access for others. * Roles, access profiles and entitlements can be requested. * While requesting entitlements, maximum of 25 entitlements and 10 recipients are allowed in a request. __REVOKE_ACCESS__ * Can only be requested for a single identity at a time. * You cannot use an access request to revoke access from an identity if that access has been granted by role membership or by birthright provisioning. * Does not support self request. Only manager can request to revoke access for their directly managed employees. * If a `removeDate` is specified, then the access will be removed on that date and time only for roles, access profiles and entitlements. * Roles, access profiles, and entitlements can be requested for revocation. * Revoke requests for entitlements are limited to 1 entitlement per access request currently. * You can specify a `removeDate` if the access doesn\'t already have a sunset date. The `removeDate` must be a future date, in the UTC timezone. * Allows a manager to request to revoke access for direct employees. A user with ORG_ADMIN authority can also request to revoke access from anyone.
|
|
25550
|
+
* Use this API to submit an access request in Identity Security Cloud (ISC), where it follows any ISC approval processes. Access requests are processed asynchronously by ISC. A successful response from this endpoint means that the request has been submitted to ISC and is queued for processing. Because this endpoint is asynchronous, it doesn\'t return an error if you submit duplicate access requests in quick succession or submit an access request for access that is already in progress, approved, or rejected. It\'s best practice to check for any existing access requests that reference the same access items before submitting a new access request. This can be accomplished by using the [List Access Request Status](https://developer.sailpoint.com/idn/api/v3/list-access-request-status) or the [Pending Access Request Approvals](https://developer.sailpoint.com/idn/api/v3/list-pending-approvals) APIs. You can also use the [Search API](https://developer.sailpoint.com/idn/api/v3/search) to check the existing access items an identity has before submitting an access request to ensure that you aren\'t requesting access that is already granted. If you use this API to request access that an identity already has, the API will ignore the request. These ignored requests do not display when you use the [List Access Request Status](https://developer.sailpoint.com/idn/api/v3/list-access-request-status) API. There are two types of access request: __GRANT_ACCESS__ * Can be requested for multiple identities in a single request. * Supports self request and request on behalf of other users. Refer to the [Get Access Request Configuration](https://developer.sailpoint.com/idn/api/v3/get-access-request-config) endpoint for request configuration options. * Allows any authenticated token (except API) to call this endpoint to request to grant access to themselves. Depending on the configuration, a user can request access for others. * Roles, access profiles and entitlements can be requested. * While requesting entitlements, maximum of 25 entitlements and 10 recipients are allowed in a request. * Now supports an alternate field \'requestedForWithRequestedItems\' for users to specify account selections while requesting items where they have more than one account on the source. __REVOKE_ACCESS__ * Can only be requested for a single identity at a time. * You cannot use an access request to revoke access from an identity if that access has been granted by role membership or by birthright provisioning. * Does not support self request. Only manager can request to revoke access for their directly managed employees. * If a `removeDate` is specified, then the access will be removed on that date and time only for roles, access profiles and entitlements. * Roles, access profiles, and entitlements can be requested for revocation. * Revoke requests for entitlements are limited to 1 entitlement per access request currently. * You can specify a `removeDate` if the access doesn\'t already have a sunset date. The `removeDate` must be a future date, in the UTC timezone. * Allows a manager to request to revoke access for direct employees. A user with ORG_ADMIN authority can also request to revoke access from anyone. * Now supports REVOKE_ACCESS requests for identities with multiple accounts on a single source, with the help of \'assignmentId\' and \'nativeIdentity\' fields.
|
|
25119
25551
|
* @summary Submit Access Request
|
|
25120
25552
|
* @param {AccessRequestsApiCreateAccessRequestRequest} requestParameters Request parameters.
|
|
25121
25553
|
* @param {*} [axiosOptions] Override http request option.
|
|
@@ -25269,7 +25701,7 @@ export declare class AccessRequestsApi extends BaseAPI {
|
|
|
25269
25701
|
*/
|
|
25270
25702
|
cancelAccessRequest(requestParameters: AccessRequestsApiCancelAccessRequestRequest, axiosOptions?: RawAxiosRequestConfig): Promise<import("axios").AxiosResponse<object, any>>;
|
|
25271
25703
|
/**
|
|
25272
|
-
* Use this API to submit an access request in Identity Security Cloud (ISC), where it follows any ISC approval processes. Access requests are processed asynchronously by ISC. A successful response from this endpoint means that the request has been submitted to ISC and is queued for processing. Because this endpoint is asynchronous, it doesn\'t return an error if you submit duplicate access requests in quick succession or submit an access request for access that is already in progress, approved, or rejected. It\'s best practice to check for any existing access requests that reference the same access items before submitting a new access request. This can be accomplished by using the [List Access Request Status](https://developer.sailpoint.com/idn/api/v3/list-access-request-status) or the [Pending Access Request Approvals](https://developer.sailpoint.com/idn/api/v3/list-pending-approvals) APIs. You can also use the [Search API](https://developer.sailpoint.com/idn/api/v3/search) to check the existing access items an identity has before submitting an access request to ensure that you aren\'t requesting access that is already granted. If you use this API to request access that an identity already has, the API will ignore the request. These ignored requests do not display when you use the [List Access Request Status](https://developer.sailpoint.com/idn/api/v3/list-access-request-status) API. There are two types of access request: __GRANT_ACCESS__ * Can be requested for multiple identities in a single request. * Supports self request and request on behalf of other users. Refer to the [Get Access Request Configuration](https://developer.sailpoint.com/idn/api/v3/get-access-request-config) endpoint for request configuration options. * Allows any authenticated token (except API) to call this endpoint to request to grant access to themselves. Depending on the configuration, a user can request access for others. * Roles, access profiles and entitlements can be requested. * While requesting entitlements, maximum of 25 entitlements and 10 recipients are allowed in a request. __REVOKE_ACCESS__ * Can only be requested for a single identity at a time. * You cannot use an access request to revoke access from an identity if that access has been granted by role membership or by birthright provisioning. * Does not support self request. Only manager can request to revoke access for their directly managed employees. * If a `removeDate` is specified, then the access will be removed on that date and time only for roles, access profiles and entitlements. * Roles, access profiles, and entitlements can be requested for revocation. * Revoke requests for entitlements are limited to 1 entitlement per access request currently. * You can specify a `removeDate` if the access doesn\'t already have a sunset date. The `removeDate` must be a future date, in the UTC timezone. * Allows a manager to request to revoke access for direct employees. A user with ORG_ADMIN authority can also request to revoke access from anyone.
|
|
25704
|
+
* Use this API to submit an access request in Identity Security Cloud (ISC), where it follows any ISC approval processes. Access requests are processed asynchronously by ISC. A successful response from this endpoint means that the request has been submitted to ISC and is queued for processing. Because this endpoint is asynchronous, it doesn\'t return an error if you submit duplicate access requests in quick succession or submit an access request for access that is already in progress, approved, or rejected. It\'s best practice to check for any existing access requests that reference the same access items before submitting a new access request. This can be accomplished by using the [List Access Request Status](https://developer.sailpoint.com/idn/api/v3/list-access-request-status) or the [Pending Access Request Approvals](https://developer.sailpoint.com/idn/api/v3/list-pending-approvals) APIs. You can also use the [Search API](https://developer.sailpoint.com/idn/api/v3/search) to check the existing access items an identity has before submitting an access request to ensure that you aren\'t requesting access that is already granted. If you use this API to request access that an identity already has, the API will ignore the request. These ignored requests do not display when you use the [List Access Request Status](https://developer.sailpoint.com/idn/api/v3/list-access-request-status) API. There are two types of access request: __GRANT_ACCESS__ * Can be requested for multiple identities in a single request. * Supports self request and request on behalf of other users. Refer to the [Get Access Request Configuration](https://developer.sailpoint.com/idn/api/v3/get-access-request-config) endpoint for request configuration options. * Allows any authenticated token (except API) to call this endpoint to request to grant access to themselves. Depending on the configuration, a user can request access for others. * Roles, access profiles and entitlements can be requested. * While requesting entitlements, maximum of 25 entitlements and 10 recipients are allowed in a request. * Now supports an alternate field \'requestedForWithRequestedItems\' for users to specify account selections while requesting items where they have more than one account on the source. __REVOKE_ACCESS__ * Can only be requested for a single identity at a time. * You cannot use an access request to revoke access from an identity if that access has been granted by role membership or by birthright provisioning. * Does not support self request. Only manager can request to revoke access for their directly managed employees. * If a `removeDate` is specified, then the access will be removed on that date and time only for roles, access profiles and entitlements. * Roles, access profiles, and entitlements can be requested for revocation. * Revoke requests for entitlements are limited to 1 entitlement per access request currently. * You can specify a `removeDate` if the access doesn\'t already have a sunset date. The `removeDate` must be a future date, in the UTC timezone. * Allows a manager to request to revoke access for direct employees. A user with ORG_ADMIN authority can also request to revoke access from anyone. * Now supports REVOKE_ACCESS requests for identities with multiple accounts on a single source, with the help of \'assignmentId\' and \'nativeIdentity\' fields.
|
|
25273
25705
|
* @summary Submit Access Request
|
|
25274
25706
|
* @param {AccessRequestsApiCreateAccessRequestRequest} requestParameters Request parameters.
|
|
25275
25707
|
* @param {*} [axiosOptions] Override http request option.
|
|
@@ -27451,7 +27883,7 @@ export declare const CertificationCampaignsApiFp: (configuration?: Configuration
|
|
|
27451
27883
|
* @param {*} [axiosOptions] Override http request option.
|
|
27452
27884
|
* @throws {RequiredError}
|
|
27453
27885
|
*/
|
|
27454
|
-
getCampaign(id: string, detail?: GetCampaignDetailV3, axiosOptions?: RawAxiosRequestConfig): Promise<(axios?: AxiosInstance, basePath?: string) => AxiosPromise<
|
|
27886
|
+
getCampaign(id: string, detail?: GetCampaignDetailV3, axiosOptions?: RawAxiosRequestConfig): Promise<(axios?: AxiosInstance, basePath?: string) => AxiosPromise<GetCampaign200Response>>;
|
|
27455
27887
|
/**
|
|
27456
27888
|
* Use this API to fetch all reports for a certification campaign by campaign ID.
|
|
27457
27889
|
* @summary Get Campaign Reports
|
|
@@ -27642,7 +28074,7 @@ export declare const CertificationCampaignsApiFactory: (configuration?: Configur
|
|
|
27642
28074
|
* @param {*} [axiosOptions] Override http request option.
|
|
27643
28075
|
* @throws {RequiredError}
|
|
27644
28076
|
*/
|
|
27645
|
-
getCampaign(requestParameters: CertificationCampaignsApiGetCampaignRequest, axiosOptions?: RawAxiosRequestConfig): AxiosPromise<
|
|
28077
|
+
getCampaign(requestParameters: CertificationCampaignsApiGetCampaignRequest, axiosOptions?: RawAxiosRequestConfig): AxiosPromise<GetCampaign200Response>;
|
|
27646
28078
|
/**
|
|
27647
28079
|
* Use this API to fetch all reports for a certification campaign by campaign ID.
|
|
27648
28080
|
* @summary Get Campaign Reports
|
|
@@ -28208,7 +28640,7 @@ export declare class CertificationCampaignsApi extends BaseAPI {
|
|
|
28208
28640
|
* @throws {RequiredError}
|
|
28209
28641
|
* @memberof CertificationCampaignsApi
|
|
28210
28642
|
*/
|
|
28211
|
-
getCampaign(requestParameters: CertificationCampaignsApiGetCampaignRequest, axiosOptions?: RawAxiosRequestConfig): Promise<import("axios").AxiosResponse<
|
|
28643
|
+
getCampaign(requestParameters: CertificationCampaignsApiGetCampaignRequest, axiosOptions?: RawAxiosRequestConfig): Promise<import("axios").AxiosResponse<GetCampaign200Response, any>>;
|
|
28212
28644
|
/**
|
|
28213
28645
|
* Use this API to fetch all reports for a certification campaign by campaign ID.
|
|
28214
28646
|
* @summary Get Campaign Reports
|
|
@@ -44062,10 +44494,11 @@ export declare const WorkflowsApiAxiosParamCreator: (configuration?: Configurati
|
|
|
44062
44494
|
* Get a single workflow by id.
|
|
44063
44495
|
* @summary Get Workflow By Id
|
|
44064
44496
|
* @param {string} id Id of the workflow
|
|
44497
|
+
* @param {boolean} [workflowMetrics] disable workflow metrics
|
|
44065
44498
|
* @param {*} [axiosOptions] Override http request option.
|
|
44066
44499
|
* @throws {RequiredError}
|
|
44067
44500
|
*/
|
|
44068
|
-
getWorkflow: (id: string, axiosOptions?: RawAxiosRequestConfig) => Promise<RequestArgs>;
|
|
44501
|
+
getWorkflow: (id: string, workflowMetrics?: boolean, axiosOptions?: RawAxiosRequestConfig) => Promise<RequestArgs>;
|
|
44069
44502
|
/**
|
|
44070
44503
|
* Use this API to 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.
|
|
44071
44504
|
* @summary Get Workflow Execution
|
|
@@ -44133,10 +44566,14 @@ export declare const WorkflowsApiAxiosParamCreator: (configuration?: Configurati
|
|
|
44133
44566
|
/**
|
|
44134
44567
|
* List all workflows in the tenant.
|
|
44135
44568
|
* @summary List Workflows
|
|
44569
|
+
* @param {string} [triggerId] Trigger ID
|
|
44570
|
+
* @param {string} [connectorInstanceId] Connector Instance ID
|
|
44571
|
+
* @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.
|
|
44572
|
+
* @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.
|
|
44136
44573
|
* @param {*} [axiosOptions] Override http request option.
|
|
44137
44574
|
* @throws {RequiredError}
|
|
44138
44575
|
*/
|
|
44139
|
-
listWorkflows: (axiosOptions?: RawAxiosRequestConfig) => Promise<RequestArgs>;
|
|
44576
|
+
listWorkflows: (triggerId?: string, connectorInstanceId?: string, limit?: number, offset?: number, axiosOptions?: RawAxiosRequestConfig) => Promise<RequestArgs>;
|
|
44140
44577
|
/**
|
|
44141
44578
|
* Partially update an existing Workflow using [JSON Patch](https://tools.ietf.org/html/rfc6902) syntax.
|
|
44142
44579
|
* @summary Patch Workflow
|
|
@@ -44224,10 +44661,11 @@ export declare const WorkflowsApiFp: (configuration?: Configuration) => {
|
|
|
44224
44661
|
* Get a single workflow by id.
|
|
44225
44662
|
* @summary Get Workflow By Id
|
|
44226
44663
|
* @param {string} id Id of the workflow
|
|
44664
|
+
* @param {boolean} [workflowMetrics] disable workflow metrics
|
|
44227
44665
|
* @param {*} [axiosOptions] Override http request option.
|
|
44228
44666
|
* @throws {RequiredError}
|
|
44229
44667
|
*/
|
|
44230
|
-
getWorkflow(id: string, axiosOptions?: RawAxiosRequestConfig): Promise<(axios?: AxiosInstance, basePath?: string) => AxiosPromise<Workflow>>;
|
|
44668
|
+
getWorkflow(id: string, workflowMetrics?: boolean, axiosOptions?: RawAxiosRequestConfig): Promise<(axios?: AxiosInstance, basePath?: string) => AxiosPromise<Workflow>>;
|
|
44231
44669
|
/**
|
|
44232
44670
|
* Use this API to 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.
|
|
44233
44671
|
* @summary Get Workflow Execution
|
|
@@ -44295,10 +44733,14 @@ export declare const WorkflowsApiFp: (configuration?: Configuration) => {
|
|
|
44295
44733
|
/**
|
|
44296
44734
|
* List all workflows in the tenant.
|
|
44297
44735
|
* @summary List Workflows
|
|
44736
|
+
* @param {string} [triggerId] Trigger ID
|
|
44737
|
+
* @param {string} [connectorInstanceId] Connector Instance ID
|
|
44738
|
+
* @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.
|
|
44739
|
+
* @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.
|
|
44298
44740
|
* @param {*} [axiosOptions] Override http request option.
|
|
44299
44741
|
* @throws {RequiredError}
|
|
44300
44742
|
*/
|
|
44301
|
-
listWorkflows(axiosOptions?: RawAxiosRequestConfig): Promise<(axios?: AxiosInstance, basePath?: string) => AxiosPromise<Array<Workflow>>>;
|
|
44743
|
+
listWorkflows(triggerId?: string, connectorInstanceId?: string, limit?: number, offset?: number, axiosOptions?: RawAxiosRequestConfig): Promise<(axios?: AxiosInstance, basePath?: string) => AxiosPromise<Array<Workflow>>>;
|
|
44302
44744
|
/**
|
|
44303
44745
|
* Partially update an existing Workflow using [JSON Patch](https://tools.ietf.org/html/rfc6902) syntax.
|
|
44304
44746
|
* @summary Patch Workflow
|
|
@@ -44447,10 +44889,11 @@ export declare const WorkflowsApiFactory: (configuration?: Configuration, basePa
|
|
|
44447
44889
|
/**
|
|
44448
44890
|
* List all workflows in the tenant.
|
|
44449
44891
|
* @summary List Workflows
|
|
44892
|
+
* @param {WorkflowsApiListWorkflowsRequest} requestParameters Request parameters.
|
|
44450
44893
|
* @param {*} [axiosOptions] Override http request option.
|
|
44451
44894
|
* @throws {RequiredError}
|
|
44452
44895
|
*/
|
|
44453
|
-
listWorkflows(axiosOptions?: RawAxiosRequestConfig): AxiosPromise<Array<Workflow>>;
|
|
44896
|
+
listWorkflows(requestParameters?: WorkflowsApiListWorkflowsRequest, axiosOptions?: RawAxiosRequestConfig): AxiosPromise<Array<Workflow>>;
|
|
44454
44897
|
/**
|
|
44455
44898
|
* Partially update an existing Workflow using [JSON Patch](https://tools.ietf.org/html/rfc6902) syntax.
|
|
44456
44899
|
* @summary Patch Workflow
|
|
@@ -44567,6 +45010,12 @@ export interface WorkflowsApiGetWorkflowRequest {
|
|
|
44567
45010
|
* @memberof WorkflowsApiGetWorkflow
|
|
44568
45011
|
*/
|
|
44569
45012
|
readonly id: string;
|
|
45013
|
+
/**
|
|
45014
|
+
* disable workflow metrics
|
|
45015
|
+
* @type {boolean}
|
|
45016
|
+
* @memberof WorkflowsApiGetWorkflow
|
|
45017
|
+
*/
|
|
45018
|
+
readonly workflowMetrics?: boolean;
|
|
44570
45019
|
}
|
|
44571
45020
|
/**
|
|
44572
45021
|
* Request parameters for getWorkflowExecution operation in WorkflowsApi.
|
|
@@ -44700,6 +45149,37 @@ export interface WorkflowsApiListWorkflowLibraryTriggersRequest {
|
|
|
44700
45149
|
*/
|
|
44701
45150
|
readonly filters?: string;
|
|
44702
45151
|
}
|
|
45152
|
+
/**
|
|
45153
|
+
* Request parameters for listWorkflows operation in WorkflowsApi.
|
|
45154
|
+
* @export
|
|
45155
|
+
* @interface WorkflowsApiListWorkflowsRequest
|
|
45156
|
+
*/
|
|
45157
|
+
export interface WorkflowsApiListWorkflowsRequest {
|
|
45158
|
+
/**
|
|
45159
|
+
* Trigger ID
|
|
45160
|
+
* @type {string}
|
|
45161
|
+
* @memberof WorkflowsApiListWorkflows
|
|
45162
|
+
*/
|
|
45163
|
+
readonly triggerId?: string;
|
|
45164
|
+
/**
|
|
45165
|
+
* Connector Instance ID
|
|
45166
|
+
* @type {string}
|
|
45167
|
+
* @memberof WorkflowsApiListWorkflows
|
|
45168
|
+
*/
|
|
45169
|
+
readonly connectorInstanceId?: string;
|
|
45170
|
+
/**
|
|
45171
|
+
* Max number of results to return. See [V3 API Standard Collection Parameters](https://developer.sailpoint.com/idn/api/standard-collection-parameters) for more information.
|
|
45172
|
+
* @type {number}
|
|
45173
|
+
* @memberof WorkflowsApiListWorkflows
|
|
45174
|
+
*/
|
|
45175
|
+
readonly limit?: number;
|
|
45176
|
+
/**
|
|
45177
|
+
* 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.
|
|
45178
|
+
* @type {number}
|
|
45179
|
+
* @memberof WorkflowsApiListWorkflows
|
|
45180
|
+
*/
|
|
45181
|
+
readonly offset?: number;
|
|
45182
|
+
}
|
|
44703
45183
|
/**
|
|
44704
45184
|
* Request parameters for patchWorkflow operation in WorkflowsApi.
|
|
44705
45185
|
* @export
|
|
@@ -44902,11 +45382,12 @@ export declare class WorkflowsApi extends BaseAPI {
|
|
|
44902
45382
|
/**
|
|
44903
45383
|
* List all workflows in the tenant.
|
|
44904
45384
|
* @summary List Workflows
|
|
45385
|
+
* @param {WorkflowsApiListWorkflowsRequest} requestParameters Request parameters.
|
|
44905
45386
|
* @param {*} [axiosOptions] Override http request option.
|
|
44906
45387
|
* @throws {RequiredError}
|
|
44907
45388
|
* @memberof WorkflowsApi
|
|
44908
45389
|
*/
|
|
44909
|
-
listWorkflows(axiosOptions?: RawAxiosRequestConfig): Promise<import("axios").AxiosResponse<Workflow[], any>>;
|
|
45390
|
+
listWorkflows(requestParameters?: WorkflowsApiListWorkflowsRequest, axiosOptions?: RawAxiosRequestConfig): Promise<import("axios").AxiosResponse<Workflow[], any>>;
|
|
44910
45391
|
/**
|
|
44911
45392
|
* Partially update an existing Workflow using [JSON Patch](https://tools.ietf.org/html/rfc6902) syntax.
|
|
44912
45393
|
* @summary Patch Workflow
|