sailpoint-api-client 1.4.10 → 1.4.12
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 +90 -54
- package/beta/common.ts +2 -2
- package/beta/package.json +1 -1
- package/dist/beta/api.d.ts +40 -40
- package/dist/beta/api.js +161 -71
- package/dist/beta/api.js.map +1 -1
- package/dist/beta/common.js +1 -1
- package/dist/v2024/api.d.ts +175 -124
- package/dist/v2024/api.js +255 -158
- package/dist/v2024/api.js.map +1 -1
- package/dist/v2024/common.js +1 -1
- package/dist/v3/api.d.ts +76 -64
- package/dist/v3/api.js +59 -59
- package/dist/v3/api.js.map +1 -1
- package/dist/v3/common.js +1 -1
- package/package.json +1 -1
- package/v2024/README.md +2 -2
- package/v2024/api.ts +229 -139
- package/v2024/common.ts +2 -2
- package/v2024/package.json +1 -1
- package/v3/README.md +2 -2
- package/v3/api.ts +76 -64
- package/v3/common.ts +2 -2
- package/v3/package.json +1 -1
package/dist/v3/api.js
CHANGED
|
@@ -17956,8 +17956,8 @@ var ManagedClientsApiAxiosParamCreator = function (configuration) {
|
|
|
17956
17956
|
var _this = this;
|
|
17957
17957
|
return {
|
|
17958
17958
|
/**
|
|
17959
|
-
* Create a new
|
|
17960
|
-
* @summary Create
|
|
17959
|
+
* Create a new managed client. The API returns a result that includes the managed client ID.
|
|
17960
|
+
* @summary Create Managed Client
|
|
17961
17961
|
* @param {ManagedClientRequest} managedClientRequest
|
|
17962
17962
|
* @param {*} [axiosOptions] Override http request option.
|
|
17963
17963
|
* @throws {RequiredError}
|
|
@@ -18010,9 +18010,9 @@ var ManagedClientsApiAxiosParamCreator = function (configuration) {
|
|
|
18010
18010
|
});
|
|
18011
18011
|
},
|
|
18012
18012
|
/**
|
|
18013
|
-
* Delete an existing
|
|
18014
|
-
* @summary Delete
|
|
18015
|
-
* @param {string} id Managed
|
|
18013
|
+
* Delete an existing managed client.
|
|
18014
|
+
* @summary Delete Managed Client
|
|
18015
|
+
* @param {string} id Managed client ID.
|
|
18016
18016
|
* @param {*} [axiosOptions] Override http request option.
|
|
18017
18017
|
* @throws {RequiredError}
|
|
18018
18018
|
*/
|
|
@@ -18116,10 +18116,10 @@ var ManagedClientsApiAxiosParamCreator = function (configuration) {
|
|
|
18116
18116
|
});
|
|
18117
18117
|
},
|
|
18118
18118
|
/**
|
|
18119
|
-
*
|
|
18120
|
-
* @summary Get Managed Client Status
|
|
18121
|
-
* @param {string} id
|
|
18122
|
-
* @param {ManagedClientType} type
|
|
18119
|
+
* Get a managed client\'s status, using its ID.
|
|
18120
|
+
* @summary Get Managed Client Status
|
|
18121
|
+
* @param {string} id Managed client ID to get status for.
|
|
18122
|
+
* @param {ManagedClientType} type Managed client type to get status for.
|
|
18123
18123
|
* @param {*} [axiosOptions] Override http request option.
|
|
18124
18124
|
* @throws {RequiredError}
|
|
18125
18125
|
*/
|
|
@@ -18175,7 +18175,7 @@ var ManagedClientsApiAxiosParamCreator = function (configuration) {
|
|
|
18175
18175
|
});
|
|
18176
18176
|
},
|
|
18177
18177
|
/**
|
|
18178
|
-
*
|
|
18178
|
+
* List managed clients.
|
|
18179
18179
|
* @summary Get Managed Clients
|
|
18180
18180
|
* @param {number} [offset] Offset into the full result set. Usually specified with *limit* to paginate through the results. See [V3 API Standard Collection Parameters](https://developer.sailpoint.com/idn/api/standard-collection-parameters) for more information.
|
|
18181
18181
|
* @param {number} [limit] Max number of results to return. See [V3 API Standard Collection Parameters](https://developer.sailpoint.com/idn/api/standard-collection-parameters) for more information.
|
|
@@ -18240,10 +18240,10 @@ var ManagedClientsApiAxiosParamCreator = function (configuration) {
|
|
|
18240
18240
|
});
|
|
18241
18241
|
},
|
|
18242
18242
|
/**
|
|
18243
|
-
* Update an existing
|
|
18244
|
-
* @summary Update
|
|
18245
|
-
* @param {string} id Managed
|
|
18246
|
-
* @param {Array<JsonPatchOperation>} jsonPatchOperation
|
|
18243
|
+
* Update an existing managed client.
|
|
18244
|
+
* @summary Update Managed Client
|
|
18245
|
+
* @param {string} id Managed client ID.
|
|
18246
|
+
* @param {Array<JsonPatchOperation>} jsonPatchOperation JSONPatch payload used to update the object.
|
|
18247
18247
|
* @param {*} [axiosOptions] Override http request option.
|
|
18248
18248
|
* @throws {RequiredError}
|
|
18249
18249
|
*/
|
|
@@ -18308,8 +18308,8 @@ var ManagedClientsApiFp = function (configuration) {
|
|
|
18308
18308
|
var localVarAxiosParamCreator = (0, exports.ManagedClientsApiAxiosParamCreator)(configuration);
|
|
18309
18309
|
return {
|
|
18310
18310
|
/**
|
|
18311
|
-
* Create a new
|
|
18312
|
-
* @summary Create
|
|
18311
|
+
* Create a new managed client. The API returns a result that includes the managed client ID.
|
|
18312
|
+
* @summary Create Managed Client
|
|
18313
18313
|
* @param {ManagedClientRequest} managedClientRequest
|
|
18314
18314
|
* @param {*} [axiosOptions] Override http request option.
|
|
18315
18315
|
* @throws {RequiredError}
|
|
@@ -18328,9 +18328,9 @@ var ManagedClientsApiFp = function (configuration) {
|
|
|
18328
18328
|
});
|
|
18329
18329
|
},
|
|
18330
18330
|
/**
|
|
18331
|
-
* Delete an existing
|
|
18332
|
-
* @summary Delete
|
|
18333
|
-
* @param {string} id Managed
|
|
18331
|
+
* Delete an existing managed client.
|
|
18332
|
+
* @summary Delete Managed Client
|
|
18333
|
+
* @param {string} id Managed client ID.
|
|
18334
18334
|
* @param {*} [axiosOptions] Override http request option.
|
|
18335
18335
|
* @throws {RequiredError}
|
|
18336
18336
|
*/
|
|
@@ -18368,10 +18368,10 @@ var ManagedClientsApiFp = function (configuration) {
|
|
|
18368
18368
|
});
|
|
18369
18369
|
},
|
|
18370
18370
|
/**
|
|
18371
|
-
*
|
|
18372
|
-
* @summary Get Managed Client Status
|
|
18373
|
-
* @param {string} id
|
|
18374
|
-
* @param {ManagedClientType} type
|
|
18371
|
+
* Get a managed client\'s status, using its ID.
|
|
18372
|
+
* @summary Get Managed Client Status
|
|
18373
|
+
* @param {string} id Managed client ID to get status for.
|
|
18374
|
+
* @param {ManagedClientType} type Managed client type to get status for.
|
|
18375
18375
|
* @param {*} [axiosOptions] Override http request option.
|
|
18376
18376
|
* @throws {RequiredError}
|
|
18377
18377
|
*/
|
|
@@ -18389,7 +18389,7 @@ var ManagedClientsApiFp = function (configuration) {
|
|
|
18389
18389
|
});
|
|
18390
18390
|
},
|
|
18391
18391
|
/**
|
|
18392
|
-
*
|
|
18392
|
+
* List managed clients.
|
|
18393
18393
|
* @summary Get Managed Clients
|
|
18394
18394
|
* @param {number} [offset] Offset into the full result set. Usually specified with *limit* to paginate through the results. See [V3 API Standard Collection Parameters](https://developer.sailpoint.com/idn/api/standard-collection-parameters) for more information.
|
|
18395
18395
|
* @param {number} [limit] Max number of results to return. See [V3 API Standard Collection Parameters](https://developer.sailpoint.com/idn/api/standard-collection-parameters) for more information.
|
|
@@ -18412,10 +18412,10 @@ var ManagedClientsApiFp = function (configuration) {
|
|
|
18412
18412
|
});
|
|
18413
18413
|
},
|
|
18414
18414
|
/**
|
|
18415
|
-
* Update an existing
|
|
18416
|
-
* @summary Update
|
|
18417
|
-
* @param {string} id Managed
|
|
18418
|
-
* @param {Array<JsonPatchOperation>} jsonPatchOperation
|
|
18415
|
+
* Update an existing managed client.
|
|
18416
|
+
* @summary Update Managed Client
|
|
18417
|
+
* @param {string} id Managed client ID.
|
|
18418
|
+
* @param {Array<JsonPatchOperation>} jsonPatchOperation JSONPatch payload used to update the object.
|
|
18419
18419
|
* @param {*} [axiosOptions] Override http request option.
|
|
18420
18420
|
* @throws {RequiredError}
|
|
18421
18421
|
*/
|
|
@@ -18443,8 +18443,8 @@ var ManagedClientsApiFactory = function (configuration, basePath, axios) {
|
|
|
18443
18443
|
var localVarFp = (0, exports.ManagedClientsApiFp)(configuration);
|
|
18444
18444
|
return {
|
|
18445
18445
|
/**
|
|
18446
|
-
* Create a new
|
|
18447
|
-
* @summary Create
|
|
18446
|
+
* Create a new managed client. The API returns a result that includes the managed client ID.
|
|
18447
|
+
* @summary Create Managed Client
|
|
18448
18448
|
* @param {ManagedClientRequest} managedClientRequest
|
|
18449
18449
|
* @param {*} [axiosOptions] Override http request option.
|
|
18450
18450
|
* @throws {RequiredError}
|
|
@@ -18453,9 +18453,9 @@ var ManagedClientsApiFactory = function (configuration, basePath, axios) {
|
|
|
18453
18453
|
return localVarFp.createManagedClient(managedClientRequest, axiosOptions).then(function (request) { return request(axios, basePath); });
|
|
18454
18454
|
},
|
|
18455
18455
|
/**
|
|
18456
|
-
* Delete an existing
|
|
18457
|
-
* @summary Delete
|
|
18458
|
-
* @param {string} id Managed
|
|
18456
|
+
* Delete an existing managed client.
|
|
18457
|
+
* @summary Delete Managed Client
|
|
18458
|
+
* @param {string} id Managed client ID.
|
|
18459
18459
|
* @param {*} [axiosOptions] Override http request option.
|
|
18460
18460
|
* @throws {RequiredError}
|
|
18461
18461
|
*/
|
|
@@ -18473,10 +18473,10 @@ var ManagedClientsApiFactory = function (configuration, basePath, axios) {
|
|
|
18473
18473
|
return localVarFp.getManagedClient(id, axiosOptions).then(function (request) { return request(axios, basePath); });
|
|
18474
18474
|
},
|
|
18475
18475
|
/**
|
|
18476
|
-
*
|
|
18477
|
-
* @summary Get Managed Client Status
|
|
18478
|
-
* @param {string} id
|
|
18479
|
-
* @param {ManagedClientType} type
|
|
18476
|
+
* Get a managed client\'s status, using its ID.
|
|
18477
|
+
* @summary Get Managed Client Status
|
|
18478
|
+
* @param {string} id Managed client ID to get status for.
|
|
18479
|
+
* @param {ManagedClientType} type Managed client type to get status for.
|
|
18480
18480
|
* @param {*} [axiosOptions] Override http request option.
|
|
18481
18481
|
* @throws {RequiredError}
|
|
18482
18482
|
*/
|
|
@@ -18484,7 +18484,7 @@ var ManagedClientsApiFactory = function (configuration, basePath, axios) {
|
|
|
18484
18484
|
return localVarFp.getManagedClientStatus(id, type, axiosOptions).then(function (request) { return request(axios, basePath); });
|
|
18485
18485
|
},
|
|
18486
18486
|
/**
|
|
18487
|
-
*
|
|
18487
|
+
* List managed clients.
|
|
18488
18488
|
* @summary Get Managed Clients
|
|
18489
18489
|
* @param {number} [offset] Offset into the full result set. Usually specified with *limit* to paginate through the results. See [V3 API Standard Collection Parameters](https://developer.sailpoint.com/idn/api/standard-collection-parameters) for more information.
|
|
18490
18490
|
* @param {number} [limit] Max number of results to return. See [V3 API Standard Collection Parameters](https://developer.sailpoint.com/idn/api/standard-collection-parameters) for more information.
|
|
@@ -18497,10 +18497,10 @@ var ManagedClientsApiFactory = function (configuration, basePath, axios) {
|
|
|
18497
18497
|
return localVarFp.getManagedClients(offset, limit, count, filters, axiosOptions).then(function (request) { return request(axios, basePath); });
|
|
18498
18498
|
},
|
|
18499
18499
|
/**
|
|
18500
|
-
* Update an existing
|
|
18501
|
-
* @summary Update
|
|
18502
|
-
* @param {string} id Managed
|
|
18503
|
-
* @param {Array<JsonPatchOperation>} jsonPatchOperation
|
|
18500
|
+
* Update an existing managed client.
|
|
18501
|
+
* @summary Update Managed Client
|
|
18502
|
+
* @param {string} id Managed client ID.
|
|
18503
|
+
* @param {Array<JsonPatchOperation>} jsonPatchOperation JSONPatch payload used to update the object.
|
|
18504
18504
|
* @param {*} [axiosOptions] Override http request option.
|
|
18505
18505
|
* @throws {RequiredError}
|
|
18506
18506
|
*/
|
|
@@ -18522,8 +18522,8 @@ var ManagedClientsApi = /** @class */ (function (_super) {
|
|
|
18522
18522
|
return _super !== null && _super.apply(this, arguments) || this;
|
|
18523
18523
|
}
|
|
18524
18524
|
/**
|
|
18525
|
-
* Create a new
|
|
18526
|
-
* @summary Create
|
|
18525
|
+
* Create a new managed client. The API returns a result that includes the managed client ID.
|
|
18526
|
+
* @summary Create Managed Client
|
|
18527
18527
|
* @param {ManagedClientsApiCreateManagedClientRequest} requestParameters Request parameters.
|
|
18528
18528
|
* @param {*} [axiosOptions] Override http request option.
|
|
18529
18529
|
* @throws {RequiredError}
|
|
@@ -18534,8 +18534,8 @@ var ManagedClientsApi = /** @class */ (function (_super) {
|
|
|
18534
18534
|
return (0, exports.ManagedClientsApiFp)(this.configuration).createManagedClient(requestParameters.managedClientRequest, axiosOptions).then(function (request) { return request(_this.axios, _this.basePath); });
|
|
18535
18535
|
};
|
|
18536
18536
|
/**
|
|
18537
|
-
* Delete an existing
|
|
18538
|
-
* @summary Delete
|
|
18537
|
+
* Delete an existing managed client.
|
|
18538
|
+
* @summary Delete Managed Client
|
|
18539
18539
|
* @param {ManagedClientsApiDeleteManagedClientRequest} requestParameters Request parameters.
|
|
18540
18540
|
* @param {*} [axiosOptions] Override http request option.
|
|
18541
18541
|
* @throws {RequiredError}
|
|
@@ -18558,8 +18558,8 @@ var ManagedClientsApi = /** @class */ (function (_super) {
|
|
|
18558
18558
|
return (0, exports.ManagedClientsApiFp)(this.configuration).getManagedClient(requestParameters.id, axiosOptions).then(function (request) { return request(_this.axios, _this.basePath); });
|
|
18559
18559
|
};
|
|
18560
18560
|
/**
|
|
18561
|
-
*
|
|
18562
|
-
* @summary Get Managed Client Status
|
|
18561
|
+
* Get a managed client\'s status, using its ID.
|
|
18562
|
+
* @summary Get Managed Client Status
|
|
18563
18563
|
* @param {ManagedClientsApiGetManagedClientStatusRequest} requestParameters Request parameters.
|
|
18564
18564
|
* @param {*} [axiosOptions] Override http request option.
|
|
18565
18565
|
* @throws {RequiredError}
|
|
@@ -18570,7 +18570,7 @@ var ManagedClientsApi = /** @class */ (function (_super) {
|
|
|
18570
18570
|
return (0, exports.ManagedClientsApiFp)(this.configuration).getManagedClientStatus(requestParameters.id, requestParameters.type, axiosOptions).then(function (request) { return request(_this.axios, _this.basePath); });
|
|
18571
18571
|
};
|
|
18572
18572
|
/**
|
|
18573
|
-
*
|
|
18573
|
+
* List managed clients.
|
|
18574
18574
|
* @summary Get Managed Clients
|
|
18575
18575
|
* @param {ManagedClientsApiGetManagedClientsRequest} requestParameters Request parameters.
|
|
18576
18576
|
* @param {*} [axiosOptions] Override http request option.
|
|
@@ -18583,8 +18583,8 @@ var ManagedClientsApi = /** @class */ (function (_super) {
|
|
|
18583
18583
|
return (0, exports.ManagedClientsApiFp)(this.configuration).getManagedClients(requestParameters.offset, requestParameters.limit, requestParameters.count, requestParameters.filters, axiosOptions).then(function (request) { return request(_this.axios, _this.basePath); });
|
|
18584
18584
|
};
|
|
18585
18585
|
/**
|
|
18586
|
-
* Update an existing
|
|
18587
|
-
* @summary Update
|
|
18586
|
+
* Update an existing managed client.
|
|
18587
|
+
* @summary Update Managed Client
|
|
18588
18588
|
* @param {ManagedClientsApiUpdateManagedClientRequest} requestParameters Request parameters.
|
|
18589
18589
|
* @param {*} [axiosOptions] Override http request option.
|
|
18590
18590
|
* @throws {RequiredError}
|
|
@@ -23836,7 +23836,7 @@ var PasswordManagementApiAxiosParamCreator = function (configuration) {
|
|
|
23836
23836
|
});
|
|
23837
23837
|
},
|
|
23838
23838
|
/**
|
|
23839
|
-
* 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 ISC 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). >**Note: If you want to set an identity\'s source account password, you must enable `PASSWORD` as one of the source\'s features. You can use the [PATCH Source endpoint](https://developer.sailpoint.com/docs/api/v3/update-source) to add the `PASSWORD` feature.**
|
|
23839
|
+
* 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 ISC 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). >**Note: If you want to set an identity\'s source account password, you must enable `PASSWORD` as one of the source\'s features. You can use the [PATCH Source endpoint](https://developer.sailpoint.com/docs/api/v3/update-source) to add the `PASSWORD` feature.** To generate the encryptedPassword (RSA encrypted using publicKey) for the request body, run the following command: ```bash echo \"myPassword\" | openssl pkeyutl -encrypt -inkey public_key.pem -pubin | base64 ``` In this example, myPassword is the plain text password being set and encrypted, and public_key.pem is the path to the public key file. You can retrieve the required publicKey, along with other information like identityId, sourceId, publicKeyId, accounts, and policies, using the Query Password Info endpoint. To successfully run this command, you must have OpenSSL installed on your machine. If OpenSSL is unavailable, consider using the Virtual Appliance (VA), which has OpenSSL pre-installed and configured. If you are using a Windows machine, refer to this [guide](https://tecadmin.net/install-openssl-on-windows/) for instructions on installing OpenSSL. 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.
|
|
23840
23840
|
* @summary Set Identity\'s Password
|
|
23841
23841
|
* @param {PasswordChangeRequest} passwordChangeRequest
|
|
23842
23842
|
* @param {*} [axiosOptions] Override http request option.
|
|
@@ -23930,7 +23930,7 @@ var PasswordManagementApiFp = function (configuration) {
|
|
|
23930
23930
|
});
|
|
23931
23931
|
},
|
|
23932
23932
|
/**
|
|
23933
|
-
* 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 ISC 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). >**Note: If you want to set an identity\'s source account password, you must enable `PASSWORD` as one of the source\'s features. You can use the [PATCH Source endpoint](https://developer.sailpoint.com/docs/api/v3/update-source) to add the `PASSWORD` feature.**
|
|
23933
|
+
* 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 ISC 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). >**Note: If you want to set an identity\'s source account password, you must enable `PASSWORD` as one of the source\'s features. You can use the [PATCH Source endpoint](https://developer.sailpoint.com/docs/api/v3/update-source) to add the `PASSWORD` feature.** To generate the encryptedPassword (RSA encrypted using publicKey) for the request body, run the following command: ```bash echo \"myPassword\" | openssl pkeyutl -encrypt -inkey public_key.pem -pubin | base64 ``` In this example, myPassword is the plain text password being set and encrypted, and public_key.pem is the path to the public key file. You can retrieve the required publicKey, along with other information like identityId, sourceId, publicKeyId, accounts, and policies, using the Query Password Info endpoint. To successfully run this command, you must have OpenSSL installed on your machine. If OpenSSL is unavailable, consider using the Virtual Appliance (VA), which has OpenSSL pre-installed and configured. If you are using a Windows machine, refer to this [guide](https://tecadmin.net/install-openssl-on-windows/) for instructions on installing OpenSSL. 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.
|
|
23934
23934
|
* @summary Set Identity\'s Password
|
|
23935
23935
|
* @param {PasswordChangeRequest} passwordChangeRequest
|
|
23936
23936
|
* @param {*} [axiosOptions] Override http request option.
|
|
@@ -23980,7 +23980,7 @@ var PasswordManagementApiFactory = function (configuration, basePath, axios) {
|
|
|
23980
23980
|
return localVarFp.queryPasswordInfo(passwordInfoQueryDTO, axiosOptions).then(function (request) { return request(axios, basePath); });
|
|
23981
23981
|
},
|
|
23982
23982
|
/**
|
|
23983
|
-
* 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 ISC 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). >**Note: If you want to set an identity\'s source account password, you must enable `PASSWORD` as one of the source\'s features. You can use the [PATCH Source endpoint](https://developer.sailpoint.com/docs/api/v3/update-source) to add the `PASSWORD` feature.**
|
|
23983
|
+
* 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 ISC 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). >**Note: If you want to set an identity\'s source account password, you must enable `PASSWORD` as one of the source\'s features. You can use the [PATCH Source endpoint](https://developer.sailpoint.com/docs/api/v3/update-source) to add the `PASSWORD` feature.** To generate the encryptedPassword (RSA encrypted using publicKey) for the request body, run the following command: ```bash echo \"myPassword\" | openssl pkeyutl -encrypt -inkey public_key.pem -pubin | base64 ``` In this example, myPassword is the plain text password being set and encrypted, and public_key.pem is the path to the public key file. You can retrieve the required publicKey, along with other information like identityId, sourceId, publicKeyId, accounts, and policies, using the Query Password Info endpoint. To successfully run this command, you must have OpenSSL installed on your machine. If OpenSSL is unavailable, consider using the Virtual Appliance (VA), which has OpenSSL pre-installed and configured. If you are using a Windows machine, refer to this [guide](https://tecadmin.net/install-openssl-on-windows/) for instructions on installing OpenSSL. 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.
|
|
23984
23984
|
* @summary Set Identity\'s Password
|
|
23985
23985
|
* @param {PasswordChangeRequest} passwordChangeRequest
|
|
23986
23986
|
* @param {*} [axiosOptions] Override http request option.
|
|
@@ -24028,7 +24028,7 @@ var PasswordManagementApi = /** @class */ (function (_super) {
|
|
|
24028
24028
|
return (0, exports.PasswordManagementApiFp)(this.configuration).queryPasswordInfo(requestParameters.passwordInfoQueryDTO, axiosOptions).then(function (request) { return request(_this.axios, _this.basePath); });
|
|
24029
24029
|
};
|
|
24030
24030
|
/**
|
|
24031
|
-
* 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 ISC 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). >**Note: If you want to set an identity\'s source account password, you must enable `PASSWORD` as one of the source\'s features. You can use the [PATCH Source endpoint](https://developer.sailpoint.com/docs/api/v3/update-source) to add the `PASSWORD` feature.**
|
|
24031
|
+
* 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 ISC 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). >**Note: If you want to set an identity\'s source account password, you must enable `PASSWORD` as one of the source\'s features. You can use the [PATCH Source endpoint](https://developer.sailpoint.com/docs/api/v3/update-source) to add the `PASSWORD` feature.** To generate the encryptedPassword (RSA encrypted using publicKey) for the request body, run the following command: ```bash echo \"myPassword\" | openssl pkeyutl -encrypt -inkey public_key.pem -pubin | base64 ``` In this example, myPassword is the plain text password being set and encrypted, and public_key.pem is the path to the public key file. You can retrieve the required publicKey, along with other information like identityId, sourceId, publicKeyId, accounts, and policies, using the Query Password Info endpoint. To successfully run this command, you must have OpenSSL installed on your machine. If OpenSSL is unavailable, consider using the Virtual Appliance (VA), which has OpenSSL pre-installed and configured. If you are using a Windows machine, refer to this [guide](https://tecadmin.net/install-openssl-on-windows/) for instructions on installing OpenSSL. 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.
|
|
24032
24032
|
* @summary Set Identity\'s Password
|
|
24033
24033
|
* @param {PasswordManagementApiSetPasswordRequest} requestParameters Request parameters.
|
|
24034
24034
|
* @param {*} [axiosOptions] Override http request option.
|
|
@@ -30887,7 +30887,7 @@ var SearchApiAxiosParamCreator = function (configuration) {
|
|
|
30887
30887
|
});
|
|
30888
30888
|
},
|
|
30889
30889
|
/**
|
|
30890
|
-
*
|
|
30890
|
+
* Perform a search with the provided query and return a matching result collection. To page past 10,000 records, you can use `searchAfter` paging. Refer to [Paginating Search Queries](https://developer.sailpoint.com/idn/api/standard-collection-parameters#paginating-search-queries) for more information about how to implement `searchAfter` paging.
|
|
30891
30891
|
* @summary Perform Search
|
|
30892
30892
|
* @param {Search} search
|
|
30893
30893
|
* @param {number} [offset] Offset into the full result set. Usually specified with *limit* to paginate through the results. See [V3 API Standard Collection Parameters](https://developer.sailpoint.com/idn/api/standard-collection-parameters) for more information.
|
|
@@ -31027,7 +31027,7 @@ var SearchApiFp = function (configuration) {
|
|
|
31027
31027
|
});
|
|
31028
31028
|
},
|
|
31029
31029
|
/**
|
|
31030
|
-
*
|
|
31030
|
+
* Perform a search with the provided query and return a matching result collection. To page past 10,000 records, you can use `searchAfter` paging. Refer to [Paginating Search Queries](https://developer.sailpoint.com/idn/api/standard-collection-parameters#paginating-search-queries) for more information about how to implement `searchAfter` paging.
|
|
31031
31031
|
* @summary Perform Search
|
|
31032
31032
|
* @param {Search} search
|
|
31033
31033
|
* @param {number} [offset] Offset into the full result set. Usually specified with *limit* to paginate through the results. See [V3 API Standard Collection Parameters](https://developer.sailpoint.com/idn/api/standard-collection-parameters) for more information.
|
|
@@ -31094,7 +31094,7 @@ var SearchApiFactory = function (configuration, basePath, axios) {
|
|
|
31094
31094
|
return localVarFp.searchGet(index, id, axiosOptions).then(function (request) { return request(axios, basePath); });
|
|
31095
31095
|
},
|
|
31096
31096
|
/**
|
|
31097
|
-
*
|
|
31097
|
+
* Perform a search with the provided query and return a matching result collection. To page past 10,000 records, you can use `searchAfter` paging. Refer to [Paginating Search Queries](https://developer.sailpoint.com/idn/api/standard-collection-parameters#paginating-search-queries) for more information about how to implement `searchAfter` paging.
|
|
31098
31098
|
* @summary Perform Search
|
|
31099
31099
|
* @param {Search} search
|
|
31100
31100
|
* @param {number} [offset] Offset into the full result set. Usually specified with *limit* to paginate through the results. See [V3 API Standard Collection Parameters](https://developer.sailpoint.com/idn/api/standard-collection-parameters) for more information.
|
|
@@ -31157,7 +31157,7 @@ var SearchApi = /** @class */ (function (_super) {
|
|
|
31157
31157
|
return (0, exports.SearchApiFp)(this.configuration).searchGet(requestParameters.index, requestParameters.id, axiosOptions).then(function (request) { return request(_this.axios, _this.basePath); });
|
|
31158
31158
|
};
|
|
31159
31159
|
/**
|
|
31160
|
-
*
|
|
31160
|
+
* Perform a search with the provided query and return a matching result collection. To page past 10,000 records, you can use `searchAfter` paging. Refer to [Paginating Search Queries](https://developer.sailpoint.com/idn/api/standard-collection-parameters#paginating-search-queries) for more information about how to implement `searchAfter` paging.
|
|
31161
31161
|
* @summary Perform Search
|
|
31162
31162
|
* @param {SearchApiSearchPostRequest} requestParameters Request parameters.
|
|
31163
31163
|
* @param {*} [axiosOptions] Override http request option.
|