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/v2024/common.js
CHANGED
|
@@ -241,7 +241,7 @@ var createRequestFunction = function (axiosArgs, globalAxios, BASE_PATH, configu
|
|
|
241
241
|
if (axios === void 0) { axios = globalAxios; }
|
|
242
242
|
if (basePath === void 0) { basePath = BASE_PATH; }
|
|
243
243
|
(0, axios_retry_1.default)(globalAxios, configuration.retriesConfig);
|
|
244
|
-
var headers = __assign(__assign({ 'User-Agent': 'OpenAPI-Generator/1.4.
|
|
244
|
+
var headers = __assign(__assign({ 'User-Agent': 'OpenAPI-Generator/1.4.12/ts' }, axiosArgs.axiosOptions.headers), { 'X-SailPoint-SDK': 'typescript-1.4.12' });
|
|
245
245
|
if (!configuration.experimental && ("X-SailPoint-Experimental" in headers)) {
|
|
246
246
|
throw new Error("You are using Experimental APIs. Set configuration.experimental = True to enable these APIs in the SDK.");
|
|
247
247
|
}
|
package/dist/v3/api.d.ts
CHANGED
|
@@ -8455,6 +8455,12 @@ export interface EventAttributes {
|
|
|
8455
8455
|
* @memberof EventAttributes
|
|
8456
8456
|
*/
|
|
8457
8457
|
'description'?: string;
|
|
8458
|
+
/**
|
|
8459
|
+
* The attribute to filter on
|
|
8460
|
+
* @type {string}
|
|
8461
|
+
* @memberof EventAttributes
|
|
8462
|
+
*/
|
|
8463
|
+
'attributeToFilter'?: string;
|
|
8458
8464
|
}
|
|
8459
8465
|
/**
|
|
8460
8466
|
* Event
|
|
@@ -24203,6 +24209,12 @@ export interface WorkflowTriggerAttributes {
|
|
|
24203
24209
|
* @memberof WorkflowTriggerAttributes
|
|
24204
24210
|
*/
|
|
24205
24211
|
'description'?: string;
|
|
24212
|
+
/**
|
|
24213
|
+
* The attribute to filter on
|
|
24214
|
+
* @type {string}
|
|
24215
|
+
* @memberof WorkflowTriggerAttributes
|
|
24216
|
+
*/
|
|
24217
|
+
'attributeToFilter'?: string;
|
|
24206
24218
|
/**
|
|
24207
24219
|
* A unique name for the external trigger
|
|
24208
24220
|
* @type {string}
|
|
@@ -32902,17 +32914,17 @@ export declare class MFAControllerApi extends BaseAPI {
|
|
|
32902
32914
|
*/
|
|
32903
32915
|
export declare const ManagedClientsApiAxiosParamCreator: (configuration?: Configuration) => {
|
|
32904
32916
|
/**
|
|
32905
|
-
* Create a new
|
|
32906
|
-
* @summary Create
|
|
32917
|
+
* Create a new managed client. The API returns a result that includes the managed client ID.
|
|
32918
|
+
* @summary Create Managed Client
|
|
32907
32919
|
* @param {ManagedClientRequest} managedClientRequest
|
|
32908
32920
|
* @param {*} [axiosOptions] Override http request option.
|
|
32909
32921
|
* @throws {RequiredError}
|
|
32910
32922
|
*/
|
|
32911
32923
|
createManagedClient: (managedClientRequest: ManagedClientRequest, axiosOptions?: AxiosRequestConfig) => Promise<RequestArgs>;
|
|
32912
32924
|
/**
|
|
32913
|
-
* Delete an existing
|
|
32914
|
-
* @summary Delete
|
|
32915
|
-
* @param {string} id Managed
|
|
32925
|
+
* Delete an existing managed client.
|
|
32926
|
+
* @summary Delete Managed Client
|
|
32927
|
+
* @param {string} id Managed client ID.
|
|
32916
32928
|
* @param {*} [axiosOptions] Override http request option.
|
|
32917
32929
|
* @throws {RequiredError}
|
|
32918
32930
|
*/
|
|
@@ -32926,16 +32938,16 @@ export declare const ManagedClientsApiAxiosParamCreator: (configuration?: Config
|
|
|
32926
32938
|
*/
|
|
32927
32939
|
getManagedClient: (id: string, axiosOptions?: AxiosRequestConfig) => Promise<RequestArgs>;
|
|
32928
32940
|
/**
|
|
32929
|
-
*
|
|
32930
|
-
* @summary Get Managed Client Status
|
|
32931
|
-
* @param {string} id
|
|
32932
|
-
* @param {ManagedClientType} type
|
|
32941
|
+
* Get a managed client\'s status, using its ID.
|
|
32942
|
+
* @summary Get Managed Client Status
|
|
32943
|
+
* @param {string} id Managed client ID to get status for.
|
|
32944
|
+
* @param {ManagedClientType} type Managed client type to get status for.
|
|
32933
32945
|
* @param {*} [axiosOptions] Override http request option.
|
|
32934
32946
|
* @throws {RequiredError}
|
|
32935
32947
|
*/
|
|
32936
32948
|
getManagedClientStatus: (id: string, type: ManagedClientType, axiosOptions?: AxiosRequestConfig) => Promise<RequestArgs>;
|
|
32937
32949
|
/**
|
|
32938
|
-
*
|
|
32950
|
+
* List managed clients.
|
|
32939
32951
|
* @summary Get Managed Clients
|
|
32940
32952
|
* @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.
|
|
32941
32953
|
* @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.
|
|
@@ -32946,10 +32958,10 @@ export declare const ManagedClientsApiAxiosParamCreator: (configuration?: Config
|
|
|
32946
32958
|
*/
|
|
32947
32959
|
getManagedClients: (offset?: number, limit?: number, count?: boolean, filters?: string, axiosOptions?: AxiosRequestConfig) => Promise<RequestArgs>;
|
|
32948
32960
|
/**
|
|
32949
|
-
* Update an existing
|
|
32950
|
-
* @summary Update
|
|
32951
|
-
* @param {string} id Managed
|
|
32952
|
-
* @param {Array<JsonPatchOperation>} jsonPatchOperation
|
|
32961
|
+
* Update an existing managed client.
|
|
32962
|
+
* @summary Update Managed Client
|
|
32963
|
+
* @param {string} id Managed client ID.
|
|
32964
|
+
* @param {Array<JsonPatchOperation>} jsonPatchOperation JSONPatch payload used to update the object.
|
|
32953
32965
|
* @param {*} [axiosOptions] Override http request option.
|
|
32954
32966
|
* @throws {RequiredError}
|
|
32955
32967
|
*/
|
|
@@ -32961,17 +32973,17 @@ export declare const ManagedClientsApiAxiosParamCreator: (configuration?: Config
|
|
|
32961
32973
|
*/
|
|
32962
32974
|
export declare const ManagedClientsApiFp: (configuration?: Configuration) => {
|
|
32963
32975
|
/**
|
|
32964
|
-
* Create a new
|
|
32965
|
-
* @summary Create
|
|
32976
|
+
* Create a new managed client. The API returns a result that includes the managed client ID.
|
|
32977
|
+
* @summary Create Managed Client
|
|
32966
32978
|
* @param {ManagedClientRequest} managedClientRequest
|
|
32967
32979
|
* @param {*} [axiosOptions] Override http request option.
|
|
32968
32980
|
* @throws {RequiredError}
|
|
32969
32981
|
*/
|
|
32970
32982
|
createManagedClient(managedClientRequest: ManagedClientRequest, axiosOptions?: AxiosRequestConfig): Promise<(axios?: AxiosInstance, basePath?: string) => AxiosPromise<ManagedClient>>;
|
|
32971
32983
|
/**
|
|
32972
|
-
* Delete an existing
|
|
32973
|
-
* @summary Delete
|
|
32974
|
-
* @param {string} id Managed
|
|
32984
|
+
* Delete an existing managed client.
|
|
32985
|
+
* @summary Delete Managed Client
|
|
32986
|
+
* @param {string} id Managed client ID.
|
|
32975
32987
|
* @param {*} [axiosOptions] Override http request option.
|
|
32976
32988
|
* @throws {RequiredError}
|
|
32977
32989
|
*/
|
|
@@ -32985,16 +32997,16 @@ export declare const ManagedClientsApiFp: (configuration?: Configuration) => {
|
|
|
32985
32997
|
*/
|
|
32986
32998
|
getManagedClient(id: string, axiosOptions?: AxiosRequestConfig): Promise<(axios?: AxiosInstance, basePath?: string) => AxiosPromise<ManagedClient>>;
|
|
32987
32999
|
/**
|
|
32988
|
-
*
|
|
32989
|
-
* @summary Get Managed Client Status
|
|
32990
|
-
* @param {string} id
|
|
32991
|
-
* @param {ManagedClientType} type
|
|
33000
|
+
* Get a managed client\'s status, using its ID.
|
|
33001
|
+
* @summary Get Managed Client Status
|
|
33002
|
+
* @param {string} id Managed client ID to get status for.
|
|
33003
|
+
* @param {ManagedClientType} type Managed client type to get status for.
|
|
32992
33004
|
* @param {*} [axiosOptions] Override http request option.
|
|
32993
33005
|
* @throws {RequiredError}
|
|
32994
33006
|
*/
|
|
32995
33007
|
getManagedClientStatus(id: string, type: ManagedClientType, axiosOptions?: AxiosRequestConfig): Promise<(axios?: AxiosInstance, basePath?: string) => AxiosPromise<ManagedClientStatus>>;
|
|
32996
33008
|
/**
|
|
32997
|
-
*
|
|
33009
|
+
* List managed clients.
|
|
32998
33010
|
* @summary Get Managed Clients
|
|
32999
33011
|
* @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.
|
|
33000
33012
|
* @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.
|
|
@@ -33005,10 +33017,10 @@ export declare const ManagedClientsApiFp: (configuration?: Configuration) => {
|
|
|
33005
33017
|
*/
|
|
33006
33018
|
getManagedClients(offset?: number, limit?: number, count?: boolean, filters?: string, axiosOptions?: AxiosRequestConfig): Promise<(axios?: AxiosInstance, basePath?: string) => AxiosPromise<Array<ManagedClient>>>;
|
|
33007
33019
|
/**
|
|
33008
|
-
* Update an existing
|
|
33009
|
-
* @summary Update
|
|
33010
|
-
* @param {string} id Managed
|
|
33011
|
-
* @param {Array<JsonPatchOperation>} jsonPatchOperation
|
|
33020
|
+
* Update an existing managed client.
|
|
33021
|
+
* @summary Update Managed Client
|
|
33022
|
+
* @param {string} id Managed client ID.
|
|
33023
|
+
* @param {Array<JsonPatchOperation>} jsonPatchOperation JSONPatch payload used to update the object.
|
|
33012
33024
|
* @param {*} [axiosOptions] Override http request option.
|
|
33013
33025
|
* @throws {RequiredError}
|
|
33014
33026
|
*/
|
|
@@ -33020,17 +33032,17 @@ export declare const ManagedClientsApiFp: (configuration?: Configuration) => {
|
|
|
33020
33032
|
*/
|
|
33021
33033
|
export declare const ManagedClientsApiFactory: (configuration?: Configuration, basePath?: string, axios?: AxiosInstance) => {
|
|
33022
33034
|
/**
|
|
33023
|
-
* Create a new
|
|
33024
|
-
* @summary Create
|
|
33035
|
+
* Create a new managed client. The API returns a result that includes the managed client ID.
|
|
33036
|
+
* @summary Create Managed Client
|
|
33025
33037
|
* @param {ManagedClientRequest} managedClientRequest
|
|
33026
33038
|
* @param {*} [axiosOptions] Override http request option.
|
|
33027
33039
|
* @throws {RequiredError}
|
|
33028
33040
|
*/
|
|
33029
33041
|
createManagedClient(managedClientRequest: ManagedClientRequest, axiosOptions?: any): AxiosPromise<ManagedClient>;
|
|
33030
33042
|
/**
|
|
33031
|
-
* Delete an existing
|
|
33032
|
-
* @summary Delete
|
|
33033
|
-
* @param {string} id Managed
|
|
33043
|
+
* Delete an existing managed client.
|
|
33044
|
+
* @summary Delete Managed Client
|
|
33045
|
+
* @param {string} id Managed client ID.
|
|
33034
33046
|
* @param {*} [axiosOptions] Override http request option.
|
|
33035
33047
|
* @throws {RequiredError}
|
|
33036
33048
|
*/
|
|
@@ -33044,16 +33056,16 @@ export declare const ManagedClientsApiFactory: (configuration?: Configuration, b
|
|
|
33044
33056
|
*/
|
|
33045
33057
|
getManagedClient(id: string, axiosOptions?: any): AxiosPromise<ManagedClient>;
|
|
33046
33058
|
/**
|
|
33047
|
-
*
|
|
33048
|
-
* @summary Get Managed Client Status
|
|
33049
|
-
* @param {string} id
|
|
33050
|
-
* @param {ManagedClientType} type
|
|
33059
|
+
* Get a managed client\'s status, using its ID.
|
|
33060
|
+
* @summary Get Managed Client Status
|
|
33061
|
+
* @param {string} id Managed client ID to get status for.
|
|
33062
|
+
* @param {ManagedClientType} type Managed client type to get status for.
|
|
33051
33063
|
* @param {*} [axiosOptions] Override http request option.
|
|
33052
33064
|
* @throws {RequiredError}
|
|
33053
33065
|
*/
|
|
33054
33066
|
getManagedClientStatus(id: string, type: ManagedClientType, axiosOptions?: any): AxiosPromise<ManagedClientStatus>;
|
|
33055
33067
|
/**
|
|
33056
|
-
*
|
|
33068
|
+
* List managed clients.
|
|
33057
33069
|
* @summary Get Managed Clients
|
|
33058
33070
|
* @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.
|
|
33059
33071
|
* @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.
|
|
@@ -33064,10 +33076,10 @@ export declare const ManagedClientsApiFactory: (configuration?: Configuration, b
|
|
|
33064
33076
|
*/
|
|
33065
33077
|
getManagedClients(offset?: number, limit?: number, count?: boolean, filters?: string, axiosOptions?: any): AxiosPromise<Array<ManagedClient>>;
|
|
33066
33078
|
/**
|
|
33067
|
-
* Update an existing
|
|
33068
|
-
* @summary Update
|
|
33069
|
-
* @param {string} id Managed
|
|
33070
|
-
* @param {Array<JsonPatchOperation>} jsonPatchOperation
|
|
33079
|
+
* Update an existing managed client.
|
|
33080
|
+
* @summary Update Managed Client
|
|
33081
|
+
* @param {string} id Managed client ID.
|
|
33082
|
+
* @param {Array<JsonPatchOperation>} jsonPatchOperation JSONPatch payload used to update the object.
|
|
33071
33083
|
* @param {*} [axiosOptions] Override http request option.
|
|
33072
33084
|
* @throws {RequiredError}
|
|
33073
33085
|
*/
|
|
@@ -33093,7 +33105,7 @@ export interface ManagedClientsApiCreateManagedClientRequest {
|
|
|
33093
33105
|
*/
|
|
33094
33106
|
export interface ManagedClientsApiDeleteManagedClientRequest {
|
|
33095
33107
|
/**
|
|
33096
|
-
* Managed
|
|
33108
|
+
* Managed client ID.
|
|
33097
33109
|
* @type {string}
|
|
33098
33110
|
* @memberof ManagedClientsApiDeleteManagedClient
|
|
33099
33111
|
*/
|
|
@@ -33119,13 +33131,13 @@ export interface ManagedClientsApiGetManagedClientRequest {
|
|
|
33119
33131
|
*/
|
|
33120
33132
|
export interface ManagedClientsApiGetManagedClientStatusRequest {
|
|
33121
33133
|
/**
|
|
33122
|
-
*
|
|
33134
|
+
* Managed client ID to get status for.
|
|
33123
33135
|
* @type {string}
|
|
33124
33136
|
* @memberof ManagedClientsApiGetManagedClientStatus
|
|
33125
33137
|
*/
|
|
33126
33138
|
readonly id: string;
|
|
33127
33139
|
/**
|
|
33128
|
-
*
|
|
33140
|
+
* Managed client type to get status for.
|
|
33129
33141
|
* @type {ManagedClientType}
|
|
33130
33142
|
* @memberof ManagedClientsApiGetManagedClientStatus
|
|
33131
33143
|
*/
|
|
@@ -33169,13 +33181,13 @@ export interface ManagedClientsApiGetManagedClientsRequest {
|
|
|
33169
33181
|
*/
|
|
33170
33182
|
export interface ManagedClientsApiUpdateManagedClientRequest {
|
|
33171
33183
|
/**
|
|
33172
|
-
* Managed
|
|
33184
|
+
* Managed client ID.
|
|
33173
33185
|
* @type {string}
|
|
33174
33186
|
* @memberof ManagedClientsApiUpdateManagedClient
|
|
33175
33187
|
*/
|
|
33176
33188
|
readonly id: string;
|
|
33177
33189
|
/**
|
|
33178
|
-
*
|
|
33190
|
+
* JSONPatch payload used to update the object.
|
|
33179
33191
|
* @type {Array<JsonPatchOperation>}
|
|
33180
33192
|
* @memberof ManagedClientsApiUpdateManagedClient
|
|
33181
33193
|
*/
|
|
@@ -33189,8 +33201,8 @@ export interface ManagedClientsApiUpdateManagedClientRequest {
|
|
|
33189
33201
|
*/
|
|
33190
33202
|
export declare class ManagedClientsApi extends BaseAPI {
|
|
33191
33203
|
/**
|
|
33192
|
-
* Create a new
|
|
33193
|
-
* @summary Create
|
|
33204
|
+
* Create a new managed client. The API returns a result that includes the managed client ID.
|
|
33205
|
+
* @summary Create Managed Client
|
|
33194
33206
|
* @param {ManagedClientsApiCreateManagedClientRequest} requestParameters Request parameters.
|
|
33195
33207
|
* @param {*} [axiosOptions] Override http request option.
|
|
33196
33208
|
* @throws {RequiredError}
|
|
@@ -33198,8 +33210,8 @@ export declare class ManagedClientsApi extends BaseAPI {
|
|
|
33198
33210
|
*/
|
|
33199
33211
|
createManagedClient(requestParameters: ManagedClientsApiCreateManagedClientRequest, axiosOptions?: AxiosRequestConfig): Promise<import("axios").AxiosResponse<ManagedClient, any>>;
|
|
33200
33212
|
/**
|
|
33201
|
-
* Delete an existing
|
|
33202
|
-
* @summary Delete
|
|
33213
|
+
* Delete an existing managed client.
|
|
33214
|
+
* @summary Delete Managed Client
|
|
33203
33215
|
* @param {ManagedClientsApiDeleteManagedClientRequest} requestParameters Request parameters.
|
|
33204
33216
|
* @param {*} [axiosOptions] Override http request option.
|
|
33205
33217
|
* @throws {RequiredError}
|
|
@@ -33216,8 +33228,8 @@ export declare class ManagedClientsApi extends BaseAPI {
|
|
|
33216
33228
|
*/
|
|
33217
33229
|
getManagedClient(requestParameters: ManagedClientsApiGetManagedClientRequest, axiosOptions?: AxiosRequestConfig): Promise<import("axios").AxiosResponse<ManagedClient, any>>;
|
|
33218
33230
|
/**
|
|
33219
|
-
*
|
|
33220
|
-
* @summary Get Managed Client Status
|
|
33231
|
+
* Get a managed client\'s status, using its ID.
|
|
33232
|
+
* @summary Get Managed Client Status
|
|
33221
33233
|
* @param {ManagedClientsApiGetManagedClientStatusRequest} requestParameters Request parameters.
|
|
33222
33234
|
* @param {*} [axiosOptions] Override http request option.
|
|
33223
33235
|
* @throws {RequiredError}
|
|
@@ -33225,7 +33237,7 @@ export declare class ManagedClientsApi extends BaseAPI {
|
|
|
33225
33237
|
*/
|
|
33226
33238
|
getManagedClientStatus(requestParameters: ManagedClientsApiGetManagedClientStatusRequest, axiosOptions?: AxiosRequestConfig): Promise<import("axios").AxiosResponse<ManagedClientStatus, any>>;
|
|
33227
33239
|
/**
|
|
33228
|
-
*
|
|
33240
|
+
* List managed clients.
|
|
33229
33241
|
* @summary Get Managed Clients
|
|
33230
33242
|
* @param {ManagedClientsApiGetManagedClientsRequest} requestParameters Request parameters.
|
|
33231
33243
|
* @param {*} [axiosOptions] Override http request option.
|
|
@@ -33234,8 +33246,8 @@ export declare class ManagedClientsApi extends BaseAPI {
|
|
|
33234
33246
|
*/
|
|
33235
33247
|
getManagedClients(requestParameters?: ManagedClientsApiGetManagedClientsRequest, axiosOptions?: AxiosRequestConfig): Promise<import("axios").AxiosResponse<ManagedClient[], any>>;
|
|
33236
33248
|
/**
|
|
33237
|
-
* Update an existing
|
|
33238
|
-
* @summary Update
|
|
33249
|
+
* Update an existing managed client.
|
|
33250
|
+
* @summary Update Managed Client
|
|
33239
33251
|
* @param {ManagedClientsApiUpdateManagedClientRequest} requestParameters Request parameters.
|
|
33240
33252
|
* @param {*} [axiosOptions] Override http request option.
|
|
33241
33253
|
* @throws {RequiredError}
|
|
@@ -35957,7 +35969,7 @@ export declare const PasswordManagementApiAxiosParamCreator: (configuration?: Co
|
|
|
35957
35969
|
*/
|
|
35958
35970
|
queryPasswordInfo: (passwordInfoQueryDTO: PasswordInfoQueryDTO, axiosOptions?: AxiosRequestConfig) => Promise<RequestArgs>;
|
|
35959
35971
|
/**
|
|
35960
|
-
* 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.**
|
|
35972
|
+
* 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.
|
|
35961
35973
|
* @summary Set Identity\'s Password
|
|
35962
35974
|
* @param {PasswordChangeRequest} passwordChangeRequest
|
|
35963
35975
|
* @param {*} [axiosOptions] Override http request option.
|
|
@@ -35987,7 +35999,7 @@ export declare const PasswordManagementApiFp: (configuration?: Configuration) =>
|
|
|
35987
35999
|
*/
|
|
35988
36000
|
queryPasswordInfo(passwordInfoQueryDTO: PasswordInfoQueryDTO, axiosOptions?: AxiosRequestConfig): Promise<(axios?: AxiosInstance, basePath?: string) => AxiosPromise<PasswordInfo>>;
|
|
35989
36001
|
/**
|
|
35990
|
-
* 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.**
|
|
36002
|
+
* 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.
|
|
35991
36003
|
* @summary Set Identity\'s Password
|
|
35992
36004
|
* @param {PasswordChangeRequest} passwordChangeRequest
|
|
35993
36005
|
* @param {*} [axiosOptions] Override http request option.
|
|
@@ -36017,7 +36029,7 @@ export declare const PasswordManagementApiFactory: (configuration?: Configuratio
|
|
|
36017
36029
|
*/
|
|
36018
36030
|
queryPasswordInfo(passwordInfoQueryDTO: PasswordInfoQueryDTO, axiosOptions?: any): AxiosPromise<PasswordInfo>;
|
|
36019
36031
|
/**
|
|
36020
|
-
* 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.**
|
|
36032
|
+
* 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.
|
|
36021
36033
|
* @summary Set Identity\'s Password
|
|
36022
36034
|
* @param {PasswordChangeRequest} passwordChangeRequest
|
|
36023
36035
|
* @param {*} [axiosOptions] Override http request option.
|
|
@@ -36090,7 +36102,7 @@ export declare class PasswordManagementApi extends BaseAPI {
|
|
|
36090
36102
|
*/
|
|
36091
36103
|
queryPasswordInfo(requestParameters: PasswordManagementApiQueryPasswordInfoRequest, axiosOptions?: AxiosRequestConfig): Promise<import("axios").AxiosResponse<PasswordInfo, any>>;
|
|
36092
36104
|
/**
|
|
36093
|
-
* 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.**
|
|
36105
|
+
* 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.
|
|
36094
36106
|
* @summary Set Identity\'s Password
|
|
36095
36107
|
* @param {PasswordManagementApiSetPasswordRequest} requestParameters Request parameters.
|
|
36096
36108
|
* @param {*} [axiosOptions] Override http request option.
|
|
@@ -39684,7 +39696,7 @@ export declare const SearchApiAxiosParamCreator: (configuration?: Configuration)
|
|
|
39684
39696
|
*/
|
|
39685
39697
|
searchGet: (index: string, id: string, axiosOptions?: AxiosRequestConfig) => Promise<RequestArgs>;
|
|
39686
39698
|
/**
|
|
39687
|
-
*
|
|
39699
|
+
* 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.
|
|
39688
39700
|
* @summary Perform Search
|
|
39689
39701
|
* @param {Search} search
|
|
39690
39702
|
* @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.
|
|
@@ -39729,7 +39741,7 @@ export declare const SearchApiFp: (configuration?: Configuration) => {
|
|
|
39729
39741
|
*/
|
|
39730
39742
|
searchGet(index: string, id: string, axiosOptions?: AxiosRequestConfig): Promise<(axios?: AxiosInstance, basePath?: string) => AxiosPromise<SearchDocument>>;
|
|
39731
39743
|
/**
|
|
39732
|
-
*
|
|
39744
|
+
* 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.
|
|
39733
39745
|
* @summary Perform Search
|
|
39734
39746
|
* @param {Search} search
|
|
39735
39747
|
* @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.
|
|
@@ -39774,7 +39786,7 @@ export declare const SearchApiFactory: (configuration?: Configuration, basePath?
|
|
|
39774
39786
|
*/
|
|
39775
39787
|
searchGet(index: string, id: string, axiosOptions?: any): AxiosPromise<SearchDocument>;
|
|
39776
39788
|
/**
|
|
39777
|
-
*
|
|
39789
|
+
* 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.
|
|
39778
39790
|
* @summary Perform Search
|
|
39779
39791
|
* @param {Search} search
|
|
39780
39792
|
* @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.
|
|
@@ -39914,7 +39926,7 @@ export declare class SearchApi extends BaseAPI {
|
|
|
39914
39926
|
*/
|
|
39915
39927
|
searchGet(requestParameters: SearchApiSearchGetRequest, axiosOptions?: AxiosRequestConfig): Promise<import("axios").AxiosResponse<SearchDocument, any>>;
|
|
39916
39928
|
/**
|
|
39917
|
-
*
|
|
39929
|
+
* 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.
|
|
39918
39930
|
* @summary Perform Search
|
|
39919
39931
|
* @param {SearchApiSearchPostRequest} requestParameters Request parameters.
|
|
39920
39932
|
* @param {*} [axiosOptions] Override http request option.
|