sailpoint-api-client 1.0.3 → 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/README.md +2 -2
- package/beta/api.ts +408 -288
- package/beta/common.ts +2 -2
- package/beta/package.json +1 -1
- package/cc/README.md +2 -2
- package/cc/api.ts +1096 -9
- package/cc/common.ts +2 -2
- package/cc/package.json +1 -1
- package/dist/beta/api.d.ts +361 -278
- package/dist/beta/api.js +284 -184
- package/dist/beta/api.js.map +1 -1
- package/dist/beta/common.js +2 -2
- package/dist/cc/api.d.ts +1055 -11
- package/dist/cc/api.js +95 -0
- package/dist/cc/api.js.map +1 -1
- package/dist/cc/common.js +2 -2
- package/dist/v2/common.js +2 -2
- package/dist/v3/api.d.ts +90 -78
- package/dist/v3/api.js +43 -43
- package/dist/v3/api.js.map +1 -1
- package/dist/v3/common.js +2 -2
- package/package.json +1 -1
- package/v2/README.md +2 -2
- package/v2/common.ts +2 -2
- package/v2/package.json +1 -1
- package/v3/README.md +2 -2
- package/v3/api.ts +90 -78
- package/v3/common.ts +2 -2
- package/v3/package.json +1 -1
package/v3/api.ts
CHANGED
|
@@ -1017,29 +1017,35 @@ export interface Account {
|
|
|
1017
1017
|
*/
|
|
1018
1018
|
'modified'?: string;
|
|
1019
1019
|
/**
|
|
1020
|
-
*
|
|
1020
|
+
* The unique ID of the source this account belongs to
|
|
1021
1021
|
* @type {string}
|
|
1022
1022
|
* @memberof Account
|
|
1023
1023
|
*/
|
|
1024
|
-
'sourceId'
|
|
1024
|
+
'sourceId': string;
|
|
1025
1025
|
/**
|
|
1026
|
-
*
|
|
1026
|
+
* The display name of the source this account belongs to
|
|
1027
|
+
* @type {string}
|
|
1028
|
+
* @memberof Account
|
|
1029
|
+
*/
|
|
1030
|
+
'sourceName': string;
|
|
1031
|
+
/**
|
|
1032
|
+
* The unique ID of the identity this account is correlated to
|
|
1027
1033
|
* @type {string}
|
|
1028
1034
|
* @memberof Account
|
|
1029
1035
|
*/
|
|
1030
1036
|
'identityId'?: string;
|
|
1031
1037
|
/**
|
|
1032
|
-
*
|
|
1038
|
+
* The account attributes that are aggregated
|
|
1033
1039
|
* @type {{ [key: string]: any; }}
|
|
1034
1040
|
* @memberof Account
|
|
1035
1041
|
*/
|
|
1036
|
-
'attributes'
|
|
1042
|
+
'attributes': { [key: string]: any; };
|
|
1037
1043
|
/**
|
|
1038
1044
|
* Indicates if this account is from an authoritative source
|
|
1039
1045
|
* @type {boolean}
|
|
1040
1046
|
* @memberof Account
|
|
1041
1047
|
*/
|
|
1042
|
-
'authoritative'
|
|
1048
|
+
'authoritative': boolean;
|
|
1043
1049
|
/**
|
|
1044
1050
|
* A description of the account
|
|
1045
1051
|
* @type {string}
|
|
@@ -1051,49 +1057,49 @@ export interface Account {
|
|
|
1051
1057
|
* @type {boolean}
|
|
1052
1058
|
* @memberof Account
|
|
1053
1059
|
*/
|
|
1054
|
-
'disabled'
|
|
1060
|
+
'disabled': boolean;
|
|
1055
1061
|
/**
|
|
1056
1062
|
* Indicates if the account is currently locked
|
|
1057
1063
|
* @type {boolean}
|
|
1058
1064
|
* @memberof Account
|
|
1059
1065
|
*/
|
|
1060
|
-
'locked'
|
|
1066
|
+
'locked': boolean;
|
|
1061
1067
|
/**
|
|
1062
|
-
*
|
|
1068
|
+
* The unique ID of the account generated by the source system
|
|
1063
1069
|
* @type {string}
|
|
1064
1070
|
* @memberof Account
|
|
1065
1071
|
*/
|
|
1066
|
-
'nativeIdentity'
|
|
1072
|
+
'nativeIdentity': string;
|
|
1067
1073
|
/**
|
|
1068
|
-
*
|
|
1074
|
+
* If true, this is a user account within IdentityNow. If false, this is an account from a source system.
|
|
1069
1075
|
* @type {boolean}
|
|
1070
1076
|
* @memberof Account
|
|
1071
1077
|
*/
|
|
1072
|
-
'systemAccount'
|
|
1078
|
+
'systemAccount': boolean;
|
|
1073
1079
|
/**
|
|
1074
1080
|
* Indicates if this account is not correlated to an identity
|
|
1075
1081
|
* @type {boolean}
|
|
1076
1082
|
* @memberof Account
|
|
1077
1083
|
*/
|
|
1078
|
-
'uncorrelated'
|
|
1084
|
+
'uncorrelated': boolean;
|
|
1079
1085
|
/**
|
|
1080
1086
|
* The unique ID of the account as determined by the account schema
|
|
1081
1087
|
* @type {string}
|
|
1082
1088
|
* @memberof Account
|
|
1083
1089
|
*/
|
|
1084
|
-
'uuid'?: string;
|
|
1090
|
+
'uuid'?: string | null;
|
|
1085
1091
|
/**
|
|
1086
1092
|
* Indicates if the account has been manually correlated to an identity
|
|
1087
1093
|
* @type {boolean}
|
|
1088
1094
|
* @memberof Account
|
|
1089
1095
|
*/
|
|
1090
|
-
'manuallyCorrelated'
|
|
1096
|
+
'manuallyCorrelated': boolean;
|
|
1091
1097
|
/**
|
|
1092
1098
|
* Indicates if the account has entitlements
|
|
1093
1099
|
* @type {boolean}
|
|
1094
1100
|
* @memberof Account
|
|
1095
1101
|
*/
|
|
1096
|
-
'hasEntitlements'
|
|
1102
|
+
'hasEntitlements': boolean;
|
|
1097
1103
|
}
|
|
1098
1104
|
/**
|
|
1099
1105
|
* Object for specifying Actions to be performed on a specified list of sources\' account.
|
|
@@ -1689,29 +1695,35 @@ export interface AccountActivitySearchedItemAllOf {
|
|
|
1689
1695
|
*/
|
|
1690
1696
|
export interface AccountAllOf {
|
|
1691
1697
|
/**
|
|
1692
|
-
*
|
|
1698
|
+
* The unique ID of the source this account belongs to
|
|
1693
1699
|
* @type {string}
|
|
1694
1700
|
* @memberof AccountAllOf
|
|
1695
1701
|
*/
|
|
1696
|
-
'sourceId'
|
|
1702
|
+
'sourceId': string;
|
|
1697
1703
|
/**
|
|
1698
|
-
*
|
|
1704
|
+
* The display name of the source this account belongs to
|
|
1705
|
+
* @type {string}
|
|
1706
|
+
* @memberof AccountAllOf
|
|
1707
|
+
*/
|
|
1708
|
+
'sourceName': string;
|
|
1709
|
+
/**
|
|
1710
|
+
* The unique ID of the identity this account is correlated to
|
|
1699
1711
|
* @type {string}
|
|
1700
1712
|
* @memberof AccountAllOf
|
|
1701
1713
|
*/
|
|
1702
1714
|
'identityId'?: string;
|
|
1703
1715
|
/**
|
|
1704
|
-
*
|
|
1716
|
+
* The account attributes that are aggregated
|
|
1705
1717
|
* @type {{ [key: string]: any; }}
|
|
1706
1718
|
* @memberof AccountAllOf
|
|
1707
1719
|
*/
|
|
1708
|
-
'attributes'
|
|
1720
|
+
'attributes': { [key: string]: any; };
|
|
1709
1721
|
/**
|
|
1710
1722
|
* Indicates if this account is from an authoritative source
|
|
1711
1723
|
* @type {boolean}
|
|
1712
1724
|
* @memberof AccountAllOf
|
|
1713
1725
|
*/
|
|
1714
|
-
'authoritative'
|
|
1726
|
+
'authoritative': boolean;
|
|
1715
1727
|
/**
|
|
1716
1728
|
* A description of the account
|
|
1717
1729
|
* @type {string}
|
|
@@ -1723,49 +1735,49 @@ export interface AccountAllOf {
|
|
|
1723
1735
|
* @type {boolean}
|
|
1724
1736
|
* @memberof AccountAllOf
|
|
1725
1737
|
*/
|
|
1726
|
-
'disabled'
|
|
1738
|
+
'disabled': boolean;
|
|
1727
1739
|
/**
|
|
1728
1740
|
* Indicates if the account is currently locked
|
|
1729
1741
|
* @type {boolean}
|
|
1730
1742
|
* @memberof AccountAllOf
|
|
1731
1743
|
*/
|
|
1732
|
-
'locked'
|
|
1744
|
+
'locked': boolean;
|
|
1733
1745
|
/**
|
|
1734
|
-
*
|
|
1746
|
+
* The unique ID of the account generated by the source system
|
|
1735
1747
|
* @type {string}
|
|
1736
1748
|
* @memberof AccountAllOf
|
|
1737
1749
|
*/
|
|
1738
|
-
'nativeIdentity'
|
|
1750
|
+
'nativeIdentity': string;
|
|
1739
1751
|
/**
|
|
1740
|
-
*
|
|
1752
|
+
* If true, this is a user account within IdentityNow. If false, this is an account from a source system.
|
|
1741
1753
|
* @type {boolean}
|
|
1742
1754
|
* @memberof AccountAllOf
|
|
1743
1755
|
*/
|
|
1744
|
-
'systemAccount'
|
|
1756
|
+
'systemAccount': boolean;
|
|
1745
1757
|
/**
|
|
1746
1758
|
* Indicates if this account is not correlated to an identity
|
|
1747
1759
|
* @type {boolean}
|
|
1748
1760
|
* @memberof AccountAllOf
|
|
1749
1761
|
*/
|
|
1750
|
-
'uncorrelated'
|
|
1762
|
+
'uncorrelated': boolean;
|
|
1751
1763
|
/**
|
|
1752
1764
|
* The unique ID of the account as determined by the account schema
|
|
1753
1765
|
* @type {string}
|
|
1754
1766
|
* @memberof AccountAllOf
|
|
1755
1767
|
*/
|
|
1756
|
-
'uuid'?: string;
|
|
1768
|
+
'uuid'?: string | null;
|
|
1757
1769
|
/**
|
|
1758
1770
|
* Indicates if the account has been manually correlated to an identity
|
|
1759
1771
|
* @type {boolean}
|
|
1760
1772
|
* @memberof AccountAllOf
|
|
1761
1773
|
*/
|
|
1762
|
-
'manuallyCorrelated'
|
|
1774
|
+
'manuallyCorrelated': boolean;
|
|
1763
1775
|
/**
|
|
1764
1776
|
* Indicates if the account has entitlements
|
|
1765
1777
|
* @type {boolean}
|
|
1766
1778
|
* @memberof AccountAllOf
|
|
1767
1779
|
*/
|
|
1768
|
-
'hasEntitlements'
|
|
1780
|
+
'hasEntitlements': boolean;
|
|
1769
1781
|
}
|
|
1770
1782
|
/**
|
|
1771
1783
|
*
|
|
@@ -14031,7 +14043,7 @@ export interface Source {
|
|
|
14031
14043
|
*/
|
|
14032
14044
|
'features'?: Array<SourceFeature>;
|
|
14033
14045
|
/**
|
|
14034
|
-
* Specifies the type of system being managed e.g. Active Directory, Workday, etc..
|
|
14046
|
+
* 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`.
|
|
14035
14047
|
* @type {string}
|
|
14036
14048
|
* @memberof Source
|
|
14037
14049
|
*/
|
|
@@ -14294,7 +14306,7 @@ export interface SourceHealthDto {
|
|
|
14294
14306
|
*/
|
|
14295
14307
|
'id'?: string;
|
|
14296
14308
|
/**
|
|
14297
|
-
* Specifies the type of system being managed e.g. Active Directory, Workday, etc..
|
|
14309
|
+
* 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`.
|
|
14298
14310
|
* @type {string}
|
|
14299
14311
|
* @memberof SourceHealthDto
|
|
14300
14312
|
*/
|
|
@@ -25844,7 +25856,7 @@ export const PasswordManagementApiAxiosParamCreator = function (configuration?:
|
|
|
25844
25856
|
};
|
|
25845
25857
|
},
|
|
25846
25858
|
/**
|
|
25847
|
-
* 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.
|
|
25859
|
+
* 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.
|
|
25848
25860
|
* @summary Set Identity\'s Password
|
|
25849
25861
|
* @param {PasswordChangeRequest} passwordChangeRequest
|
|
25850
25862
|
* @param {*} [axiosOptions] Override http request option.
|
|
@@ -25920,7 +25932,7 @@ export const PasswordManagementApiFp = function(configuration?: Configuration) {
|
|
|
25920
25932
|
return createRequestFunction(localVarAxiosArgs, globalAxios, BASE_PATH, configuration);
|
|
25921
25933
|
},
|
|
25922
25934
|
/**
|
|
25923
|
-
* 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.
|
|
25935
|
+
* 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.
|
|
25924
25936
|
* @summary Set Identity\'s Password
|
|
25925
25937
|
* @param {PasswordChangeRequest} passwordChangeRequest
|
|
25926
25938
|
* @param {*} [axiosOptions] Override http request option.
|
|
@@ -25961,7 +25973,7 @@ export const PasswordManagementApiFactory = function (configuration?: Configurat
|
|
|
25961
25973
|
return localVarFp.queryPasswordInfo(passwordInfoQueryDTO, axiosOptions).then((request) => request(axios, basePath));
|
|
25962
25974
|
},
|
|
25963
25975
|
/**
|
|
25964
|
-
* 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.
|
|
25976
|
+
* 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.
|
|
25965
25977
|
* @summary Set Identity\'s Password
|
|
25966
25978
|
* @param {PasswordChangeRequest} passwordChangeRequest
|
|
25967
25979
|
* @param {*} [axiosOptions] Override http request option.
|
|
@@ -26047,7 +26059,7 @@ export class PasswordManagementApi extends BaseAPI {
|
|
|
26047
26059
|
}
|
|
26048
26060
|
|
|
26049
26061
|
/**
|
|
26050
|
-
* 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.
|
|
26062
|
+
* 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.
|
|
26051
26063
|
* @summary Set Identity\'s Password
|
|
26052
26064
|
* @param {PasswordManagementApiSetPasswordRequest} requestParameters Request parameters.
|
|
26053
26065
|
* @param {*} [axiosOptions] Override http request option.
|
|
@@ -30118,7 +30130,7 @@ export const ServiceDeskIntegrationApiAxiosParamCreator = function (configuratio
|
|
|
30118
30130
|
return {
|
|
30119
30131
|
/**
|
|
30120
30132
|
* Create a new Service Desk Integrations. A token with Org Admin or Service Desk Admin authority is required to access this endpoint.
|
|
30121
|
-
* @summary Create
|
|
30133
|
+
* @summary Create new Service Desk integration
|
|
30122
30134
|
* @param {ServiceDeskIntegrationDto} serviceDeskIntegrationDto The specifics of a new integration to create
|
|
30123
30135
|
* @param {*} [axiosOptions] Override http request option.
|
|
30124
30136
|
* @throws {RequiredError}
|
|
@@ -30162,7 +30174,7 @@ export const ServiceDeskIntegrationApiAxiosParamCreator = function (configuratio
|
|
|
30162
30174
|
},
|
|
30163
30175
|
/**
|
|
30164
30176
|
* Delete an existing Service Desk integration by ID. A token with Org Admin or Service Desk Admin authority is required to access this endpoint.
|
|
30165
|
-
* @summary Delete a Service Desk integration
|
|
30177
|
+
* @summary Delete a Service Desk integration
|
|
30166
30178
|
* @param {string} id ID of Service Desk integration to delete
|
|
30167
30179
|
* @param {*} [axiosOptions] Override http request option.
|
|
30168
30180
|
* @throws {RequiredError}
|
|
@@ -30204,7 +30216,7 @@ export const ServiceDeskIntegrationApiAxiosParamCreator = function (configuratio
|
|
|
30204
30216
|
},
|
|
30205
30217
|
/**
|
|
30206
30218
|
* Get an existing Service Desk integration by ID. A token with Org Admin or Service Desk Admin authority is required to access this endpoint.
|
|
30207
|
-
* @summary Get a Service Desk integration
|
|
30219
|
+
* @summary Get a Service Desk integration
|
|
30208
30220
|
* @param {string} id ID of the Service Desk integration to get
|
|
30209
30221
|
* @param {*} [axiosOptions] Override http request option.
|
|
30210
30222
|
* @throws {RequiredError}
|
|
@@ -30389,7 +30401,7 @@ export const ServiceDeskIntegrationApiAxiosParamCreator = function (configuratio
|
|
|
30389
30401
|
},
|
|
30390
30402
|
/**
|
|
30391
30403
|
* 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.
|
|
30392
|
-
* @summary Get the time check configuration
|
|
30404
|
+
* @summary Get the time check configuration
|
|
30393
30405
|
* @param {*} [axiosOptions] Override http request option.
|
|
30394
30406
|
* @throws {RequiredError}
|
|
30395
30407
|
*/
|
|
@@ -30427,7 +30439,7 @@ export const ServiceDeskIntegrationApiAxiosParamCreator = function (configuratio
|
|
|
30427
30439
|
},
|
|
30428
30440
|
/**
|
|
30429
30441
|
* Update an existing ServiceDeskIntegration by ID with a PATCH request.
|
|
30430
|
-
* @summary Service Desk Integration Update
|
|
30442
|
+
* @summary Service Desk Integration Update PATCH
|
|
30431
30443
|
* @param {string} id ID of the Service Desk integration to update
|
|
30432
30444
|
* @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.
|
|
30433
30445
|
* @param {*} [axiosOptions] Override http request option.
|
|
@@ -30475,7 +30487,7 @@ export const ServiceDeskIntegrationApiAxiosParamCreator = function (configuratio
|
|
|
30475
30487
|
},
|
|
30476
30488
|
/**
|
|
30477
30489
|
* 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.
|
|
30478
|
-
* @summary Update a Service Desk integration
|
|
30490
|
+
* @summary Update a Service Desk integration
|
|
30479
30491
|
* @param {string} id ID of the Service Desk integration to update
|
|
30480
30492
|
* @param {ServiceDeskIntegrationDto} serviceDeskIntegrationDto The specifics of the integration to update
|
|
30481
30493
|
* @param {*} [axiosOptions] Override http request option.
|
|
@@ -30523,7 +30535,7 @@ export const ServiceDeskIntegrationApiAxiosParamCreator = function (configuratio
|
|
|
30523
30535
|
},
|
|
30524
30536
|
/**
|
|
30525
30537
|
* 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.
|
|
30526
|
-
* @summary Update the time check configuration
|
|
30538
|
+
* @summary Update the time check configuration
|
|
30527
30539
|
* @param {QueuedCheckConfigDetails} queuedCheckConfigDetails the modified time check configuration
|
|
30528
30540
|
* @param {*} [axiosOptions] Override http request option.
|
|
30529
30541
|
* @throws {RequiredError}
|
|
@@ -30577,7 +30589,7 @@ export const ServiceDeskIntegrationApiFp = function(configuration?: Configuratio
|
|
|
30577
30589
|
return {
|
|
30578
30590
|
/**
|
|
30579
30591
|
* Create a new Service Desk Integrations. A token with Org Admin or Service Desk Admin authority is required to access this endpoint.
|
|
30580
|
-
* @summary Create
|
|
30592
|
+
* @summary Create new Service Desk integration
|
|
30581
30593
|
* @param {ServiceDeskIntegrationDto} serviceDeskIntegrationDto The specifics of a new integration to create
|
|
30582
30594
|
* @param {*} [axiosOptions] Override http request option.
|
|
30583
30595
|
* @throws {RequiredError}
|
|
@@ -30588,7 +30600,7 @@ export const ServiceDeskIntegrationApiFp = function(configuration?: Configuratio
|
|
|
30588
30600
|
},
|
|
30589
30601
|
/**
|
|
30590
30602
|
* Delete an existing Service Desk integration by ID. A token with Org Admin or Service Desk Admin authority is required to access this endpoint.
|
|
30591
|
-
* @summary Delete a Service Desk integration
|
|
30603
|
+
* @summary Delete a Service Desk integration
|
|
30592
30604
|
* @param {string} id ID of Service Desk integration to delete
|
|
30593
30605
|
* @param {*} [axiosOptions] Override http request option.
|
|
30594
30606
|
* @throws {RequiredError}
|
|
@@ -30599,7 +30611,7 @@ export const ServiceDeskIntegrationApiFp = function(configuration?: Configuratio
|
|
|
30599
30611
|
},
|
|
30600
30612
|
/**
|
|
30601
30613
|
* Get an existing Service Desk integration by ID. A token with Org Admin or Service Desk Admin authority is required to access this endpoint.
|
|
30602
|
-
* @summary Get a Service Desk integration
|
|
30614
|
+
* @summary Get a Service Desk integration
|
|
30603
30615
|
* @param {string} id ID of the Service Desk integration to get
|
|
30604
30616
|
* @param {*} [axiosOptions] Override http request option.
|
|
30605
30617
|
* @throws {RequiredError}
|
|
@@ -30646,7 +30658,7 @@ export const ServiceDeskIntegrationApiFp = function(configuration?: Configuratio
|
|
|
30646
30658
|
},
|
|
30647
30659
|
/**
|
|
30648
30660
|
* 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.
|
|
30649
|
-
* @summary Get the time check configuration
|
|
30661
|
+
* @summary Get the time check configuration
|
|
30650
30662
|
* @param {*} [axiosOptions] Override http request option.
|
|
30651
30663
|
* @throws {RequiredError}
|
|
30652
30664
|
*/
|
|
@@ -30656,7 +30668,7 @@ export const ServiceDeskIntegrationApiFp = function(configuration?: Configuratio
|
|
|
30656
30668
|
},
|
|
30657
30669
|
/**
|
|
30658
30670
|
* Update an existing ServiceDeskIntegration by ID with a PATCH request.
|
|
30659
|
-
* @summary Service Desk Integration Update
|
|
30671
|
+
* @summary Service Desk Integration Update PATCH
|
|
30660
30672
|
* @param {string} id ID of the Service Desk integration to update
|
|
30661
30673
|
* @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.
|
|
30662
30674
|
* @param {*} [axiosOptions] Override http request option.
|
|
@@ -30668,7 +30680,7 @@ export const ServiceDeskIntegrationApiFp = function(configuration?: Configuratio
|
|
|
30668
30680
|
},
|
|
30669
30681
|
/**
|
|
30670
30682
|
* 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.
|
|
30671
|
-
* @summary Update a Service Desk integration
|
|
30683
|
+
* @summary Update a Service Desk integration
|
|
30672
30684
|
* @param {string} id ID of the Service Desk integration to update
|
|
30673
30685
|
* @param {ServiceDeskIntegrationDto} serviceDeskIntegrationDto The specifics of the integration to update
|
|
30674
30686
|
* @param {*} [axiosOptions] Override http request option.
|
|
@@ -30680,7 +30692,7 @@ export const ServiceDeskIntegrationApiFp = function(configuration?: Configuratio
|
|
|
30680
30692
|
},
|
|
30681
30693
|
/**
|
|
30682
30694
|
* 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.
|
|
30683
|
-
* @summary Update the time check configuration
|
|
30695
|
+
* @summary Update the time check configuration
|
|
30684
30696
|
* @param {QueuedCheckConfigDetails} queuedCheckConfigDetails the modified time check configuration
|
|
30685
30697
|
* @param {*} [axiosOptions] Override http request option.
|
|
30686
30698
|
* @throws {RequiredError}
|
|
@@ -30701,7 +30713,7 @@ export const ServiceDeskIntegrationApiFactory = function (configuration?: Config
|
|
|
30701
30713
|
return {
|
|
30702
30714
|
/**
|
|
30703
30715
|
* Create a new Service Desk Integrations. A token with Org Admin or Service Desk Admin authority is required to access this endpoint.
|
|
30704
|
-
* @summary Create
|
|
30716
|
+
* @summary Create new Service Desk integration
|
|
30705
30717
|
* @param {ServiceDeskIntegrationDto} serviceDeskIntegrationDto The specifics of a new integration to create
|
|
30706
30718
|
* @param {*} [axiosOptions] Override http request option.
|
|
30707
30719
|
* @throws {RequiredError}
|
|
@@ -30711,7 +30723,7 @@ export const ServiceDeskIntegrationApiFactory = function (configuration?: Config
|
|
|
30711
30723
|
},
|
|
30712
30724
|
/**
|
|
30713
30725
|
* Delete an existing Service Desk integration by ID. A token with Org Admin or Service Desk Admin authority is required to access this endpoint.
|
|
30714
|
-
* @summary Delete a Service Desk integration
|
|
30726
|
+
* @summary Delete a Service Desk integration
|
|
30715
30727
|
* @param {string} id ID of Service Desk integration to delete
|
|
30716
30728
|
* @param {*} [axiosOptions] Override http request option.
|
|
30717
30729
|
* @throws {RequiredError}
|
|
@@ -30721,7 +30733,7 @@ export const ServiceDeskIntegrationApiFactory = function (configuration?: Config
|
|
|
30721
30733
|
},
|
|
30722
30734
|
/**
|
|
30723
30735
|
* Get an existing Service Desk integration by ID. A token with Org Admin or Service Desk Admin authority is required to access this endpoint.
|
|
30724
|
-
* @summary Get a Service Desk integration
|
|
30736
|
+
* @summary Get a Service Desk integration
|
|
30725
30737
|
* @param {string} id ID of the Service Desk integration to get
|
|
30726
30738
|
* @param {*} [axiosOptions] Override http request option.
|
|
30727
30739
|
* @throws {RequiredError}
|
|
@@ -30764,7 +30776,7 @@ export const ServiceDeskIntegrationApiFactory = function (configuration?: Config
|
|
|
30764
30776
|
},
|
|
30765
30777
|
/**
|
|
30766
30778
|
* 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.
|
|
30767
|
-
* @summary Get the time check configuration
|
|
30779
|
+
* @summary Get the time check configuration
|
|
30768
30780
|
* @param {*} [axiosOptions] Override http request option.
|
|
30769
30781
|
* @throws {RequiredError}
|
|
30770
30782
|
*/
|
|
@@ -30773,7 +30785,7 @@ export const ServiceDeskIntegrationApiFactory = function (configuration?: Config
|
|
|
30773
30785
|
},
|
|
30774
30786
|
/**
|
|
30775
30787
|
* Update an existing ServiceDeskIntegration by ID with a PATCH request.
|
|
30776
|
-
* @summary Service Desk Integration Update
|
|
30788
|
+
* @summary Service Desk Integration Update PATCH
|
|
30777
30789
|
* @param {string} id ID of the Service Desk integration to update
|
|
30778
30790
|
* @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.
|
|
30779
30791
|
* @param {*} [axiosOptions] Override http request option.
|
|
@@ -30784,7 +30796,7 @@ export const ServiceDeskIntegrationApiFactory = function (configuration?: Config
|
|
|
30784
30796
|
},
|
|
30785
30797
|
/**
|
|
30786
30798
|
* 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.
|
|
30787
|
-
* @summary Update a Service Desk integration
|
|
30799
|
+
* @summary Update a Service Desk integration
|
|
30788
30800
|
* @param {string} id ID of the Service Desk integration to update
|
|
30789
30801
|
* @param {ServiceDeskIntegrationDto} serviceDeskIntegrationDto The specifics of the integration to update
|
|
30790
30802
|
* @param {*} [axiosOptions] Override http request option.
|
|
@@ -30795,7 +30807,7 @@ export const ServiceDeskIntegrationApiFactory = function (configuration?: Config
|
|
|
30795
30807
|
},
|
|
30796
30808
|
/**
|
|
30797
30809
|
* 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.
|
|
30798
|
-
* @summary Update the time check configuration
|
|
30810
|
+
* @summary Update the time check configuration
|
|
30799
30811
|
* @param {QueuedCheckConfigDetails} queuedCheckConfigDetails the modified time check configuration
|
|
30800
30812
|
* @param {*} [axiosOptions] Override http request option.
|
|
30801
30813
|
* @throws {RequiredError}
|
|
@@ -30969,7 +30981,7 @@ export interface ServiceDeskIntegrationApiUpdateStatusCheckDetailsRequest {
|
|
|
30969
30981
|
export class ServiceDeskIntegrationApi extends BaseAPI {
|
|
30970
30982
|
/**
|
|
30971
30983
|
* Create a new Service Desk Integrations. A token with Org Admin or Service Desk Admin authority is required to access this endpoint.
|
|
30972
|
-
* @summary Create
|
|
30984
|
+
* @summary Create new Service Desk integration
|
|
30973
30985
|
* @param {ServiceDeskIntegrationApiCreateServiceDeskIntegrationRequest} requestParameters Request parameters.
|
|
30974
30986
|
* @param {*} [axiosOptions] Override http request option.
|
|
30975
30987
|
* @throws {RequiredError}
|
|
@@ -30981,7 +30993,7 @@ export class ServiceDeskIntegrationApi extends BaseAPI {
|
|
|
30981
30993
|
|
|
30982
30994
|
/**
|
|
30983
30995
|
* Delete an existing Service Desk integration by ID. A token with Org Admin or Service Desk Admin authority is required to access this endpoint.
|
|
30984
|
-
* @summary Delete a Service Desk integration
|
|
30996
|
+
* @summary Delete a Service Desk integration
|
|
30985
30997
|
* @param {ServiceDeskIntegrationApiDeleteServiceDeskIntegrationRequest} requestParameters Request parameters.
|
|
30986
30998
|
* @param {*} [axiosOptions] Override http request option.
|
|
30987
30999
|
* @throws {RequiredError}
|
|
@@ -30993,7 +31005,7 @@ export class ServiceDeskIntegrationApi extends BaseAPI {
|
|
|
30993
31005
|
|
|
30994
31006
|
/**
|
|
30995
31007
|
* Get an existing Service Desk integration by ID. A token with Org Admin or Service Desk Admin authority is required to access this endpoint.
|
|
30996
|
-
* @summary Get a Service Desk integration
|
|
31008
|
+
* @summary Get a Service Desk integration
|
|
30997
31009
|
* @param {ServiceDeskIntegrationApiGetServiceDeskIntegrationRequest} requestParameters Request parameters.
|
|
30998
31010
|
* @param {*} [axiosOptions] Override http request option.
|
|
30999
31011
|
* @throws {RequiredError}
|
|
@@ -31040,7 +31052,7 @@ export class ServiceDeskIntegrationApi extends BaseAPI {
|
|
|
31040
31052
|
|
|
31041
31053
|
/**
|
|
31042
31054
|
* 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.
|
|
31043
|
-
* @summary Get the time check configuration
|
|
31055
|
+
* @summary Get the time check configuration
|
|
31044
31056
|
* @param {*} [axiosOptions] Override http request option.
|
|
31045
31057
|
* @throws {RequiredError}
|
|
31046
31058
|
* @memberof ServiceDeskIntegrationApi
|
|
@@ -31051,7 +31063,7 @@ export class ServiceDeskIntegrationApi extends BaseAPI {
|
|
|
31051
31063
|
|
|
31052
31064
|
/**
|
|
31053
31065
|
* Update an existing ServiceDeskIntegration by ID with a PATCH request.
|
|
31054
|
-
* @summary Service Desk Integration Update
|
|
31066
|
+
* @summary Service Desk Integration Update PATCH
|
|
31055
31067
|
* @param {ServiceDeskIntegrationApiPatchServiceDeskIntegrationRequest} requestParameters Request parameters.
|
|
31056
31068
|
* @param {*} [axiosOptions] Override http request option.
|
|
31057
31069
|
* @throws {RequiredError}
|
|
@@ -31063,7 +31075,7 @@ export class ServiceDeskIntegrationApi extends BaseAPI {
|
|
|
31063
31075
|
|
|
31064
31076
|
/**
|
|
31065
31077
|
* 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.
|
|
31066
|
-
* @summary Update a Service Desk integration
|
|
31078
|
+
* @summary Update a Service Desk integration
|
|
31067
31079
|
* @param {ServiceDeskIntegrationApiUpdateServiceDeskIntegrationRequest} requestParameters Request parameters.
|
|
31068
31080
|
* @param {*} [axiosOptions] Override http request option.
|
|
31069
31081
|
* @throws {RequiredError}
|
|
@@ -31075,7 +31087,7 @@ export class ServiceDeskIntegrationApi extends BaseAPI {
|
|
|
31075
31087
|
|
|
31076
31088
|
/**
|
|
31077
31089
|
* 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.
|
|
31078
|
-
* @summary Update the time check configuration
|
|
31090
|
+
* @summary Update the time check configuration
|
|
31079
31091
|
* @param {ServiceDeskIntegrationApiUpdateStatusCheckDetailsRequest} requestParameters Request parameters.
|
|
31080
31092
|
* @param {*} [axiosOptions] Override http request option.
|
|
31081
31093
|
* @throws {RequiredError}
|
|
@@ -31145,7 +31157,7 @@ export const SourcesApiAxiosParamCreator = function (configuration?: Configurati
|
|
|
31145
31157
|
* 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.
|
|
31146
31158
|
* @summary Creates a source in IdentityNow.
|
|
31147
31159
|
* @param {Source} source
|
|
31148
|
-
* @param {boolean} [provisionAsCsv]
|
|
31160
|
+
* @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.
|
|
31149
31161
|
* @param {*} [axiosOptions] Override http request option.
|
|
31150
31162
|
* @throws {RequiredError}
|
|
31151
31163
|
*/
|
|
@@ -32147,7 +32159,7 @@ export const SourcesApiAxiosParamCreator = function (configuration?: Configurati
|
|
|
32147
32159
|
};
|
|
32148
32160
|
},
|
|
32149
32161
|
/**
|
|
32150
|
-
* 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** ->
|
|
32162
|
+
* 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.**
|
|
32151
32163
|
* @summary Uploads source accounts schema template
|
|
32152
32164
|
* @param {string} id The Source id
|
|
32153
32165
|
* @param {any} [file]
|
|
@@ -32249,7 +32261,7 @@ export const SourcesApiAxiosParamCreator = function (configuration?: Configurati
|
|
|
32249
32261
|
};
|
|
32250
32262
|
},
|
|
32251
32263
|
/**
|
|
32252
|
-
* 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** ->
|
|
32264
|
+
* 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.**
|
|
32253
32265
|
* @summary Uploads source entitlements schema template
|
|
32254
32266
|
* @param {string} id The Source id
|
|
32255
32267
|
* @param {string} [schemaName] Name of entitlement schema
|
|
@@ -32330,7 +32342,7 @@ export const SourcesApiFp = function(configuration?: Configuration) {
|
|
|
32330
32342
|
* 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.
|
|
32331
32343
|
* @summary Creates a source in IdentityNow.
|
|
32332
32344
|
* @param {Source} source
|
|
32333
|
-
* @param {boolean} [provisionAsCsv]
|
|
32345
|
+
* @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.
|
|
32334
32346
|
* @param {*} [axiosOptions] Override http request option.
|
|
32335
32347
|
* @throws {RequiredError}
|
|
32336
32348
|
*/
|
|
@@ -32582,7 +32594,7 @@ export const SourcesApiFp = function(configuration?: Configuration) {
|
|
|
32582
32594
|
return createRequestFunction(localVarAxiosArgs, globalAxios, BASE_PATH, configuration);
|
|
32583
32595
|
},
|
|
32584
32596
|
/**
|
|
32585
|
-
* 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** ->
|
|
32597
|
+
* 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.**
|
|
32586
32598
|
* @summary Uploads source accounts schema template
|
|
32587
32599
|
* @param {string} id The Source id
|
|
32588
32600
|
* @param {any} [file]
|
|
@@ -32606,7 +32618,7 @@ export const SourcesApiFp = function(configuration?: Configuration) {
|
|
|
32606
32618
|
return createRequestFunction(localVarAxiosArgs, globalAxios, BASE_PATH, configuration);
|
|
32607
32619
|
},
|
|
32608
32620
|
/**
|
|
32609
|
-
* 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** ->
|
|
32621
|
+
* 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.**
|
|
32610
32622
|
* @summary Uploads source entitlements schema template
|
|
32611
32623
|
* @param {string} id The Source id
|
|
32612
32624
|
* @param {string} [schemaName] Name of entitlement schema
|
|
@@ -32643,7 +32655,7 @@ export const SourcesApiFactory = function (configuration?: Configuration, basePa
|
|
|
32643
32655
|
* 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.
|
|
32644
32656
|
* @summary Creates a source in IdentityNow.
|
|
32645
32657
|
* @param {Source} source
|
|
32646
|
-
* @param {boolean} [provisionAsCsv]
|
|
32658
|
+
* @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.
|
|
32647
32659
|
* @param {*} [axiosOptions] Override http request option.
|
|
32648
32660
|
* @throws {RequiredError}
|
|
32649
32661
|
*/
|
|
@@ -32874,7 +32886,7 @@ export const SourcesApiFactory = function (configuration?: Configuration, basePa
|
|
|
32874
32886
|
return localVarFp.updateSourceSchema(sourceId, schemaId, jsonPatchOperation, axiosOptions).then((request) => request(axios, basePath));
|
|
32875
32887
|
},
|
|
32876
32888
|
/**
|
|
32877
|
-
* 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** ->
|
|
32889
|
+
* 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.**
|
|
32878
32890
|
* @summary Uploads source accounts schema template
|
|
32879
32891
|
* @param {string} id The Source id
|
|
32880
32892
|
* @param {any} [file]
|
|
@@ -32896,7 +32908,7 @@ export const SourcesApiFactory = function (configuration?: Configuration, basePa
|
|
|
32896
32908
|
return localVarFp.uploadSourceConnectorFile(sourceId, file, axiosOptions).then((request) => request(axios, basePath));
|
|
32897
32909
|
},
|
|
32898
32910
|
/**
|
|
32899
|
-
* 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** ->
|
|
32911
|
+
* 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.**
|
|
32900
32912
|
* @summary Uploads source entitlements schema template
|
|
32901
32913
|
* @param {string} id The Source id
|
|
32902
32914
|
* @param {string} [schemaName] Name of entitlement schema
|
|
@@ -32945,7 +32957,7 @@ export interface SourcesApiCreateSourceRequest {
|
|
|
32945
32957
|
readonly source: Source
|
|
32946
32958
|
|
|
32947
32959
|
/**
|
|
32948
|
-
*
|
|
32960
|
+
* 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.
|
|
32949
32961
|
* @type {boolean}
|
|
32950
32962
|
* @memberof SourcesApiCreateSource
|
|
32951
32963
|
*/
|
|
@@ -33735,7 +33747,7 @@ export class SourcesApi extends BaseAPI {
|
|
|
33735
33747
|
}
|
|
33736
33748
|
|
|
33737
33749
|
/**
|
|
33738
|
-
* 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** ->
|
|
33750
|
+
* 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.**
|
|
33739
33751
|
* @summary Uploads source accounts schema template
|
|
33740
33752
|
* @param {SourcesApiUploadSourceAccountsSchemaRequest} requestParameters Request parameters.
|
|
33741
33753
|
* @param {*} [axiosOptions] Override http request option.
|
|
@@ -33759,7 +33771,7 @@ export class SourcesApi extends BaseAPI {
|
|
|
33759
33771
|
}
|
|
33760
33772
|
|
|
33761
33773
|
/**
|
|
33762
|
-
* 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** ->
|
|
33774
|
+
* 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.**
|
|
33763
33775
|
* @summary Uploads source entitlements schema template
|
|
33764
33776
|
* @param {SourcesApiUploadSourceEntitlementsSchemaRequest} requestParameters Request parameters.
|
|
33765
33777
|
* @param {*} [axiosOptions] Override http request option.
|