sailpoint-api-client 1.0.2 → 1.0.4
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/.openapi-generator/FILES +1 -0
- package/beta/README.md +2 -2
- package/beta/api.ts +2132 -951
- package/beta/common.ts +2 -1
- package/beta/package.json +1 -1
- package/cc/.openapi-generator/FILES +1 -0
- package/cc/README.md +2 -2
- package/cc/api.ts +1150 -53
- package/cc/common.ts +2 -1
- package/cc/package.json +1 -1
- package/configuration.ts +3 -3
- package/dist/beta/api.d.ts +1555 -758
- package/dist/beta/api.js +1511 -643
- package/dist/beta/api.js.map +1 -1
- package/dist/beta/common.js +2 -1
- package/dist/beta/common.js.map +1 -1
- package/dist/cc/api.d.ts +1092 -48
- package/dist/cc/api.js +126 -26
- package/dist/cc/api.js.map +1 -1
- package/dist/cc/common.js +2 -1
- package/dist/cc/common.js.map +1 -1
- package/dist/configuration.js +3 -3
- package/dist/configuration.js.map +1 -1
- package/dist/index.spec.d.ts +1 -0
- package/dist/index.spec.js +217 -0
- package/dist/index.spec.js.map +1 -0
- package/dist/paginator.js +2 -2
- package/dist/paginator.js.map +1 -1
- package/dist/v2/common.js +2 -1
- package/dist/v2/common.js.map +1 -1
- package/dist/v3/api.d.ts +845 -253
- package/dist/v3/api.js +1258 -160
- package/dist/v3/api.js.map +1 -1
- package/dist/v3/common.js +2 -1
- package/dist/v3/common.js.map +1 -1
- package/index.spec.ts +119 -0
- package/package.json +12 -2
- package/paginator.ts +2 -2
- package/tsconfig.json +2 -1
- package/v2/.openapi-generator/FILES +1 -0
- package/v2/README.md +2 -2
- package/v2/common.ts +2 -1
- package/v2/package.json +1 -1
- package/v3/.openapi-generator/FILES +1 -0
- package/v3/README.md +2 -2
- package/v3/api.ts +1406 -333
- package/v3/common.ts +2 -1
- package/v3/package.json +1 -1
package/dist/v3/api.d.ts
CHANGED
|
@@ -740,7 +740,7 @@ export interface AccessRequestItem {
|
|
|
740
740
|
[key: string]: string;
|
|
741
741
|
};
|
|
742
742
|
/**
|
|
743
|
-
* The date the role or access profile is no longer assigned to the specified identity. * 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. * Currently it is not supported for entitlements.
|
|
743
|
+
* The date the role or access profile is no longer assigned to the specified identity. * 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. * Currently it is not supported for entitlements. * If sunset date for role or access profile specified, removeDate cannot be established. This rule doesn\'t apply for entitlements.
|
|
744
744
|
* @type {string}
|
|
745
745
|
* @memberof AccessRequestItem
|
|
746
746
|
*/
|
|
@@ -808,7 +808,7 @@ export declare const AccessRequestPhasesResultEnum: {
|
|
|
808
808
|
};
|
|
809
809
|
export declare type AccessRequestPhasesResultEnum = typeof AccessRequestPhasesResultEnum[keyof typeof AccessRequestPhasesResultEnum];
|
|
810
810
|
/**
|
|
811
|
-
* Access request type. Defaults to GRANT_ACCESS. REVOKE_ACCESS type can only have a single Identity ID in the requestedFor field.
|
|
811
|
+
* Access request type. Defaults to GRANT_ACCESS. REVOKE_ACCESS type can only have a single Identity ID in the requestedFor field.
|
|
812
812
|
* @export
|
|
813
813
|
* @enum {string}
|
|
814
814
|
*/
|
|
@@ -988,23 +988,29 @@ export interface Account {
|
|
|
988
988
|
*/
|
|
989
989
|
'modified'?: string;
|
|
990
990
|
/**
|
|
991
|
-
*
|
|
991
|
+
* The unique ID of the source this account belongs to
|
|
992
992
|
* @type {string}
|
|
993
993
|
* @memberof Account
|
|
994
994
|
*/
|
|
995
|
-
'sourceId'
|
|
995
|
+
'sourceId': string;
|
|
996
996
|
/**
|
|
997
|
-
*
|
|
997
|
+
* The display name of the source this account belongs to
|
|
998
|
+
* @type {string}
|
|
999
|
+
* @memberof Account
|
|
1000
|
+
*/
|
|
1001
|
+
'sourceName': string;
|
|
1002
|
+
/**
|
|
1003
|
+
* The unique ID of the identity this account is correlated to
|
|
998
1004
|
* @type {string}
|
|
999
1005
|
* @memberof Account
|
|
1000
1006
|
*/
|
|
1001
1007
|
'identityId'?: string;
|
|
1002
1008
|
/**
|
|
1003
|
-
*
|
|
1009
|
+
* The account attributes that are aggregated
|
|
1004
1010
|
* @type {{ [key: string]: any; }}
|
|
1005
1011
|
* @memberof Account
|
|
1006
1012
|
*/
|
|
1007
|
-
'attributes'
|
|
1013
|
+
'attributes': {
|
|
1008
1014
|
[key: string]: any;
|
|
1009
1015
|
};
|
|
1010
1016
|
/**
|
|
@@ -1012,7 +1018,7 @@ export interface Account {
|
|
|
1012
1018
|
* @type {boolean}
|
|
1013
1019
|
* @memberof Account
|
|
1014
1020
|
*/
|
|
1015
|
-
'authoritative'
|
|
1021
|
+
'authoritative': boolean;
|
|
1016
1022
|
/**
|
|
1017
1023
|
* A description of the account
|
|
1018
1024
|
* @type {string}
|
|
@@ -1024,49 +1030,49 @@ export interface Account {
|
|
|
1024
1030
|
* @type {boolean}
|
|
1025
1031
|
* @memberof Account
|
|
1026
1032
|
*/
|
|
1027
|
-
'disabled'
|
|
1033
|
+
'disabled': boolean;
|
|
1028
1034
|
/**
|
|
1029
1035
|
* Indicates if the account is currently locked
|
|
1030
1036
|
* @type {boolean}
|
|
1031
1037
|
* @memberof Account
|
|
1032
1038
|
*/
|
|
1033
|
-
'locked'
|
|
1039
|
+
'locked': boolean;
|
|
1034
1040
|
/**
|
|
1035
|
-
*
|
|
1041
|
+
* The unique ID of the account generated by the source system
|
|
1036
1042
|
* @type {string}
|
|
1037
1043
|
* @memberof Account
|
|
1038
1044
|
*/
|
|
1039
|
-
'nativeIdentity'
|
|
1045
|
+
'nativeIdentity': string;
|
|
1040
1046
|
/**
|
|
1041
|
-
*
|
|
1047
|
+
* If true, this is a user account within IdentityNow. If false, this is an account from a source system.
|
|
1042
1048
|
* @type {boolean}
|
|
1043
1049
|
* @memberof Account
|
|
1044
1050
|
*/
|
|
1045
|
-
'systemAccount'
|
|
1051
|
+
'systemAccount': boolean;
|
|
1046
1052
|
/**
|
|
1047
1053
|
* Indicates if this account is not correlated to an identity
|
|
1048
1054
|
* @type {boolean}
|
|
1049
1055
|
* @memberof Account
|
|
1050
1056
|
*/
|
|
1051
|
-
'uncorrelated'
|
|
1057
|
+
'uncorrelated': boolean;
|
|
1052
1058
|
/**
|
|
1053
1059
|
* The unique ID of the account as determined by the account schema
|
|
1054
1060
|
* @type {string}
|
|
1055
1061
|
* @memberof Account
|
|
1056
1062
|
*/
|
|
1057
|
-
'uuid'?: string;
|
|
1063
|
+
'uuid'?: string | null;
|
|
1058
1064
|
/**
|
|
1059
1065
|
* Indicates if the account has been manually correlated to an identity
|
|
1060
1066
|
* @type {boolean}
|
|
1061
1067
|
* @memberof Account
|
|
1062
1068
|
*/
|
|
1063
|
-
'manuallyCorrelated'
|
|
1069
|
+
'manuallyCorrelated': boolean;
|
|
1064
1070
|
/**
|
|
1065
1071
|
* Indicates if the account has entitlements
|
|
1066
1072
|
* @type {boolean}
|
|
1067
1073
|
* @memberof Account
|
|
1068
1074
|
*/
|
|
1069
|
-
'hasEntitlements'
|
|
1075
|
+
'hasEntitlements': boolean;
|
|
1070
1076
|
}
|
|
1071
1077
|
/**
|
|
1072
1078
|
* Object for specifying Actions to be performed on a specified list of sources\' account.
|
|
@@ -1659,23 +1665,29 @@ export interface AccountActivitySearchedItemAllOf {
|
|
|
1659
1665
|
*/
|
|
1660
1666
|
export interface AccountAllOf {
|
|
1661
1667
|
/**
|
|
1662
|
-
*
|
|
1668
|
+
* The unique ID of the source this account belongs to
|
|
1663
1669
|
* @type {string}
|
|
1664
1670
|
* @memberof AccountAllOf
|
|
1665
1671
|
*/
|
|
1666
|
-
'sourceId'
|
|
1672
|
+
'sourceId': string;
|
|
1667
1673
|
/**
|
|
1668
|
-
*
|
|
1674
|
+
* The display name of the source this account belongs to
|
|
1675
|
+
* @type {string}
|
|
1676
|
+
* @memberof AccountAllOf
|
|
1677
|
+
*/
|
|
1678
|
+
'sourceName': string;
|
|
1679
|
+
/**
|
|
1680
|
+
* The unique ID of the identity this account is correlated to
|
|
1669
1681
|
* @type {string}
|
|
1670
1682
|
* @memberof AccountAllOf
|
|
1671
1683
|
*/
|
|
1672
1684
|
'identityId'?: string;
|
|
1673
1685
|
/**
|
|
1674
|
-
*
|
|
1686
|
+
* The account attributes that are aggregated
|
|
1675
1687
|
* @type {{ [key: string]: any; }}
|
|
1676
1688
|
* @memberof AccountAllOf
|
|
1677
1689
|
*/
|
|
1678
|
-
'attributes'
|
|
1690
|
+
'attributes': {
|
|
1679
1691
|
[key: string]: any;
|
|
1680
1692
|
};
|
|
1681
1693
|
/**
|
|
@@ -1683,7 +1695,7 @@ export interface AccountAllOf {
|
|
|
1683
1695
|
* @type {boolean}
|
|
1684
1696
|
* @memberof AccountAllOf
|
|
1685
1697
|
*/
|
|
1686
|
-
'authoritative'
|
|
1698
|
+
'authoritative': boolean;
|
|
1687
1699
|
/**
|
|
1688
1700
|
* A description of the account
|
|
1689
1701
|
* @type {string}
|
|
@@ -1695,49 +1707,49 @@ export interface AccountAllOf {
|
|
|
1695
1707
|
* @type {boolean}
|
|
1696
1708
|
* @memberof AccountAllOf
|
|
1697
1709
|
*/
|
|
1698
|
-
'disabled'
|
|
1710
|
+
'disabled': boolean;
|
|
1699
1711
|
/**
|
|
1700
1712
|
* Indicates if the account is currently locked
|
|
1701
1713
|
* @type {boolean}
|
|
1702
1714
|
* @memberof AccountAllOf
|
|
1703
1715
|
*/
|
|
1704
|
-
'locked'
|
|
1716
|
+
'locked': boolean;
|
|
1705
1717
|
/**
|
|
1706
|
-
*
|
|
1718
|
+
* The unique ID of the account generated by the source system
|
|
1707
1719
|
* @type {string}
|
|
1708
1720
|
* @memberof AccountAllOf
|
|
1709
1721
|
*/
|
|
1710
|
-
'nativeIdentity'
|
|
1722
|
+
'nativeIdentity': string;
|
|
1711
1723
|
/**
|
|
1712
|
-
*
|
|
1724
|
+
* If true, this is a user account within IdentityNow. If false, this is an account from a source system.
|
|
1713
1725
|
* @type {boolean}
|
|
1714
1726
|
* @memberof AccountAllOf
|
|
1715
1727
|
*/
|
|
1716
|
-
'systemAccount'
|
|
1728
|
+
'systemAccount': boolean;
|
|
1717
1729
|
/**
|
|
1718
1730
|
* Indicates if this account is not correlated to an identity
|
|
1719
1731
|
* @type {boolean}
|
|
1720
1732
|
* @memberof AccountAllOf
|
|
1721
1733
|
*/
|
|
1722
|
-
'uncorrelated'
|
|
1734
|
+
'uncorrelated': boolean;
|
|
1723
1735
|
/**
|
|
1724
1736
|
* The unique ID of the account as determined by the account schema
|
|
1725
1737
|
* @type {string}
|
|
1726
1738
|
* @memberof AccountAllOf
|
|
1727
1739
|
*/
|
|
1728
|
-
'uuid'?: string;
|
|
1740
|
+
'uuid'?: string | null;
|
|
1729
1741
|
/**
|
|
1730
1742
|
* Indicates if the account has been manually correlated to an identity
|
|
1731
1743
|
* @type {boolean}
|
|
1732
1744
|
* @memberof AccountAllOf
|
|
1733
1745
|
*/
|
|
1734
|
-
'manuallyCorrelated'
|
|
1746
|
+
'manuallyCorrelated': boolean;
|
|
1735
1747
|
/**
|
|
1736
1748
|
* Indicates if the account has entitlements
|
|
1737
1749
|
* @type {boolean}
|
|
1738
1750
|
* @memberof AccountAllOf
|
|
1739
1751
|
*/
|
|
1740
|
-
'hasEntitlements'
|
|
1752
|
+
'hasEntitlements': boolean;
|
|
1741
1753
|
}
|
|
1742
1754
|
/**
|
|
1743
1755
|
*
|
|
@@ -2595,7 +2607,7 @@ export interface ApprovalComment {
|
|
|
2595
2607
|
*/
|
|
2596
2608
|
export interface ApprovalForwardHistory {
|
|
2597
2609
|
/**
|
|
2598
|
-
* Display name of approver
|
|
2610
|
+
* Display name of approver from whom the approval was forwarded.
|
|
2599
2611
|
* @type {string}
|
|
2600
2612
|
* @memberof ApprovalForwardHistory
|
|
2601
2613
|
*/
|
|
@@ -2607,17 +2619,29 @@ export interface ApprovalForwardHistory {
|
|
|
2607
2619
|
*/
|
|
2608
2620
|
'newApproverName'?: string;
|
|
2609
2621
|
/**
|
|
2610
|
-
* Comment made
|
|
2622
|
+
* Comment made while forwarding.
|
|
2611
2623
|
* @type {string}
|
|
2612
2624
|
* @memberof ApprovalForwardHistory
|
|
2613
2625
|
*/
|
|
2614
|
-
'comment'?: string;
|
|
2626
|
+
'comment'?: string | null;
|
|
2615
2627
|
/**
|
|
2616
2628
|
* Time at which approval was forwarded.
|
|
2617
2629
|
* @type {string}
|
|
2618
2630
|
* @memberof ApprovalForwardHistory
|
|
2619
2631
|
*/
|
|
2620
2632
|
'modified'?: string;
|
|
2633
|
+
/**
|
|
2634
|
+
* Display name of forwarder who forwarded the approval.
|
|
2635
|
+
* @type {string}
|
|
2636
|
+
* @memberof ApprovalForwardHistory
|
|
2637
|
+
*/
|
|
2638
|
+
'forwarderName'?: string | null;
|
|
2639
|
+
/**
|
|
2640
|
+
*
|
|
2641
|
+
* @type {ReassignmentType}
|
|
2642
|
+
* @memberof ApprovalForwardHistory
|
|
2643
|
+
*/
|
|
2644
|
+
'reassignmentType'?: ReassignmentType;
|
|
2621
2645
|
}
|
|
2622
2646
|
/**
|
|
2623
2647
|
*
|
|
@@ -2759,6 +2783,7 @@ export declare const ApprovalScheme: {
|
|
|
2759
2783
|
readonly Manager: "MANAGER";
|
|
2760
2784
|
readonly RoleOwner: "ROLE_OWNER";
|
|
2761
2785
|
readonly AccessProfileOwner: "ACCESS_PROFILE_OWNER";
|
|
2786
|
+
readonly EntitlementOwner: "ENTITLEMENT_OWNER";
|
|
2762
2787
|
readonly GovernanceGroup: "GOVERNANCE_GROUP";
|
|
2763
2788
|
};
|
|
2764
2789
|
export declare type ApprovalScheme = typeof ApprovalScheme[keyof typeof ApprovalScheme];
|
|
@@ -4041,10 +4066,10 @@ export interface CompletedApproval {
|
|
|
4041
4066
|
'requesterComment'?: CommentDto;
|
|
4042
4067
|
/**
|
|
4043
4068
|
*
|
|
4044
|
-
* @type {
|
|
4069
|
+
* @type {CompletedApprovalReviewerComment}
|
|
4045
4070
|
* @memberof CompletedApproval
|
|
4046
4071
|
*/
|
|
4047
|
-
'reviewerComment'?:
|
|
4072
|
+
'reviewerComment'?: CompletedApprovalReviewerComment | null;
|
|
4048
4073
|
/**
|
|
4049
4074
|
* The history of the previous reviewers comments.
|
|
4050
4075
|
* @type {Array<CommentDto>}
|
|
@@ -4074,7 +4099,7 @@ export interface CompletedApproval {
|
|
|
4074
4099
|
* @type {string}
|
|
4075
4100
|
* @memberof CompletedApproval
|
|
4076
4101
|
*/
|
|
4077
|
-
'removeDate'?: string;
|
|
4102
|
+
'removeDate'?: string | null;
|
|
4078
4103
|
/**
|
|
4079
4104
|
* If true, then the request was to change the remove date or sunset date.
|
|
4080
4105
|
* @type {boolean}
|
|
@@ -4086,7 +4111,7 @@ export interface CompletedApproval {
|
|
|
4086
4111
|
* @type {string}
|
|
4087
4112
|
* @memberof CompletedApproval
|
|
4088
4113
|
*/
|
|
4089
|
-
'currentRemoveDate'?: string;
|
|
4114
|
+
'currentRemoveDate'?: string | null;
|
|
4090
4115
|
/**
|
|
4091
4116
|
*
|
|
4092
4117
|
* @type {SodViolationContextCheckCompleted}
|
|
@@ -4094,6 +4119,31 @@ export interface CompletedApproval {
|
|
|
4094
4119
|
*/
|
|
4095
4120
|
'sodViolationContext'?: SodViolationContextCheckCompleted;
|
|
4096
4121
|
}
|
|
4122
|
+
/**
|
|
4123
|
+
* The approval\'s reviewer\'s comment.
|
|
4124
|
+
* @export
|
|
4125
|
+
* @interface CompletedApprovalReviewerComment
|
|
4126
|
+
*/
|
|
4127
|
+
export interface CompletedApprovalReviewerComment {
|
|
4128
|
+
/**
|
|
4129
|
+
* Content of the comment
|
|
4130
|
+
* @type {string}
|
|
4131
|
+
* @memberof CompletedApprovalReviewerComment
|
|
4132
|
+
*/
|
|
4133
|
+
'comment'?: string;
|
|
4134
|
+
/**
|
|
4135
|
+
*
|
|
4136
|
+
* @type {CommentDtoAuthor}
|
|
4137
|
+
* @memberof CompletedApprovalReviewerComment
|
|
4138
|
+
*/
|
|
4139
|
+
'author'?: CommentDtoAuthor;
|
|
4140
|
+
/**
|
|
4141
|
+
* Date and time comment was created
|
|
4142
|
+
* @type {string}
|
|
4143
|
+
* @memberof CompletedApprovalReviewerComment
|
|
4144
|
+
*/
|
|
4145
|
+
'created'?: string;
|
|
4146
|
+
}
|
|
4097
4147
|
/**
|
|
4098
4148
|
* Enum represents completed approval object\'s state.
|
|
4099
4149
|
* @export
|
|
@@ -5380,7 +5430,7 @@ export interface EntitlementRequestConfig {
|
|
|
5380
5430
|
*/
|
|
5381
5431
|
'deniedCommentsRequired'?: boolean;
|
|
5382
5432
|
/**
|
|
5383
|
-
* Approval schemes for granting entitlement request. This can be empty if no approval is needed. Multiple schemes must be comma-separated. The valid schemes are \"sourceOwner\", \"manager\" and \"workgroup:{id}\". Multiple workgroups (governance groups) can be used.
|
|
5433
|
+
* Approval schemes for granting entitlement request. This can be empty if no approval is needed. Multiple schemes must be comma-separated. The valid schemes are \"entitlementOwner\", \"sourceOwner\", \"manager\" and \"workgroup:{id}\". Multiple workgroups (governance groups) can be used.
|
|
5384
5434
|
* @type {string}
|
|
5385
5435
|
* @memberof EntitlementRequestConfig
|
|
5386
5436
|
*/
|
|
@@ -7920,6 +7970,12 @@ export interface ManualWorkItemDetails {
|
|
|
7920
7970
|
* @memberof ManualWorkItemDetails
|
|
7921
7971
|
*/
|
|
7922
7972
|
'status'?: ManualWorkItemState;
|
|
7973
|
+
/**
|
|
7974
|
+
* The history of approval forward action.
|
|
7975
|
+
* @type {Array<ApprovalForwardHistory>}
|
|
7976
|
+
* @memberof ManualWorkItemDetails
|
|
7977
|
+
*/
|
|
7978
|
+
'forwardHistory'?: Array<ApprovalForwardHistory>;
|
|
7923
7979
|
}
|
|
7924
7980
|
/**
|
|
7925
7981
|
* Indicates the state of the request processing for this item: * PENDING: The request for this item is awaiting processing. * APPROVED: The request for this item has been approved. * REJECTED: The request for this item was rejected. * EXPIRED: The request for this item expired with no action taken. * CANCELLED: The request for this item was cancelled with no user action. * ARCHIVED: The request for this item has been archived after completion.
|
|
@@ -9859,6 +9915,37 @@ export interface PasswordInfoQueryDTO {
|
|
|
9859
9915
|
*/
|
|
9860
9916
|
'sourceName'?: string;
|
|
9861
9917
|
}
|
|
9918
|
+
/**
|
|
9919
|
+
*
|
|
9920
|
+
* @export
|
|
9921
|
+
* @interface PasswordOrgConfig
|
|
9922
|
+
*/
|
|
9923
|
+
export interface PasswordOrgConfig {
|
|
9924
|
+
/**
|
|
9925
|
+
* Indicator whether custom password instructions feature is enabled. The default value is false.
|
|
9926
|
+
* @type {boolean}
|
|
9927
|
+
* @memberof PasswordOrgConfig
|
|
9928
|
+
*/
|
|
9929
|
+
'customInstructionsEnabled'?: boolean;
|
|
9930
|
+
/**
|
|
9931
|
+
* Indicator whether \"digit token\" feature is enabled. The default value is false.
|
|
9932
|
+
* @type {boolean}
|
|
9933
|
+
* @memberof PasswordOrgConfig
|
|
9934
|
+
*/
|
|
9935
|
+
'digitTokenEnabled'?: boolean;
|
|
9936
|
+
/**
|
|
9937
|
+
* The duration of \"digit token\" in minutes. The default value is 5.
|
|
9938
|
+
* @type {number}
|
|
9939
|
+
* @memberof PasswordOrgConfig
|
|
9940
|
+
*/
|
|
9941
|
+
'digitTokenDurationMinutes'?: number;
|
|
9942
|
+
/**
|
|
9943
|
+
* The length of \"digit token\". The default value is 6.
|
|
9944
|
+
* @type {number}
|
|
9945
|
+
* @memberof PasswordOrgConfig
|
|
9946
|
+
*/
|
|
9947
|
+
'digitTokenLength'?: number;
|
|
9948
|
+
}
|
|
9862
9949
|
/**
|
|
9863
9950
|
*
|
|
9864
9951
|
* @export
|
|
@@ -9896,6 +9983,37 @@ export declare const PasswordStatusStateEnum: {
|
|
|
9896
9983
|
readonly Failed: "FAILED";
|
|
9897
9984
|
};
|
|
9898
9985
|
export declare type PasswordStatusStateEnum = typeof PasswordStatusStateEnum[keyof typeof PasswordStatusStateEnum];
|
|
9986
|
+
/**
|
|
9987
|
+
*
|
|
9988
|
+
* @export
|
|
9989
|
+
* @interface PasswordSyncGroup
|
|
9990
|
+
*/
|
|
9991
|
+
export interface PasswordSyncGroup {
|
|
9992
|
+
/**
|
|
9993
|
+
* ID of the sync group
|
|
9994
|
+
* @type {string}
|
|
9995
|
+
* @memberof PasswordSyncGroup
|
|
9996
|
+
*/
|
|
9997
|
+
'id'?: string;
|
|
9998
|
+
/**
|
|
9999
|
+
* Name of the sync group
|
|
10000
|
+
* @type {string}
|
|
10001
|
+
* @memberof PasswordSyncGroup
|
|
10002
|
+
*/
|
|
10003
|
+
'name'?: string;
|
|
10004
|
+
/**
|
|
10005
|
+
* ID of the password policy
|
|
10006
|
+
* @type {string}
|
|
10007
|
+
* @memberof PasswordSyncGroup
|
|
10008
|
+
*/
|
|
10009
|
+
'passwordPolicyId'?: string;
|
|
10010
|
+
/**
|
|
10011
|
+
* List of password managed sources IDs
|
|
10012
|
+
* @type {Array<string>}
|
|
10013
|
+
* @memberof PasswordSyncGroup
|
|
10014
|
+
*/
|
|
10015
|
+
'sourceIds'?: Array<string>;
|
|
10016
|
+
}
|
|
9899
10017
|
/**
|
|
9900
10018
|
*
|
|
9901
10019
|
* @export
|
|
@@ -10138,6 +10256,18 @@ export interface ProvisioningConfig {
|
|
|
10138
10256
|
* @memberof ProvisioningConfig
|
|
10139
10257
|
*/
|
|
10140
10258
|
'planInitializerScript'?: ProvisioningConfigPlanInitializerScript;
|
|
10259
|
+
/**
|
|
10260
|
+
* Name of an attribute that when true disables the saving of ProvisioningRequest objects whenever plans are sent through this integration.
|
|
10261
|
+
* @type {boolean}
|
|
10262
|
+
* @memberof ProvisioningConfig
|
|
10263
|
+
*/
|
|
10264
|
+
'noProvisioningRequests'?: boolean;
|
|
10265
|
+
/**
|
|
10266
|
+
* When saving pending requests is enabled, this defines the number of hours the request is allowed to live before it is considered expired and no longer affects plan compilation.
|
|
10267
|
+
* @type {number}
|
|
10268
|
+
* @memberof ProvisioningConfig
|
|
10269
|
+
*/
|
|
10270
|
+
'provisioningRequestExpiration'?: number;
|
|
10141
10271
|
}
|
|
10142
10272
|
/**
|
|
10143
10273
|
*
|
|
@@ -10147,22 +10277,22 @@ export interface ProvisioningConfig {
|
|
|
10147
10277
|
export interface ProvisioningConfigManagedResourceRefsInner {
|
|
10148
10278
|
/**
|
|
10149
10279
|
* The type of object being referenced
|
|
10150
|
-
* @type {
|
|
10280
|
+
* @type {object}
|
|
10151
10281
|
* @memberof ProvisioningConfigManagedResourceRefsInner
|
|
10152
10282
|
*/
|
|
10153
10283
|
'type'?: ProvisioningConfigManagedResourceRefsInnerTypeEnum;
|
|
10154
10284
|
/**
|
|
10155
10285
|
* ID of the source
|
|
10156
|
-
* @type {
|
|
10286
|
+
* @type {object}
|
|
10157
10287
|
* @memberof ProvisioningConfigManagedResourceRefsInner
|
|
10158
10288
|
*/
|
|
10159
|
-
'id'?:
|
|
10289
|
+
'id'?: object;
|
|
10160
10290
|
/**
|
|
10161
10291
|
* Human-readable display name of the source
|
|
10162
|
-
* @type {
|
|
10292
|
+
* @type {object}
|
|
10163
10293
|
* @memberof ProvisioningConfigManagedResourceRefsInner
|
|
10164
10294
|
*/
|
|
10165
|
-
'name'?:
|
|
10295
|
+
'name'?: object;
|
|
10166
10296
|
}
|
|
10167
10297
|
export declare const ProvisioningConfigManagedResourceRefsInnerTypeEnum: {
|
|
10168
10298
|
readonly Source: "SOURCE";
|
|
@@ -10686,6 +10816,18 @@ export declare const ReassignmentReferenceTypeEnum: {
|
|
|
10686
10816
|
readonly IdentitySummary: "IDENTITY_SUMMARY";
|
|
10687
10817
|
};
|
|
10688
10818
|
export declare type ReassignmentReferenceTypeEnum = typeof ReassignmentReferenceTypeEnum[keyof typeof ReassignmentReferenceTypeEnum];
|
|
10819
|
+
/**
|
|
10820
|
+
* Type of approval reassignment.
|
|
10821
|
+
* @export
|
|
10822
|
+
* @enum {string}
|
|
10823
|
+
*/
|
|
10824
|
+
export declare const ReassignmentType: {
|
|
10825
|
+
readonly ManualReassignment: "MANUAL_REASSIGNMENT";
|
|
10826
|
+
readonly AutomaticReassignment: "AUTOMATIC_REASSIGNMENT";
|
|
10827
|
+
readonly AutoEscalation: "AUTO_ESCALATION";
|
|
10828
|
+
readonly SelfReviewDelegation: "SELF_REVIEW_DELEGATION";
|
|
10829
|
+
};
|
|
10830
|
+
export declare type ReassignmentType = typeof ReassignmentType[keyof typeof ReassignmentType];
|
|
10689
10831
|
/**
|
|
10690
10832
|
*
|
|
10691
10833
|
* @export
|
|
@@ -13282,17 +13424,17 @@ export interface ServiceDeskIntegrationDto {
|
|
|
13282
13424
|
*/
|
|
13283
13425
|
'type': string;
|
|
13284
13426
|
/**
|
|
13285
|
-
*
|
|
13286
|
-
* @type {
|
|
13427
|
+
* Reference to the identity that is the owner of this Service Desk integration
|
|
13428
|
+
* @type {BaseReferenceDto}
|
|
13287
13429
|
* @memberof ServiceDeskIntegrationDto
|
|
13288
13430
|
*/
|
|
13289
|
-
'ownerRef'?:
|
|
13431
|
+
'ownerRef'?: BaseReferenceDto;
|
|
13290
13432
|
/**
|
|
13291
|
-
*
|
|
13292
|
-
* @type {
|
|
13433
|
+
* Reference to the source cluster for this Service Desk integration
|
|
13434
|
+
* @type {BaseReferenceDto}
|
|
13293
13435
|
* @memberof ServiceDeskIntegrationDto
|
|
13294
13436
|
*/
|
|
13295
|
-
'clusterRef'?:
|
|
13437
|
+
'clusterRef'?: BaseReferenceDto;
|
|
13296
13438
|
/**
|
|
13297
13439
|
* ID of the cluster for the Service Desk integration (replaced by clusterRef, retained for backward compatibility)
|
|
13298
13440
|
* @type {string}
|
|
@@ -13322,11 +13464,11 @@ export interface ServiceDeskIntegrationDto {
|
|
|
13322
13464
|
[key: string]: any;
|
|
13323
13465
|
};
|
|
13324
13466
|
/**
|
|
13325
|
-
*
|
|
13326
|
-
* @type {
|
|
13467
|
+
* Reference to beforeProvisioningRule for this Service Desk integration
|
|
13468
|
+
* @type {BaseReferenceDto}
|
|
13327
13469
|
* @memberof ServiceDeskIntegrationDto
|
|
13328
13470
|
*/
|
|
13329
|
-
'beforeProvisioningRule'?:
|
|
13471
|
+
'beforeProvisioningRule'?: BaseReferenceDto;
|
|
13330
13472
|
}
|
|
13331
13473
|
/**
|
|
13332
13474
|
* Specification of a Service Desk integration
|
|
@@ -13347,17 +13489,17 @@ export interface ServiceDeskIntegrationDtoAllOf {
|
|
|
13347
13489
|
*/
|
|
13348
13490
|
'type': string;
|
|
13349
13491
|
/**
|
|
13350
|
-
*
|
|
13351
|
-
* @type {
|
|
13492
|
+
* Reference to the identity that is the owner of this Service Desk integration
|
|
13493
|
+
* @type {BaseReferenceDto}
|
|
13352
13494
|
* @memberof ServiceDeskIntegrationDtoAllOf
|
|
13353
13495
|
*/
|
|
13354
|
-
'ownerRef'?:
|
|
13496
|
+
'ownerRef'?: BaseReferenceDto;
|
|
13355
13497
|
/**
|
|
13356
|
-
*
|
|
13357
|
-
* @type {
|
|
13498
|
+
* Reference to the source cluster for this Service Desk integration
|
|
13499
|
+
* @type {BaseReferenceDto}
|
|
13358
13500
|
* @memberof ServiceDeskIntegrationDtoAllOf
|
|
13359
13501
|
*/
|
|
13360
|
-
'clusterRef'?:
|
|
13502
|
+
'clusterRef'?: BaseReferenceDto;
|
|
13361
13503
|
/**
|
|
13362
13504
|
* ID of the cluster for the Service Desk integration (replaced by clusterRef, retained for backward compatibility)
|
|
13363
13505
|
* @type {string}
|
|
@@ -13387,99 +13529,12 @@ export interface ServiceDeskIntegrationDtoAllOf {
|
|
|
13387
13529
|
[key: string]: any;
|
|
13388
13530
|
};
|
|
13389
13531
|
/**
|
|
13390
|
-
*
|
|
13391
|
-
* @type {
|
|
13532
|
+
* Reference to beforeProvisioningRule for this Service Desk integration
|
|
13533
|
+
* @type {BaseReferenceDto}
|
|
13392
13534
|
* @memberof ServiceDeskIntegrationDtoAllOf
|
|
13393
13535
|
*/
|
|
13394
|
-
'beforeProvisioningRule'?:
|
|
13395
|
-
}
|
|
13396
|
-
/**
|
|
13397
|
-
* Reference to beforeProvisioningRule for this Service Desk integration
|
|
13398
|
-
* @export
|
|
13399
|
-
* @interface ServiceDeskIntegrationDtoAllOfBeforeProvisioningRule
|
|
13400
|
-
*/
|
|
13401
|
-
export interface ServiceDeskIntegrationDtoAllOfBeforeProvisioningRule {
|
|
13402
|
-
/**
|
|
13403
|
-
* The type of object being referenced
|
|
13404
|
-
* @type {string}
|
|
13405
|
-
* @memberof ServiceDeskIntegrationDtoAllOfBeforeProvisioningRule
|
|
13406
|
-
*/
|
|
13407
|
-
'type'?: ServiceDeskIntegrationDtoAllOfBeforeProvisioningRuleTypeEnum;
|
|
13408
|
-
/**
|
|
13409
|
-
* ID of the rule
|
|
13410
|
-
* @type {string}
|
|
13411
|
-
* @memberof ServiceDeskIntegrationDtoAllOfBeforeProvisioningRule
|
|
13412
|
-
*/
|
|
13413
|
-
'id'?: string;
|
|
13414
|
-
/**
|
|
13415
|
-
* Human-readable display name of the rule
|
|
13416
|
-
* @type {string}
|
|
13417
|
-
* @memberof ServiceDeskIntegrationDtoAllOfBeforeProvisioningRule
|
|
13418
|
-
*/
|
|
13419
|
-
'name'?: string;
|
|
13420
|
-
}
|
|
13421
|
-
export declare const ServiceDeskIntegrationDtoAllOfBeforeProvisioningRuleTypeEnum: {
|
|
13422
|
-
readonly Rule: "RULE";
|
|
13423
|
-
};
|
|
13424
|
-
export declare type ServiceDeskIntegrationDtoAllOfBeforeProvisioningRuleTypeEnum = typeof ServiceDeskIntegrationDtoAllOfBeforeProvisioningRuleTypeEnum[keyof typeof ServiceDeskIntegrationDtoAllOfBeforeProvisioningRuleTypeEnum];
|
|
13425
|
-
/**
|
|
13426
|
-
* Reference to the source cluster for this Service Desk integration
|
|
13427
|
-
* @export
|
|
13428
|
-
* @interface ServiceDeskIntegrationDtoAllOfClusterRef
|
|
13429
|
-
*/
|
|
13430
|
-
export interface ServiceDeskIntegrationDtoAllOfClusterRef {
|
|
13431
|
-
/**
|
|
13432
|
-
* The type of object being referenced
|
|
13433
|
-
* @type {string}
|
|
13434
|
-
* @memberof ServiceDeskIntegrationDtoAllOfClusterRef
|
|
13435
|
-
*/
|
|
13436
|
-
'type'?: ServiceDeskIntegrationDtoAllOfClusterRefTypeEnum;
|
|
13437
|
-
/**
|
|
13438
|
-
* ID of the cluster
|
|
13439
|
-
* @type {string}
|
|
13440
|
-
* @memberof ServiceDeskIntegrationDtoAllOfClusterRef
|
|
13441
|
-
*/
|
|
13442
|
-
'id'?: string;
|
|
13443
|
-
/**
|
|
13444
|
-
* Human-readable display name of the cluster
|
|
13445
|
-
* @type {string}
|
|
13446
|
-
* @memberof ServiceDeskIntegrationDtoAllOfClusterRef
|
|
13447
|
-
*/
|
|
13448
|
-
'name'?: string;
|
|
13449
|
-
}
|
|
13450
|
-
export declare const ServiceDeskIntegrationDtoAllOfClusterRefTypeEnum: {
|
|
13451
|
-
readonly Cluster: "CLUSTER";
|
|
13452
|
-
};
|
|
13453
|
-
export declare type ServiceDeskIntegrationDtoAllOfClusterRefTypeEnum = typeof ServiceDeskIntegrationDtoAllOfClusterRefTypeEnum[keyof typeof ServiceDeskIntegrationDtoAllOfClusterRefTypeEnum];
|
|
13454
|
-
/**
|
|
13455
|
-
* Reference to the identity that is the owner of this Service Desk integration
|
|
13456
|
-
* @export
|
|
13457
|
-
* @interface ServiceDeskIntegrationDtoAllOfOwnerRef
|
|
13458
|
-
*/
|
|
13459
|
-
export interface ServiceDeskIntegrationDtoAllOfOwnerRef {
|
|
13460
|
-
/**
|
|
13461
|
-
* The type of object being referenced
|
|
13462
|
-
* @type {string}
|
|
13463
|
-
* @memberof ServiceDeskIntegrationDtoAllOfOwnerRef
|
|
13464
|
-
*/
|
|
13465
|
-
'type'?: ServiceDeskIntegrationDtoAllOfOwnerRefTypeEnum;
|
|
13466
|
-
/**
|
|
13467
|
-
* ID of the identity
|
|
13468
|
-
* @type {string}
|
|
13469
|
-
* @memberof ServiceDeskIntegrationDtoAllOfOwnerRef
|
|
13470
|
-
*/
|
|
13471
|
-
'id'?: string;
|
|
13472
|
-
/**
|
|
13473
|
-
* Human-readable display name of the identity
|
|
13474
|
-
* @type {string}
|
|
13475
|
-
* @memberof ServiceDeskIntegrationDtoAllOfOwnerRef
|
|
13476
|
-
*/
|
|
13477
|
-
'name'?: string;
|
|
13536
|
+
'beforeProvisioningRule'?: BaseReferenceDto;
|
|
13478
13537
|
}
|
|
13479
|
-
export declare const ServiceDeskIntegrationDtoAllOfOwnerRefTypeEnum: {
|
|
13480
|
-
readonly Identity: "IDENTITY";
|
|
13481
|
-
};
|
|
13482
|
-
export declare type ServiceDeskIntegrationDtoAllOfOwnerRefTypeEnum = typeof ServiceDeskIntegrationDtoAllOfOwnerRefTypeEnum[keyof typeof ServiceDeskIntegrationDtoAllOfOwnerRefTypeEnum];
|
|
13483
13538
|
/**
|
|
13484
13539
|
*
|
|
13485
13540
|
* @export
|
|
@@ -13766,6 +13821,12 @@ export interface Source {
|
|
|
13766
13821
|
* @memberof Source
|
|
13767
13822
|
*/
|
|
13768
13823
|
'id'?: string;
|
|
13824
|
+
/**
|
|
13825
|
+
* Human-readable name of the source
|
|
13826
|
+
* @type {string}
|
|
13827
|
+
* @memberof Source
|
|
13828
|
+
*/
|
|
13829
|
+
'name': string;
|
|
13769
13830
|
/**
|
|
13770
13831
|
* Human-readable description of the source
|
|
13771
13832
|
* @type {string}
|
|
@@ -13777,7 +13838,7 @@ export interface Source {
|
|
|
13777
13838
|
* @type {SourceOwner}
|
|
13778
13839
|
* @memberof Source
|
|
13779
13840
|
*/
|
|
13780
|
-
'owner'
|
|
13841
|
+
'owner': SourceOwner;
|
|
13781
13842
|
/**
|
|
13782
13843
|
*
|
|
13783
13844
|
* @type {SourceCluster}
|
|
@@ -13833,7 +13894,7 @@ export interface Source {
|
|
|
13833
13894
|
*/
|
|
13834
13895
|
'features'?: Array<SourceFeature>;
|
|
13835
13896
|
/**
|
|
13836
|
-
* Specifies the type of system being managed e.g. Active Directory, Workday, etc..
|
|
13897
|
+
* Specifies the type of system being managed e.g. Active Directory, Workday, etc.. If you are creating a Delimited File source, you must set the `provisionasCsv` query parameter to `true`.
|
|
13837
13898
|
* @type {string}
|
|
13838
13899
|
* @memberof Source
|
|
13839
13900
|
*/
|
|
@@ -13843,7 +13904,7 @@ export interface Source {
|
|
|
13843
13904
|
* @type {string}
|
|
13844
13905
|
* @memberof Source
|
|
13845
13906
|
*/
|
|
13846
|
-
'connector'
|
|
13907
|
+
'connector': string;
|
|
13847
13908
|
/**
|
|
13848
13909
|
* The fully qualified name of the Java class that implements the connector interface.
|
|
13849
13910
|
* @type {string}
|
|
@@ -14080,7 +14141,7 @@ export interface SourceHealthDto {
|
|
|
14080
14141
|
*/
|
|
14081
14142
|
'id'?: string;
|
|
14082
14143
|
/**
|
|
14083
|
-
* Specifies the type of system being managed e.g. Active Directory, Workday, etc..
|
|
14144
|
+
* Specifies the type of system being managed e.g. Active Directory, Workday, etc.. If you are creating a Delimited File source, you must set the `provisionasCsv` query parameter to `true`.
|
|
14084
14145
|
* @type {string}
|
|
14085
14146
|
* @memberof SourceHealthDto
|
|
14086
14147
|
*/
|
|
@@ -14666,28 +14727,28 @@ export interface UUIDGenerator {
|
|
|
14666
14727
|
/**
|
|
14667
14728
|
*
|
|
14668
14729
|
* @export
|
|
14669
|
-
* @interface
|
|
14730
|
+
* @interface UpdatePasswordDictionaryRequest
|
|
14670
14731
|
*/
|
|
14671
|
-
export interface
|
|
14732
|
+
export interface UpdatePasswordDictionaryRequest {
|
|
14672
14733
|
/**
|
|
14673
14734
|
*
|
|
14674
|
-
* @type {
|
|
14675
|
-
* @memberof
|
|
14735
|
+
* @type {any}
|
|
14736
|
+
* @memberof UpdatePasswordDictionaryRequest
|
|
14676
14737
|
*/
|
|
14677
|
-
'
|
|
14738
|
+
'file'?: any;
|
|
14678
14739
|
}
|
|
14679
14740
|
/**
|
|
14680
14741
|
*
|
|
14681
14742
|
* @export
|
|
14682
|
-
* @interface
|
|
14743
|
+
* @interface UploadNonEmployeeRecordsInBulkRequest
|
|
14683
14744
|
*/
|
|
14684
|
-
export interface
|
|
14745
|
+
export interface UploadNonEmployeeRecordsInBulkRequest {
|
|
14685
14746
|
/**
|
|
14686
14747
|
*
|
|
14687
|
-
* @type {
|
|
14688
|
-
* @memberof
|
|
14748
|
+
* @type {string}
|
|
14749
|
+
* @memberof UploadNonEmployeeRecordsInBulkRequest
|
|
14689
14750
|
*/
|
|
14690
|
-
'
|
|
14751
|
+
'data': string;
|
|
14691
14752
|
}
|
|
14692
14753
|
/**
|
|
14693
14754
|
*
|
|
@@ -15779,7 +15840,7 @@ export declare const AccessRequestsApiAxiosParamCreator: (configuration?: Config
|
|
|
15779
15840
|
*/
|
|
15780
15841
|
cancelAccessRequest: (cancelAccessRequest: CancelAccessRequest, axiosOptions?: AxiosRequestConfig) => Promise<RequestArgs>;
|
|
15781
15842
|
/**
|
|
15782
|
-
* This submits the access request into IdentityNow, where it will follow any IdentityNow approval processes. Access requests are processed asynchronously by IdentityNow. A success response from this endpoint means the request has been submitted to IDN and is queued for processing. Because this endpoint is asynchronous, it will not return an error if you submit duplicate access requests in quick succession, or you submit an access request for access that is already in progress, approved, or rejected. It is 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 [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) endpoints. You can also use the [search API](https://developer.sailpoint.com/idn/api/v3/search) to check the existing access items that an identity has before submitting an access request to ensure you are not requesting access that is already granted. 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, see \'/beta/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. * Does not support self request. Only manager can request to revoke access for their directly managed employees. * If removeDate is specified, then the access will be removed on that date and time. *
|
|
15843
|
+
* This submits the access request into IdentityNow, where it will follow any IdentityNow approval processes. Access requests are processed asynchronously by IdentityNow. A success response from this endpoint means the request has been submitted to IDN and is queued for processing. Because this endpoint is asynchronous, it will not return an error if you submit duplicate access requests in quick succession, or you submit an access request for access that is already in progress, approved, or rejected. It is 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 [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) endpoints. You can also use the [search API](https://developer.sailpoint.com/idn/api/v3/search) to check the existing access items that an identity has before submitting an access request to ensure you are not requesting access that is already granted. 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, see \'/beta/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. * Does not support self request. Only manager can request to revoke access for their directly managed employees. * If removeDate is specified, then the access will be removed on that date and time only for Roles and Access Profiles. Entitlements are currently unsupported for removeDate. * Roles, Access Profiles, and Entitlements can be requested for revocation. * Revoke requests for entitlements are limited to 1 entitlement per access request currently. * [Roles, Access Profiles] RemoveData can be specified only if access don\'t have a sunset date. * Allows a manager to request to revoke access for direct employees. A token with ORG_ADMIN authority can also request to revoke access from anyone. NOTE: There is no indication to the approver in the IdentityNow UI that the approval request is for a revoke action. Take this into consideration when calling this API. A token with API authority cannot be used to call this endpoint.
|
|
15783
15844
|
* @summary Submit an Access Request
|
|
15784
15845
|
* @param {AccessRequest} accessRequest
|
|
15785
15846
|
* @param {*} [axiosOptions] Override http request option.
|
|
@@ -15831,7 +15892,7 @@ export declare const AccessRequestsApiFp: (configuration?: Configuration) => {
|
|
|
15831
15892
|
*/
|
|
15832
15893
|
cancelAccessRequest(cancelAccessRequest: CancelAccessRequest, axiosOptions?: AxiosRequestConfig): Promise<(axios?: AxiosInstance, basePath?: string) => AxiosPromise<object>>;
|
|
15833
15894
|
/**
|
|
15834
|
-
* This submits the access request into IdentityNow, where it will follow any IdentityNow approval processes. Access requests are processed asynchronously by IdentityNow. A success response from this endpoint means the request has been submitted to IDN and is queued for processing. Because this endpoint is asynchronous, it will not return an error if you submit duplicate access requests in quick succession, or you submit an access request for access that is already in progress, approved, or rejected. It is 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 [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) endpoints. You can also use the [search API](https://developer.sailpoint.com/idn/api/v3/search) to check the existing access items that an identity has before submitting an access request to ensure you are not requesting access that is already granted. 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, see \'/beta/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. * Does not support self request. Only manager can request to revoke access for their directly managed employees. * If removeDate is specified, then the access will be removed on that date and time. *
|
|
15895
|
+
* This submits the access request into IdentityNow, where it will follow any IdentityNow approval processes. Access requests are processed asynchronously by IdentityNow. A success response from this endpoint means the request has been submitted to IDN and is queued for processing. Because this endpoint is asynchronous, it will not return an error if you submit duplicate access requests in quick succession, or you submit an access request for access that is already in progress, approved, or rejected. It is 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 [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) endpoints. You can also use the [search API](https://developer.sailpoint.com/idn/api/v3/search) to check the existing access items that an identity has before submitting an access request to ensure you are not requesting access that is already granted. 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, see \'/beta/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. * Does not support self request. Only manager can request to revoke access for their directly managed employees. * If removeDate is specified, then the access will be removed on that date and time only for Roles and Access Profiles. Entitlements are currently unsupported for removeDate. * Roles, Access Profiles, and Entitlements can be requested for revocation. * Revoke requests for entitlements are limited to 1 entitlement per access request currently. * [Roles, Access Profiles] RemoveData can be specified only if access don\'t have a sunset date. * Allows a manager to request to revoke access for direct employees. A token with ORG_ADMIN authority can also request to revoke access from anyone. NOTE: There is no indication to the approver in the IdentityNow UI that the approval request is for a revoke action. Take this into consideration when calling this API. A token with API authority cannot be used to call this endpoint.
|
|
15835
15896
|
* @summary Submit an Access Request
|
|
15836
15897
|
* @param {AccessRequest} accessRequest
|
|
15837
15898
|
* @param {*} [axiosOptions] Override http request option.
|
|
@@ -15883,7 +15944,7 @@ export declare const AccessRequestsApiFactory: (configuration?: Configuration, b
|
|
|
15883
15944
|
*/
|
|
15884
15945
|
cancelAccessRequest(cancelAccessRequest: CancelAccessRequest, axiosOptions?: any): AxiosPromise<object>;
|
|
15885
15946
|
/**
|
|
15886
|
-
* This submits the access request into IdentityNow, where it will follow any IdentityNow approval processes. Access requests are processed asynchronously by IdentityNow. A success response from this endpoint means the request has been submitted to IDN and is queued for processing. Because this endpoint is asynchronous, it will not return an error if you submit duplicate access requests in quick succession, or you submit an access request for access that is already in progress, approved, or rejected. It is 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 [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) endpoints. You can also use the [search API](https://developer.sailpoint.com/idn/api/v3/search) to check the existing access items that an identity has before submitting an access request to ensure you are not requesting access that is already granted. 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, see \'/beta/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. * Does not support self request. Only manager can request to revoke access for their directly managed employees. * If removeDate is specified, then the access will be removed on that date and time. *
|
|
15947
|
+
* This submits the access request into IdentityNow, where it will follow any IdentityNow approval processes. Access requests are processed asynchronously by IdentityNow. A success response from this endpoint means the request has been submitted to IDN and is queued for processing. Because this endpoint is asynchronous, it will not return an error if you submit duplicate access requests in quick succession, or you submit an access request for access that is already in progress, approved, or rejected. It is 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 [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) endpoints. You can also use the [search API](https://developer.sailpoint.com/idn/api/v3/search) to check the existing access items that an identity has before submitting an access request to ensure you are not requesting access that is already granted. 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, see \'/beta/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. * Does not support self request. Only manager can request to revoke access for their directly managed employees. * If removeDate is specified, then the access will be removed on that date and time only for Roles and Access Profiles. Entitlements are currently unsupported for removeDate. * Roles, Access Profiles, and Entitlements can be requested for revocation. * Revoke requests for entitlements are limited to 1 entitlement per access request currently. * [Roles, Access Profiles] RemoveData can be specified only if access don\'t have a sunset date. * Allows a manager to request to revoke access for direct employees. A token with ORG_ADMIN authority can also request to revoke access from anyone. NOTE: There is no indication to the approver in the IdentityNow UI that the approval request is for a revoke action. Take this into consideration when calling this API. A token with API authority cannot be used to call this endpoint.
|
|
15887
15948
|
* @summary Submit an Access Request
|
|
15888
15949
|
* @param {AccessRequest} accessRequest
|
|
15889
15950
|
* @param {*} [axiosOptions] Override http request option.
|
|
@@ -16032,7 +16093,7 @@ export declare class AccessRequestsApi extends BaseAPI {
|
|
|
16032
16093
|
*/
|
|
16033
16094
|
cancelAccessRequest(requestParameters: AccessRequestsApiCancelAccessRequestRequest, axiosOptions?: AxiosRequestConfig): Promise<import("axios").AxiosResponse<object, any>>;
|
|
16034
16095
|
/**
|
|
16035
|
-
* This submits the access request into IdentityNow, where it will follow any IdentityNow approval processes. Access requests are processed asynchronously by IdentityNow. A success response from this endpoint means the request has been submitted to IDN and is queued for processing. Because this endpoint is asynchronous, it will not return an error if you submit duplicate access requests in quick succession, or you submit an access request for access that is already in progress, approved, or rejected. It is 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 [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) endpoints. You can also use the [search API](https://developer.sailpoint.com/idn/api/v3/search) to check the existing access items that an identity has before submitting an access request to ensure you are not requesting access that is already granted. 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, see \'/beta/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. * Does not support self request. Only manager can request to revoke access for their directly managed employees. * If removeDate is specified, then the access will be removed on that date and time. *
|
|
16096
|
+
* This submits the access request into IdentityNow, where it will follow any IdentityNow approval processes. Access requests are processed asynchronously by IdentityNow. A success response from this endpoint means the request has been submitted to IDN and is queued for processing. Because this endpoint is asynchronous, it will not return an error if you submit duplicate access requests in quick succession, or you submit an access request for access that is already in progress, approved, or rejected. It is 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 [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) endpoints. You can also use the [search API](https://developer.sailpoint.com/idn/api/v3/search) to check the existing access items that an identity has before submitting an access request to ensure you are not requesting access that is already granted. 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, see \'/beta/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. * Does not support self request. Only manager can request to revoke access for their directly managed employees. * If removeDate is specified, then the access will be removed on that date and time only for Roles and Access Profiles. Entitlements are currently unsupported for removeDate. * Roles, Access Profiles, and Entitlements can be requested for revocation. * Revoke requests for entitlements are limited to 1 entitlement per access request currently. * [Roles, Access Profiles] RemoveData can be specified only if access don\'t have a sunset date. * Allows a manager to request to revoke access for direct employees. A token with ORG_ADMIN authority can also request to revoke access from anyone. NOTE: There is no indication to the approver in the IdentityNow UI that the approval request is for a revoke action. Take this into consideration when calling this API. A token with API authority cannot be used to call this endpoint.
|
|
16036
16097
|
* @summary Submit an Access Request
|
|
16037
16098
|
* @param {AccessRequestsApiCreateAccessRequestRequest} requestParameters Request parameters.
|
|
16038
16099
|
* @param {*} [axiosOptions] Override http request option.
|
|
@@ -16892,7 +16953,7 @@ export declare const CertificationSummariesApiAxiosParamCreator: (configuration?
|
|
|
16892
16953
|
* @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.
|
|
16893
16954
|
* @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.
|
|
16894
16955
|
* @param {boolean} [count] If *true* it will populate the *X-Total-Count* response header with the number of results that would be returned if *limit* and *offset* were ignored. Since requesting a total count can have a performance impact, it is recommended not to send **count=true** if that value will not be used. See [V3 API Standard Collection Parameters](https://developer.sailpoint.com/idn/api/standard-collection-parameters) for more information.
|
|
16895
|
-
* @param {string} [filters] Filter results using the standard syntax described in [V3 API Standard Collection Parameters](https://
|
|
16956
|
+
* @param {string} [filters] Filter results using the standard syntax described in [V3 API Standard Collection Parameters](https://developer.sailpoint.com/idn/api/standard-collection-parameters#filtering-results) Filtering is supported for the following fields and operators: **completed**: *eq, ne* **access.id**: *eq, in* **access.name**: *eq, sw* **entitlement.sourceName**: *eq, sw* **accessProfile.sourceName**: *eq, sw*
|
|
16896
16957
|
* @param {string} [sorters] Sort results using the standard syntax described in [V3 API Standard Collection Parameters](https://developer.sailpoint.com/idn/api/standard-collection-parameters#sorting-results) Sorting is supported for the following fields: **access.name**
|
|
16897
16958
|
* @param {*} [axiosOptions] Override http request option.
|
|
16898
16959
|
* @throws {RequiredError}
|
|
@@ -16902,7 +16963,7 @@ export declare const CertificationSummariesApiAxiosParamCreator: (configuration?
|
|
|
16902
16963
|
* This API returns a summary of the decisions made on an identity campaign certification. The decisions are summarized by type. A token with ORG_ADMIN or CERT_ADMIN authority is required to call this API. Reviewers for this certification can also call this API.
|
|
16903
16964
|
* @summary Summary of Certification Decisions
|
|
16904
16965
|
* @param {string} id The certification ID
|
|
16905
|
-
* @param {string} [filters] Filter results using the standard syntax described in [V3 API Standard Collection Parameters](https://
|
|
16966
|
+
* @param {string} [filters] Filter results using the standard syntax described in [V3 API Standard Collection Parameters](https://developer.sailpoint.com/idn/api/standard-collection-parameters#filtering-results) Filtering is supported for the following fields and operators: **identitySummary.id**: *eq, in*
|
|
16906
16967
|
* @param {*} [axiosOptions] Override http request option.
|
|
16907
16968
|
* @throws {RequiredError}
|
|
16908
16969
|
*/
|
|
@@ -16943,7 +17004,7 @@ export declare const CertificationSummariesApiFp: (configuration?: Configuration
|
|
|
16943
17004
|
* @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.
|
|
16944
17005
|
* @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.
|
|
16945
17006
|
* @param {boolean} [count] If *true* it will populate the *X-Total-Count* response header with the number of results that would be returned if *limit* and *offset* were ignored. Since requesting a total count can have a performance impact, it is recommended not to send **count=true** if that value will not be used. See [V3 API Standard Collection Parameters](https://developer.sailpoint.com/idn/api/standard-collection-parameters) for more information.
|
|
16946
|
-
* @param {string} [filters] Filter results using the standard syntax described in [V3 API Standard Collection Parameters](https://
|
|
17007
|
+
* @param {string} [filters] Filter results using the standard syntax described in [V3 API Standard Collection Parameters](https://developer.sailpoint.com/idn/api/standard-collection-parameters#filtering-results) Filtering is supported for the following fields and operators: **completed**: *eq, ne* **access.id**: *eq, in* **access.name**: *eq, sw* **entitlement.sourceName**: *eq, sw* **accessProfile.sourceName**: *eq, sw*
|
|
16947
17008
|
* @param {string} [sorters] Sort results using the standard syntax described in [V3 API Standard Collection Parameters](https://developer.sailpoint.com/idn/api/standard-collection-parameters#sorting-results) Sorting is supported for the following fields: **access.name**
|
|
16948
17009
|
* @param {*} [axiosOptions] Override http request option.
|
|
16949
17010
|
* @throws {RequiredError}
|
|
@@ -16953,7 +17014,7 @@ export declare const CertificationSummariesApiFp: (configuration?: Configuration
|
|
|
16953
17014
|
* This API returns a summary of the decisions made on an identity campaign certification. The decisions are summarized by type. A token with ORG_ADMIN or CERT_ADMIN authority is required to call this API. Reviewers for this certification can also call this API.
|
|
16954
17015
|
* @summary Summary of Certification Decisions
|
|
16955
17016
|
* @param {string} id The certification ID
|
|
16956
|
-
* @param {string} [filters] Filter results using the standard syntax described in [V3 API Standard Collection Parameters](https://
|
|
17017
|
+
* @param {string} [filters] Filter results using the standard syntax described in [V3 API Standard Collection Parameters](https://developer.sailpoint.com/idn/api/standard-collection-parameters#filtering-results) Filtering is supported for the following fields and operators: **identitySummary.id**: *eq, in*
|
|
16957
17018
|
* @param {*} [axiosOptions] Override http request option.
|
|
16958
17019
|
* @throws {RequiredError}
|
|
16959
17020
|
*/
|
|
@@ -16994,7 +17055,7 @@ export declare const CertificationSummariesApiFactory: (configuration?: Configur
|
|
|
16994
17055
|
* @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.
|
|
16995
17056
|
* @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.
|
|
16996
17057
|
* @param {boolean} [count] If *true* it will populate the *X-Total-Count* response header with the number of results that would be returned if *limit* and *offset* were ignored. Since requesting a total count can have a performance impact, it is recommended not to send **count=true** if that value will not be used. See [V3 API Standard Collection Parameters](https://developer.sailpoint.com/idn/api/standard-collection-parameters) for more information.
|
|
16997
|
-
* @param {string} [filters] Filter results using the standard syntax described in [V3 API Standard Collection Parameters](https://
|
|
17058
|
+
* @param {string} [filters] Filter results using the standard syntax described in [V3 API Standard Collection Parameters](https://developer.sailpoint.com/idn/api/standard-collection-parameters#filtering-results) Filtering is supported for the following fields and operators: **completed**: *eq, ne* **access.id**: *eq, in* **access.name**: *eq, sw* **entitlement.sourceName**: *eq, sw* **accessProfile.sourceName**: *eq, sw*
|
|
16998
17059
|
* @param {string} [sorters] Sort results using the standard syntax described in [V3 API Standard Collection Parameters](https://developer.sailpoint.com/idn/api/standard-collection-parameters#sorting-results) Sorting is supported for the following fields: **access.name**
|
|
16999
17060
|
* @param {*} [axiosOptions] Override http request option.
|
|
17000
17061
|
* @throws {RequiredError}
|
|
@@ -17004,7 +17065,7 @@ export declare const CertificationSummariesApiFactory: (configuration?: Configur
|
|
|
17004
17065
|
* This API returns a summary of the decisions made on an identity campaign certification. The decisions are summarized by type. A token with ORG_ADMIN or CERT_ADMIN authority is required to call this API. Reviewers for this certification can also call this API.
|
|
17005
17066
|
* @summary Summary of Certification Decisions
|
|
17006
17067
|
* @param {string} id The certification ID
|
|
17007
|
-
* @param {string} [filters] Filter results using the standard syntax described in [V3 API Standard Collection Parameters](https://
|
|
17068
|
+
* @param {string} [filters] Filter results using the standard syntax described in [V3 API Standard Collection Parameters](https://developer.sailpoint.com/idn/api/standard-collection-parameters#filtering-results) Filtering is supported for the following fields and operators: **identitySummary.id**: *eq, in*
|
|
17008
17069
|
* @param {*} [axiosOptions] Override http request option.
|
|
17009
17070
|
* @throws {RequiredError}
|
|
17010
17071
|
*/
|
|
@@ -17069,7 +17130,7 @@ export interface CertificationSummariesApiGetIdentityAccessSummariesRequest {
|
|
|
17069
17130
|
*/
|
|
17070
17131
|
readonly count?: boolean;
|
|
17071
17132
|
/**
|
|
17072
|
-
* Filter results using the standard syntax described in [V3 API Standard Collection Parameters](https://
|
|
17133
|
+
* Filter results using the standard syntax described in [V3 API Standard Collection Parameters](https://developer.sailpoint.com/idn/api/standard-collection-parameters#filtering-results) Filtering is supported for the following fields and operators: **completed**: *eq, ne* **access.id**: *eq, in* **access.name**: *eq, sw* **entitlement.sourceName**: *eq, sw* **accessProfile.sourceName**: *eq, sw*
|
|
17073
17134
|
* @type {string}
|
|
17074
17135
|
* @memberof CertificationSummariesApiGetIdentityAccessSummaries
|
|
17075
17136
|
*/
|
|
@@ -17094,7 +17155,7 @@ export interface CertificationSummariesApiGetIdentityDecisionSummaryRequest {
|
|
|
17094
17155
|
*/
|
|
17095
17156
|
readonly id: string;
|
|
17096
17157
|
/**
|
|
17097
|
-
* Filter results using the standard syntax described in [V3 API Standard Collection Parameters](https://
|
|
17158
|
+
* Filter results using the standard syntax described in [V3 API Standard Collection Parameters](https://developer.sailpoint.com/idn/api/standard-collection-parameters#filtering-results) Filtering is supported for the following fields and operators: **identitySummary.id**: *eq, in*
|
|
17098
17159
|
* @type {string}
|
|
17099
17160
|
* @memberof CertificationSummariesApiGetIdentityDecisionSummary
|
|
17100
17161
|
*/
|
|
@@ -20406,67 +20467,315 @@ export declare class OAuthClientsApi extends BaseAPI {
|
|
|
20406
20467
|
patchOauthClient(requestParameters: OAuthClientsApiPatchOauthClientRequest, axiosOptions?: AxiosRequestConfig): Promise<import("axios").AxiosResponse<GetOAuthClientResponse, any>>;
|
|
20407
20468
|
}
|
|
20408
20469
|
/**
|
|
20409
|
-
*
|
|
20470
|
+
* PasswordConfigurationApi - axios parameter creator
|
|
20410
20471
|
* @export
|
|
20411
20472
|
*/
|
|
20412
|
-
export declare const
|
|
20473
|
+
export declare const PasswordConfigurationApiAxiosParamCreator: (configuration?: Configuration) => {
|
|
20413
20474
|
/**
|
|
20414
|
-
* This API
|
|
20415
|
-
* @summary
|
|
20416
|
-
* @param {
|
|
20475
|
+
* This API creates the password org config. Unspecified fields will use default value. Requires ORG_ADMIN, API role or authorization scope of \'idn:password-org-config:write\'
|
|
20476
|
+
* @summary Create Password Org Config
|
|
20477
|
+
* @param {PasswordOrgConfig} passwordOrgConfig
|
|
20417
20478
|
* @param {*} [axiosOptions] Override http request option.
|
|
20418
20479
|
* @throws {RequiredError}
|
|
20419
20480
|
*/
|
|
20420
|
-
|
|
20481
|
+
createPasswordOrgConfig: (passwordOrgConfig: PasswordOrgConfig, axiosOptions?: AxiosRequestConfig) => Promise<RequestArgs>;
|
|
20421
20482
|
/**
|
|
20422
|
-
* This API
|
|
20423
|
-
* @summary
|
|
20424
|
-
* @param {PasswordInfoQueryDTO} passwordInfoQueryDTO
|
|
20483
|
+
* This API returns the password org config . Requires ORG_ADMIN, API role or authorization scope of \'idn:password-org-config:read\'
|
|
20484
|
+
* @summary Get Password Org Config
|
|
20425
20485
|
* @param {*} [axiosOptions] Override http request option.
|
|
20426
20486
|
* @throws {RequiredError}
|
|
20427
20487
|
*/
|
|
20428
|
-
|
|
20488
|
+
getPasswordOrgConfig: (axiosOptions?: AxiosRequestConfig) => Promise<RequestArgs>;
|
|
20429
20489
|
/**
|
|
20430
|
-
* This API
|
|
20431
|
-
* @summary
|
|
20432
|
-
* @param {
|
|
20490
|
+
* This API updates the password org config for specified fields. Other fields will keep original value. Requires ORG_ADMIN, API role or authorization scope of \'idn:password-org-config:write\'
|
|
20491
|
+
* @summary Update Password Org Config
|
|
20492
|
+
* @param {PasswordOrgConfig} passwordOrgConfig
|
|
20433
20493
|
* @param {*} [axiosOptions] Override http request option.
|
|
20434
20494
|
* @throws {RequiredError}
|
|
20435
20495
|
*/
|
|
20436
|
-
|
|
20496
|
+
updatePasswordOrgConfig: (passwordOrgConfig: PasswordOrgConfig, axiosOptions?: AxiosRequestConfig) => Promise<RequestArgs>;
|
|
20437
20497
|
};
|
|
20438
20498
|
/**
|
|
20439
|
-
*
|
|
20499
|
+
* PasswordConfigurationApi - functional programming interface
|
|
20440
20500
|
* @export
|
|
20441
20501
|
*/
|
|
20442
|
-
export declare const
|
|
20502
|
+
export declare const PasswordConfigurationApiFp: (configuration?: Configuration) => {
|
|
20443
20503
|
/**
|
|
20444
|
-
* This API
|
|
20445
|
-
* @summary
|
|
20446
|
-
* @param {
|
|
20504
|
+
* This API creates the password org config. Unspecified fields will use default value. Requires ORG_ADMIN, API role or authorization scope of \'idn:password-org-config:write\'
|
|
20505
|
+
* @summary Create Password Org Config
|
|
20506
|
+
* @param {PasswordOrgConfig} passwordOrgConfig
|
|
20447
20507
|
* @param {*} [axiosOptions] Override http request option.
|
|
20448
20508
|
* @throws {RequiredError}
|
|
20449
20509
|
*/
|
|
20450
|
-
|
|
20510
|
+
createPasswordOrgConfig(passwordOrgConfig: PasswordOrgConfig, axiosOptions?: AxiosRequestConfig): Promise<(axios?: AxiosInstance, basePath?: string) => AxiosPromise<PasswordOrgConfig>>;
|
|
20451
20511
|
/**
|
|
20452
|
-
* This API
|
|
20453
|
-
* @summary
|
|
20454
|
-
* @param {PasswordInfoQueryDTO} passwordInfoQueryDTO
|
|
20512
|
+
* This API returns the password org config . Requires ORG_ADMIN, API role or authorization scope of \'idn:password-org-config:read\'
|
|
20513
|
+
* @summary Get Password Org Config
|
|
20455
20514
|
* @param {*} [axiosOptions] Override http request option.
|
|
20456
20515
|
* @throws {RequiredError}
|
|
20457
20516
|
*/
|
|
20458
|
-
|
|
20517
|
+
getPasswordOrgConfig(axiosOptions?: AxiosRequestConfig): Promise<(axios?: AxiosInstance, basePath?: string) => AxiosPromise<PasswordOrgConfig>>;
|
|
20459
20518
|
/**
|
|
20460
|
-
* This API
|
|
20461
|
-
* @summary
|
|
20462
|
-
* @param {
|
|
20519
|
+
* This API updates the password org config for specified fields. Other fields will keep original value. Requires ORG_ADMIN, API role or authorization scope of \'idn:password-org-config:write\'
|
|
20520
|
+
* @summary Update Password Org Config
|
|
20521
|
+
* @param {PasswordOrgConfig} passwordOrgConfig
|
|
20463
20522
|
* @param {*} [axiosOptions] Override http request option.
|
|
20464
20523
|
* @throws {RequiredError}
|
|
20465
20524
|
*/
|
|
20466
|
-
|
|
20525
|
+
updatePasswordOrgConfig(passwordOrgConfig: PasswordOrgConfig, axiosOptions?: AxiosRequestConfig): Promise<(axios?: AxiosInstance, basePath?: string) => AxiosPromise<PasswordOrgConfig>>;
|
|
20467
20526
|
};
|
|
20468
20527
|
/**
|
|
20469
|
-
*
|
|
20528
|
+
* PasswordConfigurationApi - factory interface
|
|
20529
|
+
* @export
|
|
20530
|
+
*/
|
|
20531
|
+
export declare const PasswordConfigurationApiFactory: (configuration?: Configuration, basePath?: string, axios?: AxiosInstance) => {
|
|
20532
|
+
/**
|
|
20533
|
+
* This API creates the password org config. Unspecified fields will use default value. Requires ORG_ADMIN, API role or authorization scope of \'idn:password-org-config:write\'
|
|
20534
|
+
* @summary Create Password Org Config
|
|
20535
|
+
* @param {PasswordOrgConfig} passwordOrgConfig
|
|
20536
|
+
* @param {*} [axiosOptions] Override http request option.
|
|
20537
|
+
* @throws {RequiredError}
|
|
20538
|
+
*/
|
|
20539
|
+
createPasswordOrgConfig(passwordOrgConfig: PasswordOrgConfig, axiosOptions?: any): AxiosPromise<PasswordOrgConfig>;
|
|
20540
|
+
/**
|
|
20541
|
+
* This API returns the password org config . Requires ORG_ADMIN, API role or authorization scope of \'idn:password-org-config:read\'
|
|
20542
|
+
* @summary Get Password Org Config
|
|
20543
|
+
* @param {*} [axiosOptions] Override http request option.
|
|
20544
|
+
* @throws {RequiredError}
|
|
20545
|
+
*/
|
|
20546
|
+
getPasswordOrgConfig(axiosOptions?: any): AxiosPromise<PasswordOrgConfig>;
|
|
20547
|
+
/**
|
|
20548
|
+
* This API updates the password org config for specified fields. Other fields will keep original value. Requires ORG_ADMIN, API role or authorization scope of \'idn:password-org-config:write\'
|
|
20549
|
+
* @summary Update Password Org Config
|
|
20550
|
+
* @param {PasswordOrgConfig} passwordOrgConfig
|
|
20551
|
+
* @param {*} [axiosOptions] Override http request option.
|
|
20552
|
+
* @throws {RequiredError}
|
|
20553
|
+
*/
|
|
20554
|
+
updatePasswordOrgConfig(passwordOrgConfig: PasswordOrgConfig, axiosOptions?: any): AxiosPromise<PasswordOrgConfig>;
|
|
20555
|
+
};
|
|
20556
|
+
/**
|
|
20557
|
+
* Request parameters for createPasswordOrgConfig operation in PasswordConfigurationApi.
|
|
20558
|
+
* @export
|
|
20559
|
+
* @interface PasswordConfigurationApiCreatePasswordOrgConfigRequest
|
|
20560
|
+
*/
|
|
20561
|
+
export interface PasswordConfigurationApiCreatePasswordOrgConfigRequest {
|
|
20562
|
+
/**
|
|
20563
|
+
*
|
|
20564
|
+
* @type {PasswordOrgConfig}
|
|
20565
|
+
* @memberof PasswordConfigurationApiCreatePasswordOrgConfig
|
|
20566
|
+
*/
|
|
20567
|
+
readonly passwordOrgConfig: PasswordOrgConfig;
|
|
20568
|
+
}
|
|
20569
|
+
/**
|
|
20570
|
+
* Request parameters for updatePasswordOrgConfig operation in PasswordConfigurationApi.
|
|
20571
|
+
* @export
|
|
20572
|
+
* @interface PasswordConfigurationApiUpdatePasswordOrgConfigRequest
|
|
20573
|
+
*/
|
|
20574
|
+
export interface PasswordConfigurationApiUpdatePasswordOrgConfigRequest {
|
|
20575
|
+
/**
|
|
20576
|
+
*
|
|
20577
|
+
* @type {PasswordOrgConfig}
|
|
20578
|
+
* @memberof PasswordConfigurationApiUpdatePasswordOrgConfig
|
|
20579
|
+
*/
|
|
20580
|
+
readonly passwordOrgConfig: PasswordOrgConfig;
|
|
20581
|
+
}
|
|
20582
|
+
/**
|
|
20583
|
+
* PasswordConfigurationApi - object-oriented interface
|
|
20584
|
+
* @export
|
|
20585
|
+
* @class PasswordConfigurationApi
|
|
20586
|
+
* @extends {BaseAPI}
|
|
20587
|
+
*/
|
|
20588
|
+
export declare class PasswordConfigurationApi extends BaseAPI {
|
|
20589
|
+
/**
|
|
20590
|
+
* This API creates the password org config. Unspecified fields will use default value. Requires ORG_ADMIN, API role or authorization scope of \'idn:password-org-config:write\'
|
|
20591
|
+
* @summary Create Password Org Config
|
|
20592
|
+
* @param {PasswordConfigurationApiCreatePasswordOrgConfigRequest} requestParameters Request parameters.
|
|
20593
|
+
* @param {*} [axiosOptions] Override http request option.
|
|
20594
|
+
* @throws {RequiredError}
|
|
20595
|
+
* @memberof PasswordConfigurationApi
|
|
20596
|
+
*/
|
|
20597
|
+
createPasswordOrgConfig(requestParameters: PasswordConfigurationApiCreatePasswordOrgConfigRequest, axiosOptions?: AxiosRequestConfig): Promise<import("axios").AxiosResponse<PasswordOrgConfig, any>>;
|
|
20598
|
+
/**
|
|
20599
|
+
* This API returns the password org config . Requires ORG_ADMIN, API role or authorization scope of \'idn:password-org-config:read\'
|
|
20600
|
+
* @summary Get Password Org Config
|
|
20601
|
+
* @param {*} [axiosOptions] Override http request option.
|
|
20602
|
+
* @throws {RequiredError}
|
|
20603
|
+
* @memberof PasswordConfigurationApi
|
|
20604
|
+
*/
|
|
20605
|
+
getPasswordOrgConfig(axiosOptions?: AxiosRequestConfig): Promise<import("axios").AxiosResponse<PasswordOrgConfig, any>>;
|
|
20606
|
+
/**
|
|
20607
|
+
* This API updates the password org config for specified fields. Other fields will keep original value. Requires ORG_ADMIN, API role or authorization scope of \'idn:password-org-config:write\'
|
|
20608
|
+
* @summary Update Password Org Config
|
|
20609
|
+
* @param {PasswordConfigurationApiUpdatePasswordOrgConfigRequest} requestParameters Request parameters.
|
|
20610
|
+
* @param {*} [axiosOptions] Override http request option.
|
|
20611
|
+
* @throws {RequiredError}
|
|
20612
|
+
* @memberof PasswordConfigurationApi
|
|
20613
|
+
*/
|
|
20614
|
+
updatePasswordOrgConfig(requestParameters: PasswordConfigurationApiUpdatePasswordOrgConfigRequest, axiosOptions?: AxiosRequestConfig): Promise<import("axios").AxiosResponse<PasswordOrgConfig, any>>;
|
|
20615
|
+
}
|
|
20616
|
+
/**
|
|
20617
|
+
* PasswordDictionaryApi - axios parameter creator
|
|
20618
|
+
* @export
|
|
20619
|
+
*/
|
|
20620
|
+
export declare const PasswordDictionaryApiAxiosParamCreator: (configuration?: Configuration) => {
|
|
20621
|
+
/**
|
|
20622
|
+
* This gets password dictionary for the organization. A token with ORG_ADMIN authority is required to call this API.
|
|
20623
|
+
* @summary Get Password Dictionary
|
|
20624
|
+
* @param {*} [axiosOptions] Override http request option.
|
|
20625
|
+
* @throws {RequiredError}
|
|
20626
|
+
*/
|
|
20627
|
+
getPasswordDictionary: (axiosOptions?: AxiosRequestConfig) => Promise<RequestArgs>;
|
|
20628
|
+
/**
|
|
20629
|
+
* This updates password dictionary for the organization. A token with ORG_ADMIN authority is required to call this API.
|
|
20630
|
+
* @summary Update Password Dictionary
|
|
20631
|
+
* @param {any} [file]
|
|
20632
|
+
* @param {*} [axiosOptions] Override http request option.
|
|
20633
|
+
* @throws {RequiredError}
|
|
20634
|
+
*/
|
|
20635
|
+
updatePasswordDictionary: (file?: any, axiosOptions?: AxiosRequestConfig) => Promise<RequestArgs>;
|
|
20636
|
+
};
|
|
20637
|
+
/**
|
|
20638
|
+
* PasswordDictionaryApi - functional programming interface
|
|
20639
|
+
* @export
|
|
20640
|
+
*/
|
|
20641
|
+
export declare const PasswordDictionaryApiFp: (configuration?: Configuration) => {
|
|
20642
|
+
/**
|
|
20643
|
+
* This gets password dictionary for the organization. A token with ORG_ADMIN authority is required to call this API.
|
|
20644
|
+
* @summary Get Password Dictionary
|
|
20645
|
+
* @param {*} [axiosOptions] Override http request option.
|
|
20646
|
+
* @throws {RequiredError}
|
|
20647
|
+
*/
|
|
20648
|
+
getPasswordDictionary(axiosOptions?: AxiosRequestConfig): Promise<(axios?: AxiosInstance, basePath?: string) => AxiosPromise<string>>;
|
|
20649
|
+
/**
|
|
20650
|
+
* This updates password dictionary for the organization. A token with ORG_ADMIN authority is required to call this API.
|
|
20651
|
+
* @summary Update Password Dictionary
|
|
20652
|
+
* @param {any} [file]
|
|
20653
|
+
* @param {*} [axiosOptions] Override http request option.
|
|
20654
|
+
* @throws {RequiredError}
|
|
20655
|
+
*/
|
|
20656
|
+
updatePasswordDictionary(file?: any, axiosOptions?: AxiosRequestConfig): Promise<(axios?: AxiosInstance, basePath?: string) => AxiosPromise<void>>;
|
|
20657
|
+
};
|
|
20658
|
+
/**
|
|
20659
|
+
* PasswordDictionaryApi - factory interface
|
|
20660
|
+
* @export
|
|
20661
|
+
*/
|
|
20662
|
+
export declare const PasswordDictionaryApiFactory: (configuration?: Configuration, basePath?: string, axios?: AxiosInstance) => {
|
|
20663
|
+
/**
|
|
20664
|
+
* This gets password dictionary for the organization. A token with ORG_ADMIN authority is required to call this API.
|
|
20665
|
+
* @summary Get Password Dictionary
|
|
20666
|
+
* @param {*} [axiosOptions] Override http request option.
|
|
20667
|
+
* @throws {RequiredError}
|
|
20668
|
+
*/
|
|
20669
|
+
getPasswordDictionary(axiosOptions?: any): AxiosPromise<string>;
|
|
20670
|
+
/**
|
|
20671
|
+
* This updates password dictionary for the organization. A token with ORG_ADMIN authority is required to call this API.
|
|
20672
|
+
* @summary Update Password Dictionary
|
|
20673
|
+
* @param {any} [file]
|
|
20674
|
+
* @param {*} [axiosOptions] Override http request option.
|
|
20675
|
+
* @throws {RequiredError}
|
|
20676
|
+
*/
|
|
20677
|
+
updatePasswordDictionary(file?: any, axiosOptions?: any): AxiosPromise<void>;
|
|
20678
|
+
};
|
|
20679
|
+
/**
|
|
20680
|
+
* Request parameters for updatePasswordDictionary operation in PasswordDictionaryApi.
|
|
20681
|
+
* @export
|
|
20682
|
+
* @interface PasswordDictionaryApiUpdatePasswordDictionaryRequest
|
|
20683
|
+
*/
|
|
20684
|
+
export interface PasswordDictionaryApiUpdatePasswordDictionaryRequest {
|
|
20685
|
+
/**
|
|
20686
|
+
*
|
|
20687
|
+
* @type {any}
|
|
20688
|
+
* @memberof PasswordDictionaryApiUpdatePasswordDictionary
|
|
20689
|
+
*/
|
|
20690
|
+
readonly file?: any;
|
|
20691
|
+
}
|
|
20692
|
+
/**
|
|
20693
|
+
* PasswordDictionaryApi - object-oriented interface
|
|
20694
|
+
* @export
|
|
20695
|
+
* @class PasswordDictionaryApi
|
|
20696
|
+
* @extends {BaseAPI}
|
|
20697
|
+
*/
|
|
20698
|
+
export declare class PasswordDictionaryApi extends BaseAPI {
|
|
20699
|
+
/**
|
|
20700
|
+
* This gets password dictionary for the organization. A token with ORG_ADMIN authority is required to call this API.
|
|
20701
|
+
* @summary Get Password Dictionary
|
|
20702
|
+
* @param {*} [axiosOptions] Override http request option.
|
|
20703
|
+
* @throws {RequiredError}
|
|
20704
|
+
* @memberof PasswordDictionaryApi
|
|
20705
|
+
*/
|
|
20706
|
+
getPasswordDictionary(axiosOptions?: AxiosRequestConfig): Promise<import("axios").AxiosResponse<string, any>>;
|
|
20707
|
+
/**
|
|
20708
|
+
* This updates password dictionary for the organization. A token with ORG_ADMIN authority is required to call this API.
|
|
20709
|
+
* @summary Update Password Dictionary
|
|
20710
|
+
* @param {PasswordDictionaryApiUpdatePasswordDictionaryRequest} requestParameters Request parameters.
|
|
20711
|
+
* @param {*} [axiosOptions] Override http request option.
|
|
20712
|
+
* @throws {RequiredError}
|
|
20713
|
+
* @memberof PasswordDictionaryApi
|
|
20714
|
+
*/
|
|
20715
|
+
updatePasswordDictionary(requestParameters?: PasswordDictionaryApiUpdatePasswordDictionaryRequest, axiosOptions?: AxiosRequestConfig): Promise<import("axios").AxiosResponse<void, any>>;
|
|
20716
|
+
}
|
|
20717
|
+
/**
|
|
20718
|
+
* PasswordManagementApi - axios parameter creator
|
|
20719
|
+
* @export
|
|
20720
|
+
*/
|
|
20721
|
+
export declare const PasswordManagementApiAxiosParamCreator: (configuration?: Configuration) => {
|
|
20722
|
+
/**
|
|
20723
|
+
* This API returns the status of a password change request. A token with identity owner or trusted API client application authority is required to call this API.
|
|
20724
|
+
* @summary Get Password Change Request Status
|
|
20725
|
+
* @param {string} id Password change request ID
|
|
20726
|
+
* @param {*} [axiosOptions] Override http request option.
|
|
20727
|
+
* @throws {RequiredError}
|
|
20728
|
+
*/
|
|
20729
|
+
getPasswordChangeStatus: (id: string, axiosOptions?: AxiosRequestConfig) => Promise<RequestArgs>;
|
|
20730
|
+
/**
|
|
20731
|
+
* This API is used to query password related information. A token with [API authority](https://developer.sailpoint.com/idn/api/authentication#client-credentials-grant-flow) is required to call this API. \"API authority\" refers to a token that only has the \"client_credentials\" grant type, and therefore no user context. A [personal access token](https://developer.sailpoint.com/idn/api/authentication#personal-access-tokens) or a token generated with the [authorization_code](https://developer.sailpoint.com/idn/api/authentication#authorization-code-grant-flow) grant type will **NOT** work on this endpoint, and a `403 Forbidden` response will be returned.
|
|
20732
|
+
* @summary Query Password Info
|
|
20733
|
+
* @param {PasswordInfoQueryDTO} passwordInfoQueryDTO
|
|
20734
|
+
* @param {*} [axiosOptions] Override http request option.
|
|
20735
|
+
* @throws {RequiredError}
|
|
20736
|
+
*/
|
|
20737
|
+
queryPasswordInfo: (passwordInfoQueryDTO: PasswordInfoQueryDTO, axiosOptions?: AxiosRequestConfig) => Promise<RequestArgs>;
|
|
20738
|
+
/**
|
|
20739
|
+
* This API is used to set a password for an identity. An identity can change their own password (as well as any of their accounts\' passwords) if they use a token generated by their IDN user, such as a [personal access token](https://developer.sailpoint.com/idn/api/authentication#personal-access-tokens) or [\"authorization_code\" derived OAuth token](https://developer.sailpoint.com/idn/api/authentication#authorization-code-grant-flow). A token with [API authority](https://developer.sailpoint.com/idn/api/authentication#client-credentials-grant-flow) can be used to change **any** identity\'s password or the password of any of the identity\'s accounts. \"API authority\" refers to a token that only has the \"client_credentials\" grant type. You can use this endpoint to generate an `encryptedPassword` (RSA encrypted using publicKey). To do so, follow these steps: 1. Use [Query Password Info](https://developer.sailpoint.com/idn/api/v3/query-password-info) to get the following information: `identityId`, `sourceId`, `publicKeyId`, `publicKey`, `accounts`, and `policies`. 2. Choose an account from the previous response that you will provide as an `accountId` in your request to set an encrypted password. 3. Use [Set Identity\'s Password](https://developer.sailpoint.com/idn/api/v3/set-password) and provide the information you got from your earlier query. Then add this code to your request to get the encrypted password: ```java import javax.crypto.Cipher; import java.security.KeyFactory; import java.security.PublicKey; import java.security.spec.X509EncodedKeySpec; import java util.Base64; String encrypt(String publicKey, String toEncrypt) throws Exception { byte[] publicKeyBytes = Base64.getDecoder().decode(publicKey); byte[] encryptedBytes = encryptRsa(publicKeyBytes, toEncrypt.getBytes(\"UTF-8\")); return Base64.getEncoder().encodeToString(encryptedBytes); } private byte[] encryptRsa(byte[] publicKeyBytes, byte[] toEncryptBytes) throws Exception { PublicKey key = KeyFactory.getInstance(\"RSA\").generatePublic(new X509EncodedKeySpec(publicKeyBytes)); String transformation = \"RSA/ECB/PKCS1Padding\"; Cipher cipher = Cipher.getInstance(transformation); cipher.init(1, key); return cipher.doFinal(toEncryptBytes); } ``` In this example, `toEncrypt` refers to the plain text password you are setting and then encrypting, and the `publicKey` refers to the publicKey you got from the first request you sent. You can then use [Get Password Change Request Status](https://developer.sailpoint.com/idn/api/v3/get-password-change-status) to check the password change request status. To do so, you must provide the `requestId` from your earlier request to set the password.
|
|
20740
|
+
* @summary Set Identity\'s Password
|
|
20741
|
+
* @param {PasswordChangeRequest} passwordChangeRequest
|
|
20742
|
+
* @param {*} [axiosOptions] Override http request option.
|
|
20743
|
+
* @throws {RequiredError}
|
|
20744
|
+
*/
|
|
20745
|
+
setPassword: (passwordChangeRequest: PasswordChangeRequest, axiosOptions?: AxiosRequestConfig) => Promise<RequestArgs>;
|
|
20746
|
+
};
|
|
20747
|
+
/**
|
|
20748
|
+
* PasswordManagementApi - functional programming interface
|
|
20749
|
+
* @export
|
|
20750
|
+
*/
|
|
20751
|
+
export declare const PasswordManagementApiFp: (configuration?: Configuration) => {
|
|
20752
|
+
/**
|
|
20753
|
+
* This API returns the status of a password change request. A token with identity owner or trusted API client application authority is required to call this API.
|
|
20754
|
+
* @summary Get Password Change Request Status
|
|
20755
|
+
* @param {string} id Password change request ID
|
|
20756
|
+
* @param {*} [axiosOptions] Override http request option.
|
|
20757
|
+
* @throws {RequiredError}
|
|
20758
|
+
*/
|
|
20759
|
+
getPasswordChangeStatus(id: string, axiosOptions?: AxiosRequestConfig): Promise<(axios?: AxiosInstance, basePath?: string) => AxiosPromise<PasswordStatus>>;
|
|
20760
|
+
/**
|
|
20761
|
+
* This API is used to query password related information. A token with [API authority](https://developer.sailpoint.com/idn/api/authentication#client-credentials-grant-flow) is required to call this API. \"API authority\" refers to a token that only has the \"client_credentials\" grant type, and therefore no user context. A [personal access token](https://developer.sailpoint.com/idn/api/authentication#personal-access-tokens) or a token generated with the [authorization_code](https://developer.sailpoint.com/idn/api/authentication#authorization-code-grant-flow) grant type will **NOT** work on this endpoint, and a `403 Forbidden` response will be returned.
|
|
20762
|
+
* @summary Query Password Info
|
|
20763
|
+
* @param {PasswordInfoQueryDTO} passwordInfoQueryDTO
|
|
20764
|
+
* @param {*} [axiosOptions] Override http request option.
|
|
20765
|
+
* @throws {RequiredError}
|
|
20766
|
+
*/
|
|
20767
|
+
queryPasswordInfo(passwordInfoQueryDTO: PasswordInfoQueryDTO, axiosOptions?: AxiosRequestConfig): Promise<(axios?: AxiosInstance, basePath?: string) => AxiosPromise<PasswordInfo>>;
|
|
20768
|
+
/**
|
|
20769
|
+
* This API is used to set a password for an identity. An identity can change their own password (as well as any of their accounts\' passwords) if they use a token generated by their IDN user, such as a [personal access token](https://developer.sailpoint.com/idn/api/authentication#personal-access-tokens) or [\"authorization_code\" derived OAuth token](https://developer.sailpoint.com/idn/api/authentication#authorization-code-grant-flow). A token with [API authority](https://developer.sailpoint.com/idn/api/authentication#client-credentials-grant-flow) can be used to change **any** identity\'s password or the password of any of the identity\'s accounts. \"API authority\" refers to a token that only has the \"client_credentials\" grant type. You can use this endpoint to generate an `encryptedPassword` (RSA encrypted using publicKey). To do so, follow these steps: 1. Use [Query Password Info](https://developer.sailpoint.com/idn/api/v3/query-password-info) to get the following information: `identityId`, `sourceId`, `publicKeyId`, `publicKey`, `accounts`, and `policies`. 2. Choose an account from the previous response that you will provide as an `accountId` in your request to set an encrypted password. 3. Use [Set Identity\'s Password](https://developer.sailpoint.com/idn/api/v3/set-password) and provide the information you got from your earlier query. Then add this code to your request to get the encrypted password: ```java import javax.crypto.Cipher; import java.security.KeyFactory; import java.security.PublicKey; import java.security.spec.X509EncodedKeySpec; import java util.Base64; String encrypt(String publicKey, String toEncrypt) throws Exception { byte[] publicKeyBytes = Base64.getDecoder().decode(publicKey); byte[] encryptedBytes = encryptRsa(publicKeyBytes, toEncrypt.getBytes(\"UTF-8\")); return Base64.getEncoder().encodeToString(encryptedBytes); } private byte[] encryptRsa(byte[] publicKeyBytes, byte[] toEncryptBytes) throws Exception { PublicKey key = KeyFactory.getInstance(\"RSA\").generatePublic(new X509EncodedKeySpec(publicKeyBytes)); String transformation = \"RSA/ECB/PKCS1Padding\"; Cipher cipher = Cipher.getInstance(transformation); cipher.init(1, key); return cipher.doFinal(toEncryptBytes); } ``` In this example, `toEncrypt` refers to the plain text password you are setting and then encrypting, and the `publicKey` refers to the publicKey you got from the first request you sent. You can then use [Get Password Change Request Status](https://developer.sailpoint.com/idn/api/v3/get-password-change-status) to check the password change request status. To do so, you must provide the `requestId` from your earlier request to set the password.
|
|
20770
|
+
* @summary Set Identity\'s Password
|
|
20771
|
+
* @param {PasswordChangeRequest} passwordChangeRequest
|
|
20772
|
+
* @param {*} [axiosOptions] Override http request option.
|
|
20773
|
+
* @throws {RequiredError}
|
|
20774
|
+
*/
|
|
20775
|
+
setPassword(passwordChangeRequest: PasswordChangeRequest, axiosOptions?: AxiosRequestConfig): Promise<(axios?: AxiosInstance, basePath?: string) => AxiosPromise<PasswordChangeResponse>>;
|
|
20776
|
+
};
|
|
20777
|
+
/**
|
|
20778
|
+
* PasswordManagementApi - factory interface
|
|
20470
20779
|
* @export
|
|
20471
20780
|
*/
|
|
20472
20781
|
export declare const PasswordManagementApiFactory: (configuration?: Configuration, basePath?: string, axios?: AxiosInstance) => {
|
|
@@ -20487,7 +20796,7 @@ export declare const PasswordManagementApiFactory: (configuration?: Configuratio
|
|
|
20487
20796
|
*/
|
|
20488
20797
|
queryPasswordInfo(passwordInfoQueryDTO: PasswordInfoQueryDTO, axiosOptions?: any): AxiosPromise<PasswordInfo>;
|
|
20489
20798
|
/**
|
|
20490
|
-
* This API is used to set a password for an identity. An identity can change their own password if they use a token generated by their IDN user, such as a [personal access token](https://developer.sailpoint.com/idn/api/authentication#personal-access-tokens) or [\"authorization_code\" derived OAuth token](https://developer.sailpoint.com/idn/api/authentication#authorization-code-grant-flow). A token with [API authority](https://developer.sailpoint.com/idn/api/authentication#client-credentials-grant-flow) can be used to change **any** identity\'s password. \"API authority\" refers to a token that only has the \"client_credentials\" grant type.
|
|
20799
|
+
* This API is used to set a password for an identity. An identity can change their own password (as well as any of their accounts\' passwords) if they use a token generated by their IDN user, such as a [personal access token](https://developer.sailpoint.com/idn/api/authentication#personal-access-tokens) or [\"authorization_code\" derived OAuth token](https://developer.sailpoint.com/idn/api/authentication#authorization-code-grant-flow). A token with [API authority](https://developer.sailpoint.com/idn/api/authentication#client-credentials-grant-flow) can be used to change **any** identity\'s password or the password of any of the identity\'s accounts. \"API authority\" refers to a token that only has the \"client_credentials\" grant type. You can use this endpoint to generate an `encryptedPassword` (RSA encrypted using publicKey). To do so, follow these steps: 1. Use [Query Password Info](https://developer.sailpoint.com/idn/api/v3/query-password-info) to get the following information: `identityId`, `sourceId`, `publicKeyId`, `publicKey`, `accounts`, and `policies`. 2. Choose an account from the previous response that you will provide as an `accountId` in your request to set an encrypted password. 3. Use [Set Identity\'s Password](https://developer.sailpoint.com/idn/api/v3/set-password) and provide the information you got from your earlier query. Then add this code to your request to get the encrypted password: ```java import javax.crypto.Cipher; import java.security.KeyFactory; import java.security.PublicKey; import java.security.spec.X509EncodedKeySpec; import java util.Base64; String encrypt(String publicKey, String toEncrypt) throws Exception { byte[] publicKeyBytes = Base64.getDecoder().decode(publicKey); byte[] encryptedBytes = encryptRsa(publicKeyBytes, toEncrypt.getBytes(\"UTF-8\")); return Base64.getEncoder().encodeToString(encryptedBytes); } private byte[] encryptRsa(byte[] publicKeyBytes, byte[] toEncryptBytes) throws Exception { PublicKey key = KeyFactory.getInstance(\"RSA\").generatePublic(new X509EncodedKeySpec(publicKeyBytes)); String transformation = \"RSA/ECB/PKCS1Padding\"; Cipher cipher = Cipher.getInstance(transformation); cipher.init(1, key); return cipher.doFinal(toEncryptBytes); } ``` In this example, `toEncrypt` refers to the plain text password you are setting and then encrypting, and the `publicKey` refers to the publicKey you got from the first request you sent. You can then use [Get Password Change Request Status](https://developer.sailpoint.com/idn/api/v3/get-password-change-status) to check the password change request status. To do so, you must provide the `requestId` from your earlier request to set the password.
|
|
20491
20800
|
* @summary Set Identity\'s Password
|
|
20492
20801
|
* @param {PasswordChangeRequest} passwordChangeRequest
|
|
20493
20802
|
* @param {*} [axiosOptions] Override http request option.
|
|
@@ -20560,7 +20869,7 @@ export declare class PasswordManagementApi extends BaseAPI {
|
|
|
20560
20869
|
*/
|
|
20561
20870
|
queryPasswordInfo(requestParameters: PasswordManagementApiQueryPasswordInfoRequest, axiosOptions?: AxiosRequestConfig): Promise<import("axios").AxiosResponse<PasswordInfo, any>>;
|
|
20562
20871
|
/**
|
|
20563
|
-
* This API is used to set a password for an identity. An identity can change their own password if they use a token generated by their IDN user, such as a [personal access token](https://developer.sailpoint.com/idn/api/authentication#personal-access-tokens) or [\"authorization_code\" derived OAuth token](https://developer.sailpoint.com/idn/api/authentication#authorization-code-grant-flow). A token with [API authority](https://developer.sailpoint.com/idn/api/authentication#client-credentials-grant-flow) can be used to change **any** identity\'s password. \"API authority\" refers to a token that only has the \"client_credentials\" grant type.
|
|
20872
|
+
* This API is used to set a password for an identity. An identity can change their own password (as well as any of their accounts\' passwords) if they use a token generated by their IDN user, such as a [personal access token](https://developer.sailpoint.com/idn/api/authentication#personal-access-tokens) or [\"authorization_code\" derived OAuth token](https://developer.sailpoint.com/idn/api/authentication#authorization-code-grant-flow). A token with [API authority](https://developer.sailpoint.com/idn/api/authentication#client-credentials-grant-flow) can be used to change **any** identity\'s password or the password of any of the identity\'s accounts. \"API authority\" refers to a token that only has the \"client_credentials\" grant type. You can use this endpoint to generate an `encryptedPassword` (RSA encrypted using publicKey). To do so, follow these steps: 1. Use [Query Password Info](https://developer.sailpoint.com/idn/api/v3/query-password-info) to get the following information: `identityId`, `sourceId`, `publicKeyId`, `publicKey`, `accounts`, and `policies`. 2. Choose an account from the previous response that you will provide as an `accountId` in your request to set an encrypted password. 3. Use [Set Identity\'s Password](https://developer.sailpoint.com/idn/api/v3/set-password) and provide the information you got from your earlier query. Then add this code to your request to get the encrypted password: ```java import javax.crypto.Cipher; import java.security.KeyFactory; import java.security.PublicKey; import java.security.spec.X509EncodedKeySpec; import java util.Base64; String encrypt(String publicKey, String toEncrypt) throws Exception { byte[] publicKeyBytes = Base64.getDecoder().decode(publicKey); byte[] encryptedBytes = encryptRsa(publicKeyBytes, toEncrypt.getBytes(\"UTF-8\")); return Base64.getEncoder().encodeToString(encryptedBytes); } private byte[] encryptRsa(byte[] publicKeyBytes, byte[] toEncryptBytes) throws Exception { PublicKey key = KeyFactory.getInstance(\"RSA\").generatePublic(new X509EncodedKeySpec(publicKeyBytes)); String transformation = \"RSA/ECB/PKCS1Padding\"; Cipher cipher = Cipher.getInstance(transformation); cipher.init(1, key); return cipher.doFinal(toEncryptBytes); } ``` In this example, `toEncrypt` refers to the plain text password you are setting and then encrypting, and the `publicKey` refers to the publicKey you got from the first request you sent. You can then use [Get Password Change Request Status](https://developer.sailpoint.com/idn/api/v3/get-password-change-status) to check the password change request status. To do so, you must provide the `requestId` from your earlier request to set the password.
|
|
20564
20873
|
* @summary Set Identity\'s Password
|
|
20565
20874
|
* @param {PasswordManagementApiSetPasswordRequest} requestParameters Request parameters.
|
|
20566
20875
|
* @param {*} [axiosOptions] Override http request option.
|
|
@@ -20569,6 +20878,289 @@ export declare class PasswordManagementApi extends BaseAPI {
|
|
|
20569
20878
|
*/
|
|
20570
20879
|
setPassword(requestParameters: PasswordManagementApiSetPasswordRequest, axiosOptions?: AxiosRequestConfig): Promise<import("axios").AxiosResponse<PasswordChangeResponse, any>>;
|
|
20571
20880
|
}
|
|
20881
|
+
/**
|
|
20882
|
+
* PasswordSyncGroupsApi - axios parameter creator
|
|
20883
|
+
* @export
|
|
20884
|
+
*/
|
|
20885
|
+
export declare const PasswordSyncGroupsApiAxiosParamCreator: (configuration?: Configuration) => {
|
|
20886
|
+
/**
|
|
20887
|
+
* This API creates a password sync group based on the specifications provided. A token with ORG_ADMIN authority is required to call this API.
|
|
20888
|
+
* @summary Create Password Sync Group
|
|
20889
|
+
* @param {PasswordSyncGroup} passwordSyncGroup
|
|
20890
|
+
* @param {*} [axiosOptions] Override http request option.
|
|
20891
|
+
* @throws {RequiredError}
|
|
20892
|
+
*/
|
|
20893
|
+
createPasswordSyncGroup: (passwordSyncGroup: PasswordSyncGroup, axiosOptions?: AxiosRequestConfig) => Promise<RequestArgs>;
|
|
20894
|
+
/**
|
|
20895
|
+
* This API deletes the specified password sync group. A token with ORG_ADMIN authority is required to call this API.
|
|
20896
|
+
* @summary Delete Password Sync Group by ID
|
|
20897
|
+
* @param {string} id The ID of password sync group to delete.
|
|
20898
|
+
* @param {*} [axiosOptions] Override http request option.
|
|
20899
|
+
* @throws {RequiredError}
|
|
20900
|
+
*/
|
|
20901
|
+
deletePasswordSyncGroup: (id: string, axiosOptions?: AxiosRequestConfig) => Promise<RequestArgs>;
|
|
20902
|
+
/**
|
|
20903
|
+
* This API returns the sync group for the specified ID. A token with ORG_ADMIN authority is required to call this API.
|
|
20904
|
+
* @summary Get Password Sync Group by ID
|
|
20905
|
+
* @param {string} id The ID of password sync group to retrieve.
|
|
20906
|
+
* @param {*} [axiosOptions] Override http request option.
|
|
20907
|
+
* @throws {RequiredError}
|
|
20908
|
+
*/
|
|
20909
|
+
getPasswordSyncGroup: (id: string, axiosOptions?: AxiosRequestConfig) => Promise<RequestArgs>;
|
|
20910
|
+
/**
|
|
20911
|
+
* This API returns a list of password sync groups. A token with ORG_ADMIN authority is required to call this API.
|
|
20912
|
+
* @summary Get Password Sync Group List
|
|
20913
|
+
* @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.
|
|
20914
|
+
* @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.
|
|
20915
|
+
* @param {boolean} [count] If *true* it will populate the *X-Total-Count* response header with the number of results that would be returned if *limit* and *offset* were ignored. Since requesting a total count can have a performance impact, it is recommended not to send **count=true** if that value will not be used. See [V3 API Standard Collection Parameters](https://developer.sailpoint.com/idn/api/standard-collection-parameters) for more information.
|
|
20916
|
+
* @param {*} [axiosOptions] Override http request option.
|
|
20917
|
+
* @throws {RequiredError}
|
|
20918
|
+
*/
|
|
20919
|
+
getPasswordSyncGroups: (limit?: number, offset?: number, count?: boolean, axiosOptions?: AxiosRequestConfig) => Promise<RequestArgs>;
|
|
20920
|
+
/**
|
|
20921
|
+
* This API updates the specified password sync group. A token with ORG_ADMIN authority is required to call this API.
|
|
20922
|
+
* @summary Update Password Sync Group by ID
|
|
20923
|
+
* @param {string} id The ID of password sync group to update.
|
|
20924
|
+
* @param {PasswordSyncGroup} passwordSyncGroup
|
|
20925
|
+
* @param {*} [axiosOptions] Override http request option.
|
|
20926
|
+
* @throws {RequiredError}
|
|
20927
|
+
*/
|
|
20928
|
+
updatePasswordSyncGroup: (id: string, passwordSyncGroup: PasswordSyncGroup, axiosOptions?: AxiosRequestConfig) => Promise<RequestArgs>;
|
|
20929
|
+
};
|
|
20930
|
+
/**
|
|
20931
|
+
* PasswordSyncGroupsApi - functional programming interface
|
|
20932
|
+
* @export
|
|
20933
|
+
*/
|
|
20934
|
+
export declare const PasswordSyncGroupsApiFp: (configuration?: Configuration) => {
|
|
20935
|
+
/**
|
|
20936
|
+
* This API creates a password sync group based on the specifications provided. A token with ORG_ADMIN authority is required to call this API.
|
|
20937
|
+
* @summary Create Password Sync Group
|
|
20938
|
+
* @param {PasswordSyncGroup} passwordSyncGroup
|
|
20939
|
+
* @param {*} [axiosOptions] Override http request option.
|
|
20940
|
+
* @throws {RequiredError}
|
|
20941
|
+
*/
|
|
20942
|
+
createPasswordSyncGroup(passwordSyncGroup: PasswordSyncGroup, axiosOptions?: AxiosRequestConfig): Promise<(axios?: AxiosInstance, basePath?: string) => AxiosPromise<PasswordSyncGroup>>;
|
|
20943
|
+
/**
|
|
20944
|
+
* This API deletes the specified password sync group. A token with ORG_ADMIN authority is required to call this API.
|
|
20945
|
+
* @summary Delete Password Sync Group by ID
|
|
20946
|
+
* @param {string} id The ID of password sync group to delete.
|
|
20947
|
+
* @param {*} [axiosOptions] Override http request option.
|
|
20948
|
+
* @throws {RequiredError}
|
|
20949
|
+
*/
|
|
20950
|
+
deletePasswordSyncGroup(id: string, axiosOptions?: AxiosRequestConfig): Promise<(axios?: AxiosInstance, basePath?: string) => AxiosPromise<void>>;
|
|
20951
|
+
/**
|
|
20952
|
+
* This API returns the sync group for the specified ID. A token with ORG_ADMIN authority is required to call this API.
|
|
20953
|
+
* @summary Get Password Sync Group by ID
|
|
20954
|
+
* @param {string} id The ID of password sync group to retrieve.
|
|
20955
|
+
* @param {*} [axiosOptions] Override http request option.
|
|
20956
|
+
* @throws {RequiredError}
|
|
20957
|
+
*/
|
|
20958
|
+
getPasswordSyncGroup(id: string, axiosOptions?: AxiosRequestConfig): Promise<(axios?: AxiosInstance, basePath?: string) => AxiosPromise<PasswordSyncGroup>>;
|
|
20959
|
+
/**
|
|
20960
|
+
* This API returns a list of password sync groups. A token with ORG_ADMIN authority is required to call this API.
|
|
20961
|
+
* @summary Get Password Sync Group List
|
|
20962
|
+
* @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.
|
|
20963
|
+
* @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.
|
|
20964
|
+
* @param {boolean} [count] If *true* it will populate the *X-Total-Count* response header with the number of results that would be returned if *limit* and *offset* were ignored. Since requesting a total count can have a performance impact, it is recommended not to send **count=true** if that value will not be used. See [V3 API Standard Collection Parameters](https://developer.sailpoint.com/idn/api/standard-collection-parameters) for more information.
|
|
20965
|
+
* @param {*} [axiosOptions] Override http request option.
|
|
20966
|
+
* @throws {RequiredError}
|
|
20967
|
+
*/
|
|
20968
|
+
getPasswordSyncGroups(limit?: number, offset?: number, count?: boolean, axiosOptions?: AxiosRequestConfig): Promise<(axios?: AxiosInstance, basePath?: string) => AxiosPromise<Array<PasswordSyncGroup>>>;
|
|
20969
|
+
/**
|
|
20970
|
+
* This API updates the specified password sync group. A token with ORG_ADMIN authority is required to call this API.
|
|
20971
|
+
* @summary Update Password Sync Group by ID
|
|
20972
|
+
* @param {string} id The ID of password sync group to update.
|
|
20973
|
+
* @param {PasswordSyncGroup} passwordSyncGroup
|
|
20974
|
+
* @param {*} [axiosOptions] Override http request option.
|
|
20975
|
+
* @throws {RequiredError}
|
|
20976
|
+
*/
|
|
20977
|
+
updatePasswordSyncGroup(id: string, passwordSyncGroup: PasswordSyncGroup, axiosOptions?: AxiosRequestConfig): Promise<(axios?: AxiosInstance, basePath?: string) => AxiosPromise<PasswordSyncGroup>>;
|
|
20978
|
+
};
|
|
20979
|
+
/**
|
|
20980
|
+
* PasswordSyncGroupsApi - factory interface
|
|
20981
|
+
* @export
|
|
20982
|
+
*/
|
|
20983
|
+
export declare const PasswordSyncGroupsApiFactory: (configuration?: Configuration, basePath?: string, axios?: AxiosInstance) => {
|
|
20984
|
+
/**
|
|
20985
|
+
* This API creates a password sync group based on the specifications provided. A token with ORG_ADMIN authority is required to call this API.
|
|
20986
|
+
* @summary Create Password Sync Group
|
|
20987
|
+
* @param {PasswordSyncGroup} passwordSyncGroup
|
|
20988
|
+
* @param {*} [axiosOptions] Override http request option.
|
|
20989
|
+
* @throws {RequiredError}
|
|
20990
|
+
*/
|
|
20991
|
+
createPasswordSyncGroup(passwordSyncGroup: PasswordSyncGroup, axiosOptions?: any): AxiosPromise<PasswordSyncGroup>;
|
|
20992
|
+
/**
|
|
20993
|
+
* This API deletes the specified password sync group. A token with ORG_ADMIN authority is required to call this API.
|
|
20994
|
+
* @summary Delete Password Sync Group by ID
|
|
20995
|
+
* @param {string} id The ID of password sync group to delete.
|
|
20996
|
+
* @param {*} [axiosOptions] Override http request option.
|
|
20997
|
+
* @throws {RequiredError}
|
|
20998
|
+
*/
|
|
20999
|
+
deletePasswordSyncGroup(id: string, axiosOptions?: any): AxiosPromise<void>;
|
|
21000
|
+
/**
|
|
21001
|
+
* This API returns the sync group for the specified ID. A token with ORG_ADMIN authority is required to call this API.
|
|
21002
|
+
* @summary Get Password Sync Group by ID
|
|
21003
|
+
* @param {string} id The ID of password sync group to retrieve.
|
|
21004
|
+
* @param {*} [axiosOptions] Override http request option.
|
|
21005
|
+
* @throws {RequiredError}
|
|
21006
|
+
*/
|
|
21007
|
+
getPasswordSyncGroup(id: string, axiosOptions?: any): AxiosPromise<PasswordSyncGroup>;
|
|
21008
|
+
/**
|
|
21009
|
+
* This API returns a list of password sync groups. A token with ORG_ADMIN authority is required to call this API.
|
|
21010
|
+
* @summary Get Password Sync Group List
|
|
21011
|
+
* @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.
|
|
21012
|
+
* @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.
|
|
21013
|
+
* @param {boolean} [count] If *true* it will populate the *X-Total-Count* response header with the number of results that would be returned if *limit* and *offset* were ignored. Since requesting a total count can have a performance impact, it is recommended not to send **count=true** if that value will not be used. See [V3 API Standard Collection Parameters](https://developer.sailpoint.com/idn/api/standard-collection-parameters) for more information.
|
|
21014
|
+
* @param {*} [axiosOptions] Override http request option.
|
|
21015
|
+
* @throws {RequiredError}
|
|
21016
|
+
*/
|
|
21017
|
+
getPasswordSyncGroups(limit?: number, offset?: number, count?: boolean, axiosOptions?: any): AxiosPromise<Array<PasswordSyncGroup>>;
|
|
21018
|
+
/**
|
|
21019
|
+
* This API updates the specified password sync group. A token with ORG_ADMIN authority is required to call this API.
|
|
21020
|
+
* @summary Update Password Sync Group by ID
|
|
21021
|
+
* @param {string} id The ID of password sync group to update.
|
|
21022
|
+
* @param {PasswordSyncGroup} passwordSyncGroup
|
|
21023
|
+
* @param {*} [axiosOptions] Override http request option.
|
|
21024
|
+
* @throws {RequiredError}
|
|
21025
|
+
*/
|
|
21026
|
+
updatePasswordSyncGroup(id: string, passwordSyncGroup: PasswordSyncGroup, axiosOptions?: any): AxiosPromise<PasswordSyncGroup>;
|
|
21027
|
+
};
|
|
21028
|
+
/**
|
|
21029
|
+
* Request parameters for createPasswordSyncGroup operation in PasswordSyncGroupsApi.
|
|
21030
|
+
* @export
|
|
21031
|
+
* @interface PasswordSyncGroupsApiCreatePasswordSyncGroupRequest
|
|
21032
|
+
*/
|
|
21033
|
+
export interface PasswordSyncGroupsApiCreatePasswordSyncGroupRequest {
|
|
21034
|
+
/**
|
|
21035
|
+
*
|
|
21036
|
+
* @type {PasswordSyncGroup}
|
|
21037
|
+
* @memberof PasswordSyncGroupsApiCreatePasswordSyncGroup
|
|
21038
|
+
*/
|
|
21039
|
+
readonly passwordSyncGroup: PasswordSyncGroup;
|
|
21040
|
+
}
|
|
21041
|
+
/**
|
|
21042
|
+
* Request parameters for deletePasswordSyncGroup operation in PasswordSyncGroupsApi.
|
|
21043
|
+
* @export
|
|
21044
|
+
* @interface PasswordSyncGroupsApiDeletePasswordSyncGroupRequest
|
|
21045
|
+
*/
|
|
21046
|
+
export interface PasswordSyncGroupsApiDeletePasswordSyncGroupRequest {
|
|
21047
|
+
/**
|
|
21048
|
+
* The ID of password sync group to delete.
|
|
21049
|
+
* @type {string}
|
|
21050
|
+
* @memberof PasswordSyncGroupsApiDeletePasswordSyncGroup
|
|
21051
|
+
*/
|
|
21052
|
+
readonly id: string;
|
|
21053
|
+
}
|
|
21054
|
+
/**
|
|
21055
|
+
* Request parameters for getPasswordSyncGroup operation in PasswordSyncGroupsApi.
|
|
21056
|
+
* @export
|
|
21057
|
+
* @interface PasswordSyncGroupsApiGetPasswordSyncGroupRequest
|
|
21058
|
+
*/
|
|
21059
|
+
export interface PasswordSyncGroupsApiGetPasswordSyncGroupRequest {
|
|
21060
|
+
/**
|
|
21061
|
+
* The ID of password sync group to retrieve.
|
|
21062
|
+
* @type {string}
|
|
21063
|
+
* @memberof PasswordSyncGroupsApiGetPasswordSyncGroup
|
|
21064
|
+
*/
|
|
21065
|
+
readonly id: string;
|
|
21066
|
+
}
|
|
21067
|
+
/**
|
|
21068
|
+
* Request parameters for getPasswordSyncGroups operation in PasswordSyncGroupsApi.
|
|
21069
|
+
* @export
|
|
21070
|
+
* @interface PasswordSyncGroupsApiGetPasswordSyncGroupsRequest
|
|
21071
|
+
*/
|
|
21072
|
+
export interface PasswordSyncGroupsApiGetPasswordSyncGroupsRequest {
|
|
21073
|
+
/**
|
|
21074
|
+
* Max number of results to return. See [V3 API Standard Collection Parameters](https://developer.sailpoint.com/idn/api/standard-collection-parameters) for more information.
|
|
21075
|
+
* @type {number}
|
|
21076
|
+
* @memberof PasswordSyncGroupsApiGetPasswordSyncGroups
|
|
21077
|
+
*/
|
|
21078
|
+
readonly limit?: number;
|
|
21079
|
+
/**
|
|
21080
|
+
* 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.
|
|
21081
|
+
* @type {number}
|
|
21082
|
+
* @memberof PasswordSyncGroupsApiGetPasswordSyncGroups
|
|
21083
|
+
*/
|
|
21084
|
+
readonly offset?: number;
|
|
21085
|
+
/**
|
|
21086
|
+
* If *true* it will populate the *X-Total-Count* response header with the number of results that would be returned if *limit* and *offset* were ignored. Since requesting a total count can have a performance impact, it is recommended not to send **count=true** if that value will not be used. See [V3 API Standard Collection Parameters](https://developer.sailpoint.com/idn/api/standard-collection-parameters) for more information.
|
|
21087
|
+
* @type {boolean}
|
|
21088
|
+
* @memberof PasswordSyncGroupsApiGetPasswordSyncGroups
|
|
21089
|
+
*/
|
|
21090
|
+
readonly count?: boolean;
|
|
21091
|
+
}
|
|
21092
|
+
/**
|
|
21093
|
+
* Request parameters for updatePasswordSyncGroup operation in PasswordSyncGroupsApi.
|
|
21094
|
+
* @export
|
|
21095
|
+
* @interface PasswordSyncGroupsApiUpdatePasswordSyncGroupRequest
|
|
21096
|
+
*/
|
|
21097
|
+
export interface PasswordSyncGroupsApiUpdatePasswordSyncGroupRequest {
|
|
21098
|
+
/**
|
|
21099
|
+
* The ID of password sync group to update.
|
|
21100
|
+
* @type {string}
|
|
21101
|
+
* @memberof PasswordSyncGroupsApiUpdatePasswordSyncGroup
|
|
21102
|
+
*/
|
|
21103
|
+
readonly id: string;
|
|
21104
|
+
/**
|
|
21105
|
+
*
|
|
21106
|
+
* @type {PasswordSyncGroup}
|
|
21107
|
+
* @memberof PasswordSyncGroupsApiUpdatePasswordSyncGroup
|
|
21108
|
+
*/
|
|
21109
|
+
readonly passwordSyncGroup: PasswordSyncGroup;
|
|
21110
|
+
}
|
|
21111
|
+
/**
|
|
21112
|
+
* PasswordSyncGroupsApi - object-oriented interface
|
|
21113
|
+
* @export
|
|
21114
|
+
* @class PasswordSyncGroupsApi
|
|
21115
|
+
* @extends {BaseAPI}
|
|
21116
|
+
*/
|
|
21117
|
+
export declare class PasswordSyncGroupsApi extends BaseAPI {
|
|
21118
|
+
/**
|
|
21119
|
+
* This API creates a password sync group based on the specifications provided. A token with ORG_ADMIN authority is required to call this API.
|
|
21120
|
+
* @summary Create Password Sync Group
|
|
21121
|
+
* @param {PasswordSyncGroupsApiCreatePasswordSyncGroupRequest} requestParameters Request parameters.
|
|
21122
|
+
* @param {*} [axiosOptions] Override http request option.
|
|
21123
|
+
* @throws {RequiredError}
|
|
21124
|
+
* @memberof PasswordSyncGroupsApi
|
|
21125
|
+
*/
|
|
21126
|
+
createPasswordSyncGroup(requestParameters: PasswordSyncGroupsApiCreatePasswordSyncGroupRequest, axiosOptions?: AxiosRequestConfig): Promise<import("axios").AxiosResponse<PasswordSyncGroup, any>>;
|
|
21127
|
+
/**
|
|
21128
|
+
* This API deletes the specified password sync group. A token with ORG_ADMIN authority is required to call this API.
|
|
21129
|
+
* @summary Delete Password Sync Group by ID
|
|
21130
|
+
* @param {PasswordSyncGroupsApiDeletePasswordSyncGroupRequest} requestParameters Request parameters.
|
|
21131
|
+
* @param {*} [axiosOptions] Override http request option.
|
|
21132
|
+
* @throws {RequiredError}
|
|
21133
|
+
* @memberof PasswordSyncGroupsApi
|
|
21134
|
+
*/
|
|
21135
|
+
deletePasswordSyncGroup(requestParameters: PasswordSyncGroupsApiDeletePasswordSyncGroupRequest, axiosOptions?: AxiosRequestConfig): Promise<import("axios").AxiosResponse<void, any>>;
|
|
21136
|
+
/**
|
|
21137
|
+
* This API returns the sync group for the specified ID. A token with ORG_ADMIN authority is required to call this API.
|
|
21138
|
+
* @summary Get Password Sync Group by ID
|
|
21139
|
+
* @param {PasswordSyncGroupsApiGetPasswordSyncGroupRequest} requestParameters Request parameters.
|
|
21140
|
+
* @param {*} [axiosOptions] Override http request option.
|
|
21141
|
+
* @throws {RequiredError}
|
|
21142
|
+
* @memberof PasswordSyncGroupsApi
|
|
21143
|
+
*/
|
|
21144
|
+
getPasswordSyncGroup(requestParameters: PasswordSyncGroupsApiGetPasswordSyncGroupRequest, axiosOptions?: AxiosRequestConfig): Promise<import("axios").AxiosResponse<PasswordSyncGroup, any>>;
|
|
21145
|
+
/**
|
|
21146
|
+
* This API returns a list of password sync groups. A token with ORG_ADMIN authority is required to call this API.
|
|
21147
|
+
* @summary Get Password Sync Group List
|
|
21148
|
+
* @param {PasswordSyncGroupsApiGetPasswordSyncGroupsRequest} requestParameters Request parameters.
|
|
21149
|
+
* @param {*} [axiosOptions] Override http request option.
|
|
21150
|
+
* @throws {RequiredError}
|
|
21151
|
+
* @memberof PasswordSyncGroupsApi
|
|
21152
|
+
*/
|
|
21153
|
+
getPasswordSyncGroups(requestParameters?: PasswordSyncGroupsApiGetPasswordSyncGroupsRequest, axiosOptions?: AxiosRequestConfig): Promise<import("axios").AxiosResponse<PasswordSyncGroup[], any>>;
|
|
21154
|
+
/**
|
|
21155
|
+
* This API updates the specified password sync group. A token with ORG_ADMIN authority is required to call this API.
|
|
21156
|
+
* @summary Update Password Sync Group by ID
|
|
21157
|
+
* @param {PasswordSyncGroupsApiUpdatePasswordSyncGroupRequest} requestParameters Request parameters.
|
|
21158
|
+
* @param {*} [axiosOptions] Override http request option.
|
|
21159
|
+
* @throws {RequiredError}
|
|
21160
|
+
* @memberof PasswordSyncGroupsApi
|
|
21161
|
+
*/
|
|
21162
|
+
updatePasswordSyncGroup(requestParameters: PasswordSyncGroupsApiUpdatePasswordSyncGroupRequest, axiosOptions?: AxiosRequestConfig): Promise<import("axios").AxiosResponse<PasswordSyncGroup, any>>;
|
|
21163
|
+
}
|
|
20572
21164
|
/**
|
|
20573
21165
|
* PersonalAccessTokensApi - axios parameter creator
|
|
20574
21166
|
* @export
|
|
@@ -22506,7 +23098,7 @@ export declare class SearchApi extends BaseAPI {
|
|
|
22506
23098
|
export declare const ServiceDeskIntegrationApiAxiosParamCreator: (configuration?: Configuration) => {
|
|
22507
23099
|
/**
|
|
22508
23100
|
* Create a new Service Desk Integrations. A token with Org Admin or Service Desk Admin authority is required to access this endpoint.
|
|
22509
|
-
* @summary Create
|
|
23101
|
+
* @summary Create new Service Desk integration
|
|
22510
23102
|
* @param {ServiceDeskIntegrationDto} serviceDeskIntegrationDto The specifics of a new integration to create
|
|
22511
23103
|
* @param {*} [axiosOptions] Override http request option.
|
|
22512
23104
|
* @throws {RequiredError}
|
|
@@ -22514,7 +23106,7 @@ export declare const ServiceDeskIntegrationApiAxiosParamCreator: (configuration?
|
|
|
22514
23106
|
createServiceDeskIntegration: (serviceDeskIntegrationDto: ServiceDeskIntegrationDto, axiosOptions?: AxiosRequestConfig) => Promise<RequestArgs>;
|
|
22515
23107
|
/**
|
|
22516
23108
|
* Delete an existing Service Desk integration by ID. A token with Org Admin or Service Desk Admin authority is required to access this endpoint.
|
|
22517
|
-
* @summary Delete a Service Desk integration
|
|
23109
|
+
* @summary Delete a Service Desk integration
|
|
22518
23110
|
* @param {string} id ID of Service Desk integration to delete
|
|
22519
23111
|
* @param {*} [axiosOptions] Override http request option.
|
|
22520
23112
|
* @throws {RequiredError}
|
|
@@ -22522,7 +23114,7 @@ export declare const ServiceDeskIntegrationApiAxiosParamCreator: (configuration?
|
|
|
22522
23114
|
deleteServiceDeskIntegration: (id: string, axiosOptions?: AxiosRequestConfig) => Promise<RequestArgs>;
|
|
22523
23115
|
/**
|
|
22524
23116
|
* Get an existing Service Desk integration by ID. A token with Org Admin or Service Desk Admin authority is required to access this endpoint.
|
|
22525
|
-
* @summary Get a Service Desk integration
|
|
23117
|
+
* @summary Get a Service Desk integration
|
|
22526
23118
|
* @param {string} id ID of the Service Desk integration to get
|
|
22527
23119
|
* @param {*} [axiosOptions] Override http request option.
|
|
22528
23120
|
* @throws {RequiredError}
|
|
@@ -22557,14 +23149,14 @@ export declare const ServiceDeskIntegrationApiAxiosParamCreator: (configuration?
|
|
|
22557
23149
|
getServiceDeskIntegrations: (offset?: number, limit?: number, sorters?: string, filters?: string, count?: boolean, axiosOptions?: AxiosRequestConfig) => Promise<RequestArgs>;
|
|
22558
23150
|
/**
|
|
22559
23151
|
* Get the time check configuration of queued SDIM tickets. A token with Org Admin or Service Desk Admin authority is required to access this endpoint.
|
|
22560
|
-
* @summary Get the time check configuration
|
|
23152
|
+
* @summary Get the time check configuration
|
|
22561
23153
|
* @param {*} [axiosOptions] Override http request option.
|
|
22562
23154
|
* @throws {RequiredError}
|
|
22563
23155
|
*/
|
|
22564
23156
|
getStatusCheckDetails: (axiosOptions?: AxiosRequestConfig) => Promise<RequestArgs>;
|
|
22565
23157
|
/**
|
|
22566
23158
|
* Update an existing ServiceDeskIntegration by ID with a PATCH request.
|
|
22567
|
-
* @summary Service Desk Integration Update
|
|
23159
|
+
* @summary Service Desk Integration Update PATCH
|
|
22568
23160
|
* @param {string} id ID of the Service Desk integration to update
|
|
22569
23161
|
* @param {JsonPatch} jsonPatch A list of SDIM update operations according to the [JSON Patch](https://tools.ietf.org/html/rfc6902) standard. PATCH can only be applied to the following fields: * \"beforeProvisioningRule\" A 403 Forbidden Error indicates that you attempted to PATCH a field that is not allowed.
|
|
22570
23162
|
* @param {*} [axiosOptions] Override http request option.
|
|
@@ -22573,7 +23165,7 @@ export declare const ServiceDeskIntegrationApiAxiosParamCreator: (configuration?
|
|
|
22573
23165
|
patchServiceDeskIntegration: (id: string, jsonPatch: JsonPatch, axiosOptions?: AxiosRequestConfig) => Promise<RequestArgs>;
|
|
22574
23166
|
/**
|
|
22575
23167
|
* Update an existing Service Desk integration by ID with updated value in JSON form as the request body. A token with Org Admin or Service Desk Admin authority is required to access this endpoint.
|
|
22576
|
-
* @summary Update a Service Desk integration
|
|
23168
|
+
* @summary Update a Service Desk integration
|
|
22577
23169
|
* @param {string} id ID of the Service Desk integration to update
|
|
22578
23170
|
* @param {ServiceDeskIntegrationDto} serviceDeskIntegrationDto The specifics of the integration to update
|
|
22579
23171
|
* @param {*} [axiosOptions] Override http request option.
|
|
@@ -22582,7 +23174,7 @@ export declare const ServiceDeskIntegrationApiAxiosParamCreator: (configuration?
|
|
|
22582
23174
|
updateServiceDeskIntegration: (id: string, serviceDeskIntegrationDto: ServiceDeskIntegrationDto, axiosOptions?: AxiosRequestConfig) => Promise<RequestArgs>;
|
|
22583
23175
|
/**
|
|
22584
23176
|
* Update the time check configuration of queued SDIM tickets. A token with Org Admin or Service Desk Admin authority is required to access this endpoint.
|
|
22585
|
-
* @summary Update the time check configuration
|
|
23177
|
+
* @summary Update the time check configuration
|
|
22586
23178
|
* @param {QueuedCheckConfigDetails} queuedCheckConfigDetails the modified time check configuration
|
|
22587
23179
|
* @param {*} [axiosOptions] Override http request option.
|
|
22588
23180
|
* @throws {RequiredError}
|
|
@@ -22596,7 +23188,7 @@ export declare const ServiceDeskIntegrationApiAxiosParamCreator: (configuration?
|
|
|
22596
23188
|
export declare const ServiceDeskIntegrationApiFp: (configuration?: Configuration) => {
|
|
22597
23189
|
/**
|
|
22598
23190
|
* Create a new Service Desk Integrations. A token with Org Admin or Service Desk Admin authority is required to access this endpoint.
|
|
22599
|
-
* @summary Create
|
|
23191
|
+
* @summary Create new Service Desk integration
|
|
22600
23192
|
* @param {ServiceDeskIntegrationDto} serviceDeskIntegrationDto The specifics of a new integration to create
|
|
22601
23193
|
* @param {*} [axiosOptions] Override http request option.
|
|
22602
23194
|
* @throws {RequiredError}
|
|
@@ -22604,7 +23196,7 @@ export declare const ServiceDeskIntegrationApiFp: (configuration?: Configuration
|
|
|
22604
23196
|
createServiceDeskIntegration(serviceDeskIntegrationDto: ServiceDeskIntegrationDto, axiosOptions?: AxiosRequestConfig): Promise<(axios?: AxiosInstance, basePath?: string) => AxiosPromise<ServiceDeskIntegrationDto>>;
|
|
22605
23197
|
/**
|
|
22606
23198
|
* Delete an existing Service Desk integration by ID. A token with Org Admin or Service Desk Admin authority is required to access this endpoint.
|
|
22607
|
-
* @summary Delete a Service Desk integration
|
|
23199
|
+
* @summary Delete a Service Desk integration
|
|
22608
23200
|
* @param {string} id ID of Service Desk integration to delete
|
|
22609
23201
|
* @param {*} [axiosOptions] Override http request option.
|
|
22610
23202
|
* @throws {RequiredError}
|
|
@@ -22612,7 +23204,7 @@ export declare const ServiceDeskIntegrationApiFp: (configuration?: Configuration
|
|
|
22612
23204
|
deleteServiceDeskIntegration(id: string, axiosOptions?: AxiosRequestConfig): Promise<(axios?: AxiosInstance, basePath?: string) => AxiosPromise<void>>;
|
|
22613
23205
|
/**
|
|
22614
23206
|
* Get an existing Service Desk integration by ID. A token with Org Admin or Service Desk Admin authority is required to access this endpoint.
|
|
22615
|
-
* @summary Get a Service Desk integration
|
|
23207
|
+
* @summary Get a Service Desk integration
|
|
22616
23208
|
* @param {string} id ID of the Service Desk integration to get
|
|
22617
23209
|
* @param {*} [axiosOptions] Override http request option.
|
|
22618
23210
|
* @throws {RequiredError}
|
|
@@ -22647,14 +23239,14 @@ export declare const ServiceDeskIntegrationApiFp: (configuration?: Configuration
|
|
|
22647
23239
|
getServiceDeskIntegrations(offset?: number, limit?: number, sorters?: string, filters?: string, count?: boolean, axiosOptions?: AxiosRequestConfig): Promise<(axios?: AxiosInstance, basePath?: string) => AxiosPromise<Array<ServiceDeskIntegrationDto>>>;
|
|
22648
23240
|
/**
|
|
22649
23241
|
* Get the time check configuration of queued SDIM tickets. A token with Org Admin or Service Desk Admin authority is required to access this endpoint.
|
|
22650
|
-
* @summary Get the time check configuration
|
|
23242
|
+
* @summary Get the time check configuration
|
|
22651
23243
|
* @param {*} [axiosOptions] Override http request option.
|
|
22652
23244
|
* @throws {RequiredError}
|
|
22653
23245
|
*/
|
|
22654
23246
|
getStatusCheckDetails(axiosOptions?: AxiosRequestConfig): Promise<(axios?: AxiosInstance, basePath?: string) => AxiosPromise<QueuedCheckConfigDetails>>;
|
|
22655
23247
|
/**
|
|
22656
23248
|
* Update an existing ServiceDeskIntegration by ID with a PATCH request.
|
|
22657
|
-
* @summary Service Desk Integration Update
|
|
23249
|
+
* @summary Service Desk Integration Update PATCH
|
|
22658
23250
|
* @param {string} id ID of the Service Desk integration to update
|
|
22659
23251
|
* @param {JsonPatch} jsonPatch A list of SDIM update operations according to the [JSON Patch](https://tools.ietf.org/html/rfc6902) standard. PATCH can only be applied to the following fields: * \"beforeProvisioningRule\" A 403 Forbidden Error indicates that you attempted to PATCH a field that is not allowed.
|
|
22660
23252
|
* @param {*} [axiosOptions] Override http request option.
|
|
@@ -22663,7 +23255,7 @@ export declare const ServiceDeskIntegrationApiFp: (configuration?: Configuration
|
|
|
22663
23255
|
patchServiceDeskIntegration(id: string, jsonPatch: JsonPatch, axiosOptions?: AxiosRequestConfig): Promise<(axios?: AxiosInstance, basePath?: string) => AxiosPromise<ServiceDeskIntegrationDto>>;
|
|
22664
23256
|
/**
|
|
22665
23257
|
* Update an existing Service Desk integration by ID with updated value in JSON form as the request body. A token with Org Admin or Service Desk Admin authority is required to access this endpoint.
|
|
22666
|
-
* @summary Update a Service Desk integration
|
|
23258
|
+
* @summary Update a Service Desk integration
|
|
22667
23259
|
* @param {string} id ID of the Service Desk integration to update
|
|
22668
23260
|
* @param {ServiceDeskIntegrationDto} serviceDeskIntegrationDto The specifics of the integration to update
|
|
22669
23261
|
* @param {*} [axiosOptions] Override http request option.
|
|
@@ -22672,7 +23264,7 @@ export declare const ServiceDeskIntegrationApiFp: (configuration?: Configuration
|
|
|
22672
23264
|
updateServiceDeskIntegration(id: string, serviceDeskIntegrationDto: ServiceDeskIntegrationDto, axiosOptions?: AxiosRequestConfig): Promise<(axios?: AxiosInstance, basePath?: string) => AxiosPromise<ServiceDeskIntegrationDto>>;
|
|
22673
23265
|
/**
|
|
22674
23266
|
* Update the time check configuration of queued SDIM tickets. A token with Org Admin or Service Desk Admin authority is required to access this endpoint.
|
|
22675
|
-
* @summary Update the time check configuration
|
|
23267
|
+
* @summary Update the time check configuration
|
|
22676
23268
|
* @param {QueuedCheckConfigDetails} queuedCheckConfigDetails the modified time check configuration
|
|
22677
23269
|
* @param {*} [axiosOptions] Override http request option.
|
|
22678
23270
|
* @throws {RequiredError}
|
|
@@ -22686,7 +23278,7 @@ export declare const ServiceDeskIntegrationApiFp: (configuration?: Configuration
|
|
|
22686
23278
|
export declare const ServiceDeskIntegrationApiFactory: (configuration?: Configuration, basePath?: string, axios?: AxiosInstance) => {
|
|
22687
23279
|
/**
|
|
22688
23280
|
* Create a new Service Desk Integrations. A token with Org Admin or Service Desk Admin authority is required to access this endpoint.
|
|
22689
|
-
* @summary Create
|
|
23281
|
+
* @summary Create new Service Desk integration
|
|
22690
23282
|
* @param {ServiceDeskIntegrationDto} serviceDeskIntegrationDto The specifics of a new integration to create
|
|
22691
23283
|
* @param {*} [axiosOptions] Override http request option.
|
|
22692
23284
|
* @throws {RequiredError}
|
|
@@ -22694,7 +23286,7 @@ export declare const ServiceDeskIntegrationApiFactory: (configuration?: Configur
|
|
|
22694
23286
|
createServiceDeskIntegration(serviceDeskIntegrationDto: ServiceDeskIntegrationDto, axiosOptions?: any): AxiosPromise<ServiceDeskIntegrationDto>;
|
|
22695
23287
|
/**
|
|
22696
23288
|
* Delete an existing Service Desk integration by ID. A token with Org Admin or Service Desk Admin authority is required to access this endpoint.
|
|
22697
|
-
* @summary Delete a Service Desk integration
|
|
23289
|
+
* @summary Delete a Service Desk integration
|
|
22698
23290
|
* @param {string} id ID of Service Desk integration to delete
|
|
22699
23291
|
* @param {*} [axiosOptions] Override http request option.
|
|
22700
23292
|
* @throws {RequiredError}
|
|
@@ -22702,7 +23294,7 @@ export declare const ServiceDeskIntegrationApiFactory: (configuration?: Configur
|
|
|
22702
23294
|
deleteServiceDeskIntegration(id: string, axiosOptions?: any): AxiosPromise<void>;
|
|
22703
23295
|
/**
|
|
22704
23296
|
* Get an existing Service Desk integration by ID. A token with Org Admin or Service Desk Admin authority is required to access this endpoint.
|
|
22705
|
-
* @summary Get a Service Desk integration
|
|
23297
|
+
* @summary Get a Service Desk integration
|
|
22706
23298
|
* @param {string} id ID of the Service Desk integration to get
|
|
22707
23299
|
* @param {*} [axiosOptions] Override http request option.
|
|
22708
23300
|
* @throws {RequiredError}
|
|
@@ -22737,14 +23329,14 @@ export declare const ServiceDeskIntegrationApiFactory: (configuration?: Configur
|
|
|
22737
23329
|
getServiceDeskIntegrations(offset?: number, limit?: number, sorters?: string, filters?: string, count?: boolean, axiosOptions?: any): AxiosPromise<Array<ServiceDeskIntegrationDto>>;
|
|
22738
23330
|
/**
|
|
22739
23331
|
* Get the time check configuration of queued SDIM tickets. A token with Org Admin or Service Desk Admin authority is required to access this endpoint.
|
|
22740
|
-
* @summary Get the time check configuration
|
|
23332
|
+
* @summary Get the time check configuration
|
|
22741
23333
|
* @param {*} [axiosOptions] Override http request option.
|
|
22742
23334
|
* @throws {RequiredError}
|
|
22743
23335
|
*/
|
|
22744
23336
|
getStatusCheckDetails(axiosOptions?: any): AxiosPromise<QueuedCheckConfigDetails>;
|
|
22745
23337
|
/**
|
|
22746
23338
|
* Update an existing ServiceDeskIntegration by ID with a PATCH request.
|
|
22747
|
-
* @summary Service Desk Integration Update
|
|
23339
|
+
* @summary Service Desk Integration Update PATCH
|
|
22748
23340
|
* @param {string} id ID of the Service Desk integration to update
|
|
22749
23341
|
* @param {JsonPatch} jsonPatch A list of SDIM update operations according to the [JSON Patch](https://tools.ietf.org/html/rfc6902) standard. PATCH can only be applied to the following fields: * \"beforeProvisioningRule\" A 403 Forbidden Error indicates that you attempted to PATCH a field that is not allowed.
|
|
22750
23342
|
* @param {*} [axiosOptions] Override http request option.
|
|
@@ -22753,7 +23345,7 @@ export declare const ServiceDeskIntegrationApiFactory: (configuration?: Configur
|
|
|
22753
23345
|
patchServiceDeskIntegration(id: string, jsonPatch: JsonPatch, axiosOptions?: any): AxiosPromise<ServiceDeskIntegrationDto>;
|
|
22754
23346
|
/**
|
|
22755
23347
|
* Update an existing Service Desk integration by ID with updated value in JSON form as the request body. A token with Org Admin or Service Desk Admin authority is required to access this endpoint.
|
|
22756
|
-
* @summary Update a Service Desk integration
|
|
23348
|
+
* @summary Update a Service Desk integration
|
|
22757
23349
|
* @param {string} id ID of the Service Desk integration to update
|
|
22758
23350
|
* @param {ServiceDeskIntegrationDto} serviceDeskIntegrationDto The specifics of the integration to update
|
|
22759
23351
|
* @param {*} [axiosOptions] Override http request option.
|
|
@@ -22762,7 +23354,7 @@ export declare const ServiceDeskIntegrationApiFactory: (configuration?: Configur
|
|
|
22762
23354
|
updateServiceDeskIntegration(id: string, serviceDeskIntegrationDto: ServiceDeskIntegrationDto, axiosOptions?: any): AxiosPromise<ServiceDeskIntegrationDto>;
|
|
22763
23355
|
/**
|
|
22764
23356
|
* Update the time check configuration of queued SDIM tickets. A token with Org Admin or Service Desk Admin authority is required to access this endpoint.
|
|
22765
|
-
* @summary Update the time check configuration
|
|
23357
|
+
* @summary Update the time check configuration
|
|
22766
23358
|
* @param {QueuedCheckConfigDetails} queuedCheckConfigDetails the modified time check configuration
|
|
22767
23359
|
* @param {*} [axiosOptions] Override http request option.
|
|
22768
23360
|
* @throws {RequiredError}
|
|
@@ -22918,7 +23510,7 @@ export interface ServiceDeskIntegrationApiUpdateStatusCheckDetailsRequest {
|
|
|
22918
23510
|
export declare class ServiceDeskIntegrationApi extends BaseAPI {
|
|
22919
23511
|
/**
|
|
22920
23512
|
* Create a new Service Desk Integrations. A token with Org Admin or Service Desk Admin authority is required to access this endpoint.
|
|
22921
|
-
* @summary Create
|
|
23513
|
+
* @summary Create new Service Desk integration
|
|
22922
23514
|
* @param {ServiceDeskIntegrationApiCreateServiceDeskIntegrationRequest} requestParameters Request parameters.
|
|
22923
23515
|
* @param {*} [axiosOptions] Override http request option.
|
|
22924
23516
|
* @throws {RequiredError}
|
|
@@ -22927,7 +23519,7 @@ export declare class ServiceDeskIntegrationApi extends BaseAPI {
|
|
|
22927
23519
|
createServiceDeskIntegration(requestParameters: ServiceDeskIntegrationApiCreateServiceDeskIntegrationRequest, axiosOptions?: AxiosRequestConfig): Promise<import("axios").AxiosResponse<ServiceDeskIntegrationDto, any>>;
|
|
22928
23520
|
/**
|
|
22929
23521
|
* Delete an existing Service Desk integration by ID. A token with Org Admin or Service Desk Admin authority is required to access this endpoint.
|
|
22930
|
-
* @summary Delete a Service Desk integration
|
|
23522
|
+
* @summary Delete a Service Desk integration
|
|
22931
23523
|
* @param {ServiceDeskIntegrationApiDeleteServiceDeskIntegrationRequest} requestParameters Request parameters.
|
|
22932
23524
|
* @param {*} [axiosOptions] Override http request option.
|
|
22933
23525
|
* @throws {RequiredError}
|
|
@@ -22936,7 +23528,7 @@ export declare class ServiceDeskIntegrationApi extends BaseAPI {
|
|
|
22936
23528
|
deleteServiceDeskIntegration(requestParameters: ServiceDeskIntegrationApiDeleteServiceDeskIntegrationRequest, axiosOptions?: AxiosRequestConfig): Promise<import("axios").AxiosResponse<void, any>>;
|
|
22937
23529
|
/**
|
|
22938
23530
|
* Get an existing Service Desk integration by ID. A token with Org Admin or Service Desk Admin authority is required to access this endpoint.
|
|
22939
|
-
* @summary Get a Service Desk integration
|
|
23531
|
+
* @summary Get a Service Desk integration
|
|
22940
23532
|
* @param {ServiceDeskIntegrationApiGetServiceDeskIntegrationRequest} requestParameters Request parameters.
|
|
22941
23533
|
* @param {*} [axiosOptions] Override http request option.
|
|
22942
23534
|
* @throws {RequiredError}
|
|
@@ -22971,7 +23563,7 @@ export declare class ServiceDeskIntegrationApi extends BaseAPI {
|
|
|
22971
23563
|
getServiceDeskIntegrations(requestParameters?: ServiceDeskIntegrationApiGetServiceDeskIntegrationsRequest, axiosOptions?: AxiosRequestConfig): Promise<import("axios").AxiosResponse<ServiceDeskIntegrationDto[], any>>;
|
|
22972
23564
|
/**
|
|
22973
23565
|
* Get the time check configuration of queued SDIM tickets. A token with Org Admin or Service Desk Admin authority is required to access this endpoint.
|
|
22974
|
-
* @summary Get the time check configuration
|
|
23566
|
+
* @summary Get the time check configuration
|
|
22975
23567
|
* @param {*} [axiosOptions] Override http request option.
|
|
22976
23568
|
* @throws {RequiredError}
|
|
22977
23569
|
* @memberof ServiceDeskIntegrationApi
|
|
@@ -22979,7 +23571,7 @@ export declare class ServiceDeskIntegrationApi extends BaseAPI {
|
|
|
22979
23571
|
getStatusCheckDetails(axiosOptions?: AxiosRequestConfig): Promise<import("axios").AxiosResponse<QueuedCheckConfigDetails, any>>;
|
|
22980
23572
|
/**
|
|
22981
23573
|
* Update an existing ServiceDeskIntegration by ID with a PATCH request.
|
|
22982
|
-
* @summary Service Desk Integration Update
|
|
23574
|
+
* @summary Service Desk Integration Update PATCH
|
|
22983
23575
|
* @param {ServiceDeskIntegrationApiPatchServiceDeskIntegrationRequest} requestParameters Request parameters.
|
|
22984
23576
|
* @param {*} [axiosOptions] Override http request option.
|
|
22985
23577
|
* @throws {RequiredError}
|
|
@@ -22988,7 +23580,7 @@ export declare class ServiceDeskIntegrationApi extends BaseAPI {
|
|
|
22988
23580
|
patchServiceDeskIntegration(requestParameters: ServiceDeskIntegrationApiPatchServiceDeskIntegrationRequest, axiosOptions?: AxiosRequestConfig): Promise<import("axios").AxiosResponse<ServiceDeskIntegrationDto, any>>;
|
|
22989
23581
|
/**
|
|
22990
23582
|
* Update an existing Service Desk integration by ID with updated value in JSON form as the request body. A token with Org Admin or Service Desk Admin authority is required to access this endpoint.
|
|
22991
|
-
* @summary Update a Service Desk integration
|
|
23583
|
+
* @summary Update a Service Desk integration
|
|
22992
23584
|
* @param {ServiceDeskIntegrationApiUpdateServiceDeskIntegrationRequest} requestParameters Request parameters.
|
|
22993
23585
|
* @param {*} [axiosOptions] Override http request option.
|
|
22994
23586
|
* @throws {RequiredError}
|
|
@@ -22997,7 +23589,7 @@ export declare class ServiceDeskIntegrationApi extends BaseAPI {
|
|
|
22997
23589
|
updateServiceDeskIntegration(requestParameters: ServiceDeskIntegrationApiUpdateServiceDeskIntegrationRequest, axiosOptions?: AxiosRequestConfig): Promise<import("axios").AxiosResponse<ServiceDeskIntegrationDto, any>>;
|
|
22998
23590
|
/**
|
|
22999
23591
|
* Update the time check configuration of queued SDIM tickets. A token with Org Admin or Service Desk Admin authority is required to access this endpoint.
|
|
23000
|
-
* @summary Update the time check configuration
|
|
23592
|
+
* @summary Update the time check configuration
|
|
23001
23593
|
* @param {ServiceDeskIntegrationApiUpdateStatusCheckDetailsRequest} requestParameters Request parameters.
|
|
23002
23594
|
* @param {*} [axiosOptions] Override http request option.
|
|
23003
23595
|
* @throws {RequiredError}
|
|
@@ -23023,7 +23615,7 @@ export declare const SourcesApiAxiosParamCreator: (configuration?: Configuration
|
|
|
23023
23615
|
* This creates a specific source with a full source JSON representation. Any passwords are submitted as plain-text and encrypted upon receipt in IdentityNow. A token with ORG_ADMIN, SOURCE_ADMIN, or SOURCE_SUBADMIN authority is required to call this API.
|
|
23024
23616
|
* @summary Creates a source in IdentityNow.
|
|
23025
23617
|
* @param {Source} source
|
|
23026
|
-
* @param {boolean} [provisionAsCsv]
|
|
23618
|
+
* @param {boolean} [provisionAsCsv] If this parameter is `true`, it configures the source as a Delimited File (CSV) source. Setting this to `true` will automatically set the `type` of the source to `DelimitedFile`. You must use this query parameter to create a Delimited File source as you would in the UI. If you don\'t set this query parameter and you attempt to set the `type` attribute directly, the request won\'t correctly generate the source.
|
|
23027
23619
|
* @param {*} [axiosOptions] Override http request option.
|
|
23028
23620
|
* @throws {RequiredError}
|
|
23029
23621
|
*/
|
|
@@ -23202,7 +23794,7 @@ export declare const SourcesApiAxiosParamCreator: (configuration?: Configuration
|
|
|
23202
23794
|
*/
|
|
23203
23795
|
updateSource: (id: string, jsonPatchOperation: Array<JsonPatchOperation>, axiosOptions?: AxiosRequestConfig) => Promise<RequestArgs>;
|
|
23204
23796
|
/**
|
|
23205
|
-
* Use this API to selectively update an existing Schema using a JSONPatch payload. The following schema fields are immutable and cannot be updated: - id - name - created - modified To switch an account attribute to a group entitlement, you need to have the following in place: - `isEntitlement: true` - Must define a schema for the group and [add it to the source](https://developer.sailpoint.com/idn/api/v3/create-schema) before updating the `isGroup` flag. For example, here is the `group` account attribute referencing a schema that defines the group: ```json { \"name\": \"groups\", \"type\": \"STRING\", \"schema\": { \"type\": \"CONNECTOR_SCHEMA\", \"id\": \"2c9180887671ff8c01767b4671fc7d60\", \"name\": \"group\" }, \"description\": \"The groups, roles etc. that reference account group objects\", \"isMulti\": true, \"isEntitlement\": true, \"isGroup\": true } ```
|
|
23797
|
+
* Use this API to selectively update an existing Schema using a JSONPatch payload. The following schema fields are immutable and cannot be updated: - id - name - created - modified To switch an account attribute to a group entitlement, you need to have the following in place: - `isEntitlement: true` - Must define a schema for the group and [add it to the source](https://developer.sailpoint.com/idn/api/v3/create-source-schema) before updating the `isGroup` flag. For example, here is the `group` account attribute referencing a schema that defines the group: ```json { \"name\": \"groups\", \"type\": \"STRING\", \"schema\": { \"type\": \"CONNECTOR_SCHEMA\", \"id\": \"2c9180887671ff8c01767b4671fc7d60\", \"name\": \"group\" }, \"description\": \"The groups, roles etc. that reference account group objects\", \"isMulti\": true, \"isEntitlement\": true, \"isGroup\": true } ```
|
|
23206
23798
|
* @summary Update Source Schema (Partial)
|
|
23207
23799
|
* @param {string} sourceId The Source id.
|
|
23208
23800
|
* @param {string} schemaId The Schema id.
|
|
@@ -23212,7 +23804,7 @@ export declare const SourcesApiAxiosParamCreator: (configuration?: Configuration
|
|
|
23212
23804
|
*/
|
|
23213
23805
|
updateSourceSchema: (sourceId: string, schemaId: string, jsonPatchOperation: Array<JsonPatchOperation>, axiosOptions?: AxiosRequestConfig) => Promise<RequestArgs>;
|
|
23214
23806
|
/**
|
|
23215
|
-
* This API uploads a source schema template file to configure a source\'s account attributes. To retrieve the file to modify and upload, log into Identity Now. Click **Admin** -> **Connections** -> **Sources** ->
|
|
23807
|
+
* This API uploads a source schema template file to configure a source\'s account attributes. To retrieve the file to modify and upload, log into Identity Now. Click **Admin** -> **Connections** -> **Sources** -> **`{SourceName}`** -> **Import Data** -> **Account Schema** -> **Options** -> **Download Schema** >**NOTE: This API is designated only for Delimited File sources.**
|
|
23216
23808
|
* @summary Uploads source accounts schema template
|
|
23217
23809
|
* @param {string} id The Source id
|
|
23218
23810
|
* @param {any} [file]
|
|
@@ -23230,7 +23822,7 @@ export declare const SourcesApiAxiosParamCreator: (configuration?: Configuration
|
|
|
23230
23822
|
*/
|
|
23231
23823
|
uploadSourceConnectorFile: (sourceId: string, file?: any, axiosOptions?: AxiosRequestConfig) => Promise<RequestArgs>;
|
|
23232
23824
|
/**
|
|
23233
|
-
* This API uploads a source schema template file to configure a source\'s entitlement attributes. To retrieve the file to modify and upload, log into Identity Now. Click **Admin** -> **Connections** -> **Sources** ->
|
|
23825
|
+
* This API uploads a source schema template file to configure a source\'s entitlement attributes. To retrieve the file to modify and upload, log into Identity Now. Click **Admin** -> **Connections** -> **Sources** -> **`{SourceName}`** -> **Import Data** -> **Import Entitlements** -> **Download** >**NOTE: This API is designated only for Delimited File sources.**
|
|
23234
23826
|
* @summary Uploads source entitlements schema template
|
|
23235
23827
|
* @param {string} id The Source id
|
|
23236
23828
|
* @param {string} [schemaName] Name of entitlement schema
|
|
@@ -23258,7 +23850,7 @@ export declare const SourcesApiFp: (configuration?: Configuration) => {
|
|
|
23258
23850
|
* This creates a specific source with a full source JSON representation. Any passwords are submitted as plain-text and encrypted upon receipt in IdentityNow. A token with ORG_ADMIN, SOURCE_ADMIN, or SOURCE_SUBADMIN authority is required to call this API.
|
|
23259
23851
|
* @summary Creates a source in IdentityNow.
|
|
23260
23852
|
* @param {Source} source
|
|
23261
|
-
* @param {boolean} [provisionAsCsv]
|
|
23853
|
+
* @param {boolean} [provisionAsCsv] If this parameter is `true`, it configures the source as a Delimited File (CSV) source. Setting this to `true` will automatically set the `type` of the source to `DelimitedFile`. You must use this query parameter to create a Delimited File source as you would in the UI. If you don\'t set this query parameter and you attempt to set the `type` attribute directly, the request won\'t correctly generate the source.
|
|
23262
23854
|
* @param {*} [axiosOptions] Override http request option.
|
|
23263
23855
|
* @throws {RequiredError}
|
|
23264
23856
|
*/
|
|
@@ -23437,7 +24029,7 @@ export declare const SourcesApiFp: (configuration?: Configuration) => {
|
|
|
23437
24029
|
*/
|
|
23438
24030
|
updateSource(id: string, jsonPatchOperation: Array<JsonPatchOperation>, axiosOptions?: AxiosRequestConfig): Promise<(axios?: AxiosInstance, basePath?: string) => AxiosPromise<Source>>;
|
|
23439
24031
|
/**
|
|
23440
|
-
* Use this API to selectively update an existing Schema using a JSONPatch payload. The following schema fields are immutable and cannot be updated: - id - name - created - modified To switch an account attribute to a group entitlement, you need to have the following in place: - `isEntitlement: true` - Must define a schema for the group and [add it to the source](https://developer.sailpoint.com/idn/api/v3/create-schema) before updating the `isGroup` flag. For example, here is the `group` account attribute referencing a schema that defines the group: ```json { \"name\": \"groups\", \"type\": \"STRING\", \"schema\": { \"type\": \"CONNECTOR_SCHEMA\", \"id\": \"2c9180887671ff8c01767b4671fc7d60\", \"name\": \"group\" }, \"description\": \"The groups, roles etc. that reference account group objects\", \"isMulti\": true, \"isEntitlement\": true, \"isGroup\": true } ```
|
|
24032
|
+
* Use this API to selectively update an existing Schema using a JSONPatch payload. The following schema fields are immutable and cannot be updated: - id - name - created - modified To switch an account attribute to a group entitlement, you need to have the following in place: - `isEntitlement: true` - Must define a schema for the group and [add it to the source](https://developer.sailpoint.com/idn/api/v3/create-source-schema) before updating the `isGroup` flag. For example, here is the `group` account attribute referencing a schema that defines the group: ```json { \"name\": \"groups\", \"type\": \"STRING\", \"schema\": { \"type\": \"CONNECTOR_SCHEMA\", \"id\": \"2c9180887671ff8c01767b4671fc7d60\", \"name\": \"group\" }, \"description\": \"The groups, roles etc. that reference account group objects\", \"isMulti\": true, \"isEntitlement\": true, \"isGroup\": true } ```
|
|
23441
24033
|
* @summary Update Source Schema (Partial)
|
|
23442
24034
|
* @param {string} sourceId The Source id.
|
|
23443
24035
|
* @param {string} schemaId The Schema id.
|
|
@@ -23447,7 +24039,7 @@ export declare const SourcesApiFp: (configuration?: Configuration) => {
|
|
|
23447
24039
|
*/
|
|
23448
24040
|
updateSourceSchema(sourceId: string, schemaId: string, jsonPatchOperation: Array<JsonPatchOperation>, axiosOptions?: AxiosRequestConfig): Promise<(axios?: AxiosInstance, basePath?: string) => AxiosPromise<Schema>>;
|
|
23449
24041
|
/**
|
|
23450
|
-
* This API uploads a source schema template file to configure a source\'s account attributes. To retrieve the file to modify and upload, log into Identity Now. Click **Admin** -> **Connections** -> **Sources** ->
|
|
24042
|
+
* This API uploads a source schema template file to configure a source\'s account attributes. To retrieve the file to modify and upload, log into Identity Now. Click **Admin** -> **Connections** -> **Sources** -> **`{SourceName}`** -> **Import Data** -> **Account Schema** -> **Options** -> **Download Schema** >**NOTE: This API is designated only for Delimited File sources.**
|
|
23451
24043
|
* @summary Uploads source accounts schema template
|
|
23452
24044
|
* @param {string} id The Source id
|
|
23453
24045
|
* @param {any} [file]
|
|
@@ -23465,7 +24057,7 @@ export declare const SourcesApiFp: (configuration?: Configuration) => {
|
|
|
23465
24057
|
*/
|
|
23466
24058
|
uploadSourceConnectorFile(sourceId: string, file?: any, axiosOptions?: AxiosRequestConfig): Promise<(axios?: AxiosInstance, basePath?: string) => AxiosPromise<Source>>;
|
|
23467
24059
|
/**
|
|
23468
|
-
* This API uploads a source schema template file to configure a source\'s entitlement attributes. To retrieve the file to modify and upload, log into Identity Now. Click **Admin** -> **Connections** -> **Sources** ->
|
|
24060
|
+
* This API uploads a source schema template file to configure a source\'s entitlement attributes. To retrieve the file to modify and upload, log into Identity Now. Click **Admin** -> **Connections** -> **Sources** -> **`{SourceName}`** -> **Import Data** -> **Import Entitlements** -> **Download** >**NOTE: This API is designated only for Delimited File sources.**
|
|
23469
24061
|
* @summary Uploads source entitlements schema template
|
|
23470
24062
|
* @param {string} id The Source id
|
|
23471
24063
|
* @param {string} [schemaName] Name of entitlement schema
|
|
@@ -23493,7 +24085,7 @@ export declare const SourcesApiFactory: (configuration?: Configuration, basePath
|
|
|
23493
24085
|
* This creates a specific source with a full source JSON representation. Any passwords are submitted as plain-text and encrypted upon receipt in IdentityNow. A token with ORG_ADMIN, SOURCE_ADMIN, or SOURCE_SUBADMIN authority is required to call this API.
|
|
23494
24086
|
* @summary Creates a source in IdentityNow.
|
|
23495
24087
|
* @param {Source} source
|
|
23496
|
-
* @param {boolean} [provisionAsCsv]
|
|
24088
|
+
* @param {boolean} [provisionAsCsv] If this parameter is `true`, it configures the source as a Delimited File (CSV) source. Setting this to `true` will automatically set the `type` of the source to `DelimitedFile`. You must use this query parameter to create a Delimited File source as you would in the UI. If you don\'t set this query parameter and you attempt to set the `type` attribute directly, the request won\'t correctly generate the source.
|
|
23497
24089
|
* @param {*} [axiosOptions] Override http request option.
|
|
23498
24090
|
* @throws {RequiredError}
|
|
23499
24091
|
*/
|
|
@@ -23672,7 +24264,7 @@ export declare const SourcesApiFactory: (configuration?: Configuration, basePath
|
|
|
23672
24264
|
*/
|
|
23673
24265
|
updateSource(id: string, jsonPatchOperation: Array<JsonPatchOperation>, axiosOptions?: any): AxiosPromise<Source>;
|
|
23674
24266
|
/**
|
|
23675
|
-
* Use this API to selectively update an existing Schema using a JSONPatch payload. The following schema fields are immutable and cannot be updated: - id - name - created - modified To switch an account attribute to a group entitlement, you need to have the following in place: - `isEntitlement: true` - Must define a schema for the group and [add it to the source](https://developer.sailpoint.com/idn/api/v3/create-schema) before updating the `isGroup` flag. For example, here is the `group` account attribute referencing a schema that defines the group: ```json { \"name\": \"groups\", \"type\": \"STRING\", \"schema\": { \"type\": \"CONNECTOR_SCHEMA\", \"id\": \"2c9180887671ff8c01767b4671fc7d60\", \"name\": \"group\" }, \"description\": \"The groups, roles etc. that reference account group objects\", \"isMulti\": true, \"isEntitlement\": true, \"isGroup\": true } ```
|
|
24267
|
+
* Use this API to selectively update an existing Schema using a JSONPatch payload. The following schema fields are immutable and cannot be updated: - id - name - created - modified To switch an account attribute to a group entitlement, you need to have the following in place: - `isEntitlement: true` - Must define a schema for the group and [add it to the source](https://developer.sailpoint.com/idn/api/v3/create-source-schema) before updating the `isGroup` flag. For example, here is the `group` account attribute referencing a schema that defines the group: ```json { \"name\": \"groups\", \"type\": \"STRING\", \"schema\": { \"type\": \"CONNECTOR_SCHEMA\", \"id\": \"2c9180887671ff8c01767b4671fc7d60\", \"name\": \"group\" }, \"description\": \"The groups, roles etc. that reference account group objects\", \"isMulti\": true, \"isEntitlement\": true, \"isGroup\": true } ```
|
|
23676
24268
|
* @summary Update Source Schema (Partial)
|
|
23677
24269
|
* @param {string} sourceId The Source id.
|
|
23678
24270
|
* @param {string} schemaId The Schema id.
|
|
@@ -23682,7 +24274,7 @@ export declare const SourcesApiFactory: (configuration?: Configuration, basePath
|
|
|
23682
24274
|
*/
|
|
23683
24275
|
updateSourceSchema(sourceId: string, schemaId: string, jsonPatchOperation: Array<JsonPatchOperation>, axiosOptions?: any): AxiosPromise<Schema>;
|
|
23684
24276
|
/**
|
|
23685
|
-
* This API uploads a source schema template file to configure a source\'s account attributes. To retrieve the file to modify and upload, log into Identity Now. Click **Admin** -> **Connections** -> **Sources** ->
|
|
24277
|
+
* This API uploads a source schema template file to configure a source\'s account attributes. To retrieve the file to modify and upload, log into Identity Now. Click **Admin** -> **Connections** -> **Sources** -> **`{SourceName}`** -> **Import Data** -> **Account Schema** -> **Options** -> **Download Schema** >**NOTE: This API is designated only for Delimited File sources.**
|
|
23686
24278
|
* @summary Uploads source accounts schema template
|
|
23687
24279
|
* @param {string} id The Source id
|
|
23688
24280
|
* @param {any} [file]
|
|
@@ -23700,7 +24292,7 @@ export declare const SourcesApiFactory: (configuration?: Configuration, basePath
|
|
|
23700
24292
|
*/
|
|
23701
24293
|
uploadSourceConnectorFile(sourceId: string, file?: any, axiosOptions?: any): AxiosPromise<Source>;
|
|
23702
24294
|
/**
|
|
23703
|
-
* This API uploads a source schema template file to configure a source\'s entitlement attributes. To retrieve the file to modify and upload, log into Identity Now. Click **Admin** -> **Connections** -> **Sources** ->
|
|
24295
|
+
* This API uploads a source schema template file to configure a source\'s entitlement attributes. To retrieve the file to modify and upload, log into Identity Now. Click **Admin** -> **Connections** -> **Sources** -> **`{SourceName}`** -> **Import Data** -> **Import Entitlements** -> **Download** >**NOTE: This API is designated only for Delimited File sources.**
|
|
23704
24296
|
* @summary Uploads source entitlements schema template
|
|
23705
24297
|
* @param {string} id The Source id
|
|
23706
24298
|
* @param {string} [schemaName] Name of entitlement schema
|
|
@@ -23742,7 +24334,7 @@ export interface SourcesApiCreateSourceRequest {
|
|
|
23742
24334
|
*/
|
|
23743
24335
|
readonly source: Source;
|
|
23744
24336
|
/**
|
|
23745
|
-
*
|
|
24337
|
+
* If this parameter is `true`, it configures the source as a Delimited File (CSV) source. Setting this to `true` will automatically set the `type` of the source to `DelimitedFile`. You must use this query parameter to create a Delimited File source as you would in the UI. If you don\'t set this query parameter and you attempt to set the `type` attribute directly, the request won\'t correctly generate the source.
|
|
23746
24338
|
* @type {boolean}
|
|
23747
24339
|
* @memberof SourcesApiCreateSource
|
|
23748
24340
|
*/
|
|
@@ -24406,7 +24998,7 @@ export declare class SourcesApi extends BaseAPI {
|
|
|
24406
24998
|
*/
|
|
24407
24999
|
updateSource(requestParameters: SourcesApiUpdateSourceRequest, axiosOptions?: AxiosRequestConfig): Promise<import("axios").AxiosResponse<Source, any>>;
|
|
24408
25000
|
/**
|
|
24409
|
-
* Use this API to selectively update an existing Schema using a JSONPatch payload. The following schema fields are immutable and cannot be updated: - id - name - created - modified To switch an account attribute to a group entitlement, you need to have the following in place: - `isEntitlement: true` - Must define a schema for the group and [add it to the source](https://developer.sailpoint.com/idn/api/v3/create-schema) before updating the `isGroup` flag. For example, here is the `group` account attribute referencing a schema that defines the group: ```json { \"name\": \"groups\", \"type\": \"STRING\", \"schema\": { \"type\": \"CONNECTOR_SCHEMA\", \"id\": \"2c9180887671ff8c01767b4671fc7d60\", \"name\": \"group\" }, \"description\": \"The groups, roles etc. that reference account group objects\", \"isMulti\": true, \"isEntitlement\": true, \"isGroup\": true } ```
|
|
25001
|
+
* Use this API to selectively update an existing Schema using a JSONPatch payload. The following schema fields are immutable and cannot be updated: - id - name - created - modified To switch an account attribute to a group entitlement, you need to have the following in place: - `isEntitlement: true` - Must define a schema for the group and [add it to the source](https://developer.sailpoint.com/idn/api/v3/create-source-schema) before updating the `isGroup` flag. For example, here is the `group` account attribute referencing a schema that defines the group: ```json { \"name\": \"groups\", \"type\": \"STRING\", \"schema\": { \"type\": \"CONNECTOR_SCHEMA\", \"id\": \"2c9180887671ff8c01767b4671fc7d60\", \"name\": \"group\" }, \"description\": \"The groups, roles etc. that reference account group objects\", \"isMulti\": true, \"isEntitlement\": true, \"isGroup\": true } ```
|
|
24410
25002
|
* @summary Update Source Schema (Partial)
|
|
24411
25003
|
* @param {SourcesApiUpdateSourceSchemaRequest} requestParameters Request parameters.
|
|
24412
25004
|
* @param {*} [axiosOptions] Override http request option.
|
|
@@ -24415,7 +25007,7 @@ export declare class SourcesApi extends BaseAPI {
|
|
|
24415
25007
|
*/
|
|
24416
25008
|
updateSourceSchema(requestParameters: SourcesApiUpdateSourceSchemaRequest, axiosOptions?: AxiosRequestConfig): Promise<import("axios").AxiosResponse<Schema, any>>;
|
|
24417
25009
|
/**
|
|
24418
|
-
* This API uploads a source schema template file to configure a source\'s account attributes. To retrieve the file to modify and upload, log into Identity Now. Click **Admin** -> **Connections** -> **Sources** ->
|
|
25010
|
+
* This API uploads a source schema template file to configure a source\'s account attributes. To retrieve the file to modify and upload, log into Identity Now. Click **Admin** -> **Connections** -> **Sources** -> **`{SourceName}`** -> **Import Data** -> **Account Schema** -> **Options** -> **Download Schema** >**NOTE: This API is designated only for Delimited File sources.**
|
|
24419
25011
|
* @summary Uploads source accounts schema template
|
|
24420
25012
|
* @param {SourcesApiUploadSourceAccountsSchemaRequest} requestParameters Request parameters.
|
|
24421
25013
|
* @param {*} [axiosOptions] Override http request option.
|
|
@@ -24433,7 +25025,7 @@ export declare class SourcesApi extends BaseAPI {
|
|
|
24433
25025
|
*/
|
|
24434
25026
|
uploadSourceConnectorFile(requestParameters: SourcesApiUploadSourceConnectorFileRequest, axiosOptions?: AxiosRequestConfig): Promise<import("axios").AxiosResponse<Source, any>>;
|
|
24435
25027
|
/**
|
|
24436
|
-
* This API uploads a source schema template file to configure a source\'s entitlement attributes. To retrieve the file to modify and upload, log into Identity Now. Click **Admin** -> **Connections** -> **Sources** ->
|
|
25028
|
+
* This API uploads a source schema template file to configure a source\'s entitlement attributes. To retrieve the file to modify and upload, log into Identity Now. Click **Admin** -> **Connections** -> **Sources** -> **`{SourceName}`** -> **Import Data** -> **Import Entitlements** -> **Download** >**NOTE: This API is designated only for Delimited File sources.**
|
|
24437
25029
|
* @summary Uploads source entitlements schema template
|
|
24438
25030
|
* @param {SourcesApiUploadSourceEntitlementsSchemaRequest} requestParameters Request parameters.
|
|
24439
25031
|
* @param {*} [axiosOptions] Override http request option.
|