/** * Identity Security Cloud API - Tagged Objects * 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 BulkAddTaggedObject */ export interface BulkAddTaggedObject { /** * * @type {Array} * @memberof BulkAddTaggedObject */ 'objectRefs'?: Array; /** * Label to be applied to an Object * @type {Array} * @memberof BulkAddTaggedObject */ 'tags'?: Array; /** * If APPEND, tags are appended to the list of tags for the object. A 400 error is returned if this would add duplicate tags to the object. If MERGE, tags are merged with the existing tags. Duplicate tags are silently ignored. * @type {string} * @memberof BulkAddTaggedObject */ 'operation'?: BulkAddTaggedObjectOperationEnum; } export declare const BulkAddTaggedObjectOperationEnum: { readonly Append: "APPEND"; readonly Merge: "MERGE"; }; export type BulkAddTaggedObjectOperationEnum = typeof BulkAddTaggedObjectOperationEnum[keyof typeof BulkAddTaggedObjectOperationEnum]; /** * * @export * @interface BulkRemoveTaggedObject */ export interface BulkRemoveTaggedObject { /** * * @type {Array} * @memberof BulkRemoveTaggedObject */ 'objectRefs'?: Array; /** * Label to be applied to an Object * @type {Array} * @memberof BulkRemoveTaggedObject */ 'tags'?: Array; } /** * * @export * @interface BulkTaggedObjectResponse */ export interface BulkTaggedObjectResponse { /** * * @type {Array} * @memberof BulkTaggedObjectResponse */ 'objectRefs'?: Array; /** * Label to be applied to an Object * @type {Array} * @memberof BulkTaggedObjectResponse */ 'tags'?: Array; } /** * * @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 ListTaggedObjectsV1401Response */ export interface ListTaggedObjectsV1401Response { /** * A message describing the error * @type {any} * @memberof ListTaggedObjectsV1401Response */ 'error'?: any; } /** * * @export * @interface ListTaggedObjectsV1429Response */ export interface ListTaggedObjectsV1429Response { /** * A message describing the error * @type {any} * @memberof ListTaggedObjectsV1429Response */ '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]; /** * Tagged object. * @export * @interface TaggedObject */ export interface TaggedObject { /** * * @type {TaggedObjectDto} * @memberof TaggedObject */ 'objectRef'?: TaggedObjectDto; /** * Labels to be applied to an Object * @type {Array} * @memberof TaggedObject */ 'tags'?: Array; } /** * * @export * @interface TaggedObjectDto */ export interface TaggedObjectDto { /** * DTO type * @type {string} * @memberof TaggedObjectDto */ 'type'?: TaggedObjectDtoTypeEnum; /** * ID of the object this reference applies to * @type {string} * @memberof TaggedObjectDto */ 'id'?: string; /** * Human-readable display name of the object this reference applies to * @type {string} * @memberof TaggedObjectDto */ 'name'?: string | null; } export declare const TaggedObjectDtoTypeEnum: { readonly AccessProfile: "ACCESS_PROFILE"; readonly Application: "APPLICATION"; readonly Campaign: "CAMPAIGN"; readonly Entitlement: "ENTITLEMENT"; readonly Identity: "IDENTITY"; readonly Role: "ROLE"; readonly SodPolicy: "SOD_POLICY"; readonly Source: "SOURCE"; }; export type TaggedObjectDtoTypeEnum = typeof TaggedObjectDtoTypeEnum[keyof typeof TaggedObjectDtoTypeEnum]; /** * TaggedObjectsApi - axios parameter creator * @export */ export declare const TaggedObjectsApiAxiosParamCreator: (configuration?: Configuration) => { /** * Delete all tags from a tagged object. * @summary Delete object tags * @param {DeleteTaggedObjectV1TypeEnum} type The type of object to delete tags from. * @param {string} id The ID of the object to delete tags from. * @param {*} [axiosOptions] Override http request option. * @throws {RequiredError} */ deleteTaggedObjectV1: (type: DeleteTaggedObjectV1TypeEnum, id: string, axiosOptions?: RawAxiosRequestConfig) => Promise; /** * This API removes tags from multiple objects. * @summary Remove tags from multiple objects * @param {BulkRemoveTaggedObject} bulkRemoveTaggedObject Supported object types are ACCESS_PROFILE, APPLICATION, CAMPAIGN, ENTITLEMENT, IDENTITY, ROLE, SOD_POLICY, SOURCE. * @param {*} [axiosOptions] Override http request option. * @throws {RequiredError} */ deleteTagsToManyObjectV1: (bulkRemoveTaggedObject: BulkRemoveTaggedObject, axiosOptions?: RawAxiosRequestConfig) => Promise; /** * This gets a tagged object for the specified type. * @summary Get tagged object * @param {GetTaggedObjectV1TypeEnum} type The type of tagged object to retrieve. * @param {string} id The ID of the object reference to retrieve. * @param {*} [axiosOptions] Override http request option. * @throws {RequiredError} */ getTaggedObjectV1: (type: GetTaggedObjectV1TypeEnum, id: string, axiosOptions?: RawAxiosRequestConfig) => Promise; /** * This API returns a list of all tagged objects by type. * @summary List tagged objects by type * @param {ListTaggedObjectsByTypeV1TypeEnum} type The type of tagged object to retrieve. * @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 {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. Since requesting a total count can have a performance impact, it is recommended not to send **count=true** if that value will not be used. See [V3 API Standard Collection Parameters](https://developer.sailpoint.com/idn/api/standard-collection-parameters) for more information. * @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: **objectRef.id**: *eq* **objectRef.type**: *eq* * @param {*} [axiosOptions] Override http request option. * @throws {RequiredError} */ listTaggedObjectsByTypeV1: (type: ListTaggedObjectsByTypeV1TypeEnum, limit?: number, offset?: number, count?: boolean, filters?: string, axiosOptions?: RawAxiosRequestConfig) => Promise; /** * This API returns a list of all tagged objects. * @summary List tagged objects * @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 {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. Since requesting a total count can have a performance impact, it is recommended not to send **count=true** if that value will not be used. See [V3 API Standard Collection Parameters](https://developer.sailpoint.com/idn/api/standard-collection-parameters) for more information. * @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: **objectRef.id**: *eq, in* **objectRef.type**: *eq, in* **tagName**: *eq, in* * @param {*} [axiosOptions] Override http request option. * @throws {RequiredError} */ listTaggedObjectsV1: (limit?: number, offset?: number, count?: boolean, filters?: string, axiosOptions?: RawAxiosRequestConfig) => Promise; /** * This updates a tagged object for the specified type. * @summary Update tagged object * @param {PutTaggedObjectV1TypeEnum} type The type of tagged object to update. * @param {string} id The ID of the object reference to update. * @param {TaggedObject} taggedObject * @param {*} [axiosOptions] Override http request option. * @throws {RequiredError} */ putTaggedObjectV1: (type: PutTaggedObjectV1TypeEnum, id: string, taggedObject: TaggedObject, axiosOptions?: RawAxiosRequestConfig) => Promise; /** * This adds a tag to an object. * @summary Add tag to object * @param {TaggedObject} taggedObject * @param {*} [axiosOptions] Override http request option. * @throws {RequiredError} */ setTagToObjectV1: (taggedObject: TaggedObject, axiosOptions?: RawAxiosRequestConfig) => Promise; /** * This API adds tags to multiple objects. * @summary Tag multiple objects * @param {BulkAddTaggedObject} bulkAddTaggedObject Supported object types are ACCESS_PROFILE, APPLICATION, CAMPAIGN, ENTITLEMENT, IDENTITY, ROLE, SOD_POLICY, SOURCE. * @param {*} [axiosOptions] Override http request option. * @throws {RequiredError} */ setTagsToManyObjectsV1: (bulkAddTaggedObject: BulkAddTaggedObject, axiosOptions?: RawAxiosRequestConfig) => Promise; }; /** * TaggedObjectsApi - functional programming interface * @export */ export declare const TaggedObjectsApiFp: (configuration?: Configuration) => { /** * Delete all tags from a tagged object. * @summary Delete object tags * @param {DeleteTaggedObjectV1TypeEnum} type The type of object to delete tags from. * @param {string} id The ID of the object to delete tags from. * @param {*} [axiosOptions] Override http request option. * @throws {RequiredError} */ deleteTaggedObjectV1(type: DeleteTaggedObjectV1TypeEnum, id: string, axiosOptions?: RawAxiosRequestConfig): Promise<(axios?: AxiosInstance, basePath?: string) => AxiosPromise>; /** * This API removes tags from multiple objects. * @summary Remove tags from multiple objects * @param {BulkRemoveTaggedObject} bulkRemoveTaggedObject Supported object types are ACCESS_PROFILE, APPLICATION, CAMPAIGN, ENTITLEMENT, IDENTITY, ROLE, SOD_POLICY, SOURCE. * @param {*} [axiosOptions] Override http request option. * @throws {RequiredError} */ deleteTagsToManyObjectV1(bulkRemoveTaggedObject: BulkRemoveTaggedObject, axiosOptions?: RawAxiosRequestConfig): Promise<(axios?: AxiosInstance, basePath?: string) => AxiosPromise>; /** * This gets a tagged object for the specified type. * @summary Get tagged object * @param {GetTaggedObjectV1TypeEnum} type The type of tagged object to retrieve. * @param {string} id The ID of the object reference to retrieve. * @param {*} [axiosOptions] Override http request option. * @throws {RequiredError} */ getTaggedObjectV1(type: GetTaggedObjectV1TypeEnum, id: string, axiosOptions?: RawAxiosRequestConfig): Promise<(axios?: AxiosInstance, basePath?: string) => AxiosPromise>; /** * This API returns a list of all tagged objects by type. * @summary List tagged objects by type * @param {ListTaggedObjectsByTypeV1TypeEnum} type The type of tagged object to retrieve. * @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 {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. Since requesting a total count can have a performance impact, it is recommended not to send **count=true** if that value will not be used. See [V3 API Standard Collection Parameters](https://developer.sailpoint.com/idn/api/standard-collection-parameters) for more information. * @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: **objectRef.id**: *eq* **objectRef.type**: *eq* * @param {*} [axiosOptions] Override http request option. * @throws {RequiredError} */ listTaggedObjectsByTypeV1(type: ListTaggedObjectsByTypeV1TypeEnum, limit?: number, offset?: number, count?: boolean, filters?: string, axiosOptions?: RawAxiosRequestConfig): Promise<(axios?: AxiosInstance, basePath?: string) => AxiosPromise>>; /** * This API returns a list of all tagged objects. * @summary List tagged objects * @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 {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. Since requesting a total count can have a performance impact, it is recommended not to send **count=true** if that value will not be used. See [V3 API Standard Collection Parameters](https://developer.sailpoint.com/idn/api/standard-collection-parameters) for more information. * @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: **objectRef.id**: *eq, in* **objectRef.type**: *eq, in* **tagName**: *eq, in* * @param {*} [axiosOptions] Override http request option. * @throws {RequiredError} */ listTaggedObjectsV1(limit?: number, offset?: number, count?: boolean, filters?: string, axiosOptions?: RawAxiosRequestConfig): Promise<(axios?: AxiosInstance, basePath?: string) => AxiosPromise>>; /** * This updates a tagged object for the specified type. * @summary Update tagged object * @param {PutTaggedObjectV1TypeEnum} type The type of tagged object to update. * @param {string} id The ID of the object reference to update. * @param {TaggedObject} taggedObject * @param {*} [axiosOptions] Override http request option. * @throws {RequiredError} */ putTaggedObjectV1(type: PutTaggedObjectV1TypeEnum, id: string, taggedObject: TaggedObject, axiosOptions?: RawAxiosRequestConfig): Promise<(axios?: AxiosInstance, basePath?: string) => AxiosPromise>; /** * This adds a tag to an object. * @summary Add tag to object * @param {TaggedObject} taggedObject * @param {*} [axiosOptions] Override http request option. * @throws {RequiredError} */ setTagToObjectV1(taggedObject: TaggedObject, axiosOptions?: RawAxiosRequestConfig): Promise<(axios?: AxiosInstance, basePath?: string) => AxiosPromise>; /** * This API adds tags to multiple objects. * @summary Tag multiple objects * @param {BulkAddTaggedObject} bulkAddTaggedObject Supported object types are ACCESS_PROFILE, APPLICATION, CAMPAIGN, ENTITLEMENT, IDENTITY, ROLE, SOD_POLICY, SOURCE. * @param {*} [axiosOptions] Override http request option. * @throws {RequiredError} */ setTagsToManyObjectsV1(bulkAddTaggedObject: BulkAddTaggedObject, axiosOptions?: RawAxiosRequestConfig): Promise<(axios?: AxiosInstance, basePath?: string) => AxiosPromise>>; }; /** * TaggedObjectsApi - factory interface * @export */ export declare const TaggedObjectsApiFactory: (configuration?: Configuration, basePath?: string, axios?: AxiosInstance) => { /** * Delete all tags from a tagged object. * @summary Delete object tags * @param {TaggedObjectsApiDeleteTaggedObjectV1Request} requestParameters Request parameters. * @param {*} [axiosOptions] Override http request option. * @throws {RequiredError} */ deleteTaggedObjectV1(requestParameters: TaggedObjectsApiDeleteTaggedObjectV1Request, axiosOptions?: RawAxiosRequestConfig): AxiosPromise; /** * This API removes tags from multiple objects. * @summary Remove tags from multiple objects * @param {TaggedObjectsApiDeleteTagsToManyObjectV1Request} requestParameters Request parameters. * @param {*} [axiosOptions] Override http request option. * @throws {RequiredError} */ deleteTagsToManyObjectV1(requestParameters: TaggedObjectsApiDeleteTagsToManyObjectV1Request, axiosOptions?: RawAxiosRequestConfig): AxiosPromise; /** * This gets a tagged object for the specified type. * @summary Get tagged object * @param {TaggedObjectsApiGetTaggedObjectV1Request} requestParameters Request parameters. * @param {*} [axiosOptions] Override http request option. * @throws {RequiredError} */ getTaggedObjectV1(requestParameters: TaggedObjectsApiGetTaggedObjectV1Request, axiosOptions?: RawAxiosRequestConfig): AxiosPromise; /** * This API returns a list of all tagged objects by type. * @summary List tagged objects by type * @param {TaggedObjectsApiListTaggedObjectsByTypeV1Request} requestParameters Request parameters. * @param {*} [axiosOptions] Override http request option. * @throws {RequiredError} */ listTaggedObjectsByTypeV1(requestParameters: TaggedObjectsApiListTaggedObjectsByTypeV1Request, axiosOptions?: RawAxiosRequestConfig): AxiosPromise>; /** * This API returns a list of all tagged objects. * @summary List tagged objects * @param {TaggedObjectsApiListTaggedObjectsV1Request} requestParameters Request parameters. * @param {*} [axiosOptions] Override http request option. * @throws {RequiredError} */ listTaggedObjectsV1(requestParameters?: TaggedObjectsApiListTaggedObjectsV1Request, axiosOptions?: RawAxiosRequestConfig): AxiosPromise>; /** * This updates a tagged object for the specified type. * @summary Update tagged object * @param {TaggedObjectsApiPutTaggedObjectV1Request} requestParameters Request parameters. * @param {*} [axiosOptions] Override http request option. * @throws {RequiredError} */ putTaggedObjectV1(requestParameters: TaggedObjectsApiPutTaggedObjectV1Request, axiosOptions?: RawAxiosRequestConfig): AxiosPromise; /** * This adds a tag to an object. * @summary Add tag to object * @param {TaggedObjectsApiSetTagToObjectV1Request} requestParameters Request parameters. * @param {*} [axiosOptions] Override http request option. * @throws {RequiredError} */ setTagToObjectV1(requestParameters: TaggedObjectsApiSetTagToObjectV1Request, axiosOptions?: RawAxiosRequestConfig): AxiosPromise; /** * This API adds tags to multiple objects. * @summary Tag multiple objects * @param {TaggedObjectsApiSetTagsToManyObjectsV1Request} requestParameters Request parameters. * @param {*} [axiosOptions] Override http request option. * @throws {RequiredError} */ setTagsToManyObjectsV1(requestParameters: TaggedObjectsApiSetTagsToManyObjectsV1Request, axiosOptions?: RawAxiosRequestConfig): AxiosPromise>; }; /** * Request parameters for deleteTaggedObjectV1 operation in TaggedObjectsApi. * @export * @interface TaggedObjectsApiDeleteTaggedObjectV1Request */ export interface TaggedObjectsApiDeleteTaggedObjectV1Request { /** * The type of object to delete tags from. * @type {'ACCESS_PROFILE' | 'APPLICATION' | 'CAMPAIGN' | 'ENTITLEMENT' | 'IDENTITY' | 'ROLE' | 'SOD_POLICY' | 'SOURCE'} * @memberof TaggedObjectsApiDeleteTaggedObjectV1 */ readonly type: DeleteTaggedObjectV1TypeEnum; /** * The ID of the object to delete tags from. * @type {string} * @memberof TaggedObjectsApiDeleteTaggedObjectV1 */ readonly id: string; } /** * Request parameters for deleteTagsToManyObjectV1 operation in TaggedObjectsApi. * @export * @interface TaggedObjectsApiDeleteTagsToManyObjectV1Request */ export interface TaggedObjectsApiDeleteTagsToManyObjectV1Request { /** * Supported object types are ACCESS_PROFILE, APPLICATION, CAMPAIGN, ENTITLEMENT, IDENTITY, ROLE, SOD_POLICY, SOURCE. * @type {BulkRemoveTaggedObject} * @memberof TaggedObjectsApiDeleteTagsToManyObjectV1 */ readonly bulkRemoveTaggedObject: BulkRemoveTaggedObject; } /** * Request parameters for getTaggedObjectV1 operation in TaggedObjectsApi. * @export * @interface TaggedObjectsApiGetTaggedObjectV1Request */ export interface TaggedObjectsApiGetTaggedObjectV1Request { /** * The type of tagged object to retrieve. * @type {'ACCESS_PROFILE' | 'APPLICATION' | 'CAMPAIGN' | 'ENTITLEMENT' | 'IDENTITY' | 'ROLE' | 'SOD_POLICY' | 'SOURCE'} * @memberof TaggedObjectsApiGetTaggedObjectV1 */ readonly type: GetTaggedObjectV1TypeEnum; /** * The ID of the object reference to retrieve. * @type {string} * @memberof TaggedObjectsApiGetTaggedObjectV1 */ readonly id: string; } /** * Request parameters for listTaggedObjectsByTypeV1 operation in TaggedObjectsApi. * @export * @interface TaggedObjectsApiListTaggedObjectsByTypeV1Request */ export interface TaggedObjectsApiListTaggedObjectsByTypeV1Request { /** * The type of tagged object to retrieve. * @type {'ACCESS_PROFILE' | 'APPLICATION' | 'CAMPAIGN' | 'ENTITLEMENT' | 'IDENTITY' | 'ROLE' | 'SOD_POLICY' | 'SOURCE'} * @memberof TaggedObjectsApiListTaggedObjectsByTypeV1 */ readonly type: ListTaggedObjectsByTypeV1TypeEnum; /** * 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 TaggedObjectsApiListTaggedObjectsByTypeV1 */ 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 TaggedObjectsApiListTaggedObjectsByTypeV1 */ readonly offset?: number; /** * 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. Since requesting a total count can have a performance impact, it is recommended not to send **count=true** if that value will not be used. See [V3 API Standard Collection Parameters](https://developer.sailpoint.com/idn/api/standard-collection-parameters) for more information. * @type {boolean} * @memberof TaggedObjectsApiListTaggedObjectsByTypeV1 */ readonly count?: boolean; /** * 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: **objectRef.id**: *eq* **objectRef.type**: *eq* * @type {string} * @memberof TaggedObjectsApiListTaggedObjectsByTypeV1 */ readonly filters?: string; } /** * Request parameters for listTaggedObjectsV1 operation in TaggedObjectsApi. * @export * @interface TaggedObjectsApiListTaggedObjectsV1Request */ export interface TaggedObjectsApiListTaggedObjectsV1Request { /** * 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 TaggedObjectsApiListTaggedObjectsV1 */ 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 TaggedObjectsApiListTaggedObjectsV1 */ readonly offset?: number; /** * 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. Since requesting a total count can have a performance impact, it is recommended not to send **count=true** if that value will not be used. See [V3 API Standard Collection Parameters](https://developer.sailpoint.com/idn/api/standard-collection-parameters) for more information. * @type {boolean} * @memberof TaggedObjectsApiListTaggedObjectsV1 */ readonly count?: boolean; /** * 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: **objectRef.id**: *eq, in* **objectRef.type**: *eq, in* **tagName**: *eq, in* * @type {string} * @memberof TaggedObjectsApiListTaggedObjectsV1 */ readonly filters?: string; } /** * Request parameters for putTaggedObjectV1 operation in TaggedObjectsApi. * @export * @interface TaggedObjectsApiPutTaggedObjectV1Request */ export interface TaggedObjectsApiPutTaggedObjectV1Request { /** * The type of tagged object to update. * @type {'ACCESS_PROFILE' | 'APPLICATION' | 'CAMPAIGN' | 'ENTITLEMENT' | 'IDENTITY' | 'ROLE' | 'SOD_POLICY' | 'SOURCE'} * @memberof TaggedObjectsApiPutTaggedObjectV1 */ readonly type: PutTaggedObjectV1TypeEnum; /** * The ID of the object reference to update. * @type {string} * @memberof TaggedObjectsApiPutTaggedObjectV1 */ readonly id: string; /** * * @type {TaggedObject} * @memberof TaggedObjectsApiPutTaggedObjectV1 */ readonly taggedObject: TaggedObject; } /** * Request parameters for setTagToObjectV1 operation in TaggedObjectsApi. * @export * @interface TaggedObjectsApiSetTagToObjectV1Request */ export interface TaggedObjectsApiSetTagToObjectV1Request { /** * * @type {TaggedObject} * @memberof TaggedObjectsApiSetTagToObjectV1 */ readonly taggedObject: TaggedObject; } /** * Request parameters for setTagsToManyObjectsV1 operation in TaggedObjectsApi. * @export * @interface TaggedObjectsApiSetTagsToManyObjectsV1Request */ export interface TaggedObjectsApiSetTagsToManyObjectsV1Request { /** * Supported object types are ACCESS_PROFILE, APPLICATION, CAMPAIGN, ENTITLEMENT, IDENTITY, ROLE, SOD_POLICY, SOURCE. * @type {BulkAddTaggedObject} * @memberof TaggedObjectsApiSetTagsToManyObjectsV1 */ readonly bulkAddTaggedObject: BulkAddTaggedObject; } /** * TaggedObjectsApi - object-oriented interface * @export * @class TaggedObjectsApi * @extends {BaseAPI} */ export declare class TaggedObjectsApi extends BaseAPI { /** * Delete all tags from a tagged object. * @summary Delete object tags * @param {TaggedObjectsApiDeleteTaggedObjectV1Request} requestParameters Request parameters. * @param {*} [axiosOptions] Override http request option. * @throws {RequiredError} * @memberof TaggedObjectsApi */ deleteTaggedObjectV1(requestParameters: TaggedObjectsApiDeleteTaggedObjectV1Request, axiosOptions?: RawAxiosRequestConfig): Promise>; /** * This API removes tags from multiple objects. * @summary Remove tags from multiple objects * @param {TaggedObjectsApiDeleteTagsToManyObjectV1Request} requestParameters Request parameters. * @param {*} [axiosOptions] Override http request option. * @throws {RequiredError} * @memberof TaggedObjectsApi */ deleteTagsToManyObjectV1(requestParameters: TaggedObjectsApiDeleteTagsToManyObjectV1Request, axiosOptions?: RawAxiosRequestConfig): Promise>; /** * This gets a tagged object for the specified type. * @summary Get tagged object * @param {TaggedObjectsApiGetTaggedObjectV1Request} requestParameters Request parameters. * @param {*} [axiosOptions] Override http request option. * @throws {RequiredError} * @memberof TaggedObjectsApi */ getTaggedObjectV1(requestParameters: TaggedObjectsApiGetTaggedObjectV1Request, axiosOptions?: RawAxiosRequestConfig): Promise>; /** * This API returns a list of all tagged objects by type. * @summary List tagged objects by type * @param {TaggedObjectsApiListTaggedObjectsByTypeV1Request} requestParameters Request parameters. * @param {*} [axiosOptions] Override http request option. * @throws {RequiredError} * @memberof TaggedObjectsApi */ listTaggedObjectsByTypeV1(requestParameters: TaggedObjectsApiListTaggedObjectsByTypeV1Request, axiosOptions?: RawAxiosRequestConfig): Promise>; /** * This API returns a list of all tagged objects. * @summary List tagged objects * @param {TaggedObjectsApiListTaggedObjectsV1Request} requestParameters Request parameters. * @param {*} [axiosOptions] Override http request option. * @throws {RequiredError} * @memberof TaggedObjectsApi */ listTaggedObjectsV1(requestParameters?: TaggedObjectsApiListTaggedObjectsV1Request, axiosOptions?: RawAxiosRequestConfig): Promise>; /** * This updates a tagged object for the specified type. * @summary Update tagged object * @param {TaggedObjectsApiPutTaggedObjectV1Request} requestParameters Request parameters. * @param {*} [axiosOptions] Override http request option. * @throws {RequiredError} * @memberof TaggedObjectsApi */ putTaggedObjectV1(requestParameters: TaggedObjectsApiPutTaggedObjectV1Request, axiosOptions?: RawAxiosRequestConfig): Promise>; /** * This adds a tag to an object. * @summary Add tag to object * @param {TaggedObjectsApiSetTagToObjectV1Request} requestParameters Request parameters. * @param {*} [axiosOptions] Override http request option. * @throws {RequiredError} * @memberof TaggedObjectsApi */ setTagToObjectV1(requestParameters: TaggedObjectsApiSetTagToObjectV1Request, axiosOptions?: RawAxiosRequestConfig): Promise>; /** * This API adds tags to multiple objects. * @summary Tag multiple objects * @param {TaggedObjectsApiSetTagsToManyObjectsV1Request} requestParameters Request parameters. * @param {*} [axiosOptions] Override http request option. * @throws {RequiredError} * @memberof TaggedObjectsApi */ setTagsToManyObjectsV1(requestParameters: TaggedObjectsApiSetTagsToManyObjectsV1Request, axiosOptions?: RawAxiosRequestConfig): Promise>; } /** * @export */ export declare const DeleteTaggedObjectV1TypeEnum: { readonly AccessProfile: "ACCESS_PROFILE"; readonly Application: "APPLICATION"; readonly Campaign: "CAMPAIGN"; readonly Entitlement: "ENTITLEMENT"; readonly Identity: "IDENTITY"; readonly Role: "ROLE"; readonly SodPolicy: "SOD_POLICY"; readonly Source: "SOURCE"; }; export type DeleteTaggedObjectV1TypeEnum = typeof DeleteTaggedObjectV1TypeEnum[keyof typeof DeleteTaggedObjectV1TypeEnum]; /** * @export */ export declare const GetTaggedObjectV1TypeEnum: { readonly AccessProfile: "ACCESS_PROFILE"; readonly Application: "APPLICATION"; readonly Campaign: "CAMPAIGN"; readonly Entitlement: "ENTITLEMENT"; readonly Identity: "IDENTITY"; readonly Role: "ROLE"; readonly SodPolicy: "SOD_POLICY"; readonly Source: "SOURCE"; }; export type GetTaggedObjectV1TypeEnum = typeof GetTaggedObjectV1TypeEnum[keyof typeof GetTaggedObjectV1TypeEnum]; /** * @export */ export declare const ListTaggedObjectsByTypeV1TypeEnum: { readonly AccessProfile: "ACCESS_PROFILE"; readonly Application: "APPLICATION"; readonly Campaign: "CAMPAIGN"; readonly Entitlement: "ENTITLEMENT"; readonly Identity: "IDENTITY"; readonly Role: "ROLE"; readonly SodPolicy: "SOD_POLICY"; readonly Source: "SOURCE"; }; export type ListTaggedObjectsByTypeV1TypeEnum = typeof ListTaggedObjectsByTypeV1TypeEnum[keyof typeof ListTaggedObjectsByTypeV1TypeEnum]; /** * @export */ export declare const PutTaggedObjectV1TypeEnum: { readonly AccessProfile: "ACCESS_PROFILE"; readonly Application: "APPLICATION"; readonly Campaign: "CAMPAIGN"; readonly Entitlement: "ENTITLEMENT"; readonly Identity: "IDENTITY"; readonly Role: "ROLE"; readonly SodPolicy: "SOD_POLICY"; readonly Source: "SOURCE"; }; export type PutTaggedObjectV1TypeEnum = typeof PutTaggedObjectV1TypeEnum[keyof typeof PutTaggedObjectV1TypeEnum];