@sailpoint/api-client 2.2.48 → 2.2.50
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/dist/accounts/api.d.ts +504 -0
- package/dist/accounts/api.js +146 -1
- package/dist/accounts/api.js.map +1 -1
- package/dist/esm/accounts/api.js +145 -0
- package/dist/esm/generic/api.js +262 -335
- package/dist/esm/generic/base.js +4 -4
- package/dist/esm/generic/common.js +44 -31
- package/dist/esm/generic/configuration.js +3 -3
- package/dist/esm/generic/index.js +3 -3
- package/dist/esm/index.js +3 -0
- package/dist/esm/machine_identities_lifecycle_actions/api.js +5 -5
- package/dist/esm/machine_identities_lifecycle_actions/base.js +1 -1
- package/dist/esm/machine_identities_lifecycle_actions/common.js +1 -1
- package/dist/esm/machine_identities_lifecycle_actions/configuration.js +1 -1
- package/dist/esm/machine_identities_lifecycle_actions/index.js +1 -1
- package/dist/esm/nerm/common.js +2 -2
- package/dist/esm/nermv2025/common.js +2 -2
- package/dist/esm/workflows/api.js +33 -7
- package/dist/generic/api.d.ts +166 -177
- package/dist/generic/api.js +265 -338
- package/dist/generic/api.js.map +1 -1
- package/dist/generic/base.d.ts +3 -3
- package/dist/generic/base.js +4 -4
- package/dist/generic/base.js.map +1 -1
- package/dist/generic/common.d.ts +4 -4
- package/dist/generic/common.js +44 -31
- package/dist/generic/common.js.map +1 -1
- package/dist/generic/configuration.d.ts +3 -3
- package/dist/generic/configuration.js +3 -3
- package/dist/generic/configuration.js.map +1 -1
- package/dist/generic/index.d.ts +3 -3
- package/dist/generic/index.js +3 -3
- package/dist/generic/index.js.map +1 -1
- package/dist/generic.spec.d.ts +1 -0
- package/dist/generic.spec.js +133 -0
- package/dist/generic.spec.js.map +1 -0
- package/dist/index.d.ts +2 -0
- package/dist/index.js +5 -1
- package/dist/index.js.map +1 -1
- package/dist/index.spec.js +40 -0
- package/dist/index.spec.js.map +1 -1
- package/dist/machine_identities_lifecycle_actions/api.d.ts +5 -5
- package/dist/machine_identities_lifecycle_actions/api.js +5 -5
- package/dist/machine_identities_lifecycle_actions/api.js.map +1 -1
- package/dist/machine_identities_lifecycle_actions/base.d.ts +1 -1
- package/dist/machine_identities_lifecycle_actions/base.js +1 -1
- package/dist/machine_identities_lifecycle_actions/base.js.map +1 -1
- package/dist/machine_identities_lifecycle_actions/common.d.ts +1 -1
- package/dist/machine_identities_lifecycle_actions/common.js +1 -1
- package/dist/machine_identities_lifecycle_actions/common.js.map +1 -1
- package/dist/machine_identities_lifecycle_actions/configuration.d.ts +1 -1
- package/dist/machine_identities_lifecycle_actions/configuration.js +1 -1
- package/dist/machine_identities_lifecycle_actions/configuration.js.map +1 -1
- package/dist/machine_identities_lifecycle_actions/index.d.ts +1 -1
- package/dist/machine_identities_lifecycle_actions/index.js +1 -1
- package/dist/machine_identities_lifecycle_actions/index.js.map +1 -1
- package/dist/nerm/common.js +2 -2
- package/dist/nerm/common.js.map +1 -1
- package/dist/nermv2025/common.js +2 -2
- package/dist/nermv2025/common.js.map +1 -1
- package/dist/workflows/api.d.ts +62 -4
- package/dist/workflows/api.js +34 -8
- package/dist/workflows/api.js.map +1 -1
- package/package.json +3 -2
- package/sailpoint-scopes.json +16392 -0
package/dist/generic/api.d.ts
CHANGED
|
@@ -1,8 +1,8 @@
|
|
|
1
1
|
/**
|
|
2
|
-
*
|
|
3
|
-
* Generic
|
|
2
|
+
* SailPoint Identity Security API - Generic
|
|
3
|
+
* Generic client for the SailPoint Identity Security versioned APIs. Use it to call any endpoint, in any version, by its path, for example `sources/v1` or `sources/v2/{sourceId}/provisioning-policies`, including endpoints that do not have a resource-specific client or documentation yet. The version is part of the path, so this client is not tied to one API version and the base URL has no version segment.
|
|
4
4
|
*
|
|
5
|
-
* The version of the OpenAPI document:
|
|
5
|
+
* The version of the OpenAPI document: any (set in the path)
|
|
6
6
|
*
|
|
7
7
|
*
|
|
8
8
|
* NOTE: This class is auto generated by OpenAPI Generator (https://openapi-generator.tech).
|
|
@@ -14,373 +14,362 @@ import type { AxiosPromise, AxiosInstance, RawAxiosRequestConfig } from 'axios';
|
|
|
14
14
|
import type { RequestArgs } from './base';
|
|
15
15
|
import { BaseAPI } from './base';
|
|
16
16
|
/**
|
|
17
|
-
*
|
|
17
|
+
* GenericApi - axios parameter creator
|
|
18
18
|
* @export
|
|
19
19
|
*/
|
|
20
|
-
export
|
|
21
|
-
[key: string]: any;
|
|
22
|
-
}> | {
|
|
23
|
-
[key: string]: any;
|
|
24
|
-
};
|
|
25
|
-
/**
|
|
26
|
-
* DefaultApi - axios parameter creator
|
|
27
|
-
* @export
|
|
28
|
-
*/
|
|
29
|
-
export declare const DefaultApiAxiosParamCreator: (configuration?: Configuration) => {
|
|
20
|
+
export declare const GenericApiAxiosParamCreator: (configuration?: Configuration) => {
|
|
30
21
|
/**
|
|
31
|
-
*
|
|
22
|
+
* Sends a DELETE request to any versioned API path.
|
|
32
23
|
* @summary Generic DELETE request
|
|
33
|
-
* @param {string} path
|
|
34
|
-
* @param {string} [xSailPointExperimental]
|
|
24
|
+
* @param {string} path API path relative to the tenant base URL, including the API version, for example `accounts/v1`, `sources/v1/2c9180835d2e5168015d32f890ca1581` or `sources/v2/2c9180835d2e5168015d32f890ca1581/provisioning-policies`. Use whichever version the endpoint has. A leading slash is optional. Slashes separate path segments, and the SDK URL-encodes each segment, so pass the segments unencoded. Anything after a `?` is sent as query parameters, for example `accounts/v1?detailLevel=SLIM`.
|
|
25
|
+
* @param {string} [xSailPointExperimental] Set this header to `true` to call an experimental API. The SDK configuration must also enable experimental APIs.
|
|
35
26
|
* @param {*} [axiosOptions] Override http request option.
|
|
36
27
|
* @throws {RequiredError}
|
|
37
28
|
*/
|
|
38
29
|
genericDelete: (path: string, xSailPointExperimental?: string, axiosOptions?: RawAxiosRequestConfig) => Promise<RequestArgs>;
|
|
39
30
|
/**
|
|
40
|
-
*
|
|
31
|
+
* Sends a GET request to any versioned API path, for example `sources/v1/{id}/schemas` or `sources/v2/{sourceId}/provisioning-policies`.
|
|
41
32
|
* @summary Generic GET request
|
|
42
|
-
* @param {string} path
|
|
43
|
-
* @param {number} [limit] Max number of results to return. See [
|
|
44
|
-
* @param {
|
|
45
|
-
* @param {
|
|
46
|
-
* @param {string} [
|
|
33
|
+
* @param {string} path API path relative to the tenant base URL, including the API version, for example `accounts/v1`, `sources/v1/2c9180835d2e5168015d32f890ca1581` or `sources/v2/2c9180835d2e5168015d32f890ca1581/provisioning-policies`. Use whichever version the endpoint has. A leading slash is optional. Slashes separate path segments, and the SDK URL-encodes each segment, so pass the segments unencoded. Anything after a `?` is sent as query parameters, for example `accounts/v1?detailLevel=SLIM`.
|
|
34
|
+
* @param {number} [limit] Max number of results to return. See [Standard Collection Parameters](https://developer.sailpoint.com/docs/standard-collection-parameters) for more information.
|
|
35
|
+
* @param {number} [offset] Offset into the full result set. Usually specified with *limit* to paginate through the results.
|
|
36
|
+
* @param {boolean} [count] If *true* it will populate the *X-Total-Count* response header with the number of results that would be returned if *limit* and *offset* were ignored.
|
|
37
|
+
* @param {string} [filters] Filter results using the standard syntax described in [V3 API Standard Collection Parameters](https://developer.sailpoint.com/docs/standard-collection-parameters#filtering-results).
|
|
38
|
+
* @param {string} [sorters] Sort results using the standard syntax described in [V3 API Standard Collection Parameters](https://developer.sailpoint.com/docs/standard-collection-parameters#sorting-results).
|
|
39
|
+
* @param {string} [xSailPointExperimental] Set this header to `true` to call an experimental API. The SDK configuration must also enable experimental APIs.
|
|
47
40
|
* @param {*} [axiosOptions] Override http request option.
|
|
48
41
|
* @throws {RequiredError}
|
|
49
42
|
*/
|
|
50
|
-
genericGet: (path: string, limit?: number, count?: boolean,
|
|
43
|
+
genericGet: (path: string, limit?: number, offset?: number, count?: boolean, filters?: string, sorters?: string, xSailPointExperimental?: string, axiosOptions?: RawAxiosRequestConfig) => Promise<RequestArgs>;
|
|
51
44
|
/**
|
|
52
|
-
*
|
|
45
|
+
* Sends a PATCH request to any versioned API path. The body is a JSON Patch document (RFC 6902): a list of operations such as `[{\"op\": \"replace\", \"path\": \"/description\", \"value\": \"New description\"}]`.
|
|
53
46
|
* @summary Generic PATCH request
|
|
54
|
-
* @param {string} path
|
|
55
|
-
* @param {string} [xSailPointExperimental]
|
|
56
|
-
* @param {
|
|
47
|
+
* @param {string} path API path relative to the tenant base URL, including the API version, for example `accounts/v1`, `sources/v1/2c9180835d2e5168015d32f890ca1581` or `sources/v2/2c9180835d2e5168015d32f890ca1581/provisioning-policies`. Use whichever version the endpoint has. A leading slash is optional. Slashes separate path segments, and the SDK URL-encodes each segment, so pass the segments unencoded. Anything after a `?` is sent as query parameters, for example `accounts/v1?detailLevel=SLIM`.
|
|
48
|
+
* @param {string} [xSailPointExperimental] Set this header to `true` to call an experimental API. The SDK configuration must also enable experimental APIs.
|
|
49
|
+
* @param {any} [requestBody]
|
|
57
50
|
* @param {*} [axiosOptions] Override http request option.
|
|
58
51
|
* @throws {RequiredError}
|
|
59
52
|
*/
|
|
60
|
-
genericPatch: (path: string, xSailPointExperimental?: string, requestBody?:
|
|
61
|
-
[key: string]: any;
|
|
62
|
-
}, axiosOptions?: RawAxiosRequestConfig) => Promise<RequestArgs>;
|
|
53
|
+
genericPatch: (path: string, xSailPointExperimental?: string, requestBody?: any, axiosOptions?: RawAxiosRequestConfig) => Promise<RequestArgs>;
|
|
63
54
|
/**
|
|
64
|
-
*
|
|
55
|
+
* Sends a POST request with a JSON body to any versioned API path.
|
|
65
56
|
* @summary Generic POST request
|
|
66
|
-
* @param {string} path
|
|
67
|
-
* @param {string} [xSailPointExperimental]
|
|
68
|
-
* @param {
|
|
57
|
+
* @param {string} path API path relative to the tenant base URL, including the API version, for example `accounts/v1`, `sources/v1/2c9180835d2e5168015d32f890ca1581` or `sources/v2/2c9180835d2e5168015d32f890ca1581/provisioning-policies`. Use whichever version the endpoint has. A leading slash is optional. Slashes separate path segments, and the SDK URL-encodes each segment, so pass the segments unencoded. Anything after a `?` is sent as query parameters, for example `accounts/v1?detailLevel=SLIM`.
|
|
58
|
+
* @param {string} [xSailPointExperimental] Set this header to `true` to call an experimental API. The SDK configuration must also enable experimental APIs.
|
|
59
|
+
* @param {any} [requestBody]
|
|
69
60
|
* @param {*} [axiosOptions] Override http request option.
|
|
70
61
|
* @throws {RequiredError}
|
|
71
62
|
*/
|
|
72
|
-
genericPost: (path: string, xSailPointExperimental?: string, requestBody?:
|
|
73
|
-
[key: string]: any;
|
|
74
|
-
}, axiosOptions?: RawAxiosRequestConfig) => Promise<RequestArgs>;
|
|
63
|
+
genericPost: (path: string, xSailPointExperimental?: string, requestBody?: any, axiosOptions?: RawAxiosRequestConfig) => Promise<RequestArgs>;
|
|
75
64
|
/**
|
|
76
|
-
*
|
|
65
|
+
* Sends a PUT request with a JSON body to any versioned API path.
|
|
77
66
|
* @summary Generic PUT request
|
|
78
|
-
* @param {string} path
|
|
79
|
-
* @param {string} [xSailPointExperimental]
|
|
80
|
-
* @param {
|
|
67
|
+
* @param {string} path API path relative to the tenant base URL, including the API version, for example `accounts/v1`, `sources/v1/2c9180835d2e5168015d32f890ca1581` or `sources/v2/2c9180835d2e5168015d32f890ca1581/provisioning-policies`. Use whichever version the endpoint has. A leading slash is optional. Slashes separate path segments, and the SDK URL-encodes each segment, so pass the segments unencoded. Anything after a `?` is sent as query parameters, for example `accounts/v1?detailLevel=SLIM`.
|
|
68
|
+
* @param {string} [xSailPointExperimental] Set this header to `true` to call an experimental API. The SDK configuration must also enable experimental APIs.
|
|
69
|
+
* @param {any} [requestBody]
|
|
81
70
|
* @param {*} [axiosOptions] Override http request option.
|
|
82
71
|
* @throws {RequiredError}
|
|
83
72
|
*/
|
|
84
|
-
genericPut: (path: string, xSailPointExperimental?: string, requestBody?:
|
|
85
|
-
[key: string]: any;
|
|
86
|
-
}, axiosOptions?: RawAxiosRequestConfig) => Promise<RequestArgs>;
|
|
73
|
+
genericPut: (path: string, xSailPointExperimental?: string, requestBody?: any, axiosOptions?: RawAxiosRequestConfig) => Promise<RequestArgs>;
|
|
87
74
|
};
|
|
88
75
|
/**
|
|
89
|
-
*
|
|
76
|
+
* GenericApi - functional programming interface
|
|
90
77
|
* @export
|
|
91
78
|
*/
|
|
92
|
-
export declare const
|
|
79
|
+
export declare const GenericApiFp: (configuration?: Configuration) => {
|
|
93
80
|
/**
|
|
94
|
-
*
|
|
81
|
+
* Sends a DELETE request to any versioned API path.
|
|
95
82
|
* @summary Generic DELETE request
|
|
96
|
-
* @param {string} path
|
|
97
|
-
* @param {string} [xSailPointExperimental]
|
|
83
|
+
* @param {string} path API path relative to the tenant base URL, including the API version, for example `accounts/v1`, `sources/v1/2c9180835d2e5168015d32f890ca1581` or `sources/v2/2c9180835d2e5168015d32f890ca1581/provisioning-policies`. Use whichever version the endpoint has. A leading slash is optional. Slashes separate path segments, and the SDK URL-encodes each segment, so pass the segments unencoded. Anything after a `?` is sent as query parameters, for example `accounts/v1?detailLevel=SLIM`.
|
|
84
|
+
* @param {string} [xSailPointExperimental] Set this header to `true` to call an experimental API. The SDK configuration must also enable experimental APIs.
|
|
98
85
|
* @param {*} [axiosOptions] Override http request option.
|
|
99
86
|
* @throws {RequiredError}
|
|
100
87
|
*/
|
|
101
|
-
genericDelete(path: string, xSailPointExperimental?: string, axiosOptions?: RawAxiosRequestConfig): Promise<(axios?: AxiosInstance, basePath?: string) => AxiosPromise<
|
|
88
|
+
genericDelete(path: string, xSailPointExperimental?: string, axiosOptions?: RawAxiosRequestConfig): Promise<(axios?: AxiosInstance, basePath?: string) => AxiosPromise<any>>;
|
|
102
89
|
/**
|
|
103
|
-
*
|
|
90
|
+
* Sends a GET request to any versioned API path, for example `sources/v1/{id}/schemas` or `sources/v2/{sourceId}/provisioning-policies`.
|
|
104
91
|
* @summary Generic GET request
|
|
105
|
-
* @param {string} path
|
|
106
|
-
* @param {number} [limit] Max number of results to return. See [
|
|
107
|
-
* @param {
|
|
108
|
-
* @param {
|
|
109
|
-
* @param {string} [
|
|
92
|
+
* @param {string} path API path relative to the tenant base URL, including the API version, for example `accounts/v1`, `sources/v1/2c9180835d2e5168015d32f890ca1581` or `sources/v2/2c9180835d2e5168015d32f890ca1581/provisioning-policies`. Use whichever version the endpoint has. A leading slash is optional. Slashes separate path segments, and the SDK URL-encodes each segment, so pass the segments unencoded. Anything after a `?` is sent as query parameters, for example `accounts/v1?detailLevel=SLIM`.
|
|
93
|
+
* @param {number} [limit] Max number of results to return. See [Standard Collection Parameters](https://developer.sailpoint.com/docs/standard-collection-parameters) for more information.
|
|
94
|
+
* @param {number} [offset] Offset into the full result set. Usually specified with *limit* to paginate through the results.
|
|
95
|
+
* @param {boolean} [count] If *true* it will populate the *X-Total-Count* response header with the number of results that would be returned if *limit* and *offset* were ignored.
|
|
96
|
+
* @param {string} [filters] Filter results using the standard syntax described in [V3 API Standard Collection Parameters](https://developer.sailpoint.com/docs/standard-collection-parameters#filtering-results).
|
|
97
|
+
* @param {string} [sorters] Sort results using the standard syntax described in [V3 API Standard Collection Parameters](https://developer.sailpoint.com/docs/standard-collection-parameters#sorting-results).
|
|
98
|
+
* @param {string} [xSailPointExperimental] Set this header to `true` to call an experimental API. The SDK configuration must also enable experimental APIs.
|
|
110
99
|
* @param {*} [axiosOptions] Override http request option.
|
|
111
100
|
* @throws {RequiredError}
|
|
112
101
|
*/
|
|
113
|
-
genericGet(path: string, limit?: number, count?: boolean,
|
|
102
|
+
genericGet(path: string, limit?: number, offset?: number, count?: boolean, filters?: string, sorters?: string, xSailPointExperimental?: string, axiosOptions?: RawAxiosRequestConfig): Promise<(axios?: AxiosInstance, basePath?: string) => AxiosPromise<any>>;
|
|
114
103
|
/**
|
|
115
|
-
*
|
|
104
|
+
* Sends a PATCH request to any versioned API path. The body is a JSON Patch document (RFC 6902): a list of operations such as `[{\"op\": \"replace\", \"path\": \"/description\", \"value\": \"New description\"}]`.
|
|
116
105
|
* @summary Generic PATCH request
|
|
117
|
-
* @param {string} path
|
|
118
|
-
* @param {string} [xSailPointExperimental]
|
|
119
|
-
* @param {
|
|
106
|
+
* @param {string} path API path relative to the tenant base URL, including the API version, for example `accounts/v1`, `sources/v1/2c9180835d2e5168015d32f890ca1581` or `sources/v2/2c9180835d2e5168015d32f890ca1581/provisioning-policies`. Use whichever version the endpoint has. A leading slash is optional. Slashes separate path segments, and the SDK URL-encodes each segment, so pass the segments unencoded. Anything after a `?` is sent as query parameters, for example `accounts/v1?detailLevel=SLIM`.
|
|
107
|
+
* @param {string} [xSailPointExperimental] Set this header to `true` to call an experimental API. The SDK configuration must also enable experimental APIs.
|
|
108
|
+
* @param {any} [requestBody]
|
|
120
109
|
* @param {*} [axiosOptions] Override http request option.
|
|
121
110
|
* @throws {RequiredError}
|
|
122
111
|
*/
|
|
123
|
-
genericPatch(path: string, xSailPointExperimental?: string, requestBody?:
|
|
124
|
-
[key: string]: any;
|
|
125
|
-
}, axiosOptions?: RawAxiosRequestConfig): Promise<(axios?: AxiosInstance, basePath?: string) => AxiosPromise<GenericResponse>>;
|
|
112
|
+
genericPatch(path: string, xSailPointExperimental?: string, requestBody?: any, axiosOptions?: RawAxiosRequestConfig): Promise<(axios?: AxiosInstance, basePath?: string) => AxiosPromise<any>>;
|
|
126
113
|
/**
|
|
127
|
-
*
|
|
114
|
+
* Sends a POST request with a JSON body to any versioned API path.
|
|
128
115
|
* @summary Generic POST request
|
|
129
|
-
* @param {string} path
|
|
130
|
-
* @param {string} [xSailPointExperimental]
|
|
131
|
-
* @param {
|
|
116
|
+
* @param {string} path API path relative to the tenant base URL, including the API version, for example `accounts/v1`, `sources/v1/2c9180835d2e5168015d32f890ca1581` or `sources/v2/2c9180835d2e5168015d32f890ca1581/provisioning-policies`. Use whichever version the endpoint has. A leading slash is optional. Slashes separate path segments, and the SDK URL-encodes each segment, so pass the segments unencoded. Anything after a `?` is sent as query parameters, for example `accounts/v1?detailLevel=SLIM`.
|
|
117
|
+
* @param {string} [xSailPointExperimental] Set this header to `true` to call an experimental API. The SDK configuration must also enable experimental APIs.
|
|
118
|
+
* @param {any} [requestBody]
|
|
132
119
|
* @param {*} [axiosOptions] Override http request option.
|
|
133
120
|
* @throws {RequiredError}
|
|
134
121
|
*/
|
|
135
|
-
genericPost(path: string, xSailPointExperimental?: string, requestBody?:
|
|
136
|
-
[key: string]: any;
|
|
137
|
-
}, axiosOptions?: RawAxiosRequestConfig): Promise<(axios?: AxiosInstance, basePath?: string) => AxiosPromise<GenericResponse>>;
|
|
122
|
+
genericPost(path: string, xSailPointExperimental?: string, requestBody?: any, axiosOptions?: RawAxiosRequestConfig): Promise<(axios?: AxiosInstance, basePath?: string) => AxiosPromise<any>>;
|
|
138
123
|
/**
|
|
139
|
-
*
|
|
124
|
+
* Sends a PUT request with a JSON body to any versioned API path.
|
|
140
125
|
* @summary Generic PUT request
|
|
141
|
-
* @param {string} path
|
|
142
|
-
* @param {string} [xSailPointExperimental]
|
|
143
|
-
* @param {
|
|
126
|
+
* @param {string} path API path relative to the tenant base URL, including the API version, for example `accounts/v1`, `sources/v1/2c9180835d2e5168015d32f890ca1581` or `sources/v2/2c9180835d2e5168015d32f890ca1581/provisioning-policies`. Use whichever version the endpoint has. A leading slash is optional. Slashes separate path segments, and the SDK URL-encodes each segment, so pass the segments unencoded. Anything after a `?` is sent as query parameters, for example `accounts/v1?detailLevel=SLIM`.
|
|
127
|
+
* @param {string} [xSailPointExperimental] Set this header to `true` to call an experimental API. The SDK configuration must also enable experimental APIs.
|
|
128
|
+
* @param {any} [requestBody]
|
|
144
129
|
* @param {*} [axiosOptions] Override http request option.
|
|
145
130
|
* @throws {RequiredError}
|
|
146
131
|
*/
|
|
147
|
-
genericPut(path: string, xSailPointExperimental?: string, requestBody?:
|
|
148
|
-
[key: string]: any;
|
|
149
|
-
}, axiosOptions?: RawAxiosRequestConfig): Promise<(axios?: AxiosInstance, basePath?: string) => AxiosPromise<GenericResponse>>;
|
|
132
|
+
genericPut(path: string, xSailPointExperimental?: string, requestBody?: any, axiosOptions?: RawAxiosRequestConfig): Promise<(axios?: AxiosInstance, basePath?: string) => AxiosPromise<any>>;
|
|
150
133
|
};
|
|
151
134
|
/**
|
|
152
|
-
*
|
|
135
|
+
* GenericApi - factory interface
|
|
153
136
|
* @export
|
|
154
137
|
*/
|
|
155
|
-
export declare const
|
|
138
|
+
export declare const GenericApiFactory: (configuration?: Configuration, basePath?: string, axios?: AxiosInstance) => {
|
|
156
139
|
/**
|
|
157
|
-
*
|
|
140
|
+
* Sends a DELETE request to any versioned API path.
|
|
158
141
|
* @summary Generic DELETE request
|
|
159
|
-
* @param {
|
|
142
|
+
* @param {GenericApiGenericDeleteRequest} requestParameters Request parameters.
|
|
160
143
|
* @param {*} [axiosOptions] Override http request option.
|
|
161
144
|
* @throws {RequiredError}
|
|
162
145
|
*/
|
|
163
|
-
genericDelete(requestParameters:
|
|
146
|
+
genericDelete(requestParameters: GenericApiGenericDeleteRequest, axiosOptions?: RawAxiosRequestConfig): AxiosPromise<any>;
|
|
164
147
|
/**
|
|
165
|
-
*
|
|
148
|
+
* Sends a GET request to any versioned API path, for example `sources/v1/{id}/schemas` or `sources/v2/{sourceId}/provisioning-policies`.
|
|
166
149
|
* @summary Generic GET request
|
|
167
|
-
* @param {
|
|
150
|
+
* @param {GenericApiGenericGetRequest} requestParameters Request parameters.
|
|
168
151
|
* @param {*} [axiosOptions] Override http request option.
|
|
169
152
|
* @throws {RequiredError}
|
|
170
153
|
*/
|
|
171
|
-
genericGet(requestParameters:
|
|
154
|
+
genericGet(requestParameters: GenericApiGenericGetRequest, axiosOptions?: RawAxiosRequestConfig): AxiosPromise<any>;
|
|
172
155
|
/**
|
|
173
|
-
*
|
|
156
|
+
* Sends a PATCH request to any versioned API path. The body is a JSON Patch document (RFC 6902): a list of operations such as `[{\"op\": \"replace\", \"path\": \"/description\", \"value\": \"New description\"}]`.
|
|
174
157
|
* @summary Generic PATCH request
|
|
175
|
-
* @param {
|
|
158
|
+
* @param {GenericApiGenericPatchRequest} requestParameters Request parameters.
|
|
176
159
|
* @param {*} [axiosOptions] Override http request option.
|
|
177
160
|
* @throws {RequiredError}
|
|
178
161
|
*/
|
|
179
|
-
genericPatch(requestParameters:
|
|
162
|
+
genericPatch(requestParameters: GenericApiGenericPatchRequest, axiosOptions?: RawAxiosRequestConfig): AxiosPromise<any>;
|
|
180
163
|
/**
|
|
181
|
-
*
|
|
164
|
+
* Sends a POST request with a JSON body to any versioned API path.
|
|
182
165
|
* @summary Generic POST request
|
|
183
|
-
* @param {
|
|
166
|
+
* @param {GenericApiGenericPostRequest} requestParameters Request parameters.
|
|
184
167
|
* @param {*} [axiosOptions] Override http request option.
|
|
185
168
|
* @throws {RequiredError}
|
|
186
169
|
*/
|
|
187
|
-
genericPost(requestParameters:
|
|
170
|
+
genericPost(requestParameters: GenericApiGenericPostRequest, axiosOptions?: RawAxiosRequestConfig): AxiosPromise<any>;
|
|
188
171
|
/**
|
|
189
|
-
*
|
|
172
|
+
* Sends a PUT request with a JSON body to any versioned API path.
|
|
190
173
|
* @summary Generic PUT request
|
|
191
|
-
* @param {
|
|
174
|
+
* @param {GenericApiGenericPutRequest} requestParameters Request parameters.
|
|
192
175
|
* @param {*} [axiosOptions] Override http request option.
|
|
193
176
|
* @throws {RequiredError}
|
|
194
177
|
*/
|
|
195
|
-
genericPut(requestParameters:
|
|
178
|
+
genericPut(requestParameters: GenericApiGenericPutRequest, axiosOptions?: RawAxiosRequestConfig): AxiosPromise<any>;
|
|
196
179
|
};
|
|
197
180
|
/**
|
|
198
|
-
* Request parameters for genericDelete operation in
|
|
181
|
+
* Request parameters for genericDelete operation in GenericApi.
|
|
199
182
|
* @export
|
|
200
|
-
* @interface
|
|
183
|
+
* @interface GenericApiGenericDeleteRequest
|
|
201
184
|
*/
|
|
202
|
-
export interface
|
|
185
|
+
export interface GenericApiGenericDeleteRequest {
|
|
203
186
|
/**
|
|
204
|
-
*
|
|
187
|
+
* API path relative to the tenant base URL, including the API version, for example `accounts/v1`, `sources/v1/2c9180835d2e5168015d32f890ca1581` or `sources/v2/2c9180835d2e5168015d32f890ca1581/provisioning-policies`. Use whichever version the endpoint has. A leading slash is optional. Slashes separate path segments, and the SDK URL-encodes each segment, so pass the segments unencoded. Anything after a `?` is sent as query parameters, for example `accounts/v1?detailLevel=SLIM`.
|
|
205
188
|
* @type {string}
|
|
206
|
-
* @memberof
|
|
189
|
+
* @memberof GenericApiGenericDelete
|
|
207
190
|
*/
|
|
208
191
|
readonly path: string;
|
|
209
192
|
/**
|
|
210
|
-
*
|
|
193
|
+
* Set this header to `true` to call an experimental API. The SDK configuration must also enable experimental APIs.
|
|
211
194
|
* @type {string}
|
|
212
|
-
* @memberof
|
|
195
|
+
* @memberof GenericApiGenericDelete
|
|
213
196
|
*/
|
|
214
197
|
readonly xSailPointExperimental?: string;
|
|
215
198
|
}
|
|
216
199
|
/**
|
|
217
|
-
* Request parameters for genericGet operation in
|
|
200
|
+
* Request parameters for genericGet operation in GenericApi.
|
|
218
201
|
* @export
|
|
219
|
-
* @interface
|
|
202
|
+
* @interface GenericApiGenericGetRequest
|
|
220
203
|
*/
|
|
221
|
-
export interface
|
|
204
|
+
export interface GenericApiGenericGetRequest {
|
|
222
205
|
/**
|
|
223
|
-
*
|
|
206
|
+
* API path relative to the tenant base URL, including the API version, for example `accounts/v1`, `sources/v1/2c9180835d2e5168015d32f890ca1581` or `sources/v2/2c9180835d2e5168015d32f890ca1581/provisioning-policies`. Use whichever version the endpoint has. A leading slash is optional. Slashes separate path segments, and the SDK URL-encodes each segment, so pass the segments unencoded. Anything after a `?` is sent as query parameters, for example `accounts/v1?detailLevel=SLIM`.
|
|
224
207
|
* @type {string}
|
|
225
|
-
* @memberof
|
|
208
|
+
* @memberof GenericApiGenericGet
|
|
226
209
|
*/
|
|
227
210
|
readonly path: string;
|
|
228
211
|
/**
|
|
229
|
-
* Max number of results to return. See [
|
|
212
|
+
* Max number of results to return. See [Standard Collection Parameters](https://developer.sailpoint.com/docs/standard-collection-parameters) for more information.
|
|
230
213
|
* @type {number}
|
|
231
|
-
* @memberof
|
|
214
|
+
* @memberof GenericApiGenericGet
|
|
232
215
|
*/
|
|
233
216
|
readonly limit?: number;
|
|
234
217
|
/**
|
|
235
|
-
*
|
|
218
|
+
* Offset into the full result set. Usually specified with *limit* to paginate through the results.
|
|
219
|
+
* @type {number}
|
|
220
|
+
* @memberof GenericApiGenericGet
|
|
221
|
+
*/
|
|
222
|
+
readonly offset?: number;
|
|
223
|
+
/**
|
|
224
|
+
* If *true* it will populate the *X-Total-Count* response header with the number of results that would be returned if *limit* and *offset* were ignored.
|
|
236
225
|
* @type {boolean}
|
|
237
|
-
* @memberof
|
|
226
|
+
* @memberof GenericApiGenericGet
|
|
238
227
|
*/
|
|
239
228
|
readonly count?: boolean;
|
|
240
229
|
/**
|
|
241
|
-
*
|
|
242
|
-
* @type {
|
|
243
|
-
* @memberof
|
|
230
|
+
* Filter results using the standard syntax described in [V3 API Standard Collection Parameters](https://developer.sailpoint.com/docs/standard-collection-parameters#filtering-results).
|
|
231
|
+
* @type {string}
|
|
232
|
+
* @memberof GenericApiGenericGet
|
|
244
233
|
*/
|
|
245
|
-
readonly
|
|
234
|
+
readonly filters?: string;
|
|
246
235
|
/**
|
|
247
|
-
*
|
|
236
|
+
* Sort results using the standard syntax described in [V3 API Standard Collection Parameters](https://developer.sailpoint.com/docs/standard-collection-parameters#sorting-results).
|
|
248
237
|
* @type {string}
|
|
249
|
-
* @memberof
|
|
238
|
+
* @memberof GenericApiGenericGet
|
|
239
|
+
*/
|
|
240
|
+
readonly sorters?: string;
|
|
241
|
+
/**
|
|
242
|
+
* Set this header to `true` to call an experimental API. The SDK configuration must also enable experimental APIs.
|
|
243
|
+
* @type {string}
|
|
244
|
+
* @memberof GenericApiGenericGet
|
|
250
245
|
*/
|
|
251
246
|
readonly xSailPointExperimental?: string;
|
|
252
247
|
}
|
|
253
248
|
/**
|
|
254
|
-
* Request parameters for genericPatch operation in
|
|
249
|
+
* Request parameters for genericPatch operation in GenericApi.
|
|
255
250
|
* @export
|
|
256
|
-
* @interface
|
|
251
|
+
* @interface GenericApiGenericPatchRequest
|
|
257
252
|
*/
|
|
258
|
-
export interface
|
|
253
|
+
export interface GenericApiGenericPatchRequest {
|
|
259
254
|
/**
|
|
260
|
-
*
|
|
255
|
+
* API path relative to the tenant base URL, including the API version, for example `accounts/v1`, `sources/v1/2c9180835d2e5168015d32f890ca1581` or `sources/v2/2c9180835d2e5168015d32f890ca1581/provisioning-policies`. Use whichever version the endpoint has. A leading slash is optional. Slashes separate path segments, and the SDK URL-encodes each segment, so pass the segments unencoded. Anything after a `?` is sent as query parameters, for example `accounts/v1?detailLevel=SLIM`.
|
|
261
256
|
* @type {string}
|
|
262
|
-
* @memberof
|
|
257
|
+
* @memberof GenericApiGenericPatch
|
|
263
258
|
*/
|
|
264
259
|
readonly path: string;
|
|
265
260
|
/**
|
|
266
|
-
*
|
|
261
|
+
* Set this header to `true` to call an experimental API. The SDK configuration must also enable experimental APIs.
|
|
267
262
|
* @type {string}
|
|
268
|
-
* @memberof
|
|
263
|
+
* @memberof GenericApiGenericPatch
|
|
269
264
|
*/
|
|
270
265
|
readonly xSailPointExperimental?: string;
|
|
271
266
|
/**
|
|
272
267
|
*
|
|
273
|
-
* @type {
|
|
274
|
-
* @memberof
|
|
268
|
+
* @type {any}
|
|
269
|
+
* @memberof GenericApiGenericPatch
|
|
275
270
|
*/
|
|
276
|
-
readonly requestBody?:
|
|
277
|
-
[key: string]: any;
|
|
278
|
-
};
|
|
271
|
+
readonly requestBody?: any;
|
|
279
272
|
}
|
|
280
273
|
/**
|
|
281
|
-
* Request parameters for genericPost operation in
|
|
274
|
+
* Request parameters for genericPost operation in GenericApi.
|
|
282
275
|
* @export
|
|
283
|
-
* @interface
|
|
276
|
+
* @interface GenericApiGenericPostRequest
|
|
284
277
|
*/
|
|
285
|
-
export interface
|
|
278
|
+
export interface GenericApiGenericPostRequest {
|
|
286
279
|
/**
|
|
287
|
-
*
|
|
280
|
+
* API path relative to the tenant base URL, including the API version, for example `accounts/v1`, `sources/v1/2c9180835d2e5168015d32f890ca1581` or `sources/v2/2c9180835d2e5168015d32f890ca1581/provisioning-policies`. Use whichever version the endpoint has. A leading slash is optional. Slashes separate path segments, and the SDK URL-encodes each segment, so pass the segments unencoded. Anything after a `?` is sent as query parameters, for example `accounts/v1?detailLevel=SLIM`.
|
|
288
281
|
* @type {string}
|
|
289
|
-
* @memberof
|
|
282
|
+
* @memberof GenericApiGenericPost
|
|
290
283
|
*/
|
|
291
284
|
readonly path: string;
|
|
292
285
|
/**
|
|
293
|
-
*
|
|
286
|
+
* Set this header to `true` to call an experimental API. The SDK configuration must also enable experimental APIs.
|
|
294
287
|
* @type {string}
|
|
295
|
-
* @memberof
|
|
288
|
+
* @memberof GenericApiGenericPost
|
|
296
289
|
*/
|
|
297
290
|
readonly xSailPointExperimental?: string;
|
|
298
291
|
/**
|
|
299
292
|
*
|
|
300
|
-
* @type {
|
|
301
|
-
* @memberof
|
|
293
|
+
* @type {any}
|
|
294
|
+
* @memberof GenericApiGenericPost
|
|
302
295
|
*/
|
|
303
|
-
readonly requestBody?:
|
|
304
|
-
[key: string]: any;
|
|
305
|
-
};
|
|
296
|
+
readonly requestBody?: any;
|
|
306
297
|
}
|
|
307
298
|
/**
|
|
308
|
-
* Request parameters for genericPut operation in
|
|
299
|
+
* Request parameters for genericPut operation in GenericApi.
|
|
309
300
|
* @export
|
|
310
|
-
* @interface
|
|
301
|
+
* @interface GenericApiGenericPutRequest
|
|
311
302
|
*/
|
|
312
|
-
export interface
|
|
303
|
+
export interface GenericApiGenericPutRequest {
|
|
313
304
|
/**
|
|
314
|
-
*
|
|
305
|
+
* API path relative to the tenant base URL, including the API version, for example `accounts/v1`, `sources/v1/2c9180835d2e5168015d32f890ca1581` or `sources/v2/2c9180835d2e5168015d32f890ca1581/provisioning-policies`. Use whichever version the endpoint has. A leading slash is optional. Slashes separate path segments, and the SDK URL-encodes each segment, so pass the segments unencoded. Anything after a `?` is sent as query parameters, for example `accounts/v1?detailLevel=SLIM`.
|
|
315
306
|
* @type {string}
|
|
316
|
-
* @memberof
|
|
307
|
+
* @memberof GenericApiGenericPut
|
|
317
308
|
*/
|
|
318
309
|
readonly path: string;
|
|
319
310
|
/**
|
|
320
|
-
*
|
|
311
|
+
* Set this header to `true` to call an experimental API. The SDK configuration must also enable experimental APIs.
|
|
321
312
|
* @type {string}
|
|
322
|
-
* @memberof
|
|
313
|
+
* @memberof GenericApiGenericPut
|
|
323
314
|
*/
|
|
324
315
|
readonly xSailPointExperimental?: string;
|
|
325
316
|
/**
|
|
326
317
|
*
|
|
327
|
-
* @type {
|
|
328
|
-
* @memberof
|
|
318
|
+
* @type {any}
|
|
319
|
+
* @memberof GenericApiGenericPut
|
|
329
320
|
*/
|
|
330
|
-
readonly requestBody?:
|
|
331
|
-
[key: string]: any;
|
|
332
|
-
};
|
|
321
|
+
readonly requestBody?: any;
|
|
333
322
|
}
|
|
334
323
|
/**
|
|
335
|
-
*
|
|
324
|
+
* GenericApi - object-oriented interface
|
|
336
325
|
* @export
|
|
337
|
-
* @class
|
|
326
|
+
* @class GenericApi
|
|
338
327
|
* @extends {BaseAPI}
|
|
339
328
|
*/
|
|
340
|
-
export declare class
|
|
329
|
+
export declare class GenericApi extends BaseAPI {
|
|
341
330
|
/**
|
|
342
|
-
*
|
|
331
|
+
* Sends a DELETE request to any versioned API path.
|
|
343
332
|
* @summary Generic DELETE request
|
|
344
|
-
* @param {
|
|
333
|
+
* @param {GenericApiGenericDeleteRequest} requestParameters Request parameters.
|
|
345
334
|
* @param {*} [axiosOptions] Override http request option.
|
|
346
335
|
* @throws {RequiredError}
|
|
347
|
-
* @memberof
|
|
336
|
+
* @memberof GenericApi
|
|
348
337
|
*/
|
|
349
|
-
genericDelete(requestParameters:
|
|
338
|
+
genericDelete(requestParameters: GenericApiGenericDeleteRequest, axiosOptions?: RawAxiosRequestConfig): Promise<import("axios").AxiosResponse<any, any>>;
|
|
350
339
|
/**
|
|
351
|
-
*
|
|
340
|
+
* Sends a GET request to any versioned API path, for example `sources/v1/{id}/schemas` or `sources/v2/{sourceId}/provisioning-policies`.
|
|
352
341
|
* @summary Generic GET request
|
|
353
|
-
* @param {
|
|
342
|
+
* @param {GenericApiGenericGetRequest} requestParameters Request parameters.
|
|
354
343
|
* @param {*} [axiosOptions] Override http request option.
|
|
355
344
|
* @throws {RequiredError}
|
|
356
|
-
* @memberof
|
|
345
|
+
* @memberof GenericApi
|
|
357
346
|
*/
|
|
358
|
-
genericGet(requestParameters:
|
|
347
|
+
genericGet(requestParameters: GenericApiGenericGetRequest, axiosOptions?: RawAxiosRequestConfig): Promise<import("axios").AxiosResponse<any, any>>;
|
|
359
348
|
/**
|
|
360
|
-
*
|
|
349
|
+
* Sends a PATCH request to any versioned API path. The body is a JSON Patch document (RFC 6902): a list of operations such as `[{\"op\": \"replace\", \"path\": \"/description\", \"value\": \"New description\"}]`.
|
|
361
350
|
* @summary Generic PATCH request
|
|
362
|
-
* @param {
|
|
351
|
+
* @param {GenericApiGenericPatchRequest} requestParameters Request parameters.
|
|
363
352
|
* @param {*} [axiosOptions] Override http request option.
|
|
364
353
|
* @throws {RequiredError}
|
|
365
|
-
* @memberof
|
|
354
|
+
* @memberof GenericApi
|
|
366
355
|
*/
|
|
367
|
-
genericPatch(requestParameters:
|
|
356
|
+
genericPatch(requestParameters: GenericApiGenericPatchRequest, axiosOptions?: RawAxiosRequestConfig): Promise<import("axios").AxiosResponse<any, any>>;
|
|
368
357
|
/**
|
|
369
|
-
*
|
|
358
|
+
* Sends a POST request with a JSON body to any versioned API path.
|
|
370
359
|
* @summary Generic POST request
|
|
371
|
-
* @param {
|
|
360
|
+
* @param {GenericApiGenericPostRequest} requestParameters Request parameters.
|
|
372
361
|
* @param {*} [axiosOptions] Override http request option.
|
|
373
362
|
* @throws {RequiredError}
|
|
374
|
-
* @memberof
|
|
363
|
+
* @memberof GenericApi
|
|
375
364
|
*/
|
|
376
|
-
genericPost(requestParameters:
|
|
365
|
+
genericPost(requestParameters: GenericApiGenericPostRequest, axiosOptions?: RawAxiosRequestConfig): Promise<import("axios").AxiosResponse<any, any>>;
|
|
377
366
|
/**
|
|
378
|
-
*
|
|
367
|
+
* Sends a PUT request with a JSON body to any versioned API path.
|
|
379
368
|
* @summary Generic PUT request
|
|
380
|
-
* @param {
|
|
369
|
+
* @param {GenericApiGenericPutRequest} requestParameters Request parameters.
|
|
381
370
|
* @param {*} [axiosOptions] Override http request option.
|
|
382
371
|
* @throws {RequiredError}
|
|
383
|
-
* @memberof
|
|
372
|
+
* @memberof GenericApi
|
|
384
373
|
*/
|
|
385
|
-
genericPut(requestParameters:
|
|
374
|
+
genericPut(requestParameters: GenericApiGenericPutRequest, axiosOptions?: RawAxiosRequestConfig): Promise<import("axios").AxiosResponse<any, any>>;
|
|
386
375
|
}
|