/** * Identity Security Cloud API - Account Activities * 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 AccountActivity */ export interface AccountActivity { /** * Id of the account activity * @type {string} * @memberof AccountActivity */ 'id'?: string; /** * The name of the activity * @type {string} * @memberof AccountActivity */ 'name'?: string; /** * When the activity was first created * @type {string} * @memberof AccountActivity */ 'created'?: string; /** * When the activity was last modified * @type {string} * @memberof AccountActivity */ 'modified'?: string | null; /** * When the activity was completed * @type {string} * @memberof AccountActivity */ 'completed'?: string | null; /** * * @type {CompletionStatus} * @memberof AccountActivity */ 'completionStatus'?: CompletionStatus | null; /** * The type of action the activity performed. Please see the following list of types. This list may grow over time. - CloudAutomated - IdentityAttributeUpdate - appRequest - LifecycleStateChange - AccountStateUpdate - AccountAttributeUpdate - CloudPasswordRequest - Attribute Synchronization Refresh - Certification - Identity Refresh - Lifecycle Change Refresh [Learn more here](https://documentation.sailpoint.com/saas/help/search/searchable-fields.html#searching-account-activity-data). * @type {string} * @memberof AccountActivity */ 'type'?: string | null; /** * * @type {IdentitySummary} * @memberof AccountActivity */ 'requesterIdentitySummary'?: IdentitySummary | null; /** * * @type {IdentitySummary} * @memberof AccountActivity */ 'targetIdentitySummary'?: IdentitySummary | null; /** * A list of error messages, if any, that were encountered. * @type {Array} * @memberof AccountActivity */ 'errors'?: Array | null; /** * A list of warning messages, if any, that were encountered. * @type {Array} * @memberof AccountActivity */ 'warnings'?: Array | null; /** * Individual actions performed as part of this account activity * @type {Array} * @memberof AccountActivity */ 'items'?: Array | null; /** * * @type {ExecutionStatus} * @memberof AccountActivity */ 'executionStatus'?: ExecutionStatus; /** * Arbitrary key-value pairs, if any were included in the corresponding access request * @type {{ [key: string]: string; }} * @memberof AccountActivity */ 'clientMetadata'?: { [key: string]: string; } | null; } /** * The state of an approval status * @export * @enum {string} */ export declare const AccountActivityApprovalStatus: { readonly Finished: "FINISHED"; readonly Rejected: "REJECTED"; readonly Returned: "RETURNED"; readonly Expired: "EXPIRED"; readonly Pending: "PENDING"; readonly Canceled: "CANCELED"; }; export type AccountActivityApprovalStatus = typeof AccountActivityApprovalStatus[keyof typeof AccountActivityApprovalStatus]; /** * * @export * @interface AccountActivityItem */ export interface AccountActivityItem { /** * Item id * @type {string} * @memberof AccountActivityItem */ 'id'?: string; /** * Human-readable display name of item * @type {string} * @memberof AccountActivityItem */ 'name'?: string; /** * Date and time item was requested * @type {string} * @memberof AccountActivityItem */ 'requested'?: string; /** * * @type {AccountActivityApprovalStatus} * @memberof AccountActivityItem */ 'approvalStatus'?: AccountActivityApprovalStatus | null; /** * * @type {ProvisioningState} * @memberof AccountActivityItem */ 'provisioningStatus'?: ProvisioningState; /** * * @type {Comment} * @memberof AccountActivityItem */ 'requesterComment'?: Comment | null; /** * * @type {IdentitySummary} * @memberof AccountActivityItem */ 'reviewerIdentitySummary'?: IdentitySummary | null; /** * * @type {Comment} * @memberof AccountActivityItem */ 'reviewerComment'?: Comment | null; /** * * @type {AccountActivityItemOperation} * @memberof AccountActivityItem */ 'operation'?: AccountActivityItemOperation | null; /** * Attribute to which account activity applies * @type {string} * @memberof AccountActivityItem */ 'attribute'?: string | null; /** * Value of attribute * @type {string} * @memberof AccountActivityItem */ 'value'?: string | null; /** * Native identity in the target system to which the account activity applies * @type {string} * @memberof AccountActivityItem */ 'nativeIdentity'?: string | null; /** * Id of Source to which account activity applies * @type {string} * @memberof AccountActivityItem */ 'sourceId'?: string; /** * * @type {AccountRequestInfo} * @memberof AccountActivityItem */ 'accountRequestInfo'?: AccountRequestInfo | null; /** * Arbitrary key-value pairs, if any were included in the corresponding access request item * @type {{ [key: string]: string; }} * @memberof AccountActivityItem */ 'clientMetadata'?: { [key: string]: string; } | null; /** * The date the role or access profile or entitlement is no longer assigned to the specified identity. * @type {string} * @memberof AccountActivityItem */ 'removeDate'?: string | null; } /** * Represents an operation in an account activity item * @export * @enum {string} */ export declare const AccountActivityItemOperation: { readonly Add: "ADD"; readonly Create: "CREATE"; readonly Modify: "MODIFY"; readonly Delete: "DELETE"; readonly Disable: "DISABLE"; readonly Enable: "ENABLE"; readonly Unlock: "UNLOCK"; readonly Lock: "LOCK"; readonly Remove: "REMOVE"; readonly Set: "SET"; }; export type AccountActivityItemOperation = typeof AccountActivityItemOperation[keyof typeof AccountActivityItemOperation]; /** * If an account activity item is associated with an access request, captures details of that request. * @export * @interface AccountRequestInfo */ export interface AccountRequestInfo { /** * Id of requested object * @type {string} * @memberof AccountRequestInfo */ 'requestedObjectId'?: string; /** * Human-readable name of requested object * @type {string} * @memberof AccountRequestInfo */ 'requestedObjectName'?: string; /** * * @type {RequestableObjectType} * @memberof AccountRequestInfo */ 'requestedObjectType'?: RequestableObjectType; } /** * * @export * @interface Comment */ export interface Comment { /** * Id of the identity making the comment * @type {string} * @memberof Comment */ 'commenterId'?: string; /** * Human-readable display name of the identity making the comment * @type {string} * @memberof Comment */ 'commenterName'?: string; /** * Content of the comment * @type {string} * @memberof Comment */ 'body'?: string; /** * Date and time comment was made * @type {string} * @memberof Comment */ 'date'?: string; } /** * The status after completion. * @export * @enum {string} */ export declare const CompletionStatus: { readonly Success: "SUCCESS"; readonly Failure: "FAILURE"; readonly Incomplete: "INCOMPLETE"; readonly Pending: "PENDING"; }; export type CompletionStatus = typeof CompletionStatus[keyof typeof CompletionStatus]; /** * * @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; } /** * The current state of execution. * @export * @enum {string} */ export declare const ExecutionStatus: { readonly Executing: "EXECUTING"; readonly Verifying: "VERIFYING"; readonly Terminated: "TERMINATED"; readonly Completed: "COMPLETED"; }; export type ExecutionStatus = typeof ExecutionStatus[keyof typeof ExecutionStatus]; /** * * @export * @interface IdentitySummary */ export interface IdentitySummary { /** * ID of this identity summary * @type {string} * @memberof IdentitySummary */ 'id'?: string; /** * Human-readable display name of identity * @type {string} * @memberof IdentitySummary */ 'name'?: string; /** * ID of the identity that this summary represents * @type {string} * @memberof IdentitySummary */ 'identityId'?: string; /** * Indicates if all access items for this summary have been decided on * @type {boolean} * @memberof IdentitySummary */ 'completed'?: boolean; } /** * * @export * @interface ListAccountActivitiesV1401Response */ export interface ListAccountActivitiesV1401Response { /** * A message describing the error * @type {any} * @memberof ListAccountActivitiesV1401Response */ 'error'?: any; } /** * * @export * @interface ListAccountActivitiesV1429Response */ export interface ListAccountActivitiesV1429Response { /** * A message describing the error * @type {any} * @memberof ListAccountActivitiesV1429Response */ '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]; /** * Provisioning state of an account activity item * @export * @enum {string} */ export declare const ProvisioningState: { readonly Pending: "PENDING"; readonly Finished: "FINISHED"; readonly Unverifiable: "UNVERIFIABLE"; readonly Commited: "COMMITED"; readonly Failed: "FAILED"; readonly Retry: "RETRY"; }; export type ProvisioningState = typeof ProvisioningState[keyof typeof ProvisioningState]; /** * Currently supported requestable object types. * @export * @enum {string} */ export declare const RequestableObjectType: { readonly AccessProfile: "ACCESS_PROFILE"; readonly Role: "ROLE"; readonly Entitlement: "ENTITLEMENT"; }; export type RequestableObjectType = typeof RequestableObjectType[keyof typeof RequestableObjectType]; /** * AccountActivitiesApi - axios parameter creator * @export */ export declare const AccountActivitiesApiAxiosParamCreator: (configuration?: Configuration) => { /** * This gets a single account activity by its id. * @summary Get an account activity * @param {string} id The account activity id * @param {*} [axiosOptions] Override http request option. * @throws {RequiredError} */ getAccountActivityV1: (id: string, axiosOptions?: RawAxiosRequestConfig) => Promise; /** * This gets a collection of account activities that satisfy the given query parameters. * @summary List account activities * @param {string} [requestedFor] The identity that the activity was requested for. *me* indicates the current user. Mutually exclusive with *regarding-identity*. * @param {string} [requestedBy] The identity that requested the activity. *me* indicates the current user. Mutually exclusive with *regarding-identity*. * @param {string} [regardingIdentity] The specified identity will be either the requester or target of the account activity. *me* indicates the current user. Mutually exclusive with *requested-for* and *requested-by*. * @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: **type**: *eq, in, ge, le, lt, ne, isnull, sw* **created**: *gt, lt, ge, le, eq, in, ne, isnull, sw* **modified**: *gt, lt, ge, le, eq, in, ne, isnull, 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: **type, created, modified** * @param {*} [axiosOptions] Override http request option. * @throws {RequiredError} */ listAccountActivitiesV1: (requestedFor?: string, requestedBy?: string, regardingIdentity?: string, limit?: number, offset?: number, count?: boolean, filters?: string, sorters?: string, axiosOptions?: RawAxiosRequestConfig) => Promise; }; /** * AccountActivitiesApi - functional programming interface * @export */ export declare const AccountActivitiesApiFp: (configuration?: Configuration) => { /** * This gets a single account activity by its id. * @summary Get an account activity * @param {string} id The account activity id * @param {*} [axiosOptions] Override http request option. * @throws {RequiredError} */ getAccountActivityV1(id: string, axiosOptions?: RawAxiosRequestConfig): Promise<(axios?: AxiosInstance, basePath?: string) => AxiosPromise>; /** * This gets a collection of account activities that satisfy the given query parameters. * @summary List account activities * @param {string} [requestedFor] The identity that the activity was requested for. *me* indicates the current user. Mutually exclusive with *regarding-identity*. * @param {string} [requestedBy] The identity that requested the activity. *me* indicates the current user. Mutually exclusive with *regarding-identity*. * @param {string} [regardingIdentity] The specified identity will be either the requester or target of the account activity. *me* indicates the current user. Mutually exclusive with *requested-for* and *requested-by*. * @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: **type**: *eq, in, ge, le, lt, ne, isnull, sw* **created**: *gt, lt, ge, le, eq, in, ne, isnull, sw* **modified**: *gt, lt, ge, le, eq, in, ne, isnull, 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: **type, created, modified** * @param {*} [axiosOptions] Override http request option. * @throws {RequiredError} */ listAccountActivitiesV1(requestedFor?: string, requestedBy?: string, regardingIdentity?: string, limit?: number, offset?: number, count?: boolean, filters?: string, sorters?: string, axiosOptions?: RawAxiosRequestConfig): Promise<(axios?: AxiosInstance, basePath?: string) => AxiosPromise>>; }; /** * AccountActivitiesApi - factory interface * @export */ export declare const AccountActivitiesApiFactory: (configuration?: Configuration, basePath?: string, axios?: AxiosInstance) => { /** * This gets a single account activity by its id. * @summary Get an account activity * @param {AccountActivitiesApiGetAccountActivityV1Request} requestParameters Request parameters. * @param {*} [axiosOptions] Override http request option. * @throws {RequiredError} */ getAccountActivityV1(requestParameters: AccountActivitiesApiGetAccountActivityV1Request, axiosOptions?: RawAxiosRequestConfig): AxiosPromise; /** * This gets a collection of account activities that satisfy the given query parameters. * @summary List account activities * @param {AccountActivitiesApiListAccountActivitiesV1Request} requestParameters Request parameters. * @param {*} [axiosOptions] Override http request option. * @throws {RequiredError} */ listAccountActivitiesV1(requestParameters?: AccountActivitiesApiListAccountActivitiesV1Request, axiosOptions?: RawAxiosRequestConfig): AxiosPromise>; }; /** * Request parameters for getAccountActivityV1 operation in AccountActivitiesApi. * @export * @interface AccountActivitiesApiGetAccountActivityV1Request */ export interface AccountActivitiesApiGetAccountActivityV1Request { /** * The account activity id * @type {string} * @memberof AccountActivitiesApiGetAccountActivityV1 */ readonly id: string; } /** * Request parameters for listAccountActivitiesV1 operation in AccountActivitiesApi. * @export * @interface AccountActivitiesApiListAccountActivitiesV1Request */ export interface AccountActivitiesApiListAccountActivitiesV1Request { /** * The identity that the activity was requested for. *me* indicates the current user. Mutually exclusive with *regarding-identity*. * @type {string} * @memberof AccountActivitiesApiListAccountActivitiesV1 */ readonly requestedFor?: string; /** * The identity that requested the activity. *me* indicates the current user. Mutually exclusive with *regarding-identity*. * @type {string} * @memberof AccountActivitiesApiListAccountActivitiesV1 */ readonly requestedBy?: string; /** * The specified identity will be either the requester or target of the account activity. *me* indicates the current user. Mutually exclusive with *requested-for* and *requested-by*. * @type {string} * @memberof AccountActivitiesApiListAccountActivitiesV1 */ readonly regardingIdentity?: 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 AccountActivitiesApiListAccountActivitiesV1 */ 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 AccountActivitiesApiListAccountActivitiesV1 */ 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 AccountActivitiesApiListAccountActivitiesV1 */ 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: **type**: *eq, in, ge, le, lt, ne, isnull, sw* **created**: *gt, lt, ge, le, eq, in, ne, isnull, sw* **modified**: *gt, lt, ge, le, eq, in, ne, isnull, sw* * @type {string} * @memberof AccountActivitiesApiListAccountActivitiesV1 */ 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: **type, created, modified** * @type {string} * @memberof AccountActivitiesApiListAccountActivitiesV1 */ readonly sorters?: string; } /** * AccountActivitiesApi - object-oriented interface * @export * @class AccountActivitiesApi * @extends {BaseAPI} */ export declare class AccountActivitiesApi extends BaseAPI { /** * This gets a single account activity by its id. * @summary Get an account activity * @param {AccountActivitiesApiGetAccountActivityV1Request} requestParameters Request parameters. * @param {*} [axiosOptions] Override http request option. * @throws {RequiredError} * @memberof AccountActivitiesApi */ getAccountActivityV1(requestParameters: AccountActivitiesApiGetAccountActivityV1Request, axiosOptions?: RawAxiosRequestConfig): Promise>; /** * This gets a collection of account activities that satisfy the given query parameters. * @summary List account activities * @param {AccountActivitiesApiListAccountActivitiesV1Request} requestParameters Request parameters. * @param {*} [axiosOptions] Override http request option. * @throws {RequiredError} * @memberof AccountActivitiesApi */ listAccountActivitiesV1(requestParameters?: AccountActivitiesApiListAccountActivitiesV1Request, axiosOptions?: RawAxiosRequestConfig): Promise>; }