/** * Identity Security Cloud API - Search Attribute Configuration * 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 ArrayInner */ export interface ArrayInner { } /** * * @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 GetSearchAttributeConfigV1401Response */ export interface GetSearchAttributeConfigV1401Response { /** * A message describing the error * @type {any} * @memberof GetSearchAttributeConfigV1401Response */ 'error'?: any; } /** * * @export * @interface GetSearchAttributeConfigV1429Response */ export interface GetSearchAttributeConfigV1429Response { /** * A message describing the error * @type {any} * @memberof GetSearchAttributeConfigV1429Response */ 'message'?: any; } /** * A JSONPatch Operation as defined by [RFC 6902 - JSON Patch](https://tools.ietf.org/html/rfc6902) * @export * @interface JsonPatchOperation */ export interface JsonPatchOperation { /** * The operation to be performed * @type {string} * @memberof JsonPatchOperation */ 'op': JsonPatchOperationOpEnum; /** * A string JSON Pointer representing the target path to an element to be affected by the operation * @type {string} * @memberof JsonPatchOperation */ 'path': string; /** * * @type {JsonPatchOperationValue} * @memberof JsonPatchOperation */ 'value'?: JsonPatchOperationValue; } export declare const JsonPatchOperationOpEnum: { readonly Add: "add"; readonly Remove: "remove"; readonly Replace: "replace"; readonly Move: "move"; readonly Copy: "copy"; readonly Test: "test"; }; export type JsonPatchOperationOpEnum = typeof JsonPatchOperationOpEnum[keyof typeof JsonPatchOperationOpEnum]; /** * @type JsonPatchOperationValue * The value to be used for the operation, required for \"add\" and \"replace\" operations * @export */ export type JsonPatchOperationValue = Array | boolean | number | object | string; /** * 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]; /** * * @export * @interface SearchAttributeConfig */ export interface SearchAttributeConfig { /** * Name of the new attribute * @type {string} * @memberof SearchAttributeConfig */ 'name'?: string; /** * The display name of the new attribute * @type {string} * @memberof SearchAttributeConfig */ 'displayName'?: string; /** * Map of application id and their associated attribute. * @type {object} * @memberof SearchAttributeConfig */ 'applicationAttributes'?: object; } /** * SearchAttributeConfigurationApi - axios parameter creator * @export */ export declare const SearchAttributeConfigurationApiAxiosParamCreator: (configuration?: Configuration) => { /** * Create and configure extended search attributes. This API accepts an attribute name, an attribute display name and a list of name/value pair associates of application IDs to attribute names. It will then validate the inputs and configure/create the attribute promotion configuration in the Link ObjectConfig. >**Note: Give searchable attributes unique names. Do not give them the same names used for account attributes or source attributes. Also, do not give them the same names present in account schema for a current or future source, regardless of whether that source is included in the searchable attributes\' `applicationAttributes`.** * @summary Create extended search attributes * @param {SearchAttributeConfig} searchAttributeConfig * @param {*} [axiosOptions] Override http request option. * @throws {RequiredError} */ createSearchAttributeConfigV1: (searchAttributeConfig: SearchAttributeConfig, axiosOptions?: RawAxiosRequestConfig) => Promise; /** * Delete an extended attribute configuration by name. * @summary Delete extended search attribute * @param {string} name Name of the extended search attribute configuration to delete. * @param {*} [axiosOptions] Override http request option. * @throws {RequiredError} */ deleteSearchAttributeConfigV1: (name: string, axiosOptions?: RawAxiosRequestConfig) => Promise; /** * Get a list of attribute/application attributes currently configured in Identity Security Cloud (ISC). * @summary List extended search attributes * @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} */ getSearchAttributeConfigV1: (limit?: number, offset?: number, axiosOptions?: RawAxiosRequestConfig) => Promise; /** * Get an extended attribute configuration by name. * @summary Get extended search attribute * @param {string} name Name of the extended search attribute configuration to get. * @param {*} [axiosOptions] Override http request option. * @throws {RequiredError} */ getSingleSearchAttributeConfigV1: (name: string, axiosOptions?: RawAxiosRequestConfig) => Promise; /** * Update an existing search attribute configuration. You can patch these fields: * name * displayName * applicationAttributes * @summary Update extended search attribute * @param {string} name Name of the search attribute configuration to patch. * @param {Array} jsonPatchOperation * @param {*} [axiosOptions] Override http request option. * @throws {RequiredError} */ patchSearchAttributeConfigV1: (name: string, jsonPatchOperation: Array, axiosOptions?: RawAxiosRequestConfig) => Promise; }; /** * SearchAttributeConfigurationApi - functional programming interface * @export */ export declare const SearchAttributeConfigurationApiFp: (configuration?: Configuration) => { /** * Create and configure extended search attributes. This API accepts an attribute name, an attribute display name and a list of name/value pair associates of application IDs to attribute names. It will then validate the inputs and configure/create the attribute promotion configuration in the Link ObjectConfig. >**Note: Give searchable attributes unique names. Do not give them the same names used for account attributes or source attributes. Also, do not give them the same names present in account schema for a current or future source, regardless of whether that source is included in the searchable attributes\' `applicationAttributes`.** * @summary Create extended search attributes * @param {SearchAttributeConfig} searchAttributeConfig * @param {*} [axiosOptions] Override http request option. * @throws {RequiredError} */ createSearchAttributeConfigV1(searchAttributeConfig: SearchAttributeConfig, axiosOptions?: RawAxiosRequestConfig): Promise<(axios?: AxiosInstance, basePath?: string) => AxiosPromise>; /** * Delete an extended attribute configuration by name. * @summary Delete extended search attribute * @param {string} name Name of the extended search attribute configuration to delete. * @param {*} [axiosOptions] Override http request option. * @throws {RequiredError} */ deleteSearchAttributeConfigV1(name: string, axiosOptions?: RawAxiosRequestConfig): Promise<(axios?: AxiosInstance, basePath?: string) => AxiosPromise>; /** * Get a list of attribute/application attributes currently configured in Identity Security Cloud (ISC). * @summary List extended search attributes * @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} */ getSearchAttributeConfigV1(limit?: number, offset?: number, axiosOptions?: RawAxiosRequestConfig): Promise<(axios?: AxiosInstance, basePath?: string) => AxiosPromise>>; /** * Get an extended attribute configuration by name. * @summary Get extended search attribute * @param {string} name Name of the extended search attribute configuration to get. * @param {*} [axiosOptions] Override http request option. * @throws {RequiredError} */ getSingleSearchAttributeConfigV1(name: string, axiosOptions?: RawAxiosRequestConfig): Promise<(axios?: AxiosInstance, basePath?: string) => AxiosPromise>; /** * Update an existing search attribute configuration. You can patch these fields: * name * displayName * applicationAttributes * @summary Update extended search attribute * @param {string} name Name of the search attribute configuration to patch. * @param {Array} jsonPatchOperation * @param {*} [axiosOptions] Override http request option. * @throws {RequiredError} */ patchSearchAttributeConfigV1(name: string, jsonPatchOperation: Array, axiosOptions?: RawAxiosRequestConfig): Promise<(axios?: AxiosInstance, basePath?: string) => AxiosPromise>; }; /** * SearchAttributeConfigurationApi - factory interface * @export */ export declare const SearchAttributeConfigurationApiFactory: (configuration?: Configuration, basePath?: string, axios?: AxiosInstance) => { /** * Create and configure extended search attributes. This API accepts an attribute name, an attribute display name and a list of name/value pair associates of application IDs to attribute names. It will then validate the inputs and configure/create the attribute promotion configuration in the Link ObjectConfig. >**Note: Give searchable attributes unique names. Do not give them the same names used for account attributes or source attributes. Also, do not give them the same names present in account schema for a current or future source, regardless of whether that source is included in the searchable attributes\' `applicationAttributes`.** * @summary Create extended search attributes * @param {SearchAttributeConfigurationApiCreateSearchAttributeConfigV1Request} requestParameters Request parameters. * @param {*} [axiosOptions] Override http request option. * @throws {RequiredError} */ createSearchAttributeConfigV1(requestParameters: SearchAttributeConfigurationApiCreateSearchAttributeConfigV1Request, axiosOptions?: RawAxiosRequestConfig): AxiosPromise; /** * Delete an extended attribute configuration by name. * @summary Delete extended search attribute * @param {SearchAttributeConfigurationApiDeleteSearchAttributeConfigV1Request} requestParameters Request parameters. * @param {*} [axiosOptions] Override http request option. * @throws {RequiredError} */ deleteSearchAttributeConfigV1(requestParameters: SearchAttributeConfigurationApiDeleteSearchAttributeConfigV1Request, axiosOptions?: RawAxiosRequestConfig): AxiosPromise; /** * Get a list of attribute/application attributes currently configured in Identity Security Cloud (ISC). * @summary List extended search attributes * @param {SearchAttributeConfigurationApiGetSearchAttributeConfigV1Request} requestParameters Request parameters. * @param {*} [axiosOptions] Override http request option. * @throws {RequiredError} */ getSearchAttributeConfigV1(requestParameters?: SearchAttributeConfigurationApiGetSearchAttributeConfigV1Request, axiosOptions?: RawAxiosRequestConfig): AxiosPromise>; /** * Get an extended attribute configuration by name. * @summary Get extended search attribute * @param {SearchAttributeConfigurationApiGetSingleSearchAttributeConfigV1Request} requestParameters Request parameters. * @param {*} [axiosOptions] Override http request option. * @throws {RequiredError} */ getSingleSearchAttributeConfigV1(requestParameters: SearchAttributeConfigurationApiGetSingleSearchAttributeConfigV1Request, axiosOptions?: RawAxiosRequestConfig): AxiosPromise; /** * Update an existing search attribute configuration. You can patch these fields: * name * displayName * applicationAttributes * @summary Update extended search attribute * @param {SearchAttributeConfigurationApiPatchSearchAttributeConfigV1Request} requestParameters Request parameters. * @param {*} [axiosOptions] Override http request option. * @throws {RequiredError} */ patchSearchAttributeConfigV1(requestParameters: SearchAttributeConfigurationApiPatchSearchAttributeConfigV1Request, axiosOptions?: RawAxiosRequestConfig): AxiosPromise; }; /** * Request parameters for createSearchAttributeConfigV1 operation in SearchAttributeConfigurationApi. * @export * @interface SearchAttributeConfigurationApiCreateSearchAttributeConfigV1Request */ export interface SearchAttributeConfigurationApiCreateSearchAttributeConfigV1Request { /** * * @type {SearchAttributeConfig} * @memberof SearchAttributeConfigurationApiCreateSearchAttributeConfigV1 */ readonly searchAttributeConfig: SearchAttributeConfig; } /** * Request parameters for deleteSearchAttributeConfigV1 operation in SearchAttributeConfigurationApi. * @export * @interface SearchAttributeConfigurationApiDeleteSearchAttributeConfigV1Request */ export interface SearchAttributeConfigurationApiDeleteSearchAttributeConfigV1Request { /** * Name of the extended search attribute configuration to delete. * @type {string} * @memberof SearchAttributeConfigurationApiDeleteSearchAttributeConfigV1 */ readonly name: string; } /** * Request parameters for getSearchAttributeConfigV1 operation in SearchAttributeConfigurationApi. * @export * @interface SearchAttributeConfigurationApiGetSearchAttributeConfigV1Request */ export interface SearchAttributeConfigurationApiGetSearchAttributeConfigV1Request { /** * 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 SearchAttributeConfigurationApiGetSearchAttributeConfigV1 */ 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 SearchAttributeConfigurationApiGetSearchAttributeConfigV1 */ readonly offset?: number; } /** * Request parameters for getSingleSearchAttributeConfigV1 operation in SearchAttributeConfigurationApi. * @export * @interface SearchAttributeConfigurationApiGetSingleSearchAttributeConfigV1Request */ export interface SearchAttributeConfigurationApiGetSingleSearchAttributeConfigV1Request { /** * Name of the extended search attribute configuration to get. * @type {string} * @memberof SearchAttributeConfigurationApiGetSingleSearchAttributeConfigV1 */ readonly name: string; } /** * Request parameters for patchSearchAttributeConfigV1 operation in SearchAttributeConfigurationApi. * @export * @interface SearchAttributeConfigurationApiPatchSearchAttributeConfigV1Request */ export interface SearchAttributeConfigurationApiPatchSearchAttributeConfigV1Request { /** * Name of the search attribute configuration to patch. * @type {string} * @memberof SearchAttributeConfigurationApiPatchSearchAttributeConfigV1 */ readonly name: string; /** * * @type {Array} * @memberof SearchAttributeConfigurationApiPatchSearchAttributeConfigV1 */ readonly jsonPatchOperation: Array; } /** * SearchAttributeConfigurationApi - object-oriented interface * @export * @class SearchAttributeConfigurationApi * @extends {BaseAPI} */ export declare class SearchAttributeConfigurationApi extends BaseAPI { /** * Create and configure extended search attributes. This API accepts an attribute name, an attribute display name and a list of name/value pair associates of application IDs to attribute names. It will then validate the inputs and configure/create the attribute promotion configuration in the Link ObjectConfig. >**Note: Give searchable attributes unique names. Do not give them the same names used for account attributes or source attributes. Also, do not give them the same names present in account schema for a current or future source, regardless of whether that source is included in the searchable attributes\' `applicationAttributes`.** * @summary Create extended search attributes * @param {SearchAttributeConfigurationApiCreateSearchAttributeConfigV1Request} requestParameters Request parameters. * @param {*} [axiosOptions] Override http request option. * @throws {RequiredError} * @memberof SearchAttributeConfigurationApi */ createSearchAttributeConfigV1(requestParameters: SearchAttributeConfigurationApiCreateSearchAttributeConfigV1Request, axiosOptions?: RawAxiosRequestConfig): Promise>; /** * Delete an extended attribute configuration by name. * @summary Delete extended search attribute * @param {SearchAttributeConfigurationApiDeleteSearchAttributeConfigV1Request} requestParameters Request parameters. * @param {*} [axiosOptions] Override http request option. * @throws {RequiredError} * @memberof SearchAttributeConfigurationApi */ deleteSearchAttributeConfigV1(requestParameters: SearchAttributeConfigurationApiDeleteSearchAttributeConfigV1Request, axiosOptions?: RawAxiosRequestConfig): Promise>; /** * Get a list of attribute/application attributes currently configured in Identity Security Cloud (ISC). * @summary List extended search attributes * @param {SearchAttributeConfigurationApiGetSearchAttributeConfigV1Request} requestParameters Request parameters. * @param {*} [axiosOptions] Override http request option. * @throws {RequiredError} * @memberof SearchAttributeConfigurationApi */ getSearchAttributeConfigV1(requestParameters?: SearchAttributeConfigurationApiGetSearchAttributeConfigV1Request, axiosOptions?: RawAxiosRequestConfig): Promise>; /** * Get an extended attribute configuration by name. * @summary Get extended search attribute * @param {SearchAttributeConfigurationApiGetSingleSearchAttributeConfigV1Request} requestParameters Request parameters. * @param {*} [axiosOptions] Override http request option. * @throws {RequiredError} * @memberof SearchAttributeConfigurationApi */ getSingleSearchAttributeConfigV1(requestParameters: SearchAttributeConfigurationApiGetSingleSearchAttributeConfigV1Request, axiosOptions?: RawAxiosRequestConfig): Promise>; /** * Update an existing search attribute configuration. You can patch these fields: * name * displayName * applicationAttributes * @summary Update extended search attribute * @param {SearchAttributeConfigurationApiPatchSearchAttributeConfigV1Request} requestParameters Request parameters. * @param {*} [axiosOptions] Override http request option. * @throws {RequiredError} * @memberof SearchAttributeConfigurationApi */ patchSearchAttributeConfigV1(requestParameters: SearchAttributeConfigurationApiPatchSearchAttributeConfigV1Request, axiosOptions?: RawAxiosRequestConfig): Promise>; }