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/beta/api.d.ts
CHANGED
|
@@ -1283,6 +1283,12 @@ export interface AccessRequestBeta {
|
|
|
1283
1283
|
'clientMetadata'?: {
|
|
1284
1284
|
[key: string]: string;
|
|
1285
1285
|
};
|
|
1286
|
+
/**
|
|
1287
|
+
* 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
|
|
1288
|
+
* @type {Array<RequestedForDtoRefBeta>}
|
|
1289
|
+
* @memberof AccessRequestBeta
|
|
1290
|
+
*/
|
|
1291
|
+
'requestedForWithRequestedItems'?: Array<RequestedForDtoRefBeta> | null;
|
|
1286
1292
|
}
|
|
1287
1293
|
/**
|
|
1288
1294
|
*
|
|
@@ -1493,6 +1499,18 @@ export interface AccessRequestItemBeta {
|
|
|
1493
1499
|
* @memberof AccessRequestItemBeta
|
|
1494
1500
|
*/
|
|
1495
1501
|
'removeDate'?: string;
|
|
1502
|
+
/**
|
|
1503
|
+
* 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.
|
|
1504
|
+
* @type {string}
|
|
1505
|
+
* @memberof AccessRequestItemBeta
|
|
1506
|
+
*/
|
|
1507
|
+
'assignmentId'?: string | null;
|
|
1508
|
+
/**
|
|
1509
|
+
* 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.
|
|
1510
|
+
* @type {string}
|
|
1511
|
+
* @memberof AccessRequestItemBeta
|
|
1512
|
+
*/
|
|
1513
|
+
'nativeIdentity'?: string | null;
|
|
1496
1514
|
}
|
|
1497
1515
|
export declare const AccessRequestItemBetaTypeBeta: {
|
|
1498
1516
|
readonly AccessProfile: "ACCESS_PROFILE";
|
|
@@ -3117,6 +3135,25 @@ export interface AccountInfoDtoBeta {
|
|
|
3117
3135
|
*/
|
|
3118
3136
|
'uuid'?: string;
|
|
3119
3137
|
}
|
|
3138
|
+
/**
|
|
3139
|
+
*
|
|
3140
|
+
* @export
|
|
3141
|
+
* @interface AccountItemRefBeta
|
|
3142
|
+
*/
|
|
3143
|
+
export interface AccountItemRefBeta {
|
|
3144
|
+
/**
|
|
3145
|
+
* The uuid for the account, available under the \'objectguid\' attribute
|
|
3146
|
+
* @type {string}
|
|
3147
|
+
* @memberof AccountItemRefBeta
|
|
3148
|
+
*/
|
|
3149
|
+
'accountUuid'?: string | null;
|
|
3150
|
+
/**
|
|
3151
|
+
* The \'distinguishedName\' attribute for the account
|
|
3152
|
+
* @type {string}
|
|
3153
|
+
* @memberof AccountItemRefBeta
|
|
3154
|
+
*/
|
|
3155
|
+
'nativeIdentity'?: string;
|
|
3156
|
+
}
|
|
3120
3157
|
/**
|
|
3121
3158
|
* If an account activity item is associated with an access request, captures details of that request.
|
|
3122
3159
|
* @export
|
|
@@ -4629,7 +4666,7 @@ export interface AttributeDefinitionBeta {
|
|
|
4629
4666
|
* @type {AttributeDefinitionSchemaBeta}
|
|
4630
4667
|
* @memberof AttributeDefinitionBeta
|
|
4631
4668
|
*/
|
|
4632
|
-
'schema'?: AttributeDefinitionSchemaBeta;
|
|
4669
|
+
'schema'?: AttributeDefinitionSchemaBeta | null;
|
|
4633
4670
|
/**
|
|
4634
4671
|
* A human-readable description of the attribute.
|
|
4635
4672
|
* @type {string}
|
|
@@ -4694,6 +4731,7 @@ export declare const AttributeDefinitionTypeBeta: {
|
|
|
4694
4731
|
readonly Long: "LONG";
|
|
4695
4732
|
readonly Int: "INT";
|
|
4696
4733
|
readonly Boolean: "BOOLEAN";
|
|
4734
|
+
readonly Date: "DATE";
|
|
4697
4735
|
};
|
|
4698
4736
|
export type AttributeDefinitionTypeBeta = typeof AttributeDefinitionTypeBeta[keyof typeof AttributeDefinitionTypeBeta];
|
|
4699
4737
|
/**
|
|
@@ -11635,10 +11673,181 @@ export interface GenerateRandomStringBeta {
|
|
|
11635
11673
|
'requiresPeriodicRefresh'?: boolean;
|
|
11636
11674
|
}
|
|
11637
11675
|
/**
|
|
11638
|
-
*
|
|
11676
|
+
*
|
|
11639
11677
|
* @export
|
|
11678
|
+
* @interface GetActiveCampaigns200ResponseInnerBeta
|
|
11640
11679
|
*/
|
|
11641
|
-
export
|
|
11680
|
+
export interface GetActiveCampaigns200ResponseInnerBeta {
|
|
11681
|
+
/**
|
|
11682
|
+
* Id of the campaign
|
|
11683
|
+
* @type {string}
|
|
11684
|
+
* @memberof GetActiveCampaigns200ResponseInnerBeta
|
|
11685
|
+
*/
|
|
11686
|
+
'id'?: string;
|
|
11687
|
+
/**
|
|
11688
|
+
* The campaign name. If this object is part of a template, special formatting applies; see the `/campaign-templates/{id}/generate` endpoint documentation for details.
|
|
11689
|
+
* @type {string}
|
|
11690
|
+
* @memberof GetActiveCampaigns200ResponseInnerBeta
|
|
11691
|
+
*/
|
|
11692
|
+
'name': string;
|
|
11693
|
+
/**
|
|
11694
|
+
* The campaign description. If this object is part of a template, special formatting applies; see the `/campaign-templates/{id}/generate` endpoint documentation for details.
|
|
11695
|
+
* @type {string}
|
|
11696
|
+
* @memberof GetActiveCampaigns200ResponseInnerBeta
|
|
11697
|
+
*/
|
|
11698
|
+
'description': string;
|
|
11699
|
+
/**
|
|
11700
|
+
* 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.
|
|
11701
|
+
* @type {string}
|
|
11702
|
+
* @memberof GetActiveCampaigns200ResponseInnerBeta
|
|
11703
|
+
*/
|
|
11704
|
+
'deadline'?: string;
|
|
11705
|
+
/**
|
|
11706
|
+
* The type of campaign. Could be extended in the future.
|
|
11707
|
+
* @type {string}
|
|
11708
|
+
* @memberof GetActiveCampaigns200ResponseInnerBeta
|
|
11709
|
+
*/
|
|
11710
|
+
'type': GetActiveCampaigns200ResponseInnerBetaTypeBeta;
|
|
11711
|
+
/**
|
|
11712
|
+
* Enables email notification for this campaign
|
|
11713
|
+
* @type {boolean}
|
|
11714
|
+
* @memberof GetActiveCampaigns200ResponseInnerBeta
|
|
11715
|
+
*/
|
|
11716
|
+
'emailNotificationEnabled'?: boolean;
|
|
11717
|
+
/**
|
|
11718
|
+
* Allows auto revoke for this campaign
|
|
11719
|
+
* @type {boolean}
|
|
11720
|
+
* @memberof GetActiveCampaigns200ResponseInnerBeta
|
|
11721
|
+
*/
|
|
11722
|
+
'autoRevokeAllowed'?: boolean;
|
|
11723
|
+
/**
|
|
11724
|
+
* 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.
|
|
11725
|
+
* @type {boolean}
|
|
11726
|
+
* @memberof GetActiveCampaigns200ResponseInnerBeta
|
|
11727
|
+
*/
|
|
11728
|
+
'recommendationsEnabled'?: boolean;
|
|
11729
|
+
/**
|
|
11730
|
+
* The campaign\'s current status.
|
|
11731
|
+
* @type {string}
|
|
11732
|
+
* @memberof GetActiveCampaigns200ResponseInnerBeta
|
|
11733
|
+
*/
|
|
11734
|
+
'status'?: GetActiveCampaigns200ResponseInnerBetaStatusBeta;
|
|
11735
|
+
/**
|
|
11736
|
+
* 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).
|
|
11737
|
+
* @type {string}
|
|
11738
|
+
* @memberof GetActiveCampaigns200ResponseInnerBeta
|
|
11739
|
+
*/
|
|
11740
|
+
'correlatedStatus'?: GetActiveCampaigns200ResponseInnerBetaCorrelatedStatusBeta;
|
|
11741
|
+
/**
|
|
11742
|
+
* Created time of the campaign
|
|
11743
|
+
* @type {string}
|
|
11744
|
+
* @memberof GetActiveCampaigns200ResponseInnerBeta
|
|
11745
|
+
*/
|
|
11746
|
+
'created'?: string;
|
|
11747
|
+
/**
|
|
11748
|
+
* The total number of certifications in this campaign.
|
|
11749
|
+
* @type {number}
|
|
11750
|
+
* @memberof GetActiveCampaigns200ResponseInnerBeta
|
|
11751
|
+
*/
|
|
11752
|
+
'totalCertifications'?: number;
|
|
11753
|
+
/**
|
|
11754
|
+
* The number of completed certifications in this campaign.
|
|
11755
|
+
* @type {number}
|
|
11756
|
+
* @memberof GetActiveCampaigns200ResponseInnerBeta
|
|
11757
|
+
*/
|
|
11758
|
+
'completedCertifications'?: number;
|
|
11759
|
+
/**
|
|
11760
|
+
* A list of errors and warnings that have accumulated.
|
|
11761
|
+
* @type {Array<CampaignAlertBeta>}
|
|
11762
|
+
* @memberof GetActiveCampaigns200ResponseInnerBeta
|
|
11763
|
+
*/
|
|
11764
|
+
'alerts'?: Array<CampaignAlertBeta>;
|
|
11765
|
+
/**
|
|
11766
|
+
* Modified time of the campaign
|
|
11767
|
+
* @type {string}
|
|
11768
|
+
* @memberof GetActiveCampaigns200ResponseInnerBeta
|
|
11769
|
+
*/
|
|
11770
|
+
'modified'?: string;
|
|
11771
|
+
/**
|
|
11772
|
+
*
|
|
11773
|
+
* @type {FullcampaignAllOfFilterBeta}
|
|
11774
|
+
* @memberof GetActiveCampaigns200ResponseInnerBeta
|
|
11775
|
+
*/
|
|
11776
|
+
'filter'?: FullcampaignAllOfFilterBeta;
|
|
11777
|
+
/**
|
|
11778
|
+
* Determines if comments on sunset date changes are required.
|
|
11779
|
+
* @type {boolean}
|
|
11780
|
+
* @memberof GetActiveCampaigns200ResponseInnerBeta
|
|
11781
|
+
*/
|
|
11782
|
+
'sunsetCommentsRequired'?: boolean;
|
|
11783
|
+
/**
|
|
11784
|
+
*
|
|
11785
|
+
* @type {FullcampaignAllOfSourceOwnerCampaignInfoBeta}
|
|
11786
|
+
* @memberof GetActiveCampaigns200ResponseInnerBeta
|
|
11787
|
+
*/
|
|
11788
|
+
'sourceOwnerCampaignInfo'?: FullcampaignAllOfSourceOwnerCampaignInfoBeta;
|
|
11789
|
+
/**
|
|
11790
|
+
*
|
|
11791
|
+
* @type {FullcampaignAllOfSearchCampaignInfoBeta}
|
|
11792
|
+
* @memberof GetActiveCampaigns200ResponseInnerBeta
|
|
11793
|
+
*/
|
|
11794
|
+
'searchCampaignInfo'?: FullcampaignAllOfSearchCampaignInfoBeta;
|
|
11795
|
+
/**
|
|
11796
|
+
*
|
|
11797
|
+
* @type {FullcampaignAllOfRoleCompositionCampaignInfoBeta}
|
|
11798
|
+
* @memberof GetActiveCampaigns200ResponseInnerBeta
|
|
11799
|
+
*/
|
|
11800
|
+
'roleCompositionCampaignInfo'?: FullcampaignAllOfRoleCompositionCampaignInfoBeta;
|
|
11801
|
+
/**
|
|
11802
|
+
*
|
|
11803
|
+
* @type {FullcampaignAllOfMachineAccountCampaignInfoBeta}
|
|
11804
|
+
* @memberof GetActiveCampaigns200ResponseInnerBeta
|
|
11805
|
+
*/
|
|
11806
|
+
'machineAccountCampaignInfo'?: FullcampaignAllOfMachineAccountCampaignInfoBeta;
|
|
11807
|
+
/**
|
|
11808
|
+
* 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).
|
|
11809
|
+
* @type {Array<FullcampaignAllOfSourcesWithOrphanEntitlementsBeta>}
|
|
11810
|
+
* @memberof GetActiveCampaigns200ResponseInnerBeta
|
|
11811
|
+
*/
|
|
11812
|
+
'sourcesWithOrphanEntitlements'?: Array<FullcampaignAllOfSourcesWithOrphanEntitlementsBeta>;
|
|
11813
|
+
/**
|
|
11814
|
+
* 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.
|
|
11815
|
+
* @type {string}
|
|
11816
|
+
* @memberof GetActiveCampaigns200ResponseInnerBeta
|
|
11817
|
+
*/
|
|
11818
|
+
'mandatoryCommentRequirement'?: GetActiveCampaigns200ResponseInnerBetaMandatoryCommentRequirementBeta;
|
|
11819
|
+
}
|
|
11820
|
+
export declare const GetActiveCampaigns200ResponseInnerBetaTypeBeta: {
|
|
11821
|
+
readonly Manager: "MANAGER";
|
|
11822
|
+
readonly SourceOwner: "SOURCE_OWNER";
|
|
11823
|
+
readonly Search: "SEARCH";
|
|
11824
|
+
readonly RoleComposition: "ROLE_COMPOSITION";
|
|
11825
|
+
readonly MachineAccount: "MACHINE_ACCOUNT";
|
|
11826
|
+
};
|
|
11827
|
+
export type GetActiveCampaigns200ResponseInnerBetaTypeBeta = typeof GetActiveCampaigns200ResponseInnerBetaTypeBeta[keyof typeof GetActiveCampaigns200ResponseInnerBetaTypeBeta];
|
|
11828
|
+
export declare const GetActiveCampaigns200ResponseInnerBetaStatusBeta: {
|
|
11829
|
+
readonly Pending: "PENDING";
|
|
11830
|
+
readonly Staged: "STAGED";
|
|
11831
|
+
readonly Canceling: "CANCELING";
|
|
11832
|
+
readonly Activating: "ACTIVATING";
|
|
11833
|
+
readonly Active: "ACTIVE";
|
|
11834
|
+
readonly Completing: "COMPLETING";
|
|
11835
|
+
readonly Completed: "COMPLETED";
|
|
11836
|
+
readonly Error: "ERROR";
|
|
11837
|
+
readonly Archived: "ARCHIVED";
|
|
11838
|
+
};
|
|
11839
|
+
export type GetActiveCampaigns200ResponseInnerBetaStatusBeta = typeof GetActiveCampaigns200ResponseInnerBetaStatusBeta[keyof typeof GetActiveCampaigns200ResponseInnerBetaStatusBeta];
|
|
11840
|
+
export declare const GetActiveCampaigns200ResponseInnerBetaCorrelatedStatusBeta: {
|
|
11841
|
+
readonly Correlated: "CORRELATED";
|
|
11842
|
+
readonly Uncorrelated: "UNCORRELATED";
|
|
11843
|
+
};
|
|
11844
|
+
export type GetActiveCampaigns200ResponseInnerBetaCorrelatedStatusBeta = typeof GetActiveCampaigns200ResponseInnerBetaCorrelatedStatusBeta[keyof typeof GetActiveCampaigns200ResponseInnerBetaCorrelatedStatusBeta];
|
|
11845
|
+
export declare const GetActiveCampaigns200ResponseInnerBetaMandatoryCommentRequirementBeta: {
|
|
11846
|
+
readonly AllDecisions: "ALL_DECISIONS";
|
|
11847
|
+
readonly RevokeOnlyDecisions: "REVOKE_ONLY_DECISIONS";
|
|
11848
|
+
readonly NoDecisions: "NO_DECISIONS";
|
|
11849
|
+
};
|
|
11850
|
+
export type GetActiveCampaigns200ResponseInnerBetaMandatoryCommentRequirementBeta = typeof GetActiveCampaigns200ResponseInnerBetaMandatoryCommentRequirementBeta[keyof typeof GetActiveCampaigns200ResponseInnerBetaMandatoryCommentRequirementBeta];
|
|
11642
11851
|
/**
|
|
11643
11852
|
* @type GetDiscoveredApplications200ResponseInnerBeta
|
|
11644
11853
|
* @export
|
|
@@ -20597,7 +20806,7 @@ export interface ProvisioningPolicyDtoBeta {
|
|
|
20597
20806
|
* @type {string}
|
|
20598
20807
|
* @memberof ProvisioningPolicyDtoBeta
|
|
20599
20808
|
*/
|
|
20600
|
-
'name': string;
|
|
20809
|
+
'name': string | null;
|
|
20601
20810
|
/**
|
|
20602
20811
|
* the description of the provisioning policy
|
|
20603
20812
|
* @type {string}
|
|
@@ -21605,6 +21814,25 @@ export interface RequestedAccountRefBeta {
|
|
|
21605
21814
|
*/
|
|
21606
21815
|
'sourceName'?: string;
|
|
21607
21816
|
}
|
|
21817
|
+
/**
|
|
21818
|
+
*
|
|
21819
|
+
* @export
|
|
21820
|
+
* @interface RequestedForDtoRefBeta
|
|
21821
|
+
*/
|
|
21822
|
+
export interface RequestedForDtoRefBeta {
|
|
21823
|
+
/**
|
|
21824
|
+
* The identity id for which the access is requested
|
|
21825
|
+
* @type {string}
|
|
21826
|
+
* @memberof RequestedForDtoRefBeta
|
|
21827
|
+
*/
|
|
21828
|
+
'identityId': string;
|
|
21829
|
+
/**
|
|
21830
|
+
* the details for the access items that are requested for the identity
|
|
21831
|
+
* @type {Array<RequestedItemDtoRefBeta>}
|
|
21832
|
+
* @memberof RequestedForDtoRefBeta
|
|
21833
|
+
*/
|
|
21834
|
+
'requestedItems': Array<RequestedItemDtoRefBeta>;
|
|
21835
|
+
}
|
|
21608
21836
|
/**
|
|
21609
21837
|
*
|
|
21610
21838
|
* @export
|
|
@@ -21630,6 +21858,69 @@ export declare const RequestedItemDetailsBetaTypeBeta: {
|
|
|
21630
21858
|
readonly Role: "ROLE";
|
|
21631
21859
|
};
|
|
21632
21860
|
export type RequestedItemDetailsBetaTypeBeta = typeof RequestedItemDetailsBetaTypeBeta[keyof typeof RequestedItemDetailsBetaTypeBeta];
|
|
21861
|
+
/**
|
|
21862
|
+
*
|
|
21863
|
+
* @export
|
|
21864
|
+
* @interface RequestedItemDtoRefBeta
|
|
21865
|
+
*/
|
|
21866
|
+
export interface RequestedItemDtoRefBeta {
|
|
21867
|
+
/**
|
|
21868
|
+
* The type of the item being requested.
|
|
21869
|
+
* @type {string}
|
|
21870
|
+
* @memberof RequestedItemDtoRefBeta
|
|
21871
|
+
*/
|
|
21872
|
+
'type': RequestedItemDtoRefBetaTypeBeta;
|
|
21873
|
+
/**
|
|
21874
|
+
* ID of Role, Access Profile or Entitlement being requested.
|
|
21875
|
+
* @type {string}
|
|
21876
|
+
* @memberof RequestedItemDtoRefBeta
|
|
21877
|
+
*/
|
|
21878
|
+
'id': string;
|
|
21879
|
+
/**
|
|
21880
|
+
* Comment provided by requester. * Comment is required when the request is of type Revoke Access.
|
|
21881
|
+
* @type {string}
|
|
21882
|
+
* @memberof RequestedItemDtoRefBeta
|
|
21883
|
+
*/
|
|
21884
|
+
'comment'?: string;
|
|
21885
|
+
/**
|
|
21886
|
+
* 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.
|
|
21887
|
+
* @type {{ [key: string]: string; }}
|
|
21888
|
+
* @memberof RequestedItemDtoRefBeta
|
|
21889
|
+
*/
|
|
21890
|
+
'clientMetadata'?: {
|
|
21891
|
+
[key: string]: string;
|
|
21892
|
+
};
|
|
21893
|
+
/**
|
|
21894
|
+
* 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.
|
|
21895
|
+
* @type {string}
|
|
21896
|
+
* @memberof RequestedItemDtoRefBeta
|
|
21897
|
+
*/
|
|
21898
|
+
'removeDate'?: string;
|
|
21899
|
+
/**
|
|
21900
|
+
* 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.
|
|
21901
|
+
* @type {string}
|
|
21902
|
+
* @memberof RequestedItemDtoRefBeta
|
|
21903
|
+
*/
|
|
21904
|
+
'assignmentId'?: string | null;
|
|
21905
|
+
/**
|
|
21906
|
+
* 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.
|
|
21907
|
+
* @type {string}
|
|
21908
|
+
* @memberof RequestedItemDtoRefBeta
|
|
21909
|
+
*/
|
|
21910
|
+
'nativeIdentity'?: string | null;
|
|
21911
|
+
/**
|
|
21912
|
+
* 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
|
|
21913
|
+
* @type {Array<SourceItemRefBeta>}
|
|
21914
|
+
* @memberof RequestedItemDtoRefBeta
|
|
21915
|
+
*/
|
|
21916
|
+
'accountSelection'?: Array<SourceItemRefBeta> | null;
|
|
21917
|
+
}
|
|
21918
|
+
export declare const RequestedItemDtoRefBetaTypeBeta: {
|
|
21919
|
+
readonly AccessProfile: "ACCESS_PROFILE";
|
|
21920
|
+
readonly Role: "ROLE";
|
|
21921
|
+
readonly Entitlement: "ENTITLEMENT";
|
|
21922
|
+
};
|
|
21923
|
+
export type RequestedItemDtoRefBetaTypeBeta = typeof RequestedItemDtoRefBetaTypeBeta[keyof typeof RequestedItemDtoRefBetaTypeBeta];
|
|
21633
21924
|
/**
|
|
21634
21925
|
*
|
|
21635
21926
|
* @export
|
|
@@ -24583,7 +24874,7 @@ export interface SchemaBeta {
|
|
|
24583
24874
|
* @type {string}
|
|
24584
24875
|
* @memberof SchemaBeta
|
|
24585
24876
|
*/
|
|
24586
|
-
'hierarchyAttribute'?: string;
|
|
24877
|
+
'hierarchyAttribute'?: string | null;
|
|
24587
24878
|
/**
|
|
24588
24879
|
* Flag indicating whether or not the include permissions with the object data when aggregating the schema.
|
|
24589
24880
|
* @type {boolean}
|
|
@@ -24619,7 +24910,7 @@ export interface SchemaBeta {
|
|
|
24619
24910
|
* @type {string}
|
|
24620
24911
|
* @memberof SchemaBeta
|
|
24621
24912
|
*/
|
|
24622
|
-
'modified'?: string;
|
|
24913
|
+
'modified'?: string | null;
|
|
24623
24914
|
}
|
|
24624
24915
|
export declare const SchemaBetaFeaturesBeta: {
|
|
24625
24916
|
readonly Authenticate: "AUTHENTICATE";
|
|
@@ -27381,6 +27672,25 @@ export interface SourceEntitlementRequestConfigBeta {
|
|
|
27381
27672
|
*/
|
|
27382
27673
|
'accessRequestConfig'?: EntitlementAccessRequestConfigBeta;
|
|
27383
27674
|
}
|
|
27675
|
+
/**
|
|
27676
|
+
*
|
|
27677
|
+
* @export
|
|
27678
|
+
* @interface SourceItemRefBeta
|
|
27679
|
+
*/
|
|
27680
|
+
export interface SourceItemRefBeta {
|
|
27681
|
+
/**
|
|
27682
|
+
* The id for the source on which account selections are made
|
|
27683
|
+
* @type {string}
|
|
27684
|
+
* @memberof SourceItemRefBeta
|
|
27685
|
+
*/
|
|
27686
|
+
'sourceId'?: string | null;
|
|
27687
|
+
/**
|
|
27688
|
+
* A list of account selections on the source. Currently, only one selection per source is supported.
|
|
27689
|
+
* @type {Array<AccountItemRefBeta>}
|
|
27690
|
+
* @memberof SourceItemRefBeta
|
|
27691
|
+
*/
|
|
27692
|
+
'accounts'?: Array<AccountItemRefBeta> | null;
|
|
27693
|
+
}
|
|
27384
27694
|
/**
|
|
27385
27695
|
*
|
|
27386
27696
|
* @export
|
|
@@ -33393,7 +33703,7 @@ export declare const AccessRequestsBetaApiAxiosParamCreator: (configuration?: Co
|
|
|
33393
33703
|
*/
|
|
33394
33704
|
closeAccessRequest: (closeAccessRequestBeta: CloseAccessRequestBeta, axiosOptions?: RawAxiosRequestConfig) => Promise<RequestArgs>;
|
|
33395
33705
|
/**
|
|
33396
|
-
* 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.
|
|
33706
|
+
* 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.
|
|
33397
33707
|
* @summary Submit Access Request
|
|
33398
33708
|
* @param {AccessRequestBeta} accessRequestBeta
|
|
33399
33709
|
* @param {*} [axiosOptions] Override http request option.
|
|
@@ -33455,7 +33765,7 @@ export declare const AccessRequestsBetaApiFp: (configuration?: Configuration) =>
|
|
|
33455
33765
|
*/
|
|
33456
33766
|
closeAccessRequest(closeAccessRequestBeta: CloseAccessRequestBeta, axiosOptions?: RawAxiosRequestConfig): Promise<(axios?: AxiosInstance, basePath?: string) => AxiosPromise<object>>;
|
|
33457
33767
|
/**
|
|
33458
|
-
* 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.
|
|
33768
|
+
* 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.
|
|
33459
33769
|
* @summary Submit Access Request
|
|
33460
33770
|
* @param {AccessRequestBeta} accessRequestBeta
|
|
33461
33771
|
* @param {*} [axiosOptions] Override http request option.
|
|
@@ -33517,7 +33827,7 @@ export declare const AccessRequestsBetaApiFactory: (configuration?: Configuratio
|
|
|
33517
33827
|
*/
|
|
33518
33828
|
closeAccessRequest(requestParameters: AccessRequestsBetaApiCloseAccessRequestRequest, axiosOptions?: RawAxiosRequestConfig): AxiosPromise<object>;
|
|
33519
33829
|
/**
|
|
33520
|
-
* 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.
|
|
33830
|
+
* 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.
|
|
33521
33831
|
* @summary Submit Access Request
|
|
33522
33832
|
* @param {AccessRequestsBetaApiCreateAccessRequestRequest} requestParameters Request parameters.
|
|
33523
33833
|
* @param {*} [axiosOptions] Override http request option.
|
|
@@ -33693,7 +34003,7 @@ export declare class AccessRequestsBetaApi extends BaseAPI {
|
|
|
33693
34003
|
*/
|
|
33694
34004
|
closeAccessRequest(requestParameters: AccessRequestsBetaApiCloseAccessRequestRequest, axiosOptions?: RawAxiosRequestConfig): Promise<import("axios").AxiosResponse<object, any>>;
|
|
33695
34005
|
/**
|
|
33696
|
-
* 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.
|
|
34006
|
+
* 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.
|
|
33697
34007
|
* @summary Submit Access Request
|
|
33698
34008
|
* @param {AccessRequestsBetaApiCreateAccessRequestRequest} requestParameters Request parameters.
|
|
33699
34009
|
* @param {*} [axiosOptions] Override http request option.
|
|
@@ -64125,10 +64435,11 @@ export declare const WorkflowsBetaApiAxiosParamCreator: (configuration?: Configu
|
|
|
64125
64435
|
* Get a single workflow by id.
|
|
64126
64436
|
* @summary Get Workflow By Id
|
|
64127
64437
|
* @param {string} id Id of the workflow
|
|
64438
|
+
* @param {boolean} [workflowMetrics] disable workflow metrics
|
|
64128
64439
|
* @param {*} [axiosOptions] Override http request option.
|
|
64129
64440
|
* @throws {RequiredError}
|
|
64130
64441
|
*/
|
|
64131
|
-
getWorkflow: (id: string, axiosOptions?: RawAxiosRequestConfig) => Promise<RequestArgs>;
|
|
64442
|
+
getWorkflow: (id: string, workflowMetrics?: boolean, axiosOptions?: RawAxiosRequestConfig) => Promise<RequestArgs>;
|
|
64132
64443
|
/**
|
|
64133
64444
|
* 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.
|
|
64134
64445
|
* @summary Get Workflow Execution
|
|
@@ -64196,10 +64507,14 @@ export declare const WorkflowsBetaApiAxiosParamCreator: (configuration?: Configu
|
|
|
64196
64507
|
/**
|
|
64197
64508
|
* List all workflows in the tenant.
|
|
64198
64509
|
* @summary List Workflows
|
|
64510
|
+
* @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.
|
|
64511
|
+
* @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.
|
|
64512
|
+
* @param {string} [triggerId] Trigger ID
|
|
64513
|
+
* @param {string} [connectorInstanceId] Connector Instance ID
|
|
64199
64514
|
* @param {*} [axiosOptions] Override http request option.
|
|
64200
64515
|
* @throws {RequiredError}
|
|
64201
64516
|
*/
|
|
64202
|
-
listWorkflows: (axiosOptions?: RawAxiosRequestConfig) => Promise<RequestArgs>;
|
|
64517
|
+
listWorkflows: (limit?: number, offset?: number, triggerId?: string, connectorInstanceId?: string, axiosOptions?: RawAxiosRequestConfig) => Promise<RequestArgs>;
|
|
64203
64518
|
/**
|
|
64204
64519
|
* Partially update an existing Workflow using [JSON Patch](https://tools.ietf.org/html/rfc6902) syntax.
|
|
64205
64520
|
* @summary Patch Workflow
|
|
@@ -64226,6 +64541,15 @@ export declare const WorkflowsBetaApiAxiosParamCreator: (configuration?: Configu
|
|
|
64226
64541
|
* @throws {RequiredError}
|
|
64227
64542
|
*/
|
|
64228
64543
|
postWorkflowExternalTrigger: (id: string, axiosOptions?: RawAxiosRequestConfig) => Promise<RequestArgs>;
|
|
64544
|
+
/**
|
|
64545
|
+
* Perform a full update of a workflow. The updated workflow object is returned in the response.
|
|
64546
|
+
* @summary Update Workflow
|
|
64547
|
+
* @param {string} id Id of the Workflow
|
|
64548
|
+
* @param {WorkflowBodyBeta} workflowBodyBeta
|
|
64549
|
+
* @param {*} [axiosOptions] Override http request option.
|
|
64550
|
+
* @throws {RequiredError}
|
|
64551
|
+
*/
|
|
64552
|
+
putWorkflow: (id: string, workflowBodyBeta: WorkflowBodyBeta, axiosOptions?: RawAxiosRequestConfig) => Promise<RequestArgs>;
|
|
64229
64553
|
/**
|
|
64230
64554
|
* Validate a workflow with an \"External Trigger\" can receive input. The response includes the input that the workflow received, which can be used to validate that the input is intact when it reaches the workflow.
|
|
64231
64555
|
* @summary Test Workflow via External Trigger
|
|
@@ -64244,15 +64568,6 @@ export declare const WorkflowsBetaApiAxiosParamCreator: (configuration?: Configu
|
|
|
64244
64568
|
* @throws {RequiredError}
|
|
64245
64569
|
*/
|
|
64246
64570
|
testWorkflow: (id: string, testWorkflowRequestBeta: TestWorkflowRequestBeta, axiosOptions?: RawAxiosRequestConfig) => Promise<RequestArgs>;
|
|
64247
|
-
/**
|
|
64248
|
-
* Perform a full update of a workflow. The updated workflow object is returned in the response.
|
|
64249
|
-
* @summary Update Workflow
|
|
64250
|
-
* @param {string} id Id of the Workflow
|
|
64251
|
-
* @param {WorkflowBodyBeta} workflowBodyBeta
|
|
64252
|
-
* @param {*} [axiosOptions] Override http request option.
|
|
64253
|
-
* @throws {RequiredError}
|
|
64254
|
-
*/
|
|
64255
|
-
updateWorkflow: (id: string, workflowBodyBeta: WorkflowBodyBeta, axiosOptions?: RawAxiosRequestConfig) => Promise<RequestArgs>;
|
|
64256
64571
|
};
|
|
64257
64572
|
/**
|
|
64258
64573
|
* WorkflowsBetaApi - functional programming interface
|
|
@@ -64287,10 +64602,11 @@ export declare const WorkflowsBetaApiFp: (configuration?: Configuration) => {
|
|
|
64287
64602
|
* Get a single workflow by id.
|
|
64288
64603
|
* @summary Get Workflow By Id
|
|
64289
64604
|
* @param {string} id Id of the workflow
|
|
64605
|
+
* @param {boolean} [workflowMetrics] disable workflow metrics
|
|
64290
64606
|
* @param {*} [axiosOptions] Override http request option.
|
|
64291
64607
|
* @throws {RequiredError}
|
|
64292
64608
|
*/
|
|
64293
|
-
getWorkflow(id: string, axiosOptions?: RawAxiosRequestConfig): Promise<(axios?: AxiosInstance, basePath?: string) => AxiosPromise<WorkflowBeta>>;
|
|
64609
|
+
getWorkflow(id: string, workflowMetrics?: boolean, axiosOptions?: RawAxiosRequestConfig): Promise<(axios?: AxiosInstance, basePath?: string) => AxiosPromise<WorkflowBeta>>;
|
|
64294
64610
|
/**
|
|
64295
64611
|
* 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.
|
|
64296
64612
|
* @summary Get Workflow Execution
|
|
@@ -64358,10 +64674,14 @@ export declare const WorkflowsBetaApiFp: (configuration?: Configuration) => {
|
|
|
64358
64674
|
/**
|
|
64359
64675
|
* List all workflows in the tenant.
|
|
64360
64676
|
* @summary List Workflows
|
|
64677
|
+
* @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.
|
|
64678
|
+
* @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.
|
|
64679
|
+
* @param {string} [triggerId] Trigger ID
|
|
64680
|
+
* @param {string} [connectorInstanceId] Connector Instance ID
|
|
64361
64681
|
* @param {*} [axiosOptions] Override http request option.
|
|
64362
64682
|
* @throws {RequiredError}
|
|
64363
64683
|
*/
|
|
64364
|
-
listWorkflows(axiosOptions?: RawAxiosRequestConfig): Promise<(axios?: AxiosInstance, basePath?: string) => AxiosPromise<Array<WorkflowBeta>>>;
|
|
64684
|
+
listWorkflows(limit?: number, offset?: number, triggerId?: string, connectorInstanceId?: string, axiosOptions?: RawAxiosRequestConfig): Promise<(axios?: AxiosInstance, basePath?: string) => AxiosPromise<Array<WorkflowBeta>>>;
|
|
64365
64685
|
/**
|
|
64366
64686
|
* Partially update an existing Workflow using [JSON Patch](https://tools.ietf.org/html/rfc6902) syntax.
|
|
64367
64687
|
* @summary Patch Workflow
|
|
@@ -64388,6 +64708,15 @@ export declare const WorkflowsBetaApiFp: (configuration?: Configuration) => {
|
|
|
64388
64708
|
* @throws {RequiredError}
|
|
64389
64709
|
*/
|
|
64390
64710
|
postWorkflowExternalTrigger(id: string, axiosOptions?: RawAxiosRequestConfig): Promise<(axios?: AxiosInstance, basePath?: string) => AxiosPromise<WorkflowOAuthClientBeta>>;
|
|
64711
|
+
/**
|
|
64712
|
+
* Perform a full update of a workflow. The updated workflow object is returned in the response.
|
|
64713
|
+
* @summary Update Workflow
|
|
64714
|
+
* @param {string} id Id of the Workflow
|
|
64715
|
+
* @param {WorkflowBodyBeta} workflowBodyBeta
|
|
64716
|
+
* @param {*} [axiosOptions] Override http request option.
|
|
64717
|
+
* @throws {RequiredError}
|
|
64718
|
+
*/
|
|
64719
|
+
putWorkflow(id: string, workflowBodyBeta: WorkflowBodyBeta, axiosOptions?: RawAxiosRequestConfig): Promise<(axios?: AxiosInstance, basePath?: string) => AxiosPromise<WorkflowBeta>>;
|
|
64391
64720
|
/**
|
|
64392
64721
|
* Validate a workflow with an \"External Trigger\" can receive input. The response includes the input that the workflow received, which can be used to validate that the input is intact when it reaches the workflow.
|
|
64393
64722
|
* @summary Test Workflow via External Trigger
|
|
@@ -64406,15 +64735,6 @@ export declare const WorkflowsBetaApiFp: (configuration?: Configuration) => {
|
|
|
64406
64735
|
* @throws {RequiredError}
|
|
64407
64736
|
*/
|
|
64408
64737
|
testWorkflow(id: string, testWorkflowRequestBeta: TestWorkflowRequestBeta, axiosOptions?: RawAxiosRequestConfig): Promise<(axios?: AxiosInstance, basePath?: string) => AxiosPromise<TestWorkflow200ResponseBeta>>;
|
|
64409
|
-
/**
|
|
64410
|
-
* Perform a full update of a workflow. The updated workflow object is returned in the response.
|
|
64411
|
-
* @summary Update Workflow
|
|
64412
|
-
* @param {string} id Id of the Workflow
|
|
64413
|
-
* @param {WorkflowBodyBeta} workflowBodyBeta
|
|
64414
|
-
* @param {*} [axiosOptions] Override http request option.
|
|
64415
|
-
* @throws {RequiredError}
|
|
64416
|
-
*/
|
|
64417
|
-
updateWorkflow(id: string, workflowBodyBeta: WorkflowBodyBeta, axiosOptions?: RawAxiosRequestConfig): Promise<(axios?: AxiosInstance, basePath?: string) => AxiosPromise<WorkflowBeta>>;
|
|
64418
64738
|
};
|
|
64419
64739
|
/**
|
|
64420
64740
|
* WorkflowsBetaApi - factory interface
|
|
@@ -64511,10 +64831,11 @@ export declare const WorkflowsBetaApiFactory: (configuration?: Configuration, ba
|
|
|
64511
64831
|
/**
|
|
64512
64832
|
* List all workflows in the tenant.
|
|
64513
64833
|
* @summary List Workflows
|
|
64834
|
+
* @param {WorkflowsBetaApiListWorkflowsRequest} requestParameters Request parameters.
|
|
64514
64835
|
* @param {*} [axiosOptions] Override http request option.
|
|
64515
64836
|
* @throws {RequiredError}
|
|
64516
64837
|
*/
|
|
64517
|
-
listWorkflows(axiosOptions?: RawAxiosRequestConfig): AxiosPromise<Array<WorkflowBeta>>;
|
|
64838
|
+
listWorkflows(requestParameters?: WorkflowsBetaApiListWorkflowsRequest, axiosOptions?: RawAxiosRequestConfig): AxiosPromise<Array<WorkflowBeta>>;
|
|
64518
64839
|
/**
|
|
64519
64840
|
* Partially update an existing Workflow using [JSON Patch](https://tools.ietf.org/html/rfc6902) syntax.
|
|
64520
64841
|
* @summary Patch Workflow
|
|
@@ -64539,6 +64860,14 @@ export declare const WorkflowsBetaApiFactory: (configuration?: Configuration, ba
|
|
|
64539
64860
|
* @throws {RequiredError}
|
|
64540
64861
|
*/
|
|
64541
64862
|
postWorkflowExternalTrigger(requestParameters: WorkflowsBetaApiPostWorkflowExternalTriggerRequest, axiosOptions?: RawAxiosRequestConfig): AxiosPromise<WorkflowOAuthClientBeta>;
|
|
64863
|
+
/**
|
|
64864
|
+
* Perform a full update of a workflow. The updated workflow object is returned in the response.
|
|
64865
|
+
* @summary Update Workflow
|
|
64866
|
+
* @param {WorkflowsBetaApiPutWorkflowRequest} requestParameters Request parameters.
|
|
64867
|
+
* @param {*} [axiosOptions] Override http request option.
|
|
64868
|
+
* @throws {RequiredError}
|
|
64869
|
+
*/
|
|
64870
|
+
putWorkflow(requestParameters: WorkflowsBetaApiPutWorkflowRequest, axiosOptions?: RawAxiosRequestConfig): AxiosPromise<WorkflowBeta>;
|
|
64542
64871
|
/**
|
|
64543
64872
|
* Validate a workflow with an \"External Trigger\" can receive input. The response includes the input that the workflow received, which can be used to validate that the input is intact when it reaches the workflow.
|
|
64544
64873
|
* @summary Test Workflow via External Trigger
|
|
@@ -64555,14 +64884,6 @@ export declare const WorkflowsBetaApiFactory: (configuration?: Configuration, ba
|
|
|
64555
64884
|
* @throws {RequiredError}
|
|
64556
64885
|
*/
|
|
64557
64886
|
testWorkflow(requestParameters: WorkflowsBetaApiTestWorkflowRequest, axiosOptions?: RawAxiosRequestConfig): AxiosPromise<TestWorkflow200ResponseBeta>;
|
|
64558
|
-
/**
|
|
64559
|
-
* Perform a full update of a workflow. The updated workflow object is returned in the response.
|
|
64560
|
-
* @summary Update Workflow
|
|
64561
|
-
* @param {WorkflowsBetaApiUpdateWorkflowRequest} requestParameters Request parameters.
|
|
64562
|
-
* @param {*} [axiosOptions] Override http request option.
|
|
64563
|
-
* @throws {RequiredError}
|
|
64564
|
-
*/
|
|
64565
|
-
updateWorkflow(requestParameters: WorkflowsBetaApiUpdateWorkflowRequest, axiosOptions?: RawAxiosRequestConfig): AxiosPromise<WorkflowBeta>;
|
|
64566
64887
|
};
|
|
64567
64888
|
/**
|
|
64568
64889
|
* Request parameters for cancelWorkflowExecution operation in WorkflowsBetaApi.
|
|
@@ -64615,6 +64936,12 @@ export interface WorkflowsBetaApiGetWorkflowRequest {
|
|
|
64615
64936
|
* @memberof WorkflowsBetaApiGetWorkflow
|
|
64616
64937
|
*/
|
|
64617
64938
|
readonly id: string;
|
|
64939
|
+
/**
|
|
64940
|
+
* disable workflow metrics
|
|
64941
|
+
* @type {boolean}
|
|
64942
|
+
* @memberof WorkflowsBetaApiGetWorkflow
|
|
64943
|
+
*/
|
|
64944
|
+
readonly workflowMetrics?: boolean;
|
|
64618
64945
|
}
|
|
64619
64946
|
/**
|
|
64620
64947
|
* Request parameters for getWorkflowExecution operation in WorkflowsBetaApi.
|
|
@@ -64748,6 +65075,37 @@ export interface WorkflowsBetaApiListWorkflowLibraryTriggersRequest {
|
|
|
64748
65075
|
*/
|
|
64749
65076
|
readonly filters?: string;
|
|
64750
65077
|
}
|
|
65078
|
+
/**
|
|
65079
|
+
* Request parameters for listWorkflows operation in WorkflowsBetaApi.
|
|
65080
|
+
* @export
|
|
65081
|
+
* @interface WorkflowsBetaApiListWorkflowsRequest
|
|
65082
|
+
*/
|
|
65083
|
+
export interface WorkflowsBetaApiListWorkflowsRequest {
|
|
65084
|
+
/**
|
|
65085
|
+
* Max number of results to return. See [V3 API Standard Collection Parameters](https://developer.sailpoint.com/idn/api/standard-collection-parameters) for more information.
|
|
65086
|
+
* @type {number}
|
|
65087
|
+
* @memberof WorkflowsBetaApiListWorkflows
|
|
65088
|
+
*/
|
|
65089
|
+
readonly limit?: number;
|
|
65090
|
+
/**
|
|
65091
|
+
* 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.
|
|
65092
|
+
* @type {number}
|
|
65093
|
+
* @memberof WorkflowsBetaApiListWorkflows
|
|
65094
|
+
*/
|
|
65095
|
+
readonly offset?: number;
|
|
65096
|
+
/**
|
|
65097
|
+
* Trigger ID
|
|
65098
|
+
* @type {string}
|
|
65099
|
+
* @memberof WorkflowsBetaApiListWorkflows
|
|
65100
|
+
*/
|
|
65101
|
+
readonly triggerId?: string;
|
|
65102
|
+
/**
|
|
65103
|
+
* Connector Instance ID
|
|
65104
|
+
* @type {string}
|
|
65105
|
+
* @memberof WorkflowsBetaApiListWorkflows
|
|
65106
|
+
*/
|
|
65107
|
+
readonly connectorInstanceId?: string;
|
|
65108
|
+
}
|
|
64751
65109
|
/**
|
|
64752
65110
|
* Request parameters for patchWorkflow operation in WorkflowsBetaApi.
|
|
64753
65111
|
* @export
|
|
@@ -64799,6 +65157,25 @@ export interface WorkflowsBetaApiPostWorkflowExternalTriggerRequest {
|
|
|
64799
65157
|
*/
|
|
64800
65158
|
readonly id: string;
|
|
64801
65159
|
}
|
|
65160
|
+
/**
|
|
65161
|
+
* Request parameters for putWorkflow operation in WorkflowsBetaApi.
|
|
65162
|
+
* @export
|
|
65163
|
+
* @interface WorkflowsBetaApiPutWorkflowRequest
|
|
65164
|
+
*/
|
|
65165
|
+
export interface WorkflowsBetaApiPutWorkflowRequest {
|
|
65166
|
+
/**
|
|
65167
|
+
* Id of the Workflow
|
|
65168
|
+
* @type {string}
|
|
65169
|
+
* @memberof WorkflowsBetaApiPutWorkflow
|
|
65170
|
+
*/
|
|
65171
|
+
readonly id: string;
|
|
65172
|
+
/**
|
|
65173
|
+
*
|
|
65174
|
+
* @type {WorkflowBodyBeta}
|
|
65175
|
+
* @memberof WorkflowsBetaApiPutWorkflow
|
|
65176
|
+
*/
|
|
65177
|
+
readonly workflowBodyBeta: WorkflowBodyBeta;
|
|
65178
|
+
}
|
|
64802
65179
|
/**
|
|
64803
65180
|
* Request parameters for testExternalExecuteWorkflow operation in WorkflowsBetaApi.
|
|
64804
65181
|
* @export
|
|
@@ -64837,25 +65214,6 @@ export interface WorkflowsBetaApiTestWorkflowRequest {
|
|
|
64837
65214
|
*/
|
|
64838
65215
|
readonly testWorkflowRequestBeta: TestWorkflowRequestBeta;
|
|
64839
65216
|
}
|
|
64840
|
-
/**
|
|
64841
|
-
* Request parameters for updateWorkflow operation in WorkflowsBetaApi.
|
|
64842
|
-
* @export
|
|
64843
|
-
* @interface WorkflowsBetaApiUpdateWorkflowRequest
|
|
64844
|
-
*/
|
|
64845
|
-
export interface WorkflowsBetaApiUpdateWorkflowRequest {
|
|
64846
|
-
/**
|
|
64847
|
-
* Id of the Workflow
|
|
64848
|
-
* @type {string}
|
|
64849
|
-
* @memberof WorkflowsBetaApiUpdateWorkflow
|
|
64850
|
-
*/
|
|
64851
|
-
readonly id: string;
|
|
64852
|
-
/**
|
|
64853
|
-
*
|
|
64854
|
-
* @type {WorkflowBodyBeta}
|
|
64855
|
-
* @memberof WorkflowsBetaApiUpdateWorkflow
|
|
64856
|
-
*/
|
|
64857
|
-
readonly workflowBodyBeta: WorkflowBodyBeta;
|
|
64858
|
-
}
|
|
64859
65217
|
/**
|
|
64860
65218
|
* WorkflowsBetaApi - object-oriented interface
|
|
64861
65219
|
* @export
|
|
@@ -64964,11 +65322,12 @@ export declare class WorkflowsBetaApi extends BaseAPI {
|
|
|
64964
65322
|
/**
|
|
64965
65323
|
* List all workflows in the tenant.
|
|
64966
65324
|
* @summary List Workflows
|
|
65325
|
+
* @param {WorkflowsBetaApiListWorkflowsRequest} requestParameters Request parameters.
|
|
64967
65326
|
* @param {*} [axiosOptions] Override http request option.
|
|
64968
65327
|
* @throws {RequiredError}
|
|
64969
65328
|
* @memberof WorkflowsBetaApi
|
|
64970
65329
|
*/
|
|
64971
|
-
listWorkflows(axiosOptions?: RawAxiosRequestConfig): Promise<import("axios").AxiosResponse<WorkflowBeta[], any>>;
|
|
65330
|
+
listWorkflows(requestParameters?: WorkflowsBetaApiListWorkflowsRequest, axiosOptions?: RawAxiosRequestConfig): Promise<import("axios").AxiosResponse<WorkflowBeta[], any>>;
|
|
64972
65331
|
/**
|
|
64973
65332
|
* Partially update an existing Workflow using [JSON Patch](https://tools.ietf.org/html/rfc6902) syntax.
|
|
64974
65333
|
* @summary Patch Workflow
|
|
@@ -64996,6 +65355,15 @@ export declare class WorkflowsBetaApi extends BaseAPI {
|
|
|
64996
65355
|
* @memberof WorkflowsBetaApi
|
|
64997
65356
|
*/
|
|
64998
65357
|
postWorkflowExternalTrigger(requestParameters: WorkflowsBetaApiPostWorkflowExternalTriggerRequest, axiosOptions?: RawAxiosRequestConfig): Promise<import("axios").AxiosResponse<WorkflowOAuthClientBeta, any>>;
|
|
65358
|
+
/**
|
|
65359
|
+
* Perform a full update of a workflow. The updated workflow object is returned in the response.
|
|
65360
|
+
* @summary Update Workflow
|
|
65361
|
+
* @param {WorkflowsBetaApiPutWorkflowRequest} requestParameters Request parameters.
|
|
65362
|
+
* @param {*} [axiosOptions] Override http request option.
|
|
65363
|
+
* @throws {RequiredError}
|
|
65364
|
+
* @memberof WorkflowsBetaApi
|
|
65365
|
+
*/
|
|
65366
|
+
putWorkflow(requestParameters: WorkflowsBetaApiPutWorkflowRequest, axiosOptions?: RawAxiosRequestConfig): Promise<import("axios").AxiosResponse<WorkflowBeta, any>>;
|
|
64999
65367
|
/**
|
|
65000
65368
|
* Validate a workflow with an \"External Trigger\" can receive input. The response includes the input that the workflow received, which can be used to validate that the input is intact when it reaches the workflow.
|
|
65001
65369
|
* @summary Test Workflow via External Trigger
|
|
@@ -65014,13 +65382,4 @@ export declare class WorkflowsBetaApi extends BaseAPI {
|
|
|
65014
65382
|
* @memberof WorkflowsBetaApi
|
|
65015
65383
|
*/
|
|
65016
65384
|
testWorkflow(requestParameters: WorkflowsBetaApiTestWorkflowRequest, axiosOptions?: RawAxiosRequestConfig): Promise<import("axios").AxiosResponse<TestWorkflow200ResponseBeta, any>>;
|
|
65017
|
-
/**
|
|
65018
|
-
* Perform a full update of a workflow. The updated workflow object is returned in the response.
|
|
65019
|
-
* @summary Update Workflow
|
|
65020
|
-
* @param {WorkflowsBetaApiUpdateWorkflowRequest} requestParameters Request parameters.
|
|
65021
|
-
* @param {*} [axiosOptions] Override http request option.
|
|
65022
|
-
* @throws {RequiredError}
|
|
65023
|
-
* @memberof WorkflowsBetaApi
|
|
65024
|
-
*/
|
|
65025
|
-
updateWorkflow(requestParameters: WorkflowsBetaApiUpdateWorkflowRequest, axiosOptions?: RawAxiosRequestConfig): Promise<import("axios").AxiosResponse<WorkflowBeta, any>>;
|
|
65026
65385
|
}
|