/** * Identity Security Cloud API - Parameter Storage * Use these APIs to interact with the Identity Security Cloud platform to achieve repeatable, automated processes with greater scalability. We encourage you to join the SailPoint Developer Community forum at https://developer.sailpoint.com/discuss to connect with other developers using our APIs. * * The version of the OpenAPI document: v1 * * * NOTE: This class is auto generated by OpenAPI Generator (https://openapi-generator.tech). * https://openapi-generator.tech * Do not edit the class manually. */ import type { Configuration } from '../configuration'; import type { AxiosPromise, AxiosInstance, RawAxiosRequestConfig } from 'axios'; import type { RequestArgs } from './base'; import { BaseAPI } from './base'; /** * * @export * @interface DeleteParameterV1409Response */ export interface DeleteParameterV1409Response { /** * A message describing the error * @type {any} * @memberof DeleteParameterV1409Response */ 'errorName'?: any; /** * Description of the error * @type {any} * @memberof DeleteParameterV1409Response */ 'errorMessage'?: any; /** * Unique tracking id for the error. * @type {string} * @memberof DeleteParameterV1409Response */ 'trackingId'?: string; } /** * * @export * @interface ErrorMessageDto */ export interface ErrorMessageDto { /** * The locale for the message text, a BCP 47 language tag. * @type {string} * @memberof ErrorMessageDto */ 'locale'?: string | null; /** * * @type {LocaleOrigin} * @memberof ErrorMessageDto */ 'localeOrigin'?: LocaleOrigin | null; /** * Actual text of the error message in the indicated locale. * @type {string} * @memberof ErrorMessageDto */ 'text'?: string; } /** * * @export * @interface ErrorResponseDto */ export interface ErrorResponseDto { /** * Fine-grained error code providing more detail of the error. * @type {string} * @memberof ErrorResponseDto */ 'detailCode'?: string; /** * Unique tracking id for the error. * @type {string} * @memberof ErrorResponseDto */ 'trackingId'?: string; /** * Generic localized reason for error * @type {Array} * @memberof ErrorResponseDto */ 'messages'?: Array; /** * Plain-text descriptive reasons to provide additional detail to the text provided in the messages field * @type {Array} * @memberof ErrorResponseDto */ 'causes'?: Array; } /** * * @export * @interface GetAttestationDocumentV1401Response */ export interface GetAttestationDocumentV1401Response { /** * A message describing the error * @type {any} * @memberof GetAttestationDocumentV1401Response */ 'error'?: any; } /** * * @export * @interface GetAttestationDocumentV1429Response */ export interface GetAttestationDocumentV1429Response { /** * A message describing the error * @type {any} * @memberof GetAttestationDocumentV1429Response */ 'message'?: any; } /** * An indicator of how the locale was selected. *DEFAULT* means the locale is the system default. *REQUEST* means the locale was selected from the request context (i.e., best match based on the *Accept-Language* header). Additional values may be added in the future without notice. * @export * @enum {string} */ export declare const LocaleOrigin: { readonly Default: "DEFAULT"; readonly Request: "REQUEST"; }; export type LocaleOrigin = typeof LocaleOrigin[keyof typeof LocaleOrigin]; /** * The attestation document. This is Base64Url encoded binary data containing the attestation document. This has a cert with a public key that needs to be used to encrypt the private fields of the parameter on creation or update. * @export * @interface ParameterStorageAttestationDocument */ export interface ParameterStorageAttestationDocument { /** * The Base64Url encoded attestation document. * @type {string} * @memberof ParameterStorageAttestationDocument */ 'attestationDocument'?: string; } /** * RFC 6902 JSON Patch operation * @export * @interface ParameterStorageJsonPatch */ export interface ParameterStorageJsonPatch { /** * The operation to perform (add, remove, replace, move, copy, test) * @type {string} * @memberof ParameterStorageJsonPatch */ 'op': ParameterStorageJsonPatchOpEnum; /** * A JSON-Pointer describing the target location * @type {string} * @memberof ParameterStorageJsonPatch */ 'path': string; /** * The value to be used within the operations. Required for add/replace/test. * @type {any} * @memberof ParameterStorageJsonPatch */ 'value'?: any; /** * A JSON-Pointer describing the source location for move/copy. * @type {string} * @memberof ParameterStorageJsonPatch */ 'from'?: string; } export declare const ParameterStorageJsonPatchOpEnum: { readonly Add: "add"; readonly Remove: "remove"; readonly Replace: "replace"; readonly Move: "move"; readonly Copy: "copy"; readonly Test: "test"; }; export type ParameterStorageJsonPatchOpEnum = typeof ParameterStorageJsonPatchOpEnum[keyof typeof ParameterStorageJsonPatchOpEnum]; /** * A parameter to add to parameter storage. The public and private fields must match the type specification. * @export * @interface ParameterStorageNewParameter */ export interface ParameterStorageNewParameter { /** * The UUID of the parameter owner. * @type {string} * @memberof ParameterStorageNewParameter */ 'ownerId': string; /** * The human-readable name for the parameter. * @type {string} * @memberof ParameterStorageNewParameter */ 'name': string; /** * The type of the parameter. This cannot be changed after being set. Please see the types document for more information. * @type {string} * @memberof ParameterStorageNewParameter */ 'type': string; /** * The content must be a JSON object containing the public fields that can be stored with this parameter. * @type {object} * @memberof ParameterStorageNewParameter */ 'publicFields'?: object; /** * Must be a JWE AES256 encrypted blob. The content of the blob must be a JSON object containing the private fields that can be stored with this parameter. * @type {string} * @memberof ParameterStorageNewParameter */ 'privateFields'?: string; /** * Describe the parameter * @type {string} * @memberof ParameterStorageNewParameter */ 'description'?: string; } /** * A parameter that has been retrieved from the store. * @export * @interface ParameterStorageParameter */ export interface ParameterStorageParameter { /** * The ID of the reference * @type {string} * @memberof ParameterStorageParameter */ 'id': string; /** * The ID of the user who owns the parameter. * @type {string} * @memberof ParameterStorageParameter */ 'ownerId': string; /** * The type of the parameter. This cannot be changed after being set. Please see the types document for more information. * @type {string} * @memberof ParameterStorageParameter */ 'type'?: string; /** * The human-readable name of the parameter. * @type {string} * @memberof ParameterStorageParameter */ 'name': string; /** * The name of the primary field in the public fields. * @type {string} * @memberof ParameterStorageParameter */ 'primaryField'?: string; /** * The public fields stored for this parameter. See the types document for information about what can be stored. * @type {object} * @memberof ParameterStorageParameter */ 'publicFields': object; /** * Describe the parameter * @type {string} * @memberof ParameterStorageParameter */ 'description'?: string; /** * ISO8606 format datetime of the last time any field of the parameter was changed. * @type {string} * @memberof ParameterStorageParameter */ 'lastModifiedAt'?: string; /** * The ID of the user who last modified the parameter. Empty when identity is not known. * @type {string} * @memberof ParameterStorageParameter */ 'lastModifiedBy'?: string; /** * ISO8606 format datetime of the time the secret fields were changed on the parameter. * @type {string} * @memberof ParameterStorageParameter */ 'privateFieldsLastModifiedAt'?: string; /** * The ID of the user who last modified the private fields. Empty when identity is not known. * @type {string} * @memberof ParameterStorageParameter */ 'privateFieldsLastModifiedBy'?: string; } /** * Reference information returned in response to a request. * @export * @interface ParameterStorageReference */ export interface ParameterStorageReference { /** * The ID of the reference * @type {string} * @memberof ParameterStorageReference */ 'id': string; /** * The ID of the consumer holding the reference * @type {string} * @memberof ParameterStorageReference */ 'consumerId': string; /** * The ID of the parameter that the reference is pointing to. * @type {string} * @memberof ParameterStorageReference */ 'parameterId': string; /** * The human-readable name of the reference * @type {string} * @memberof ParameterStorageReference */ 'name': string; /** * The hint string used to validate the reference * @type {string} * @memberof ParameterStorageReference */ 'usageHint'?: string; } /** * An existing parameter that needs to be updated. The type cannot be changed once the parameter is created. * @export * @interface ParameterStorageUpdateParameter */ export interface ParameterStorageUpdateParameter { /** * The UUID of the parameter owner. * @type {string} * @memberof ParameterStorageUpdateParameter */ 'ownerId'?: string; /** * The human-readable name for the parameter. * @type {string} * @memberof ParameterStorageUpdateParameter */ 'name'?: string; /** * The public fields that can be stored with this parameter. * @type {object} * @memberof ParameterStorageUpdateParameter */ 'publicFields'?: object; /** * The private fields that can be stored with this parameter. * @type {string} * @memberof ParameterStorageUpdateParameter */ 'privateFields'?: string; /** * Describe the parameter * @type {string} * @memberof ParameterStorageUpdateParameter */ 'description'?: string; } /** * ParameterStorageApi - axios parameter creator * @export */ export declare const ParameterStorageApiAxiosParamCreator: (configuration?: Configuration) => { /** * Add a new parameter. * @summary Add a new parameter. * @param {ParameterStorageNewParameter} [parameterStorageNewParameter] The parameter to add to the store. * @param {*} [axiosOptions] Override http request option. * @throws {RequiredError} */ createParameterV1: (parameterStorageNewParameter?: ParameterStorageNewParameter, axiosOptions?: RawAxiosRequestConfig) => Promise; /** * Delete a parameter. Will only delete parameters without existing references. * @summary Delete a parameter. * @param {string} id The ID of the parameter to be deleted. * @param {*} [axiosOptions] Override http request option. * @throws {RequiredError} */ deleteParameterV1: (id: string, axiosOptions?: RawAxiosRequestConfig) => Promise; /** * Get an attestation document containing a NIST P-384 service public key for an ECDHE handshake, enabling the end-to-end-encrypted transport of parameter private fields. * @summary Get an attestation document. * @param {string} key Base64Url encoded NIST P-384 public key * @param {*} [axiosOptions] Override http request option. * @throws {RequiredError} */ getAttestationDocumentV1: (key: string, axiosOptions?: RawAxiosRequestConfig) => Promise; /** * Get the references for a given parameter. * @summary Get parameter references. * @param {string} id The ID of the parameter which you want to fetch the references for. * @param {string} [sorters] Sort results using the standard syntax described in [V3 API Standard Collection Parameters](https://developer.sailpoint.com/idn/api/standard-collection-parameters#sorting-results) Sorting is supported for the following fields: **id, consumerId, parameterId, name, usageHint** * @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. * @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. * @param {*} [axiosOptions] Override http request option. * @throws {RequiredError} */ getParameterReferencesV1: (id: string, sorters?: string, limit?: number, offset?: number, axiosOptions?: RawAxiosRequestConfig) => Promise; /** * Get the specifications for all parameter types. All parameters must conform to this specification document. * @summary Get specifications for parameter types. * @param {string} [acceptLanguage] The i18n internationalization code for the language that the spec is in. Defaults to english. * @param {*} [axiosOptions] Override http request option. * @throws {RequiredError} */ getParameterStorageSpecificationV1: (acceptLanguage?: string, axiosOptions?: RawAxiosRequestConfig) => Promise; /** * Get a parameter by ID. This will only return the public fields for the parameter. * @summary Get a specific parameter. * @param {string} id The ID of the parameter to be fetched * @param {*} [axiosOptions] Override http request option. * @throws {RequiredError} */ getParameterV1: (id: string, axiosOptions?: RawAxiosRequestConfig) => Promise; /** * Query a stored parameter. * @summary Query stored parameters. * @param {string} [filters] Filter results using the standard syntax described in [V3 API Standard Collection Parameters](https://developer.sailpoint.com/idn/api/standard-collection-parameters#filtering-results) Filtering is supported for the following fields and operators: **id**: *eq, ne* **name**: *eq, in, co* **description**: *co* **ownerId**: *eq* **type**: *eq, sw* * @param {string} [sorters] Sort results using the standard syntax described in [V3 API Standard Collection Parameters](https://developer.sailpoint.com/idn/api/standard-collection-parameters#sorting-results) Sorting is supported for the following fields: **id, name, ownerId, type, description, lastModifiedAt, lastModifiedBy, privateFieldsLastModifiedAt, privateFieldsLastModifiedAt** * @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. * @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. * @param {*} [axiosOptions] Override http request option. * @throws {RequiredError} */ searchParametersV1: (filters?: string, sorters?: string, offset?: number, limit?: number, axiosOptions?: RawAxiosRequestConfig) => Promise; /** * Update a parameter. You cannot change a parameter\'s type once set. Only the name, owner, description, public fields, and private fields can be updated. Private field updates are made via JWE AES256 encrypted blobs. * @summary Update a parameter. * @param {string} id The ID of the parameter to be updated. * @param {ParameterStorageUpdateParameter} [parameterStorageUpdateParameter] The updated parameter. Supports both full and RFC 6902 JSON Patch updates. For RFC 6902 JSON Patch updates, move and copy operations are not supported for privateField updates. * @param {*} [axiosOptions] Override http request option. * @throws {RequiredError} */ updateParameterV1: (id: string, parameterStorageUpdateParameter?: ParameterStorageUpdateParameter, axiosOptions?: RawAxiosRequestConfig) => Promise; }; /** * ParameterStorageApi - functional programming interface * @export */ export declare const ParameterStorageApiFp: (configuration?: Configuration) => { /** * Add a new parameter. * @summary Add a new parameter. * @param {ParameterStorageNewParameter} [parameterStorageNewParameter] The parameter to add to the store. * @param {*} [axiosOptions] Override http request option. * @throws {RequiredError} */ createParameterV1(parameterStorageNewParameter?: ParameterStorageNewParameter, axiosOptions?: RawAxiosRequestConfig): Promise<(axios?: AxiosInstance, basePath?: string) => AxiosPromise>; /** * Delete a parameter. Will only delete parameters without existing references. * @summary Delete a parameter. * @param {string} id The ID of the parameter to be deleted. * @param {*} [axiosOptions] Override http request option. * @throws {RequiredError} */ deleteParameterV1(id: string, axiosOptions?: RawAxiosRequestConfig): Promise<(axios?: AxiosInstance, basePath?: string) => AxiosPromise>; /** * Get an attestation document containing a NIST P-384 service public key for an ECDHE handshake, enabling the end-to-end-encrypted transport of parameter private fields. * @summary Get an attestation document. * @param {string} key Base64Url encoded NIST P-384 public key * @param {*} [axiosOptions] Override http request option. * @throws {RequiredError} */ getAttestationDocumentV1(key: string, axiosOptions?: RawAxiosRequestConfig): Promise<(axios?: AxiosInstance, basePath?: string) => AxiosPromise>; /** * Get the references for a given parameter. * @summary Get parameter references. * @param {string} id The ID of the parameter which you want to fetch the references for. * @param {string} [sorters] Sort results using the standard syntax described in [V3 API Standard Collection Parameters](https://developer.sailpoint.com/idn/api/standard-collection-parameters#sorting-results) Sorting is supported for the following fields: **id, consumerId, parameterId, name, usageHint** * @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. * @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. * @param {*} [axiosOptions] Override http request option. * @throws {RequiredError} */ getParameterReferencesV1(id: string, sorters?: string, limit?: number, offset?: number, axiosOptions?: RawAxiosRequestConfig): Promise<(axios?: AxiosInstance, basePath?: string) => AxiosPromise>>; /** * Get the specifications for all parameter types. All parameters must conform to this specification document. * @summary Get specifications for parameter types. * @param {string} [acceptLanguage] The i18n internationalization code for the language that the spec is in. Defaults to english. * @param {*} [axiosOptions] Override http request option. * @throws {RequiredError} */ getParameterStorageSpecificationV1(acceptLanguage?: string, axiosOptions?: RawAxiosRequestConfig): Promise<(axios?: AxiosInstance, basePath?: string) => AxiosPromise>; /** * Get a parameter by ID. This will only return the public fields for the parameter. * @summary Get a specific parameter. * @param {string} id The ID of the parameter to be fetched * @param {*} [axiosOptions] Override http request option. * @throws {RequiredError} */ getParameterV1(id: string, axiosOptions?: RawAxiosRequestConfig): Promise<(axios?: AxiosInstance, basePath?: string) => AxiosPromise>; /** * Query a stored parameter. * @summary Query stored parameters. * @param {string} [filters] Filter results using the standard syntax described in [V3 API Standard Collection Parameters](https://developer.sailpoint.com/idn/api/standard-collection-parameters#filtering-results) Filtering is supported for the following fields and operators: **id**: *eq, ne* **name**: *eq, in, co* **description**: *co* **ownerId**: *eq* **type**: *eq, sw* * @param {string} [sorters] Sort results using the standard syntax described in [V3 API Standard Collection Parameters](https://developer.sailpoint.com/idn/api/standard-collection-parameters#sorting-results) Sorting is supported for the following fields: **id, name, ownerId, type, description, lastModifiedAt, lastModifiedBy, privateFieldsLastModifiedAt, privateFieldsLastModifiedAt** * @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. * @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. * @param {*} [axiosOptions] Override http request option. * @throws {RequiredError} */ searchParametersV1(filters?: string, sorters?: string, offset?: number, limit?: number, axiosOptions?: RawAxiosRequestConfig): Promise<(axios?: AxiosInstance, basePath?: string) => AxiosPromise>>; /** * Update a parameter. You cannot change a parameter\'s type once set. Only the name, owner, description, public fields, and private fields can be updated. Private field updates are made via JWE AES256 encrypted blobs. * @summary Update a parameter. * @param {string} id The ID of the parameter to be updated. * @param {ParameterStorageUpdateParameter} [parameterStorageUpdateParameter] The updated parameter. Supports both full and RFC 6902 JSON Patch updates. For RFC 6902 JSON Patch updates, move and copy operations are not supported for privateField updates. * @param {*} [axiosOptions] Override http request option. * @throws {RequiredError} */ updateParameterV1(id: string, parameterStorageUpdateParameter?: ParameterStorageUpdateParameter, axiosOptions?: RawAxiosRequestConfig): Promise<(axios?: AxiosInstance, basePath?: string) => AxiosPromise>; }; /** * ParameterStorageApi - factory interface * @export */ export declare const ParameterStorageApiFactory: (configuration?: Configuration, basePath?: string, axios?: AxiosInstance) => { /** * Add a new parameter. * @summary Add a new parameter. * @param {ParameterStorageApiCreateParameterV1Request} requestParameters Request parameters. * @param {*} [axiosOptions] Override http request option. * @throws {RequiredError} */ createParameterV1(requestParameters?: ParameterStorageApiCreateParameterV1Request, axiosOptions?: RawAxiosRequestConfig): AxiosPromise; /** * Delete a parameter. Will only delete parameters without existing references. * @summary Delete a parameter. * @param {ParameterStorageApiDeleteParameterV1Request} requestParameters Request parameters. * @param {*} [axiosOptions] Override http request option. * @throws {RequiredError} */ deleteParameterV1(requestParameters: ParameterStorageApiDeleteParameterV1Request, axiosOptions?: RawAxiosRequestConfig): AxiosPromise; /** * Get an attestation document containing a NIST P-384 service public key for an ECDHE handshake, enabling the end-to-end-encrypted transport of parameter private fields. * @summary Get an attestation document. * @param {ParameterStorageApiGetAttestationDocumentV1Request} requestParameters Request parameters. * @param {*} [axiosOptions] Override http request option. * @throws {RequiredError} */ getAttestationDocumentV1(requestParameters: ParameterStorageApiGetAttestationDocumentV1Request, axiosOptions?: RawAxiosRequestConfig): AxiosPromise; /** * Get the references for a given parameter. * @summary Get parameter references. * @param {ParameterStorageApiGetParameterReferencesV1Request} requestParameters Request parameters. * @param {*} [axiosOptions] Override http request option. * @throws {RequiredError} */ getParameterReferencesV1(requestParameters: ParameterStorageApiGetParameterReferencesV1Request, axiosOptions?: RawAxiosRequestConfig): AxiosPromise>; /** * Get the specifications for all parameter types. All parameters must conform to this specification document. * @summary Get specifications for parameter types. * @param {ParameterStorageApiGetParameterStorageSpecificationV1Request} requestParameters Request parameters. * @param {*} [axiosOptions] Override http request option. * @throws {RequiredError} */ getParameterStorageSpecificationV1(requestParameters?: ParameterStorageApiGetParameterStorageSpecificationV1Request, axiosOptions?: RawAxiosRequestConfig): AxiosPromise; /** * Get a parameter by ID. This will only return the public fields for the parameter. * @summary Get a specific parameter. * @param {ParameterStorageApiGetParameterV1Request} requestParameters Request parameters. * @param {*} [axiosOptions] Override http request option. * @throws {RequiredError} */ getParameterV1(requestParameters: ParameterStorageApiGetParameterV1Request, axiosOptions?: RawAxiosRequestConfig): AxiosPromise; /** * Query a stored parameter. * @summary Query stored parameters. * @param {ParameterStorageApiSearchParametersV1Request} requestParameters Request parameters. * @param {*} [axiosOptions] Override http request option. * @throws {RequiredError} */ searchParametersV1(requestParameters?: ParameterStorageApiSearchParametersV1Request, axiosOptions?: RawAxiosRequestConfig): AxiosPromise>; /** * Update a parameter. You cannot change a parameter\'s type once set. Only the name, owner, description, public fields, and private fields can be updated. Private field updates are made via JWE AES256 encrypted blobs. * @summary Update a parameter. * @param {ParameterStorageApiUpdateParameterV1Request} requestParameters Request parameters. * @param {*} [axiosOptions] Override http request option. * @throws {RequiredError} */ updateParameterV1(requestParameters: ParameterStorageApiUpdateParameterV1Request, axiosOptions?: RawAxiosRequestConfig): AxiosPromise; }; /** * Request parameters for createParameterV1 operation in ParameterStorageApi. * @export * @interface ParameterStorageApiCreateParameterV1Request */ export interface ParameterStorageApiCreateParameterV1Request { /** * The parameter to add to the store. * @type {ParameterStorageNewParameter} * @memberof ParameterStorageApiCreateParameterV1 */ readonly parameterStorageNewParameter?: ParameterStorageNewParameter; } /** * Request parameters for deleteParameterV1 operation in ParameterStorageApi. * @export * @interface ParameterStorageApiDeleteParameterV1Request */ export interface ParameterStorageApiDeleteParameterV1Request { /** * The ID of the parameter to be deleted. * @type {string} * @memberof ParameterStorageApiDeleteParameterV1 */ readonly id: string; } /** * Request parameters for getAttestationDocumentV1 operation in ParameterStorageApi. * @export * @interface ParameterStorageApiGetAttestationDocumentV1Request */ export interface ParameterStorageApiGetAttestationDocumentV1Request { /** * Base64Url encoded NIST P-384 public key * @type {string} * @memberof ParameterStorageApiGetAttestationDocumentV1 */ readonly key: string; } /** * Request parameters for getParameterReferencesV1 operation in ParameterStorageApi. * @export * @interface ParameterStorageApiGetParameterReferencesV1Request */ export interface ParameterStorageApiGetParameterReferencesV1Request { /** * The ID of the parameter which you want to fetch the references for. * @type {string} * @memberof ParameterStorageApiGetParameterReferencesV1 */ readonly id: string; /** * Sort results using the standard syntax described in [V3 API Standard Collection Parameters](https://developer.sailpoint.com/idn/api/standard-collection-parameters#sorting-results) Sorting is supported for the following fields: **id, consumerId, parameterId, name, usageHint** * @type {string} * @memberof ParameterStorageApiGetParameterReferencesV1 */ readonly sorters?: string; /** * Max number of results to return. See [V3 API Standard Collection Parameters](https://developer.sailpoint.com/idn/api/standard-collection-parameters) for more information. * @type {number} * @memberof ParameterStorageApiGetParameterReferencesV1 */ readonly limit?: number; /** * 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. * @type {number} * @memberof ParameterStorageApiGetParameterReferencesV1 */ readonly offset?: number; } /** * Request parameters for getParameterStorageSpecificationV1 operation in ParameterStorageApi. * @export * @interface ParameterStorageApiGetParameterStorageSpecificationV1Request */ export interface ParameterStorageApiGetParameterStorageSpecificationV1Request { /** * The i18n internationalization code for the language that the spec is in. Defaults to english. * @type {string} * @memberof ParameterStorageApiGetParameterStorageSpecificationV1 */ readonly acceptLanguage?: string; } /** * Request parameters for getParameterV1 operation in ParameterStorageApi. * @export * @interface ParameterStorageApiGetParameterV1Request */ export interface ParameterStorageApiGetParameterV1Request { /** * The ID of the parameter to be fetched * @type {string} * @memberof ParameterStorageApiGetParameterV1 */ readonly id: string; } /** * Request parameters for searchParametersV1 operation in ParameterStorageApi. * @export * @interface ParameterStorageApiSearchParametersV1Request */ export interface ParameterStorageApiSearchParametersV1Request { /** * Filter results using the standard syntax described in [V3 API Standard Collection Parameters](https://developer.sailpoint.com/idn/api/standard-collection-parameters#filtering-results) Filtering is supported for the following fields and operators: **id**: *eq, ne* **name**: *eq, in, co* **description**: *co* **ownerId**: *eq* **type**: *eq, sw* * @type {string} * @memberof ParameterStorageApiSearchParametersV1 */ readonly filters?: string; /** * Sort results using the standard syntax described in [V3 API Standard Collection Parameters](https://developer.sailpoint.com/idn/api/standard-collection-parameters#sorting-results) Sorting is supported for the following fields: **id, name, ownerId, type, description, lastModifiedAt, lastModifiedBy, privateFieldsLastModifiedAt, privateFieldsLastModifiedAt** * @type {string} * @memberof ParameterStorageApiSearchParametersV1 */ readonly sorters?: string; /** * 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. * @type {number} * @memberof ParameterStorageApiSearchParametersV1 */ readonly offset?: number; /** * Max number of results to return. See [V3 API Standard Collection Parameters](https://developer.sailpoint.com/idn/api/standard-collection-parameters) for more information. * @type {number} * @memberof ParameterStorageApiSearchParametersV1 */ readonly limit?: number; } /** * Request parameters for updateParameterV1 operation in ParameterStorageApi. * @export * @interface ParameterStorageApiUpdateParameterV1Request */ export interface ParameterStorageApiUpdateParameterV1Request { /** * The ID of the parameter to be updated. * @type {string} * @memberof ParameterStorageApiUpdateParameterV1 */ readonly id: string; /** * The updated parameter. Supports both full and RFC 6902 JSON Patch updates. For RFC 6902 JSON Patch updates, move and copy operations are not supported for privateField updates. * @type {ParameterStorageUpdateParameter} * @memberof ParameterStorageApiUpdateParameterV1 */ readonly parameterStorageUpdateParameter?: ParameterStorageUpdateParameter; } /** * ParameterStorageApi - object-oriented interface * @export * @class ParameterStorageApi * @extends {BaseAPI} */ export declare class ParameterStorageApi extends BaseAPI { /** * Add a new parameter. * @summary Add a new parameter. * @param {ParameterStorageApiCreateParameterV1Request} requestParameters Request parameters. * @param {*} [axiosOptions] Override http request option. * @throws {RequiredError} * @memberof ParameterStorageApi */ createParameterV1(requestParameters?: ParameterStorageApiCreateParameterV1Request, axiosOptions?: RawAxiosRequestConfig): Promise>; /** * Delete a parameter. Will only delete parameters without existing references. * @summary Delete a parameter. * @param {ParameterStorageApiDeleteParameterV1Request} requestParameters Request parameters. * @param {*} [axiosOptions] Override http request option. * @throws {RequiredError} * @memberof ParameterStorageApi */ deleteParameterV1(requestParameters: ParameterStorageApiDeleteParameterV1Request, axiosOptions?: RawAxiosRequestConfig): Promise>; /** * Get an attestation document containing a NIST P-384 service public key for an ECDHE handshake, enabling the end-to-end-encrypted transport of parameter private fields. * @summary Get an attestation document. * @param {ParameterStorageApiGetAttestationDocumentV1Request} requestParameters Request parameters. * @param {*} [axiosOptions] Override http request option. * @throws {RequiredError} * @memberof ParameterStorageApi */ getAttestationDocumentV1(requestParameters: ParameterStorageApiGetAttestationDocumentV1Request, axiosOptions?: RawAxiosRequestConfig): Promise>; /** * Get the references for a given parameter. * @summary Get parameter references. * @param {ParameterStorageApiGetParameterReferencesV1Request} requestParameters Request parameters. * @param {*} [axiosOptions] Override http request option. * @throws {RequiredError} * @memberof ParameterStorageApi */ getParameterReferencesV1(requestParameters: ParameterStorageApiGetParameterReferencesV1Request, axiosOptions?: RawAxiosRequestConfig): Promise>; /** * Get the specifications for all parameter types. All parameters must conform to this specification document. * @summary Get specifications for parameter types. * @param {ParameterStorageApiGetParameterStorageSpecificationV1Request} requestParameters Request parameters. * @param {*} [axiosOptions] Override http request option. * @throws {RequiredError} * @memberof ParameterStorageApi */ getParameterStorageSpecificationV1(requestParameters?: ParameterStorageApiGetParameterStorageSpecificationV1Request, axiosOptions?: RawAxiosRequestConfig): Promise>; /** * Get a parameter by ID. This will only return the public fields for the parameter. * @summary Get a specific parameter. * @param {ParameterStorageApiGetParameterV1Request} requestParameters Request parameters. * @param {*} [axiosOptions] Override http request option. * @throws {RequiredError} * @memberof ParameterStorageApi */ getParameterV1(requestParameters: ParameterStorageApiGetParameterV1Request, axiosOptions?: RawAxiosRequestConfig): Promise>; /** * Query a stored parameter. * @summary Query stored parameters. * @param {ParameterStorageApiSearchParametersV1Request} requestParameters Request parameters. * @param {*} [axiosOptions] Override http request option. * @throws {RequiredError} * @memberof ParameterStorageApi */ searchParametersV1(requestParameters?: ParameterStorageApiSearchParametersV1Request, axiosOptions?: RawAxiosRequestConfig): Promise>; /** * Update a parameter. You cannot change a parameter\'s type once set. Only the name, owner, description, public fields, and private fields can be updated. Private field updates are made via JWE AES256 encrypted blobs. * @summary Update a parameter. * @param {ParameterStorageApiUpdateParameterV1Request} requestParameters Request parameters. * @param {*} [axiosOptions] Override http request option. * @throws {RequiredError} * @memberof ParameterStorageApi */ updateParameterV1(requestParameters: ParameterStorageApiUpdateParameterV1Request, axiosOptions?: RawAxiosRequestConfig): Promise>; }