/** * Identity Security Cloud API - Lifecycle States * 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'; /** * This is used for access configuration for a lifecycle state * @export * @interface AccessActionConfiguration */ export interface AccessActionConfiguration { /** * If true, then all accesses are marked for removal. * @type {boolean} * @memberof AccessActionConfiguration */ 'removeAllAccessEnabled'?: boolean; } /** * Object for specifying Actions to be performed on a specified list of sources\' account. * @export * @interface AccountAction */ export interface AccountAction { /** * Describes if action will be enable, disable or delete. * @type {string} * @memberof AccountAction */ 'action'?: AccountActionActionEnum; /** * A unique list of specific source IDs to apply the action to. The sources must have the ENABLE feature or flat file source. Required if allSources is not true. Must not be provided if allSources is true. Cannot be used together with excludeSourceIds See \"/sources\" endpoint for source features. * @type {Set} * @memberof AccountAction */ 'sourceIds'?: Set | null; /** * A list of source IDs to exclude from the action. Cannot be used together with sourceIds. * @type {Set} * @memberof AccountAction */ 'excludeSourceIds'?: Set | null; /** * If true, the action applies to all available sources. If true, sourceIds must not be provided. If false or not set, sourceIds is required. * @type {boolean} * @memberof AccountAction */ 'allSources'?: boolean; } export declare const AccountActionActionEnum: { readonly Enable: "ENABLE"; readonly Disable: "DISABLE"; readonly Delete: "DELETE"; }; export type AccountActionActionEnum = typeof AccountActionActionEnum[keyof typeof AccountActionActionEnum]; /** * * @export * @interface ArrayInner */ export interface ArrayInner { } /** * * @export * @interface BaseCommonDto */ export interface BaseCommonDto { /** * System-generated unique ID of the Object * @type {string} * @memberof BaseCommonDto */ 'id'?: string; /** * Name of the Object * @type {string} * @memberof BaseCommonDto */ 'name': string | null; /** * Creation date of the Object * @type {string} * @memberof BaseCommonDto */ 'created'?: string; /** * Last modification date of the Object * @type {string} * @memberof BaseCommonDto */ 'modified'?: string; } /** * This is used for representing email configuration for a lifecycle state * @export * @interface EmailNotificationOption */ export interface EmailNotificationOption { /** * If true, then the manager is notified of the lifecycle state change. * @type {boolean} * @memberof EmailNotificationOption */ 'notifyManagers'?: boolean; /** * If true, then all the admins are notified of the lifecycle state change. * @type {boolean} * @memberof EmailNotificationOption */ 'notifyAllAdmins'?: boolean; /** * If true, then the users specified in \"emailAddressList\" below are notified of lifecycle state change. * @type {boolean} * @memberof EmailNotificationOption */ 'notifySpecificUsers'?: boolean; /** * List of user email addresses. If \"notifySpecificUsers\" option is true, then these users are notified of lifecycle state change. * @type {Array} * @memberof EmailNotificationOption */ 'emailAddressList'?: 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; } /** * 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; /** * * @export * @interface LifecycleState */ export interface LifecycleState { /** * System-generated unique ID of the Object * @type {string} * @memberof LifecycleState */ 'id'?: string; /** * Name of the Object * @type {string} * @memberof LifecycleState */ 'name': string | null; /** * Creation date of the Object * @type {string} * @memberof LifecycleState */ 'created'?: string; /** * Last modification date of the Object * @type {string} * @memberof LifecycleState */ 'modified'?: string; /** * Indicates whether the lifecycle state is enabled or disabled. * @type {boolean} * @memberof LifecycleState */ 'enabled'?: boolean; /** * The lifecycle state\'s technical name. This is for internal use. * @type {string} * @memberof LifecycleState */ 'technicalName': string; /** * Lifecycle state\'s description. * @type {string} * @memberof LifecycleState */ 'description'?: string | null; /** * Number of identities that have the lifecycle state. * @type {number} * @memberof LifecycleState */ 'identityCount'?: number; /** * * @type {EmailNotificationOption} * @memberof LifecycleState */ 'emailNotificationOption'?: EmailNotificationOption; /** * * @type {Array} * @memberof LifecycleState */ 'accountActions'?: Array; /** * List of unique access-profile IDs that are associated with the lifecycle state. * @type {Set} * @memberof LifecycleState */ 'accessProfileIds'?: Set; /** * The lifecycle state\'s associated identity state. This field is generally \'null\'. * @type {string} * @memberof LifecycleState */ 'identityState'?: LifecycleStateIdentityStateEnum | null; /** * * @type {AccessActionConfiguration} * @memberof LifecycleState */ 'accessActionConfiguration'?: AccessActionConfiguration; /** * Used to control the order of lifecycle states when listing with `?sorters=priority`. Lower numbers appear first (ascending order). Out-of-the-box lifecycle states are assigned priorities in increments of 10. * @type {number} * @memberof LifecycleState */ 'priority'?: number | null; } export declare const LifecycleStateIdentityStateEnum: { readonly Active: "ACTIVE"; readonly InactiveShortTerm: "INACTIVE_SHORT_TERM"; readonly InactiveLongTerm: "INACTIVE_LONG_TERM"; }; export type LifecycleStateIdentityStateEnum = typeof LifecycleStateIdentityStateEnum[keyof typeof LifecycleStateIdentityStateEnum]; /** * Deleted lifecycle state. * @export * @interface LifecyclestateDeleted */ export interface LifecyclestateDeleted { /** * Deleted lifecycle state\'s DTO type. * @type {string} * @memberof LifecyclestateDeleted */ 'type'?: LifecyclestateDeletedTypeEnum; /** * Deleted lifecycle state ID. * @type {string} * @memberof LifecyclestateDeleted */ 'id'?: string; /** * Deleted lifecycle state\'s display name. * @type {string} * @memberof LifecyclestateDeleted */ 'name'?: string; } export declare const LifecyclestateDeletedTypeEnum: { readonly LifecycleState: "LIFECYCLE_STATE"; readonly TaskResult: "TASK_RESULT"; }; export type LifecyclestateDeletedTypeEnum = typeof LifecyclestateDeletedTypeEnum[keyof typeof LifecyclestateDeletedTypeEnum]; /** * 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 SetLifecycleStateV1200Response */ export interface SetLifecycleStateV1200Response { /** * ID of the IdentityRequest object that is generated when the workflow launches. To follow the IdentityRequest, you can provide this ID with a [Get Account Activity request](https://developer.sailpoint.com/docs/api/get-account-activity-v-1). The response will contain relevant information about the IdentityRequest, such as its status. * @type {string} * @memberof SetLifecycleStateV1200Response */ 'accountActivityId'?: string; } /** * * @export * @interface SetLifecycleStateV1401Response */ export interface SetLifecycleStateV1401Response { /** * A message describing the error * @type {any} * @memberof SetLifecycleStateV1401Response */ 'error'?: any; } /** * * @export * @interface SetLifecycleStateV1429Response */ export interface SetLifecycleStateV1429Response { /** * A message describing the error * @type {any} * @memberof SetLifecycleStateV1429Response */ 'message'?: any; } /** * * @export * @interface SetLifecycleStateV1Request */ export interface SetLifecycleStateV1Request { /** * ID of the lifecycle state to set. * @type {string} * @memberof SetLifecycleStateV1Request */ 'lifecycleStateId'?: string; } /** * LifecycleStatesApi - axios parameter creator * @export */ export declare const LifecycleStatesApiAxiosParamCreator: (configuration?: Configuration) => { /** * Use this endpoint to create a lifecycle state. * @summary Create lifecycle state * @param {string} identityProfileId Identity profile ID. * @param {LifecycleState} lifecycleState Lifecycle state to be created. * @param {*} [axiosOptions] Override http request option. * @throws {RequiredError} */ createLifecycleStateV1: (identityProfileId: string, lifecycleState: LifecycleState, axiosOptions?: RawAxiosRequestConfig) => Promise; /** * Use this endpoint to delete the lifecycle state by its ID. * @summary Delete lifecycle state * @param {string} identityProfileId Identity profile ID. * @param {string} lifecycleStateId Lifecycle state ID. * @param {*} [axiosOptions] Override http request option. * @throws {RequiredError} */ deleteLifecycleStateV1: (identityProfileId: string, lifecycleStateId: string, axiosOptions?: RawAxiosRequestConfig) => Promise; /** * Use this endpoint to get a lifecycle state by its ID and its associated identity profile ID. * @summary Get lifecycle state * @param {string} identityProfileId Identity profile ID. * @param {string} lifecycleStateId Lifecycle state ID. * @param {*} [axiosOptions] Override http request option. * @throws {RequiredError} */ getLifecycleStateV1: (identityProfileId: string, lifecycleStateId: string, axiosOptions?: RawAxiosRequestConfig) => Promise; /** * Use this endpoint to list all lifecycle states by their associated identity profiles. * @summary Lists lifecyclestates * @param {string} identityProfileId Identity profile ID. * @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} [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: **name, priority, created, modified** * @param {*} [axiosOptions] Override http request option. * @throws {RequiredError} */ getLifecycleStatesV1: (identityProfileId: string, limit?: number, offset?: number, count?: boolean, sorters?: string, axiosOptions?: RawAxiosRequestConfig) => Promise; /** * Use this API to set/update an identity\'s lifecycle state to the one provided and update the corresponding identity profile. * @summary Set lifecycle state * @param {string} identityId ID of the identity to update. * @param {SetLifecycleStateV1Request} setLifecycleStateV1Request * @param {*} [axiosOptions] Override http request option. * @throws {RequiredError} */ setLifecycleStateV1: (identityId: string, setLifecycleStateV1Request: SetLifecycleStateV1Request, axiosOptions?: RawAxiosRequestConfig) => Promise; /** * Use this endpoint to update individual lifecycle state fields, using the [JSON Patch](https://tools.ietf.org/html/rfc6902) standard. * @summary Update lifecycle state * @param {string} identityProfileId Identity profile ID. * @param {string} lifecycleStateId Lifecycle state ID. * @param {Array} jsonPatchOperation A list of lifecycle state update operations according to the [JSON Patch](https://tools.ietf.org/html/rfc6902) standard. The following fields can be updated: * enabled * description * accountActions * accessProfileIds * emailNotificationOption * accessActionConfiguration * priority * @param {*} [axiosOptions] Override http request option. * @throws {RequiredError} */ updateLifecycleStatesV1: (identityProfileId: string, lifecycleStateId: string, jsonPatchOperation: Array, axiosOptions?: RawAxiosRequestConfig) => Promise; }; /** * LifecycleStatesApi - functional programming interface * @export */ export declare const LifecycleStatesApiFp: (configuration?: Configuration) => { /** * Use this endpoint to create a lifecycle state. * @summary Create lifecycle state * @param {string} identityProfileId Identity profile ID. * @param {LifecycleState} lifecycleState Lifecycle state to be created. * @param {*} [axiosOptions] Override http request option. * @throws {RequiredError} */ createLifecycleStateV1(identityProfileId: string, lifecycleState: LifecycleState, axiosOptions?: RawAxiosRequestConfig): Promise<(axios?: AxiosInstance, basePath?: string) => AxiosPromise>; /** * Use this endpoint to delete the lifecycle state by its ID. * @summary Delete lifecycle state * @param {string} identityProfileId Identity profile ID. * @param {string} lifecycleStateId Lifecycle state ID. * @param {*} [axiosOptions] Override http request option. * @throws {RequiredError} */ deleteLifecycleStateV1(identityProfileId: string, lifecycleStateId: string, axiosOptions?: RawAxiosRequestConfig): Promise<(axios?: AxiosInstance, basePath?: string) => AxiosPromise>; /** * Use this endpoint to get a lifecycle state by its ID and its associated identity profile ID. * @summary Get lifecycle state * @param {string} identityProfileId Identity profile ID. * @param {string} lifecycleStateId Lifecycle state ID. * @param {*} [axiosOptions] Override http request option. * @throws {RequiredError} */ getLifecycleStateV1(identityProfileId: string, lifecycleStateId: string, axiosOptions?: RawAxiosRequestConfig): Promise<(axios?: AxiosInstance, basePath?: string) => AxiosPromise>; /** * Use this endpoint to list all lifecycle states by their associated identity profiles. * @summary Lists lifecyclestates * @param {string} identityProfileId Identity profile ID. * @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} [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: **name, priority, created, modified** * @param {*} [axiosOptions] Override http request option. * @throws {RequiredError} */ getLifecycleStatesV1(identityProfileId: string, limit?: number, offset?: number, count?: boolean, sorters?: string, axiosOptions?: RawAxiosRequestConfig): Promise<(axios?: AxiosInstance, basePath?: string) => AxiosPromise>>; /** * Use this API to set/update an identity\'s lifecycle state to the one provided and update the corresponding identity profile. * @summary Set lifecycle state * @param {string} identityId ID of the identity to update. * @param {SetLifecycleStateV1Request} setLifecycleStateV1Request * @param {*} [axiosOptions] Override http request option. * @throws {RequiredError} */ setLifecycleStateV1(identityId: string, setLifecycleStateV1Request: SetLifecycleStateV1Request, axiosOptions?: RawAxiosRequestConfig): Promise<(axios?: AxiosInstance, basePath?: string) => AxiosPromise>; /** * Use this endpoint to update individual lifecycle state fields, using the [JSON Patch](https://tools.ietf.org/html/rfc6902) standard. * @summary Update lifecycle state * @param {string} identityProfileId Identity profile ID. * @param {string} lifecycleStateId Lifecycle state ID. * @param {Array} jsonPatchOperation A list of lifecycle state update operations according to the [JSON Patch](https://tools.ietf.org/html/rfc6902) standard. The following fields can be updated: * enabled * description * accountActions * accessProfileIds * emailNotificationOption * accessActionConfiguration * priority * @param {*} [axiosOptions] Override http request option. * @throws {RequiredError} */ updateLifecycleStatesV1(identityProfileId: string, lifecycleStateId: string, jsonPatchOperation: Array, axiosOptions?: RawAxiosRequestConfig): Promise<(axios?: AxiosInstance, basePath?: string) => AxiosPromise>; }; /** * LifecycleStatesApi - factory interface * @export */ export declare const LifecycleStatesApiFactory: (configuration?: Configuration, basePath?: string, axios?: AxiosInstance) => { /** * Use this endpoint to create a lifecycle state. * @summary Create lifecycle state * @param {LifecycleStatesApiCreateLifecycleStateV1Request} requestParameters Request parameters. * @param {*} [axiosOptions] Override http request option. * @throws {RequiredError} */ createLifecycleStateV1(requestParameters: LifecycleStatesApiCreateLifecycleStateV1Request, axiosOptions?: RawAxiosRequestConfig): AxiosPromise; /** * Use this endpoint to delete the lifecycle state by its ID. * @summary Delete lifecycle state * @param {LifecycleStatesApiDeleteLifecycleStateV1Request} requestParameters Request parameters. * @param {*} [axiosOptions] Override http request option. * @throws {RequiredError} */ deleteLifecycleStateV1(requestParameters: LifecycleStatesApiDeleteLifecycleStateV1Request, axiosOptions?: RawAxiosRequestConfig): AxiosPromise; /** * Use this endpoint to get a lifecycle state by its ID and its associated identity profile ID. * @summary Get lifecycle state * @param {LifecycleStatesApiGetLifecycleStateV1Request} requestParameters Request parameters. * @param {*} [axiosOptions] Override http request option. * @throws {RequiredError} */ getLifecycleStateV1(requestParameters: LifecycleStatesApiGetLifecycleStateV1Request, axiosOptions?: RawAxiosRequestConfig): AxiosPromise; /** * Use this endpoint to list all lifecycle states by their associated identity profiles. * @summary Lists lifecyclestates * @param {LifecycleStatesApiGetLifecycleStatesV1Request} requestParameters Request parameters. * @param {*} [axiosOptions] Override http request option. * @throws {RequiredError} */ getLifecycleStatesV1(requestParameters: LifecycleStatesApiGetLifecycleStatesV1Request, axiosOptions?: RawAxiosRequestConfig): AxiosPromise>; /** * Use this API to set/update an identity\'s lifecycle state to the one provided and update the corresponding identity profile. * @summary Set lifecycle state * @param {LifecycleStatesApiSetLifecycleStateV1Request} requestParameters Request parameters. * @param {*} [axiosOptions] Override http request option. * @throws {RequiredError} */ setLifecycleStateV1(requestParameters: LifecycleStatesApiSetLifecycleStateV1Request, axiosOptions?: RawAxiosRequestConfig): AxiosPromise; /** * Use this endpoint to update individual lifecycle state fields, using the [JSON Patch](https://tools.ietf.org/html/rfc6902) standard. * @summary Update lifecycle state * @param {LifecycleStatesApiUpdateLifecycleStatesV1Request} requestParameters Request parameters. * @param {*} [axiosOptions] Override http request option. * @throws {RequiredError} */ updateLifecycleStatesV1(requestParameters: LifecycleStatesApiUpdateLifecycleStatesV1Request, axiosOptions?: RawAxiosRequestConfig): AxiosPromise; }; /** * Request parameters for createLifecycleStateV1 operation in LifecycleStatesApi. * @export * @interface LifecycleStatesApiCreateLifecycleStateV1Request */ export interface LifecycleStatesApiCreateLifecycleStateV1Request { /** * Identity profile ID. * @type {string} * @memberof LifecycleStatesApiCreateLifecycleStateV1 */ readonly identityProfileId: string; /** * Lifecycle state to be created. * @type {LifecycleState} * @memberof LifecycleStatesApiCreateLifecycleStateV1 */ readonly lifecycleState: LifecycleState; } /** * Request parameters for deleteLifecycleStateV1 operation in LifecycleStatesApi. * @export * @interface LifecycleStatesApiDeleteLifecycleStateV1Request */ export interface LifecycleStatesApiDeleteLifecycleStateV1Request { /** * Identity profile ID. * @type {string} * @memberof LifecycleStatesApiDeleteLifecycleStateV1 */ readonly identityProfileId: string; /** * Lifecycle state ID. * @type {string} * @memberof LifecycleStatesApiDeleteLifecycleStateV1 */ readonly lifecycleStateId: string; } /** * Request parameters for getLifecycleStateV1 operation in LifecycleStatesApi. * @export * @interface LifecycleStatesApiGetLifecycleStateV1Request */ export interface LifecycleStatesApiGetLifecycleStateV1Request { /** * Identity profile ID. * @type {string} * @memberof LifecycleStatesApiGetLifecycleStateV1 */ readonly identityProfileId: string; /** * Lifecycle state ID. * @type {string} * @memberof LifecycleStatesApiGetLifecycleStateV1 */ readonly lifecycleStateId: string; } /** * Request parameters for getLifecycleStatesV1 operation in LifecycleStatesApi. * @export * @interface LifecycleStatesApiGetLifecycleStatesV1Request */ export interface LifecycleStatesApiGetLifecycleStatesV1Request { /** * Identity profile ID. * @type {string} * @memberof LifecycleStatesApiGetLifecycleStatesV1 */ readonly identityProfileId: 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 LifecycleStatesApiGetLifecycleStatesV1 */ 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 LifecycleStatesApiGetLifecycleStatesV1 */ 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 LifecycleStatesApiGetLifecycleStatesV1 */ readonly count?: boolean; /** * 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: **name, priority, created, modified** * @type {string} * @memberof LifecycleStatesApiGetLifecycleStatesV1 */ readonly sorters?: string; } /** * Request parameters for setLifecycleStateV1 operation in LifecycleStatesApi. * @export * @interface LifecycleStatesApiSetLifecycleStateV1Request */ export interface LifecycleStatesApiSetLifecycleStateV1Request { /** * ID of the identity to update. * @type {string} * @memberof LifecycleStatesApiSetLifecycleStateV1 */ readonly identityId: string; /** * * @type {SetLifecycleStateV1Request} * @memberof LifecycleStatesApiSetLifecycleStateV1 */ readonly setLifecycleStateV1Request: SetLifecycleStateV1Request; } /** * Request parameters for updateLifecycleStatesV1 operation in LifecycleStatesApi. * @export * @interface LifecycleStatesApiUpdateLifecycleStatesV1Request */ export interface LifecycleStatesApiUpdateLifecycleStatesV1Request { /** * Identity profile ID. * @type {string} * @memberof LifecycleStatesApiUpdateLifecycleStatesV1 */ readonly identityProfileId: string; /** * Lifecycle state ID. * @type {string} * @memberof LifecycleStatesApiUpdateLifecycleStatesV1 */ readonly lifecycleStateId: string; /** * A list of lifecycle state update operations according to the [JSON Patch](https://tools.ietf.org/html/rfc6902) standard. The following fields can be updated: * enabled * description * accountActions * accessProfileIds * emailNotificationOption * accessActionConfiguration * priority * @type {Array} * @memberof LifecycleStatesApiUpdateLifecycleStatesV1 */ readonly jsonPatchOperation: Array; } /** * LifecycleStatesApi - object-oriented interface * @export * @class LifecycleStatesApi * @extends {BaseAPI} */ export declare class LifecycleStatesApi extends BaseAPI { /** * Use this endpoint to create a lifecycle state. * @summary Create lifecycle state * @param {LifecycleStatesApiCreateLifecycleStateV1Request} requestParameters Request parameters. * @param {*} [axiosOptions] Override http request option. * @throws {RequiredError} * @memberof LifecycleStatesApi */ createLifecycleStateV1(requestParameters: LifecycleStatesApiCreateLifecycleStateV1Request, axiosOptions?: RawAxiosRequestConfig): Promise>; /** * Use this endpoint to delete the lifecycle state by its ID. * @summary Delete lifecycle state * @param {LifecycleStatesApiDeleteLifecycleStateV1Request} requestParameters Request parameters. * @param {*} [axiosOptions] Override http request option. * @throws {RequiredError} * @memberof LifecycleStatesApi */ deleteLifecycleStateV1(requestParameters: LifecycleStatesApiDeleteLifecycleStateV1Request, axiosOptions?: RawAxiosRequestConfig): Promise>; /** * Use this endpoint to get a lifecycle state by its ID and its associated identity profile ID. * @summary Get lifecycle state * @param {LifecycleStatesApiGetLifecycleStateV1Request} requestParameters Request parameters. * @param {*} [axiosOptions] Override http request option. * @throws {RequiredError} * @memberof LifecycleStatesApi */ getLifecycleStateV1(requestParameters: LifecycleStatesApiGetLifecycleStateV1Request, axiosOptions?: RawAxiosRequestConfig): Promise>; /** * Use this endpoint to list all lifecycle states by their associated identity profiles. * @summary Lists lifecyclestates * @param {LifecycleStatesApiGetLifecycleStatesV1Request} requestParameters Request parameters. * @param {*} [axiosOptions] Override http request option. * @throws {RequiredError} * @memberof LifecycleStatesApi */ getLifecycleStatesV1(requestParameters: LifecycleStatesApiGetLifecycleStatesV1Request, axiosOptions?: RawAxiosRequestConfig): Promise>; /** * Use this API to set/update an identity\'s lifecycle state to the one provided and update the corresponding identity profile. * @summary Set lifecycle state * @param {LifecycleStatesApiSetLifecycleStateV1Request} requestParameters Request parameters. * @param {*} [axiosOptions] Override http request option. * @throws {RequiredError} * @memberof LifecycleStatesApi */ setLifecycleStateV1(requestParameters: LifecycleStatesApiSetLifecycleStateV1Request, axiosOptions?: RawAxiosRequestConfig): Promise>; /** * Use this endpoint to update individual lifecycle state fields, using the [JSON Patch](https://tools.ietf.org/html/rfc6902) standard. * @summary Update lifecycle state * @param {LifecycleStatesApiUpdateLifecycleStatesV1Request} requestParameters Request parameters. * @param {*} [axiosOptions] Override http request option. * @throws {RequiredError} * @memberof LifecycleStatesApi */ updateLifecycleStatesV1(requestParameters: LifecycleStatesApiUpdateLifecycleStatesV1Request, axiosOptions?: RawAxiosRequestConfig): Promise>; }