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/dist/v3/api.d.ts
CHANGED
|
@@ -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
|
*
|
|
@@ -13882,7 +13894,7 @@ export interface Source {
|
|
|
13882
13894
|
*/
|
|
13883
13895
|
'features'?: Array<SourceFeature>;
|
|
13884
13896
|
/**
|
|
13885
|
-
* 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`.
|
|
13886
13898
|
* @type {string}
|
|
13887
13899
|
* @memberof Source
|
|
13888
13900
|
*/
|
|
@@ -14129,7 +14141,7 @@ export interface SourceHealthDto {
|
|
|
14129
14141
|
*/
|
|
14130
14142
|
'id'?: string;
|
|
14131
14143
|
/**
|
|
14132
|
-
* 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`.
|
|
14133
14145
|
* @type {string}
|
|
14134
14146
|
* @memberof SourceHealthDto
|
|
14135
14147
|
*/
|
|
@@ -20724,7 +20736,7 @@ export declare const PasswordManagementApiAxiosParamCreator: (configuration?: Co
|
|
|
20724
20736
|
*/
|
|
20725
20737
|
queryPasswordInfo: (passwordInfoQueryDTO: PasswordInfoQueryDTO, axiosOptions?: AxiosRequestConfig) => Promise<RequestArgs>;
|
|
20726
20738
|
/**
|
|
20727
|
-
* 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.
|
|
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.
|
|
20728
20740
|
* @summary Set Identity\'s Password
|
|
20729
20741
|
* @param {PasswordChangeRequest} passwordChangeRequest
|
|
20730
20742
|
* @param {*} [axiosOptions] Override http request option.
|
|
@@ -20754,7 +20766,7 @@ export declare const PasswordManagementApiFp: (configuration?: Configuration) =>
|
|
|
20754
20766
|
*/
|
|
20755
20767
|
queryPasswordInfo(passwordInfoQueryDTO: PasswordInfoQueryDTO, axiosOptions?: AxiosRequestConfig): Promise<(axios?: AxiosInstance, basePath?: string) => AxiosPromise<PasswordInfo>>;
|
|
20756
20768
|
/**
|
|
20757
|
-
* 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.
|
|
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.
|
|
20758
20770
|
* @summary Set Identity\'s Password
|
|
20759
20771
|
* @param {PasswordChangeRequest} passwordChangeRequest
|
|
20760
20772
|
* @param {*} [axiosOptions] Override http request option.
|
|
@@ -20784,7 +20796,7 @@ export declare const PasswordManagementApiFactory: (configuration?: Configuratio
|
|
|
20784
20796
|
*/
|
|
20785
20797
|
queryPasswordInfo(passwordInfoQueryDTO: PasswordInfoQueryDTO, axiosOptions?: any): AxiosPromise<PasswordInfo>;
|
|
20786
20798
|
/**
|
|
20787
|
-
* 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.
|
|
20788
20800
|
* @summary Set Identity\'s Password
|
|
20789
20801
|
* @param {PasswordChangeRequest} passwordChangeRequest
|
|
20790
20802
|
* @param {*} [axiosOptions] Override http request option.
|
|
@@ -20857,7 +20869,7 @@ export declare class PasswordManagementApi extends BaseAPI {
|
|
|
20857
20869
|
*/
|
|
20858
20870
|
queryPasswordInfo(requestParameters: PasswordManagementApiQueryPasswordInfoRequest, axiosOptions?: AxiosRequestConfig): Promise<import("axios").AxiosResponse<PasswordInfo, any>>;
|
|
20859
20871
|
/**
|
|
20860
|
-
* 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.
|
|
20861
20873
|
* @summary Set Identity\'s Password
|
|
20862
20874
|
* @param {PasswordManagementApiSetPasswordRequest} requestParameters Request parameters.
|
|
20863
20875
|
* @param {*} [axiosOptions] Override http request option.
|
|
@@ -23086,7 +23098,7 @@ export declare class SearchApi extends BaseAPI {
|
|
|
23086
23098
|
export declare const ServiceDeskIntegrationApiAxiosParamCreator: (configuration?: Configuration) => {
|
|
23087
23099
|
/**
|
|
23088
23100
|
* Create a new Service Desk Integrations. A token with Org Admin or Service Desk Admin authority is required to access this endpoint.
|
|
23089
|
-
* @summary Create
|
|
23101
|
+
* @summary Create new Service Desk integration
|
|
23090
23102
|
* @param {ServiceDeskIntegrationDto} serviceDeskIntegrationDto The specifics of a new integration to create
|
|
23091
23103
|
* @param {*} [axiosOptions] Override http request option.
|
|
23092
23104
|
* @throws {RequiredError}
|
|
@@ -23094,7 +23106,7 @@ export declare const ServiceDeskIntegrationApiAxiosParamCreator: (configuration?
|
|
|
23094
23106
|
createServiceDeskIntegration: (serviceDeskIntegrationDto: ServiceDeskIntegrationDto, axiosOptions?: AxiosRequestConfig) => Promise<RequestArgs>;
|
|
23095
23107
|
/**
|
|
23096
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.
|
|
23097
|
-
* @summary Delete a Service Desk integration
|
|
23109
|
+
* @summary Delete a Service Desk integration
|
|
23098
23110
|
* @param {string} id ID of Service Desk integration to delete
|
|
23099
23111
|
* @param {*} [axiosOptions] Override http request option.
|
|
23100
23112
|
* @throws {RequiredError}
|
|
@@ -23102,7 +23114,7 @@ export declare const ServiceDeskIntegrationApiAxiosParamCreator: (configuration?
|
|
|
23102
23114
|
deleteServiceDeskIntegration: (id: string, axiosOptions?: AxiosRequestConfig) => Promise<RequestArgs>;
|
|
23103
23115
|
/**
|
|
23104
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.
|
|
23105
|
-
* @summary Get a Service Desk integration
|
|
23117
|
+
* @summary Get a Service Desk integration
|
|
23106
23118
|
* @param {string} id ID of the Service Desk integration to get
|
|
23107
23119
|
* @param {*} [axiosOptions] Override http request option.
|
|
23108
23120
|
* @throws {RequiredError}
|
|
@@ -23137,14 +23149,14 @@ export declare const ServiceDeskIntegrationApiAxiosParamCreator: (configuration?
|
|
|
23137
23149
|
getServiceDeskIntegrations: (offset?: number, limit?: number, sorters?: string, filters?: string, count?: boolean, axiosOptions?: AxiosRequestConfig) => Promise<RequestArgs>;
|
|
23138
23150
|
/**
|
|
23139
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.
|
|
23140
|
-
* @summary Get the time check configuration
|
|
23152
|
+
* @summary Get the time check configuration
|
|
23141
23153
|
* @param {*} [axiosOptions] Override http request option.
|
|
23142
23154
|
* @throws {RequiredError}
|
|
23143
23155
|
*/
|
|
23144
23156
|
getStatusCheckDetails: (axiosOptions?: AxiosRequestConfig) => Promise<RequestArgs>;
|
|
23145
23157
|
/**
|
|
23146
23158
|
* Update an existing ServiceDeskIntegration by ID with a PATCH request.
|
|
23147
|
-
* @summary Service Desk Integration Update
|
|
23159
|
+
* @summary Service Desk Integration Update PATCH
|
|
23148
23160
|
* @param {string} id ID of the Service Desk integration to update
|
|
23149
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.
|
|
23150
23162
|
* @param {*} [axiosOptions] Override http request option.
|
|
@@ -23153,7 +23165,7 @@ export declare const ServiceDeskIntegrationApiAxiosParamCreator: (configuration?
|
|
|
23153
23165
|
patchServiceDeskIntegration: (id: string, jsonPatch: JsonPatch, axiosOptions?: AxiosRequestConfig) => Promise<RequestArgs>;
|
|
23154
23166
|
/**
|
|
23155
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.
|
|
23156
|
-
* @summary Update a Service Desk integration
|
|
23168
|
+
* @summary Update a Service Desk integration
|
|
23157
23169
|
* @param {string} id ID of the Service Desk integration to update
|
|
23158
23170
|
* @param {ServiceDeskIntegrationDto} serviceDeskIntegrationDto The specifics of the integration to update
|
|
23159
23171
|
* @param {*} [axiosOptions] Override http request option.
|
|
@@ -23162,7 +23174,7 @@ export declare const ServiceDeskIntegrationApiAxiosParamCreator: (configuration?
|
|
|
23162
23174
|
updateServiceDeskIntegration: (id: string, serviceDeskIntegrationDto: ServiceDeskIntegrationDto, axiosOptions?: AxiosRequestConfig) => Promise<RequestArgs>;
|
|
23163
23175
|
/**
|
|
23164
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.
|
|
23165
|
-
* @summary Update the time check configuration
|
|
23177
|
+
* @summary Update the time check configuration
|
|
23166
23178
|
* @param {QueuedCheckConfigDetails} queuedCheckConfigDetails the modified time check configuration
|
|
23167
23179
|
* @param {*} [axiosOptions] Override http request option.
|
|
23168
23180
|
* @throws {RequiredError}
|
|
@@ -23176,7 +23188,7 @@ export declare const ServiceDeskIntegrationApiAxiosParamCreator: (configuration?
|
|
|
23176
23188
|
export declare const ServiceDeskIntegrationApiFp: (configuration?: Configuration) => {
|
|
23177
23189
|
/**
|
|
23178
23190
|
* Create a new Service Desk Integrations. A token with Org Admin or Service Desk Admin authority is required to access this endpoint.
|
|
23179
|
-
* @summary Create
|
|
23191
|
+
* @summary Create new Service Desk integration
|
|
23180
23192
|
* @param {ServiceDeskIntegrationDto} serviceDeskIntegrationDto The specifics of a new integration to create
|
|
23181
23193
|
* @param {*} [axiosOptions] Override http request option.
|
|
23182
23194
|
* @throws {RequiredError}
|
|
@@ -23184,7 +23196,7 @@ export declare const ServiceDeskIntegrationApiFp: (configuration?: Configuration
|
|
|
23184
23196
|
createServiceDeskIntegration(serviceDeskIntegrationDto: ServiceDeskIntegrationDto, axiosOptions?: AxiosRequestConfig): Promise<(axios?: AxiosInstance, basePath?: string) => AxiosPromise<ServiceDeskIntegrationDto>>;
|
|
23185
23197
|
/**
|
|
23186
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.
|
|
23187
|
-
* @summary Delete a Service Desk integration
|
|
23199
|
+
* @summary Delete a Service Desk integration
|
|
23188
23200
|
* @param {string} id ID of Service Desk integration to delete
|
|
23189
23201
|
* @param {*} [axiosOptions] Override http request option.
|
|
23190
23202
|
* @throws {RequiredError}
|
|
@@ -23192,7 +23204,7 @@ export declare const ServiceDeskIntegrationApiFp: (configuration?: Configuration
|
|
|
23192
23204
|
deleteServiceDeskIntegration(id: string, axiosOptions?: AxiosRequestConfig): Promise<(axios?: AxiosInstance, basePath?: string) => AxiosPromise<void>>;
|
|
23193
23205
|
/**
|
|
23194
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.
|
|
23195
|
-
* @summary Get a Service Desk integration
|
|
23207
|
+
* @summary Get a Service Desk integration
|
|
23196
23208
|
* @param {string} id ID of the Service Desk integration to get
|
|
23197
23209
|
* @param {*} [axiosOptions] Override http request option.
|
|
23198
23210
|
* @throws {RequiredError}
|
|
@@ -23227,14 +23239,14 @@ export declare const ServiceDeskIntegrationApiFp: (configuration?: Configuration
|
|
|
23227
23239
|
getServiceDeskIntegrations(offset?: number, limit?: number, sorters?: string, filters?: string, count?: boolean, axiosOptions?: AxiosRequestConfig): Promise<(axios?: AxiosInstance, basePath?: string) => AxiosPromise<Array<ServiceDeskIntegrationDto>>>;
|
|
23228
23240
|
/**
|
|
23229
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.
|
|
23230
|
-
* @summary Get the time check configuration
|
|
23242
|
+
* @summary Get the time check configuration
|
|
23231
23243
|
* @param {*} [axiosOptions] Override http request option.
|
|
23232
23244
|
* @throws {RequiredError}
|
|
23233
23245
|
*/
|
|
23234
23246
|
getStatusCheckDetails(axiosOptions?: AxiosRequestConfig): Promise<(axios?: AxiosInstance, basePath?: string) => AxiosPromise<QueuedCheckConfigDetails>>;
|
|
23235
23247
|
/**
|
|
23236
23248
|
* Update an existing ServiceDeskIntegration by ID with a PATCH request.
|
|
23237
|
-
* @summary Service Desk Integration Update
|
|
23249
|
+
* @summary Service Desk Integration Update PATCH
|
|
23238
23250
|
* @param {string} id ID of the Service Desk integration to update
|
|
23239
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.
|
|
23240
23252
|
* @param {*} [axiosOptions] Override http request option.
|
|
@@ -23243,7 +23255,7 @@ export declare const ServiceDeskIntegrationApiFp: (configuration?: Configuration
|
|
|
23243
23255
|
patchServiceDeskIntegration(id: string, jsonPatch: JsonPatch, axiosOptions?: AxiosRequestConfig): Promise<(axios?: AxiosInstance, basePath?: string) => AxiosPromise<ServiceDeskIntegrationDto>>;
|
|
23244
23256
|
/**
|
|
23245
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.
|
|
23246
|
-
* @summary Update a Service Desk integration
|
|
23258
|
+
* @summary Update a Service Desk integration
|
|
23247
23259
|
* @param {string} id ID of the Service Desk integration to update
|
|
23248
23260
|
* @param {ServiceDeskIntegrationDto} serviceDeskIntegrationDto The specifics of the integration to update
|
|
23249
23261
|
* @param {*} [axiosOptions] Override http request option.
|
|
@@ -23252,7 +23264,7 @@ export declare const ServiceDeskIntegrationApiFp: (configuration?: Configuration
|
|
|
23252
23264
|
updateServiceDeskIntegration(id: string, serviceDeskIntegrationDto: ServiceDeskIntegrationDto, axiosOptions?: AxiosRequestConfig): Promise<(axios?: AxiosInstance, basePath?: string) => AxiosPromise<ServiceDeskIntegrationDto>>;
|
|
23253
23265
|
/**
|
|
23254
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.
|
|
23255
|
-
* @summary Update the time check configuration
|
|
23267
|
+
* @summary Update the time check configuration
|
|
23256
23268
|
* @param {QueuedCheckConfigDetails} queuedCheckConfigDetails the modified time check configuration
|
|
23257
23269
|
* @param {*} [axiosOptions] Override http request option.
|
|
23258
23270
|
* @throws {RequiredError}
|
|
@@ -23266,7 +23278,7 @@ export declare const ServiceDeskIntegrationApiFp: (configuration?: Configuration
|
|
|
23266
23278
|
export declare const ServiceDeskIntegrationApiFactory: (configuration?: Configuration, basePath?: string, axios?: AxiosInstance) => {
|
|
23267
23279
|
/**
|
|
23268
23280
|
* Create a new Service Desk Integrations. A token with Org Admin or Service Desk Admin authority is required to access this endpoint.
|
|
23269
|
-
* @summary Create
|
|
23281
|
+
* @summary Create new Service Desk integration
|
|
23270
23282
|
* @param {ServiceDeskIntegrationDto} serviceDeskIntegrationDto The specifics of a new integration to create
|
|
23271
23283
|
* @param {*} [axiosOptions] Override http request option.
|
|
23272
23284
|
* @throws {RequiredError}
|
|
@@ -23274,7 +23286,7 @@ export declare const ServiceDeskIntegrationApiFactory: (configuration?: Configur
|
|
|
23274
23286
|
createServiceDeskIntegration(serviceDeskIntegrationDto: ServiceDeskIntegrationDto, axiosOptions?: any): AxiosPromise<ServiceDeskIntegrationDto>;
|
|
23275
23287
|
/**
|
|
23276
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.
|
|
23277
|
-
* @summary Delete a Service Desk integration
|
|
23289
|
+
* @summary Delete a Service Desk integration
|
|
23278
23290
|
* @param {string} id ID of Service Desk integration to delete
|
|
23279
23291
|
* @param {*} [axiosOptions] Override http request option.
|
|
23280
23292
|
* @throws {RequiredError}
|
|
@@ -23282,7 +23294,7 @@ export declare const ServiceDeskIntegrationApiFactory: (configuration?: Configur
|
|
|
23282
23294
|
deleteServiceDeskIntegration(id: string, axiosOptions?: any): AxiosPromise<void>;
|
|
23283
23295
|
/**
|
|
23284
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.
|
|
23285
|
-
* @summary Get a Service Desk integration
|
|
23297
|
+
* @summary Get a Service Desk integration
|
|
23286
23298
|
* @param {string} id ID of the Service Desk integration to get
|
|
23287
23299
|
* @param {*} [axiosOptions] Override http request option.
|
|
23288
23300
|
* @throws {RequiredError}
|
|
@@ -23317,14 +23329,14 @@ export declare const ServiceDeskIntegrationApiFactory: (configuration?: Configur
|
|
|
23317
23329
|
getServiceDeskIntegrations(offset?: number, limit?: number, sorters?: string, filters?: string, count?: boolean, axiosOptions?: any): AxiosPromise<Array<ServiceDeskIntegrationDto>>;
|
|
23318
23330
|
/**
|
|
23319
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.
|
|
23320
|
-
* @summary Get the time check configuration
|
|
23332
|
+
* @summary Get the time check configuration
|
|
23321
23333
|
* @param {*} [axiosOptions] Override http request option.
|
|
23322
23334
|
* @throws {RequiredError}
|
|
23323
23335
|
*/
|
|
23324
23336
|
getStatusCheckDetails(axiosOptions?: any): AxiosPromise<QueuedCheckConfigDetails>;
|
|
23325
23337
|
/**
|
|
23326
23338
|
* Update an existing ServiceDeskIntegration by ID with a PATCH request.
|
|
23327
|
-
* @summary Service Desk Integration Update
|
|
23339
|
+
* @summary Service Desk Integration Update PATCH
|
|
23328
23340
|
* @param {string} id ID of the Service Desk integration to update
|
|
23329
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.
|
|
23330
23342
|
* @param {*} [axiosOptions] Override http request option.
|
|
@@ -23333,7 +23345,7 @@ export declare const ServiceDeskIntegrationApiFactory: (configuration?: Configur
|
|
|
23333
23345
|
patchServiceDeskIntegration(id: string, jsonPatch: JsonPatch, axiosOptions?: any): AxiosPromise<ServiceDeskIntegrationDto>;
|
|
23334
23346
|
/**
|
|
23335
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.
|
|
23336
|
-
* @summary Update a Service Desk integration
|
|
23348
|
+
* @summary Update a Service Desk integration
|
|
23337
23349
|
* @param {string} id ID of the Service Desk integration to update
|
|
23338
23350
|
* @param {ServiceDeskIntegrationDto} serviceDeskIntegrationDto The specifics of the integration to update
|
|
23339
23351
|
* @param {*} [axiosOptions] Override http request option.
|
|
@@ -23342,7 +23354,7 @@ export declare const ServiceDeskIntegrationApiFactory: (configuration?: Configur
|
|
|
23342
23354
|
updateServiceDeskIntegration(id: string, serviceDeskIntegrationDto: ServiceDeskIntegrationDto, axiosOptions?: any): AxiosPromise<ServiceDeskIntegrationDto>;
|
|
23343
23355
|
/**
|
|
23344
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.
|
|
23345
|
-
* @summary Update the time check configuration
|
|
23357
|
+
* @summary Update the time check configuration
|
|
23346
23358
|
* @param {QueuedCheckConfigDetails} queuedCheckConfigDetails the modified time check configuration
|
|
23347
23359
|
* @param {*} [axiosOptions] Override http request option.
|
|
23348
23360
|
* @throws {RequiredError}
|
|
@@ -23498,7 +23510,7 @@ export interface ServiceDeskIntegrationApiUpdateStatusCheckDetailsRequest {
|
|
|
23498
23510
|
export declare class ServiceDeskIntegrationApi extends BaseAPI {
|
|
23499
23511
|
/**
|
|
23500
23512
|
* Create a new Service Desk Integrations. A token with Org Admin or Service Desk Admin authority is required to access this endpoint.
|
|
23501
|
-
* @summary Create
|
|
23513
|
+
* @summary Create new Service Desk integration
|
|
23502
23514
|
* @param {ServiceDeskIntegrationApiCreateServiceDeskIntegrationRequest} requestParameters Request parameters.
|
|
23503
23515
|
* @param {*} [axiosOptions] Override http request option.
|
|
23504
23516
|
* @throws {RequiredError}
|
|
@@ -23507,7 +23519,7 @@ export declare class ServiceDeskIntegrationApi extends BaseAPI {
|
|
|
23507
23519
|
createServiceDeskIntegration(requestParameters: ServiceDeskIntegrationApiCreateServiceDeskIntegrationRequest, axiosOptions?: AxiosRequestConfig): Promise<import("axios").AxiosResponse<ServiceDeskIntegrationDto, any>>;
|
|
23508
23520
|
/**
|
|
23509
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.
|
|
23510
|
-
* @summary Delete a Service Desk integration
|
|
23522
|
+
* @summary Delete a Service Desk integration
|
|
23511
23523
|
* @param {ServiceDeskIntegrationApiDeleteServiceDeskIntegrationRequest} requestParameters Request parameters.
|
|
23512
23524
|
* @param {*} [axiosOptions] Override http request option.
|
|
23513
23525
|
* @throws {RequiredError}
|
|
@@ -23516,7 +23528,7 @@ export declare class ServiceDeskIntegrationApi extends BaseAPI {
|
|
|
23516
23528
|
deleteServiceDeskIntegration(requestParameters: ServiceDeskIntegrationApiDeleteServiceDeskIntegrationRequest, axiosOptions?: AxiosRequestConfig): Promise<import("axios").AxiosResponse<void, any>>;
|
|
23517
23529
|
/**
|
|
23518
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.
|
|
23519
|
-
* @summary Get a Service Desk integration
|
|
23531
|
+
* @summary Get a Service Desk integration
|
|
23520
23532
|
* @param {ServiceDeskIntegrationApiGetServiceDeskIntegrationRequest} requestParameters Request parameters.
|
|
23521
23533
|
* @param {*} [axiosOptions] Override http request option.
|
|
23522
23534
|
* @throws {RequiredError}
|
|
@@ -23551,7 +23563,7 @@ export declare class ServiceDeskIntegrationApi extends BaseAPI {
|
|
|
23551
23563
|
getServiceDeskIntegrations(requestParameters?: ServiceDeskIntegrationApiGetServiceDeskIntegrationsRequest, axiosOptions?: AxiosRequestConfig): Promise<import("axios").AxiosResponse<ServiceDeskIntegrationDto[], any>>;
|
|
23552
23564
|
/**
|
|
23553
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.
|
|
23554
|
-
* @summary Get the time check configuration
|
|
23566
|
+
* @summary Get the time check configuration
|
|
23555
23567
|
* @param {*} [axiosOptions] Override http request option.
|
|
23556
23568
|
* @throws {RequiredError}
|
|
23557
23569
|
* @memberof ServiceDeskIntegrationApi
|
|
@@ -23559,7 +23571,7 @@ export declare class ServiceDeskIntegrationApi extends BaseAPI {
|
|
|
23559
23571
|
getStatusCheckDetails(axiosOptions?: AxiosRequestConfig): Promise<import("axios").AxiosResponse<QueuedCheckConfigDetails, any>>;
|
|
23560
23572
|
/**
|
|
23561
23573
|
* Update an existing ServiceDeskIntegration by ID with a PATCH request.
|
|
23562
|
-
* @summary Service Desk Integration Update
|
|
23574
|
+
* @summary Service Desk Integration Update PATCH
|
|
23563
23575
|
* @param {ServiceDeskIntegrationApiPatchServiceDeskIntegrationRequest} requestParameters Request parameters.
|
|
23564
23576
|
* @param {*} [axiosOptions] Override http request option.
|
|
23565
23577
|
* @throws {RequiredError}
|
|
@@ -23568,7 +23580,7 @@ export declare class ServiceDeskIntegrationApi extends BaseAPI {
|
|
|
23568
23580
|
patchServiceDeskIntegration(requestParameters: ServiceDeskIntegrationApiPatchServiceDeskIntegrationRequest, axiosOptions?: AxiosRequestConfig): Promise<import("axios").AxiosResponse<ServiceDeskIntegrationDto, any>>;
|
|
23569
23581
|
/**
|
|
23570
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.
|
|
23571
|
-
* @summary Update a Service Desk integration
|
|
23583
|
+
* @summary Update a Service Desk integration
|
|
23572
23584
|
* @param {ServiceDeskIntegrationApiUpdateServiceDeskIntegrationRequest} requestParameters Request parameters.
|
|
23573
23585
|
* @param {*} [axiosOptions] Override http request option.
|
|
23574
23586
|
* @throws {RequiredError}
|
|
@@ -23577,7 +23589,7 @@ export declare class ServiceDeskIntegrationApi extends BaseAPI {
|
|
|
23577
23589
|
updateServiceDeskIntegration(requestParameters: ServiceDeskIntegrationApiUpdateServiceDeskIntegrationRequest, axiosOptions?: AxiosRequestConfig): Promise<import("axios").AxiosResponse<ServiceDeskIntegrationDto, any>>;
|
|
23578
23590
|
/**
|
|
23579
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.
|
|
23580
|
-
* @summary Update the time check configuration
|
|
23592
|
+
* @summary Update the time check configuration
|
|
23581
23593
|
* @param {ServiceDeskIntegrationApiUpdateStatusCheckDetailsRequest} requestParameters Request parameters.
|
|
23582
23594
|
* @param {*} [axiosOptions] Override http request option.
|
|
23583
23595
|
* @throws {RequiredError}
|
|
@@ -23603,7 +23615,7 @@ export declare const SourcesApiAxiosParamCreator: (configuration?: Configuration
|
|
|
23603
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.
|
|
23604
23616
|
* @summary Creates a source in IdentityNow.
|
|
23605
23617
|
* @param {Source} source
|
|
23606
|
-
* @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.
|
|
23607
23619
|
* @param {*} [axiosOptions] Override http request option.
|
|
23608
23620
|
* @throws {RequiredError}
|
|
23609
23621
|
*/
|
|
@@ -23792,7 +23804,7 @@ export declare const SourcesApiAxiosParamCreator: (configuration?: Configuration
|
|
|
23792
23804
|
*/
|
|
23793
23805
|
updateSourceSchema: (sourceId: string, schemaId: string, jsonPatchOperation: Array<JsonPatchOperation>, axiosOptions?: AxiosRequestConfig) => Promise<RequestArgs>;
|
|
23794
23806
|
/**
|
|
23795
|
-
* 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.**
|
|
23796
23808
|
* @summary Uploads source accounts schema template
|
|
23797
23809
|
* @param {string} id The Source id
|
|
23798
23810
|
* @param {any} [file]
|
|
@@ -23810,7 +23822,7 @@ export declare const SourcesApiAxiosParamCreator: (configuration?: Configuration
|
|
|
23810
23822
|
*/
|
|
23811
23823
|
uploadSourceConnectorFile: (sourceId: string, file?: any, axiosOptions?: AxiosRequestConfig) => Promise<RequestArgs>;
|
|
23812
23824
|
/**
|
|
23813
|
-
* 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.**
|
|
23814
23826
|
* @summary Uploads source entitlements schema template
|
|
23815
23827
|
* @param {string} id The Source id
|
|
23816
23828
|
* @param {string} [schemaName] Name of entitlement schema
|
|
@@ -23838,7 +23850,7 @@ export declare const SourcesApiFp: (configuration?: Configuration) => {
|
|
|
23838
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.
|
|
23839
23851
|
* @summary Creates a source in IdentityNow.
|
|
23840
23852
|
* @param {Source} source
|
|
23841
|
-
* @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.
|
|
23842
23854
|
* @param {*} [axiosOptions] Override http request option.
|
|
23843
23855
|
* @throws {RequiredError}
|
|
23844
23856
|
*/
|
|
@@ -24027,7 +24039,7 @@ export declare const SourcesApiFp: (configuration?: Configuration) => {
|
|
|
24027
24039
|
*/
|
|
24028
24040
|
updateSourceSchema(sourceId: string, schemaId: string, jsonPatchOperation: Array<JsonPatchOperation>, axiosOptions?: AxiosRequestConfig): Promise<(axios?: AxiosInstance, basePath?: string) => AxiosPromise<Schema>>;
|
|
24029
24041
|
/**
|
|
24030
|
-
* 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.**
|
|
24031
24043
|
* @summary Uploads source accounts schema template
|
|
24032
24044
|
* @param {string} id The Source id
|
|
24033
24045
|
* @param {any} [file]
|
|
@@ -24045,7 +24057,7 @@ export declare const SourcesApiFp: (configuration?: Configuration) => {
|
|
|
24045
24057
|
*/
|
|
24046
24058
|
uploadSourceConnectorFile(sourceId: string, file?: any, axiosOptions?: AxiosRequestConfig): Promise<(axios?: AxiosInstance, basePath?: string) => AxiosPromise<Source>>;
|
|
24047
24059
|
/**
|
|
24048
|
-
* 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.**
|
|
24049
24061
|
* @summary Uploads source entitlements schema template
|
|
24050
24062
|
* @param {string} id The Source id
|
|
24051
24063
|
* @param {string} [schemaName] Name of entitlement schema
|
|
@@ -24073,7 +24085,7 @@ export declare const SourcesApiFactory: (configuration?: Configuration, basePath
|
|
|
24073
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.
|
|
24074
24086
|
* @summary Creates a source in IdentityNow.
|
|
24075
24087
|
* @param {Source} source
|
|
24076
|
-
* @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.
|
|
24077
24089
|
* @param {*} [axiosOptions] Override http request option.
|
|
24078
24090
|
* @throws {RequiredError}
|
|
24079
24091
|
*/
|
|
@@ -24262,7 +24274,7 @@ export declare const SourcesApiFactory: (configuration?: Configuration, basePath
|
|
|
24262
24274
|
*/
|
|
24263
24275
|
updateSourceSchema(sourceId: string, schemaId: string, jsonPatchOperation: Array<JsonPatchOperation>, axiosOptions?: any): AxiosPromise<Schema>;
|
|
24264
24276
|
/**
|
|
24265
|
-
* 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.**
|
|
24266
24278
|
* @summary Uploads source accounts schema template
|
|
24267
24279
|
* @param {string} id The Source id
|
|
24268
24280
|
* @param {any} [file]
|
|
@@ -24280,7 +24292,7 @@ export declare const SourcesApiFactory: (configuration?: Configuration, basePath
|
|
|
24280
24292
|
*/
|
|
24281
24293
|
uploadSourceConnectorFile(sourceId: string, file?: any, axiosOptions?: any): AxiosPromise<Source>;
|
|
24282
24294
|
/**
|
|
24283
|
-
* 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.**
|
|
24284
24296
|
* @summary Uploads source entitlements schema template
|
|
24285
24297
|
* @param {string} id The Source id
|
|
24286
24298
|
* @param {string} [schemaName] Name of entitlement schema
|
|
@@ -24322,7 +24334,7 @@ export interface SourcesApiCreateSourceRequest {
|
|
|
24322
24334
|
*/
|
|
24323
24335
|
readonly source: Source;
|
|
24324
24336
|
/**
|
|
24325
|
-
*
|
|
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.
|
|
24326
24338
|
* @type {boolean}
|
|
24327
24339
|
* @memberof SourcesApiCreateSource
|
|
24328
24340
|
*/
|
|
@@ -24995,7 +25007,7 @@ export declare class SourcesApi extends BaseAPI {
|
|
|
24995
25007
|
*/
|
|
24996
25008
|
updateSourceSchema(requestParameters: SourcesApiUpdateSourceSchemaRequest, axiosOptions?: AxiosRequestConfig): Promise<import("axios").AxiosResponse<Schema, any>>;
|
|
24997
25009
|
/**
|
|
24998
|
-
* 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.**
|
|
24999
25011
|
* @summary Uploads source accounts schema template
|
|
25000
25012
|
* @param {SourcesApiUploadSourceAccountsSchemaRequest} requestParameters Request parameters.
|
|
25001
25013
|
* @param {*} [axiosOptions] Override http request option.
|
|
@@ -25013,7 +25025,7 @@ export declare class SourcesApi extends BaseAPI {
|
|
|
25013
25025
|
*/
|
|
25014
25026
|
uploadSourceConnectorFile(requestParameters: SourcesApiUploadSourceConnectorFileRequest, axiosOptions?: AxiosRequestConfig): Promise<import("axios").AxiosResponse<Source, any>>;
|
|
25015
25027
|
/**
|
|
25016
|
-
* 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.**
|
|
25017
25029
|
* @summary Uploads source entitlements schema template
|
|
25018
25030
|
* @param {SourcesApiUploadSourceEntitlementsSchemaRequest} requestParameters Request parameters.
|
|
25019
25031
|
* @param {*} [axiosOptions] Override http request option.
|