/* tslint:disable */ /* eslint-disable */ /** * Identity Security Cloud API - Triggers * 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 globalAxios from 'axios'; // Some imports not used depending on template conditions // @ts-ignore import { DUMMY_BASE_URL, assertParamExists, setApiKeyToObject, setBasicAuthToObject, setBearerAuthToObject, setOAuthToObject, setSearchParams, serializeDataIfNeeded, toPathString, createRequestFunction } from './common'; import type { RequestArgs } from './base'; // @ts-ignore import { BASE_PATH, COLLECTION_FORMATS, BaseAPI, RequiredError, operationServerMap } from './base'; /** * Identity who approved the access item request. * @export * @interface AccessItemApproverDto */ export interface AccessItemApproverDto { /** * DTO type of identity who approved the access item request. * @type {string} * @memberof AccessItemApproverDto */ 'type'?: AccessItemApproverDtoTypeEnum; /** * ID of identity who approved the access item request. * @type {string} * @memberof AccessItemApproverDto */ 'id'?: string; /** * Human-readable display name of identity who approved the access item request. * @type {string} * @memberof AccessItemApproverDto */ 'name'?: string; } export const AccessItemApproverDtoTypeEnum = { Identity: 'IDENTITY' } as const; export type AccessItemApproverDtoTypeEnum = typeof AccessItemApproverDtoTypeEnum[keyof typeof AccessItemApproverDtoTypeEnum]; /** * Identity the access item is requested for. * @export * @interface AccessItemRequestedForDto */ export interface AccessItemRequestedForDto { /** * DTO type of identity the access item is requested for. * @type {string} * @memberof AccessItemRequestedForDto */ 'type'?: AccessItemRequestedForDtoTypeEnum; /** * ID of identity the access item is requested for. * @type {string} * @memberof AccessItemRequestedForDto */ 'id'?: string; /** * Human-readable display name of identity the access item is requested for. * @type {string} * @memberof AccessItemRequestedForDto */ 'name'?: string; } export const AccessItemRequestedForDtoTypeEnum = { Identity: 'IDENTITY' } as const; export type AccessItemRequestedForDtoTypeEnum = typeof AccessItemRequestedForDtoTypeEnum[keyof typeof AccessItemRequestedForDtoTypeEnum]; /** * Access item requester\'s identity. * @export * @interface AccessItemRequesterDto */ export interface AccessItemRequesterDto { /** * Access item requester\'s DTO type. * @type {string} * @memberof AccessItemRequesterDto */ 'type'?: AccessItemRequesterDtoTypeEnum; /** * Access item requester\'s identity ID. * @type {string} * @memberof AccessItemRequesterDto */ 'id'?: string; /** * Access item owner\'s human-readable display name. * @type {string} * @memberof AccessItemRequesterDto */ 'name'?: string; } export const AccessItemRequesterDtoTypeEnum = { Identity: 'IDENTITY' } as const; export type AccessItemRequesterDtoTypeEnum = typeof AccessItemRequesterDtoTypeEnum[keyof typeof AccessItemRequesterDtoTypeEnum]; /** * * @export * @interface AccessRequestDynamicApprover */ export interface AccessRequestDynamicApprover { /** * The unique ID of the access request object. Can be used with the [access request status endpoint](https://developer.sailpoint.com/docs/api/list-access-request-status-v-1) to get the status of the request. * @type {string} * @memberof AccessRequestDynamicApprover */ 'accessRequestId': string; /** * Identities access was requested for. * @type {Array} * @memberof AccessRequestDynamicApprover */ 'requestedFor': Array; /** * The access items that are being requested. * @type {Array} * @memberof AccessRequestDynamicApprover */ 'requestedItems': Array; /** * * @type {AccessItemRequesterDto} * @memberof AccessRequestDynamicApprover */ 'requestedBy': AccessItemRequesterDto; } /** * * @export * @interface AccessRequestDynamicApprover2 */ export interface AccessRequestDynamicApprover2 { /** * The unique ID of the identity to add to the approver list for the access request. * @type {string} * @memberof AccessRequestDynamicApprover2 */ 'id': string; /** * The name of the identity to add to the approver list for the access request. * @type {string} * @memberof AccessRequestDynamicApprover2 */ 'name': string; /** * The type of object being referenced. * @type {string} * @memberof AccessRequestDynamicApprover2 */ 'type': AccessRequestDynamicApprover2TypeEnum; } export const AccessRequestDynamicApprover2TypeEnum = { Identity: 'IDENTITY', GovernanceGroup: 'GOVERNANCE_GROUP' } as const; export type AccessRequestDynamicApprover2TypeEnum = typeof AccessRequestDynamicApprover2TypeEnum[keyof typeof AccessRequestDynamicApprover2TypeEnum]; /** * * @export * @interface AccessRequestDynamicApproverRequestedItemsInner */ export interface AccessRequestDynamicApproverRequestedItemsInner { /** * The unique ID of the access item. * @type {string} * @memberof AccessRequestDynamicApproverRequestedItemsInner */ 'id': string; /** * Human friendly name of the access item. * @type {string} * @memberof AccessRequestDynamicApproverRequestedItemsInner */ 'name': string; /** * Extended description of the access item. * @type {string} * @memberof AccessRequestDynamicApproverRequestedItemsInner */ 'description'?: string | null; /** * The type of access item being requested. * @type {string} * @memberof AccessRequestDynamicApproverRequestedItemsInner */ 'type': AccessRequestDynamicApproverRequestedItemsInnerTypeEnum; /** * Grant or revoke the access item * @type {string} * @memberof AccessRequestDynamicApproverRequestedItemsInner */ 'operation': AccessRequestDynamicApproverRequestedItemsInnerOperationEnum; /** * A comment from the requestor on why the access is needed. * @type {string} * @memberof AccessRequestDynamicApproverRequestedItemsInner */ 'comment'?: string | null; } export const AccessRequestDynamicApproverRequestedItemsInnerTypeEnum = { AccessProfile: 'ACCESS_PROFILE', Role: 'ROLE', Entitlement: 'ENTITLEMENT' } as const; export type AccessRequestDynamicApproverRequestedItemsInnerTypeEnum = typeof AccessRequestDynamicApproverRequestedItemsInnerTypeEnum[keyof typeof AccessRequestDynamicApproverRequestedItemsInnerTypeEnum]; export const AccessRequestDynamicApproverRequestedItemsInnerOperationEnum = { Add: 'Add', Remove: 'Remove' } as const; export type AccessRequestDynamicApproverRequestedItemsInnerOperationEnum = typeof AccessRequestDynamicApproverRequestedItemsInnerOperationEnum[keyof typeof AccessRequestDynamicApproverRequestedItemsInnerOperationEnum]; /** * * @export * @interface AccessRequestPostApproval */ export interface AccessRequestPostApproval { /** * The unique ID of the access request. * @type {string} * @memberof AccessRequestPostApproval */ 'accessRequestId': string; /** * Identities access was requested for. * @type {Array} * @memberof AccessRequestPostApproval */ 'requestedFor': Array; /** * Details on the outcome of each access item. * @type {Array} * @memberof AccessRequestPostApproval */ 'requestedItemsStatus': Array; /** * * @type {AccessItemRequesterDto} * @memberof AccessRequestPostApproval */ 'requestedBy': AccessItemRequesterDto; } /** * * @export * @interface AccessRequestPostApprovalRequestedItemsStatusInner */ export interface AccessRequestPostApprovalRequestedItemsStatusInner { /** * The unique ID of the access item being requested. * @type {string} * @memberof AccessRequestPostApprovalRequestedItemsStatusInner */ 'id': string; /** * The human friendly name of the access item. * @type {string} * @memberof AccessRequestPostApprovalRequestedItemsStatusInner */ 'name': string; /** * Detailed description of the access item. * @type {string} * @memberof AccessRequestPostApprovalRequestedItemsStatusInner */ 'description'?: string | null; /** * The type of access item. * @type {string} * @memberof AccessRequestPostApprovalRequestedItemsStatusInner */ 'type': AccessRequestPostApprovalRequestedItemsStatusInnerTypeEnum; /** * The action to perform on the access item. * @type {string} * @memberof AccessRequestPostApprovalRequestedItemsStatusInner */ 'operation': AccessRequestPostApprovalRequestedItemsStatusInnerOperationEnum; /** * A comment from the identity requesting the access. * @type {string} * @memberof AccessRequestPostApprovalRequestedItemsStatusInner */ 'comment'?: string | null; /** * Additional customer defined metadata about the access item. * @type {{ [key: string]: any; }} * @memberof AccessRequestPostApprovalRequestedItemsStatusInner */ 'clientMetadata'?: { [key: string]: any; } | null; /** * A list of one or more approvers for the access request. * @type {Array} * @memberof AccessRequestPostApprovalRequestedItemsStatusInner */ 'approvalInfo': Array; } export const AccessRequestPostApprovalRequestedItemsStatusInnerTypeEnum = { AccessProfile: 'ACCESS_PROFILE', Role: 'ROLE', Entitlement: 'ENTITLEMENT' } as const; export type AccessRequestPostApprovalRequestedItemsStatusInnerTypeEnum = typeof AccessRequestPostApprovalRequestedItemsStatusInnerTypeEnum[keyof typeof AccessRequestPostApprovalRequestedItemsStatusInnerTypeEnum]; export const AccessRequestPostApprovalRequestedItemsStatusInnerOperationEnum = { Add: 'Add', Remove: 'Remove' } as const; export type AccessRequestPostApprovalRequestedItemsStatusInnerOperationEnum = typeof AccessRequestPostApprovalRequestedItemsStatusInnerOperationEnum[keyof typeof AccessRequestPostApprovalRequestedItemsStatusInnerOperationEnum]; /** * * @export * @interface AccessRequestPostApprovalRequestedItemsStatusInnerApprovalInfoInner */ export interface AccessRequestPostApprovalRequestedItemsStatusInnerApprovalInfoInner { /** * A comment left by the approver. * @type {string} * @memberof AccessRequestPostApprovalRequestedItemsStatusInnerApprovalInfoInner */ 'approvalComment'?: string | null; /** * The final decision of the approver. * @type {string} * @memberof AccessRequestPostApprovalRequestedItemsStatusInnerApprovalInfoInner */ 'approvalDecision': AccessRequestPostApprovalRequestedItemsStatusInnerApprovalInfoInnerApprovalDecisionEnum; /** * The name of the approver * @type {string} * @memberof AccessRequestPostApprovalRequestedItemsStatusInnerApprovalInfoInner */ 'approverName': string; /** * * @type {AccessRequestPostApprovalRequestedItemsStatusInnerApprovalInfoInnerApprover} * @memberof AccessRequestPostApprovalRequestedItemsStatusInnerApprovalInfoInner */ 'approver': AccessRequestPostApprovalRequestedItemsStatusInnerApprovalInfoInnerApprover; } export const AccessRequestPostApprovalRequestedItemsStatusInnerApprovalInfoInnerApprovalDecisionEnum = { Approved: 'APPROVED', Denied: 'DENIED' } as const; export type AccessRequestPostApprovalRequestedItemsStatusInnerApprovalInfoInnerApprovalDecisionEnum = typeof AccessRequestPostApprovalRequestedItemsStatusInnerApprovalInfoInnerApprovalDecisionEnum[keyof typeof AccessRequestPostApprovalRequestedItemsStatusInnerApprovalInfoInnerApprovalDecisionEnum]; /** * The identity of the approver. * @export * @interface AccessRequestPostApprovalRequestedItemsStatusInnerApprovalInfoInnerApprover */ export interface AccessRequestPostApprovalRequestedItemsStatusInnerApprovalInfoInnerApprover { /** * The type of object that is referenced * @type {string} * @memberof AccessRequestPostApprovalRequestedItemsStatusInnerApprovalInfoInnerApprover */ 'type': AccessRequestPostApprovalRequestedItemsStatusInnerApprovalInfoInnerApproverTypeEnum; /** * ID of identity who approved the access item request. * @type {string} * @memberof AccessRequestPostApprovalRequestedItemsStatusInnerApprovalInfoInnerApprover */ 'id': string; /** * Human-readable display name of identity who approved the access item request. * @type {string} * @memberof AccessRequestPostApprovalRequestedItemsStatusInnerApprovalInfoInnerApprover */ 'name': string; } export const AccessRequestPostApprovalRequestedItemsStatusInnerApprovalInfoInnerApproverTypeEnum = { Identity: 'IDENTITY' } as const; export type AccessRequestPostApprovalRequestedItemsStatusInnerApprovalInfoInnerApproverTypeEnum = typeof AccessRequestPostApprovalRequestedItemsStatusInnerApprovalInfoInnerApproverTypeEnum[keyof typeof AccessRequestPostApprovalRequestedItemsStatusInnerApprovalInfoInnerApproverTypeEnum]; /** * * @export * @interface AccessRequestPreApproval */ export interface AccessRequestPreApproval { /** * The unique ID of the access request. * @type {string} * @memberof AccessRequestPreApproval */ 'accessRequestId': string; /** * Identities access was requested for. * @type {Array} * @memberof AccessRequestPreApproval */ 'requestedFor': Array; /** * Details of the access items being requested. * @type {Array} * @memberof AccessRequestPreApproval */ 'requestedItems': Array; /** * * @type {AccessItemRequesterDto} * @memberof AccessRequestPreApproval */ 'requestedBy': AccessItemRequesterDto; } /** * * @export * @interface AccessRequestPreApproval2 */ export interface AccessRequestPreApproval2 { /** * Whether or not to approve the access request. * @type {boolean} * @memberof AccessRequestPreApproval2 */ 'approved': boolean; /** * A comment about the decision to approve or deny the request. * @type {string} * @memberof AccessRequestPreApproval2 */ 'comment': string; /** * The name of the entity that approved or denied the request. * @type {string} * @memberof AccessRequestPreApproval2 */ 'approver': string; } /** * * @export * @interface AccessRequestPreApprovalRequestedItemsInner */ export interface AccessRequestPreApprovalRequestedItemsInner { /** * The unique ID of the access item being requested. * @type {string} * @memberof AccessRequestPreApprovalRequestedItemsInner */ 'id': string; /** * The human friendly name of the access item. * @type {string} * @memberof AccessRequestPreApprovalRequestedItemsInner */ 'name': string; /** * Detailed description of the access item. * @type {string} * @memberof AccessRequestPreApprovalRequestedItemsInner */ 'description'?: string | null; /** * The type of access item. * @type {string} * @memberof AccessRequestPreApprovalRequestedItemsInner */ 'type': AccessRequestPreApprovalRequestedItemsInnerTypeEnum; /** * The action to perform on the access item. * @type {string} * @memberof AccessRequestPreApprovalRequestedItemsInner */ 'operation': AccessRequestPreApprovalRequestedItemsInnerOperationEnum; /** * A comment from the identity requesting the access. * @type {string} * @memberof AccessRequestPreApprovalRequestedItemsInner */ 'comment'?: string | null; } export const AccessRequestPreApprovalRequestedItemsInnerTypeEnum = { AccessProfile: 'ACCESS_PROFILE', Role: 'ROLE', Entitlement: 'ENTITLEMENT' } as const; export type AccessRequestPreApprovalRequestedItemsInnerTypeEnum = typeof AccessRequestPreApprovalRequestedItemsInnerTypeEnum[keyof typeof AccessRequestPreApprovalRequestedItemsInnerTypeEnum]; export const AccessRequestPreApprovalRequestedItemsInnerOperationEnum = { Add: 'Add', Remove: 'Remove' } as const; export type AccessRequestPreApprovalRequestedItemsInnerOperationEnum = typeof AccessRequestPreApprovalRequestedItemsInnerOperationEnum[keyof typeof AccessRequestPreApprovalRequestedItemsInnerOperationEnum]; /** * * @export * @interface AccountAggregationCompleted */ export interface AccountAggregationCompleted { /** * * @type {AccountAggregationCompletedSource} * @memberof AccountAggregationCompleted */ 'source': AccountAggregationCompletedSource; /** * The overall status of the aggregation. * @type {string} * @memberof AccountAggregationCompleted */ 'status': AccountAggregationCompletedStatusEnum; /** * The date and time when the account aggregation started. * @type {string} * @memberof AccountAggregationCompleted */ 'started': string; /** * The date and time when the account aggregation finished. * @type {string} * @memberof AccountAggregationCompleted */ 'completed': string; /** * A list of errors that occurred during the aggregation. * @type {Array} * @memberof AccountAggregationCompleted */ 'errors': Array | null; /** * A list of warnings that occurred during the aggregation. * @type {Array} * @memberof AccountAggregationCompleted */ 'warnings': Array | null; /** * * @type {AccountAggregationCompletedStats} * @memberof AccountAggregationCompleted */ 'stats': AccountAggregationCompletedStats; } export const AccountAggregationCompletedStatusEnum = { Success: 'Success', Failed: 'Failed', Terminated: 'Terminated' } as const; export type AccountAggregationCompletedStatusEnum = typeof AccountAggregationCompletedStatusEnum[keyof typeof AccountAggregationCompletedStatusEnum]; /** * The source the accounts are being aggregated from. * @export * @interface AccountAggregationCompletedSource */ export interface AccountAggregationCompletedSource { /** * The DTO type of the source the accounts are being aggregated from. * @type {string} * @memberof AccountAggregationCompletedSource */ 'type': AccountAggregationCompletedSourceTypeEnum; /** * The ID of the source the accounts are being aggregated from. * @type {string} * @memberof AccountAggregationCompletedSource */ 'id': string; /** * Display name of the source the accounts are being aggregated from. * @type {string} * @memberof AccountAggregationCompletedSource */ 'name': string; } export const AccountAggregationCompletedSourceTypeEnum = { Source: 'SOURCE' } as const; export type AccountAggregationCompletedSourceTypeEnum = typeof AccountAggregationCompletedSourceTypeEnum[keyof typeof AccountAggregationCompletedSourceTypeEnum]; /** * Overall statistics about the account aggregation. * @export * @interface AccountAggregationCompletedStats */ export interface AccountAggregationCompletedStats { /** * The number of accounts which were scanned / iterated over. * @type {number} * @memberof AccountAggregationCompletedStats */ 'scanned': number; /** * The number of accounts which existed before, but had no changes. * @type {number} * @memberof AccountAggregationCompletedStats */ 'unchanged': number; /** * The number of accounts which existed before, but had changes. * @type {number} * @memberof AccountAggregationCompletedStats */ 'changed': number; /** * The number of accounts which are new - have not existed before. * @type {number} * @memberof AccountAggregationCompletedStats */ 'added': number; /** * The number accounts which existed before, but no longer exist (thus getting removed). * @type {number} * @memberof AccountAggregationCompletedStats */ 'removed': number; } /** * * @export * @interface AccountAttributesChanged */ export interface AccountAttributesChanged { /** * * @type {AccountAttributesChangedIdentity} * @memberof AccountAttributesChanged */ 'identity': AccountAttributesChangedIdentity; /** * * @type {AccountAttributesChangedSource} * @memberof AccountAttributesChanged */ 'source': AccountAttributesChangedSource; /** * * @type {AccountAttributesChangedAccount} * @memberof AccountAttributesChanged */ 'account': AccountAttributesChangedAccount; /** * A list of attributes that changed. * @type {Array} * @memberof AccountAttributesChanged */ 'changes': Array; } /** * Details of the account where the attributes changed. * @export * @interface AccountAttributesChangedAccount */ export interface AccountAttributesChangedAccount { /** * SailPoint generated unique identifier. * @type {string} * @memberof AccountAttributesChangedAccount */ 'id': string; /** * The source\'s unique identifier for the account. UUID is generated by the source system. * @type {string} * @memberof AccountAttributesChangedAccount */ 'uuid': string | null; /** * Name of the account. * @type {string} * @memberof AccountAttributesChangedAccount */ 'name': string; /** * Unique ID of the account on the source. * @type {string} * @memberof AccountAttributesChangedAccount */ 'nativeIdentity': string; /** * The type of the account * @type {string} * @memberof AccountAttributesChangedAccount */ 'type': AccountAttributesChangedAccountTypeEnum; } export const AccountAttributesChangedAccountTypeEnum = { Account: 'ACCOUNT' } as const; export type AccountAttributesChangedAccountTypeEnum = typeof AccountAttributesChangedAccountTypeEnum[keyof typeof AccountAttributesChangedAccountTypeEnum]; /** * * @export * @interface AccountAttributesChangedChangesInner */ export interface AccountAttributesChangedChangesInner { /** * The name of the attribute. * @type {string} * @memberof AccountAttributesChangedChangesInner */ 'attribute': string; /** * * @type {AccountAttributesChangedChangesInnerOldValue} * @memberof AccountAttributesChangedChangesInner */ 'oldValue': AccountAttributesChangedChangesInnerOldValue | null; /** * * @type {AccountAttributesChangedChangesInnerNewValue} * @memberof AccountAttributesChangedChangesInner */ 'newValue': AccountAttributesChangedChangesInnerNewValue | null; } /** * @type AccountAttributesChangedChangesInnerNewValue * The new value of the attribute. * @export */ export type AccountAttributesChangedChangesInnerNewValue = Array | boolean | string; /** * @type AccountAttributesChangedChangesInnerOldValue * The previous value of the attribute. * @export */ export type AccountAttributesChangedChangesInnerOldValue = Array | boolean | string; /** * The identity whose account attributes were updated. * @export * @interface AccountAttributesChangedIdentity */ export interface AccountAttributesChangedIdentity { /** * DTO type of the identity whose account attributes were updated. * @type {string} * @memberof AccountAttributesChangedIdentity */ 'type': AccountAttributesChangedIdentityTypeEnum; /** * ID of the identity whose account attributes were updated. * @type {string} * @memberof AccountAttributesChangedIdentity */ 'id': string; /** * Display name of the identity whose account attributes were updated. * @type {string} * @memberof AccountAttributesChangedIdentity */ 'name': string; } export const AccountAttributesChangedIdentityTypeEnum = { Identity: 'IDENTITY' } as const; export type AccountAttributesChangedIdentityTypeEnum = typeof AccountAttributesChangedIdentityTypeEnum[keyof typeof AccountAttributesChangedIdentityTypeEnum]; /** * The source that contains the account. * @export * @interface AccountAttributesChangedSource */ export interface AccountAttributesChangedSource { /** * ID of the object to which this reference applies * @type {string} * @memberof AccountAttributesChangedSource */ 'id': string; /** * The type of object that is referenced * @type {string} * @memberof AccountAttributesChangedSource */ 'type': AccountAttributesChangedSourceTypeEnum; /** * Human-readable display name of the object to which this reference applies * @type {string} * @memberof AccountAttributesChangedSource */ 'name': string; } export const AccountAttributesChangedSourceTypeEnum = { Source: 'SOURCE' } as const; export type AccountAttributesChangedSourceTypeEnum = typeof AccountAttributesChangedSourceTypeEnum[keyof typeof AccountAttributesChangedSourceTypeEnum]; /** * * @export * @interface AccountCorrelated */ export interface AccountCorrelated { /** * * @type {AccountCorrelatedIdentity} * @memberof AccountCorrelated */ 'identity': AccountCorrelatedIdentity; /** * * @type {AccountCorrelatedSource} * @memberof AccountCorrelated */ 'source': AccountCorrelatedSource; /** * * @type {AccountCorrelatedAccount} * @memberof AccountCorrelated */ 'account': AccountCorrelatedAccount; /** * The attributes associated with the account. Attributes are unique per source. * @type {{ [key: string]: any; }} * @memberof AccountCorrelated */ 'attributes': { [key: string]: any; }; /** * The number of entitlements associated with this account. * @type {number} * @memberof AccountCorrelated */ 'entitlementCount'?: number; } /** * The correlated account. * @export * @interface AccountCorrelatedAccount */ export interface AccountCorrelatedAccount { /** * The correlated account\'s DTO type. * @type {string} * @memberof AccountCorrelatedAccount */ 'type': AccountCorrelatedAccountTypeEnum; /** * The correlated account\'s ID. * @type {string} * @memberof AccountCorrelatedAccount */ 'id': string; /** * The correlated account\'s display name. * @type {string} * @memberof AccountCorrelatedAccount */ 'name': string; /** * Unique ID of the account on the source. * @type {string} * @memberof AccountCorrelatedAccount */ 'nativeIdentity': string; /** * The source\'s unique identifier for the account. UUID is generated by the source system. * @type {string} * @memberof AccountCorrelatedAccount */ 'uuid'?: string | null; } export const AccountCorrelatedAccountTypeEnum = { Account: 'ACCOUNT' } as const; export type AccountCorrelatedAccountTypeEnum = typeof AccountCorrelatedAccountTypeEnum[keyof typeof AccountCorrelatedAccountTypeEnum]; /** * Identity the account is correlated with. * @export * @interface AccountCorrelatedIdentity */ export interface AccountCorrelatedIdentity { /** * DTO type of the identity the account is correlated with. * @type {string} * @memberof AccountCorrelatedIdentity */ 'type': AccountCorrelatedIdentityTypeEnum; /** * ID of the identity the account is correlated with. * @type {string} * @memberof AccountCorrelatedIdentity */ 'id': string; /** * Display name of the identity the account is correlated with. * @type {string} * @memberof AccountCorrelatedIdentity */ 'name': string; } export const AccountCorrelatedIdentityTypeEnum = { Identity: 'IDENTITY' } as const; export type AccountCorrelatedIdentityTypeEnum = typeof AccountCorrelatedIdentityTypeEnum[keyof typeof AccountCorrelatedIdentityTypeEnum]; /** * The source the accounts are being correlated from. * @export * @interface AccountCorrelatedSource */ export interface AccountCorrelatedSource { /** * The DTO type of the source the accounts are being correlated from. * @type {string} * @memberof AccountCorrelatedSource */ 'type': AccountCorrelatedSourceTypeEnum; /** * The ID of the source the accounts are being correlated from. * @type {string} * @memberof AccountCorrelatedSource */ 'id': string; /** * Display name of the source the accounts are being correlated from. * @type {string} * @memberof AccountCorrelatedSource */ 'name': string; } export const AccountCorrelatedSourceTypeEnum = { Source: 'SOURCE' } as const; export type AccountCorrelatedSourceTypeEnum = typeof AccountCorrelatedSourceTypeEnum[keyof typeof AccountCorrelatedSourceTypeEnum]; /** * * @export * @interface AccountCreated */ export interface AccountCreated { /** * * @type {AccountCreatedEvent} * @memberof AccountCreated */ 'event': AccountCreatedEvent; /** * * @type {AccountSourceReference} * @memberof AccountCreated */ 'source': AccountSourceReference; /** * * @type {AccountV2} * @memberof AccountCreated */ 'account': AccountV2; /** * * @type {IdentityReference2} * @memberof AccountCreated */ 'identity': IdentityReference2; } /** * Details about the event. * @export * @interface AccountCreatedEvent */ export interface AccountCreatedEvent { /** * The type of event. * @type {string} * @memberof AccountCreatedEvent */ 'type': AccountCreatedEventTypeEnum; /** * The cause of the event. * @type {string} * @memberof AccountCreatedEvent */ 'cause': AccountCreatedEventCauseEnum; } export const AccountCreatedEventTypeEnum = { AccountCreatedV2: 'ACCOUNT_CREATED_V2' } as const; export type AccountCreatedEventTypeEnum = typeof AccountCreatedEventTypeEnum[keyof typeof AccountCreatedEventTypeEnum]; export const AccountCreatedEventCauseEnum = { Aggregation: 'AGGREGATION', Provisioning: 'PROVISIONING' } as const; export type AccountCreatedEventCauseEnum = typeof AccountCreatedEventCauseEnum[keyof typeof AccountCreatedEventCauseEnum]; /** * * @export * @interface AccountDeleted */ export interface AccountDeleted { /** * * @type {AccountDeletedEvent} * @memberof AccountDeleted */ 'event': AccountDeletedEvent; /** * * @type {AccountSourceReference} * @memberof AccountDeleted */ 'source': AccountSourceReference; /** * * @type {AccountV2} * @memberof AccountDeleted */ 'account': AccountV2; /** * * @type {IdentityReference2} * @memberof AccountDeleted */ 'identity': IdentityReference2; } /** * Details about the event. * @export * @interface AccountDeletedEvent */ export interface AccountDeletedEvent { /** * The type of event. * @type {string} * @memberof AccountDeletedEvent */ 'type': AccountDeletedEventTypeEnum; /** * The cause of the event. * @type {string} * @memberof AccountDeletedEvent */ 'cause': AccountDeletedEventCauseEnum; } export const AccountDeletedEventTypeEnum = { AccountDeletedV2: 'ACCOUNT_DELETED_V2' } as const; export type AccountDeletedEventTypeEnum = typeof AccountDeletedEventTypeEnum[keyof typeof AccountDeletedEventTypeEnum]; export const AccountDeletedEventCauseEnum = { Aggregation: 'AGGREGATION', Provisioning: 'PROVISIONING' } as const; export type AccountDeletedEventCauseEnum = typeof AccountDeletedEventCauseEnum[keyof typeof AccountDeletedEventCauseEnum]; /** * Details about the account source. * @export * @interface AccountSourceReference */ export interface AccountSourceReference { /** * The unique ID of the source. * @type {string} * @memberof AccountSourceReference */ 'id': string; /** * The name of the source. * @type {string} * @memberof AccountSourceReference */ 'name': string; /** * The alias of the source. * @type {string} * @memberof AccountSourceReference */ 'alias': string; /** * * @type {AccountSourceReferenceOwner} * @memberof AccountSourceReference */ 'owner': AccountSourceReferenceOwner; /** * * @type {AccountSourceReferenceGovernanceGroup} * @memberof AccountSourceReference */ 'governanceGroup': AccountSourceReferenceGovernanceGroup; } /** * Details about the governance group of the source. * @export * @interface AccountSourceReferenceGovernanceGroup */ export interface AccountSourceReferenceGovernanceGroup { /** * ID of the governance group. * @type {string} * @memberof AccountSourceReferenceGovernanceGroup */ 'id': string; /** * Name of the governance group. * @type {string} * @memberof AccountSourceReferenceGovernanceGroup */ 'name': string; } /** * Details about the owner of the source. * @export * @interface AccountSourceReferenceOwner */ export interface AccountSourceReferenceOwner { /** * ID of the source owner. * @type {string} * @memberof AccountSourceReferenceOwner */ 'id': string; /** * Name of the source owner. * @type {string} * @memberof AccountSourceReferenceOwner */ 'name': string; } /** * * @export * @interface AccountUncorrelated */ export interface AccountUncorrelated { /** * * @type {AccountUncorrelatedIdentity} * @memberof AccountUncorrelated */ 'identity': AccountUncorrelatedIdentity; /** * * @type {AccountUncorrelatedSource} * @memberof AccountUncorrelated */ 'source': AccountUncorrelatedSource; /** * * @type {AccountUncorrelatedAccount} * @memberof AccountUncorrelated */ 'account': AccountUncorrelatedAccount; /** * The number of entitlements associated with this account. * @type {number} * @memberof AccountUncorrelated */ 'entitlementCount'?: number; } /** * Uncorrelated account. * @export * @interface AccountUncorrelatedAccount */ export interface AccountUncorrelatedAccount { /** * Uncorrelated account\'s DTO type. * @type {string} * @memberof AccountUncorrelatedAccount */ 'type': AccountUncorrelatedAccountTypeEnum; /** * Uncorrelated account\'s ID. * @type {string} * @memberof AccountUncorrelatedAccount */ 'id': string; /** * Uncorrelated account\'s display name. * @type {string} * @memberof AccountUncorrelatedAccount */ 'name': string; /** * Unique ID of the account on the source. * @type {string} * @memberof AccountUncorrelatedAccount */ 'nativeIdentity': string; /** * The source\'s unique identifier for the account. UUID is generated by the source system. * @type {string} * @memberof AccountUncorrelatedAccount */ 'uuid'?: string | null; } export const AccountUncorrelatedAccountTypeEnum = { Account: 'ACCOUNT' } as const; export type AccountUncorrelatedAccountTypeEnum = typeof AccountUncorrelatedAccountTypeEnum[keyof typeof AccountUncorrelatedAccountTypeEnum]; /** * Identity the account is uncorrelated with. * @export * @interface AccountUncorrelatedIdentity */ export interface AccountUncorrelatedIdentity { /** * DTO type of the identity the account is uncorrelated with. * @type {string} * @memberof AccountUncorrelatedIdentity */ 'type': AccountUncorrelatedIdentityTypeEnum; /** * ID of the identity the account is uncorrelated with. * @type {string} * @memberof AccountUncorrelatedIdentity */ 'id': string; /** * Display name of the identity the account is uncorrelated with. * @type {string} * @memberof AccountUncorrelatedIdentity */ 'name': string; } export const AccountUncorrelatedIdentityTypeEnum = { Identity: 'IDENTITY' } as const; export type AccountUncorrelatedIdentityTypeEnum = typeof AccountUncorrelatedIdentityTypeEnum[keyof typeof AccountUncorrelatedIdentityTypeEnum]; /** * The source the accounts are uncorrelated from. * @export * @interface AccountUncorrelatedSource */ export interface AccountUncorrelatedSource { /** * The DTO type of the source the accounts are uncorrelated from. * @type {string} * @memberof AccountUncorrelatedSource */ 'type': AccountUncorrelatedSourceTypeEnum; /** * The ID of the source the accounts are uncorrelated from. * @type {string} * @memberof AccountUncorrelatedSource */ 'id': string; /** * Display name of the source the accounts are uncorrelated from. * @type {string} * @memberof AccountUncorrelatedSource */ 'name': string; } export const AccountUncorrelatedSourceTypeEnum = { Source: 'SOURCE' } as const; export type AccountUncorrelatedSourceTypeEnum = typeof AccountUncorrelatedSourceTypeEnum[keyof typeof AccountUncorrelatedSourceTypeEnum]; /** * * @export * @interface AccountUpdated */ export interface AccountUpdated { /** * * @type {AccountUpdatedEvent} * @memberof AccountUpdated */ 'event': AccountUpdatedEvent; /** * * @type {AccountSourceReference} * @memberof AccountUpdated */ 'source': AccountSourceReference; /** * * @type {AccountV2} * @memberof AccountUpdated */ 'account': AccountV2; /** * * @type {IdentityReference2} * @memberof AccountUpdated */ 'identity': IdentityReference2; /** * The types of changes that occurred to the account. * @type {Array} * @memberof AccountUpdated */ 'accountChangeTypes': Array; /** * Details about the single-value attribute changes that occurred to the account. * @type {Array} * @memberof AccountUpdated */ 'singleValueAttributeChanges': Array | null; /** * Details about the multi-value attribute changes that occurred to the account. * @type {Array} * @memberof AccountUpdated */ 'multiValueAttributeChanges': Array | null; /** * Details about the entitlement changes that occurred to the account. * @type {Array} * @memberof AccountUpdated */ 'entitlementChanges': Array | null; } export const AccountUpdatedAccountChangeTypesEnum = { AttributesChanged: 'ATTRIBUTES_CHANGED', EntitlementsAdded: 'ENTITLEMENTS_ADDED', EntitlementsRemoved: 'ENTITLEMENTS_REMOVED' } as const; export type AccountUpdatedAccountChangeTypesEnum = typeof AccountUpdatedAccountChangeTypesEnum[keyof typeof AccountUpdatedAccountChangeTypesEnum]; /** * * @export * @interface AccountUpdatedEntitlementChangesInner */ export interface AccountUpdatedEntitlementChangesInner { /** * The name of the entitlement attribute that was changed. * @type {string} * @memberof AccountUpdatedEntitlementChangesInner */ 'attributeName': string; /** * The entitlements that were added. * @type {Array} * @memberof AccountUpdatedEntitlementChangesInner */ 'added': Array | null; /** * The entitlements that were removed. * @type {Array} * @memberof AccountUpdatedEntitlementChangesInner */ 'removed': Array | null; } /** * * @export * @interface AccountUpdatedEntitlementChangesInnerAddedInner */ export interface AccountUpdatedEntitlementChangesInnerAddedInner { /** * The unique identifier of the entitlement. * @type {string} * @memberof AccountUpdatedEntitlementChangesInnerAddedInner */ 'id'?: string | null; /** * The name of the entitlement. * @type {string} * @memberof AccountUpdatedEntitlementChangesInnerAddedInner */ 'name'?: string | null; /** * * @type {AccountUpdatedEntitlementChangesInnerAddedInnerOwner} * @memberof AccountUpdatedEntitlementChangesInnerAddedInner */ 'owner'?: AccountUpdatedEntitlementChangesInnerAddedInnerOwner; /** * The value of the entitlement. * @type {string} * @memberof AccountUpdatedEntitlementChangesInnerAddedInner */ 'value'?: string; } /** * The type of the entitlement. * @export * @interface AccountUpdatedEntitlementChangesInnerAddedInnerOwner */ export interface AccountUpdatedEntitlementChangesInnerAddedInnerOwner { /** * The unique identifier of the owner. * @type {string} * @memberof AccountUpdatedEntitlementChangesInnerAddedInnerOwner */ 'id'?: string; /** * The name of the owner. * @type {string} * @memberof AccountUpdatedEntitlementChangesInnerAddedInnerOwner */ 'name'?: string | null; /** * The type of the owner. * @type {string} * @memberof AccountUpdatedEntitlementChangesInnerAddedInnerOwner */ 'type'?: string; } /** * Details about the event. * @export * @interface AccountUpdatedEvent */ export interface AccountUpdatedEvent { /** * The type of event. * @type {string} * @memberof AccountUpdatedEvent */ 'type': AccountUpdatedEventTypeEnum; /** * The cause of the event. * @type {string} * @memberof AccountUpdatedEvent */ 'cause': AccountUpdatedEventCauseEnum; } export const AccountUpdatedEventTypeEnum = { AccountUpdatedV2: 'ACCOUNT_UPDATED_V2' } as const; export type AccountUpdatedEventTypeEnum = typeof AccountUpdatedEventTypeEnum[keyof typeof AccountUpdatedEventTypeEnum]; export const AccountUpdatedEventCauseEnum = { Aggregation: 'AGGREGATION', Provisioning: 'PROVISIONING', PasswordChange: 'PASSWORD_CHANGE' } as const; export type AccountUpdatedEventCauseEnum = typeof AccountUpdatedEventCauseEnum[keyof typeof AccountUpdatedEventCauseEnum]; /** * * @export * @interface AccountUpdatedMultiValueAttributeChangesInner */ export interface AccountUpdatedMultiValueAttributeChangesInner { /** * The name of the attribute that was changed. * @type {string} * @memberof AccountUpdatedMultiValueAttributeChangesInner */ 'name': string; /** * The values that were added to the attribute. * @type {Array} * @memberof AccountUpdatedMultiValueAttributeChangesInner */ 'addedValues': Array; /** * The values that were removed from the attribute. * @type {Array} * @memberof AccountUpdatedMultiValueAttributeChangesInner */ 'removedValues': Array; } /** * @type AccountUpdatedMultiValueAttributeChangesInnerAddedValuesInner * @export */ export type AccountUpdatedMultiValueAttributeChangesInnerAddedValuesInner = Array | boolean | number | string; /** * * @export * @interface AccountUpdatedSingleValueAttributeChangesInner */ export interface AccountUpdatedSingleValueAttributeChangesInner { /** * The name of the attribute that was changed. * @type {string} * @memberof AccountUpdatedSingleValueAttributeChangesInner */ 'name': string; /** * * @type {AccountUpdatedSingleValueAttributeChangesInnerOldValue} * @memberof AccountUpdatedSingleValueAttributeChangesInner */ 'oldValue': AccountUpdatedSingleValueAttributeChangesInnerOldValue | null; /** * * @type {AccountUpdatedSingleValueAttributeChangesInnerNewValue} * @memberof AccountUpdatedSingleValueAttributeChangesInner */ 'newValue': AccountUpdatedSingleValueAttributeChangesInnerNewValue | null; } /** * @type AccountUpdatedSingleValueAttributeChangesInnerNewValue * The new value of the attribute after the change. * @export */ export type AccountUpdatedSingleValueAttributeChangesInnerNewValue = Array | boolean | number | string; /** * @type AccountUpdatedSingleValueAttributeChangesInnerOldValue * The old value of the attribute before the change. * @export */ export type AccountUpdatedSingleValueAttributeChangesInnerOldValue = Array | boolean | number | string; /** * Details about the account. * @export * @interface AccountV2 */ export interface AccountV2 { /** * The unique identifier of the account. * @type {string} * @memberof AccountV2 */ 'id': string; /** * The name of the account. * @type {string} * @memberof AccountV2 */ 'name': string; /** * The unique ID of the account generated by the source system. * @type {string} * @memberof AccountV2 */ 'nativeIdentity': string; /** * The unique ID associated with this account. * @type {string} * @memberof AccountV2 */ 'uuid': string | null; /** * Indicates if the account is correlated to an identity. * @type {boolean} * @memberof AccountV2 */ 'correlated': boolean; /** * Indicates if the account is a machine account. * @type {boolean} * @memberof AccountV2 */ 'isMachine': boolean; /** * The origin of the account. * @type {string} * @memberof AccountV2 */ 'origin': string | null; /** * The attributes of the account. The contents of attributes depends on the account schema for the source. * @type {{ [key: string]: any; }} * @memberof AccountV2 */ 'attributes': { [key: string]: any; } | null; } /** * * @export * @interface AccountsCollectedForAggregation */ export interface AccountsCollectedForAggregation { /** * * @type {AccountsCollectedForAggregationSource} * @memberof AccountsCollectedForAggregation */ 'source': AccountsCollectedForAggregationSource; /** * The overall status of the collection. * @type {string} * @memberof AccountsCollectedForAggregation */ 'status': AccountsCollectedForAggregationStatusEnum; /** * The date and time when the account collection started. * @type {string} * @memberof AccountsCollectedForAggregation */ 'started': string; /** * The date and time when the account collection finished. * @type {string} * @memberof AccountsCollectedForAggregation */ 'completed': string; /** * A list of errors that occurred during the collection. * @type {Array} * @memberof AccountsCollectedForAggregation */ 'errors': Array | null; /** * A list of warnings that occurred during the collection. * @type {Array} * @memberof AccountsCollectedForAggregation */ 'warnings': Array | null; /** * * @type {AccountsCollectedForAggregationStats} * @memberof AccountsCollectedForAggregation */ 'stats': AccountsCollectedForAggregationStats; } export const AccountsCollectedForAggregationStatusEnum = { Success: 'Success', Failed: 'Failed', Terminated: 'Terminated' } as const; export type AccountsCollectedForAggregationStatusEnum = typeof AccountsCollectedForAggregationStatusEnum[keyof typeof AccountsCollectedForAggregationStatusEnum]; /** * Reference to the source that has been aggregated. * @export * @interface AccountsCollectedForAggregationSource */ export interface AccountsCollectedForAggregationSource { /** * ID of the object to which this reference applies * @type {string} * @memberof AccountsCollectedForAggregationSource */ 'id': string; /** * The type of object that is referenced * @type {string} * @memberof AccountsCollectedForAggregationSource */ 'type': AccountsCollectedForAggregationSourceTypeEnum; /** * Human-readable display name of the object to which this reference applies * @type {string} * @memberof AccountsCollectedForAggregationSource */ 'name': string; } export const AccountsCollectedForAggregationSourceTypeEnum = { Source: 'SOURCE' } as const; export type AccountsCollectedForAggregationSourceTypeEnum = typeof AccountsCollectedForAggregationSourceTypeEnum[keyof typeof AccountsCollectedForAggregationSourceTypeEnum]; /** * Overall statistics about the account collection. * @export * @interface AccountsCollectedForAggregationStats */ export interface AccountsCollectedForAggregationStats { /** * The number of accounts which were scanned / iterated over. * @type {number} * @memberof AccountsCollectedForAggregationStats */ 'scanned': number; /** * The number of accounts which existed before, but had no changes. * @type {number} * @memberof AccountsCollectedForAggregationStats */ 'unchanged': number; /** * The number of accounts which existed before, but had changes. * @type {number} * @memberof AccountsCollectedForAggregationStats */ 'changed': number; /** * The number of accounts which are new - have not existed before. * @type {number} * @memberof AccountsCollectedForAggregationStats */ 'added': number; /** * The number accounts which existed before, but no longer exist (thus getting removed). * @type {number} * @memberof AccountsCollectedForAggregationStats */ 'removed': number; } /** * Config required if BASIC_AUTH is used. * @export * @interface BasicAuthConfig */ export interface BasicAuthConfig { /** * The username to authenticate. * @type {string} * @memberof BasicAuthConfig */ 'userName'?: string; /** * The password to authenticate. On response, this field is set to null as to not return secrets. * @type {string} * @memberof BasicAuthConfig */ 'password'?: string | null; } /** * Config required if BEARER_TOKEN authentication is used. On response, this field is set to null as to not return secrets. * @export * @interface BearerTokenAuthConfig */ export interface BearerTokenAuthConfig { /** * Bearer token * @type {string} * @memberof BearerTokenAuthConfig */ 'bearerToken'?: string | null; } /** * * @export * @interface CampaignActivated */ export interface CampaignActivated { /** * * @type {CampaignActivatedCampaign} * @memberof CampaignActivated */ 'campaign': CampaignActivatedCampaign; } /** * Details about the certification campaign that was activated. * @export * @interface CampaignActivatedCampaign */ export interface CampaignActivatedCampaign { /** * Unique ID for the campaign. * @type {string} * @memberof CampaignActivatedCampaign */ 'id': string; /** * The human friendly name of the campaign. * @type {string} * @memberof CampaignActivatedCampaign */ 'name': string; /** * Extended description of the campaign. * @type {string} * @memberof CampaignActivatedCampaign */ 'description': string; /** * The date and time the campaign was created. * @type {string} * @memberof CampaignActivatedCampaign */ 'created': string; /** * The date and time the campaign was last modified. * @type {string} * @memberof CampaignActivatedCampaign */ 'modified'?: string | null; /** * The date and time the campaign is due. * @type {string} * @memberof CampaignActivatedCampaign */ 'deadline': string; /** * The type of campaign. * @type {string} * @memberof CampaignActivatedCampaign */ 'type': CampaignActivatedCampaignTypeEnum; /** * * @type {CampaignActivatedCampaignCampaignOwner} * @memberof CampaignActivatedCampaign */ 'campaignOwner': CampaignActivatedCampaignCampaignOwner; /** * The current status of the campaign. * @type {string} * @memberof CampaignActivatedCampaign */ 'status': CampaignActivatedCampaignStatusEnum; } export const CampaignActivatedCampaignTypeEnum = { Manager: 'MANAGER', SourceOwner: 'SOURCE_OWNER', Search: 'SEARCH', RoleComposition: 'ROLE_COMPOSITION' } as const; export type CampaignActivatedCampaignTypeEnum = typeof CampaignActivatedCampaignTypeEnum[keyof typeof CampaignActivatedCampaignTypeEnum]; export const CampaignActivatedCampaignStatusEnum = { Active: 'ACTIVE' } as const; export type CampaignActivatedCampaignStatusEnum = typeof CampaignActivatedCampaignStatusEnum[keyof typeof CampaignActivatedCampaignStatusEnum]; /** * Details of the identity that owns the campaign. * @export * @interface CampaignActivatedCampaignCampaignOwner */ export interface CampaignActivatedCampaignCampaignOwner { /** * The unique ID of the identity. * @type {string} * @memberof CampaignActivatedCampaignCampaignOwner */ 'id': string; /** * The human friendly name of the identity. * @type {string} * @memberof CampaignActivatedCampaignCampaignOwner */ 'displayName': string; /** * The primary email address of the identity. * @type {string} * @memberof CampaignActivatedCampaignCampaignOwner */ 'email': string; } /** * * @export * @interface CampaignEnded */ export interface CampaignEnded { /** * * @type {CampaignEndedCampaign} * @memberof CampaignEnded */ 'campaign': CampaignEndedCampaign; } /** * Details about the certification campaign that ended. * @export * @interface CampaignEndedCampaign */ export interface CampaignEndedCampaign { /** * Unique ID for the campaign. * @type {string} * @memberof CampaignEndedCampaign */ 'id': string; /** * The human friendly name of the campaign. * @type {string} * @memberof CampaignEndedCampaign */ 'name': string; /** * Extended description of the campaign. * @type {string} * @memberof CampaignEndedCampaign */ 'description': string; /** * The date and time the campaign was created. * @type {string} * @memberof CampaignEndedCampaign */ 'created': string; /** * The date and time the campaign was last modified. * @type {string} * @memberof CampaignEndedCampaign */ 'modified'?: string | null; /** * The date and time the campaign is due. * @type {string} * @memberof CampaignEndedCampaign */ 'deadline': string; /** * The type of campaign. * @type {string} * @memberof CampaignEndedCampaign */ 'type': CampaignEndedCampaignTypeEnum; /** * * @type {CampaignActivatedCampaignCampaignOwner} * @memberof CampaignEndedCampaign */ 'campaignOwner': CampaignActivatedCampaignCampaignOwner; /** * The current status of the campaign. * @type {string} * @memberof CampaignEndedCampaign */ 'status': CampaignEndedCampaignStatusEnum; } export const CampaignEndedCampaignTypeEnum = { Manager: 'MANAGER', SourceOwner: 'SOURCE_OWNER', Search: 'SEARCH', RoleComposition: 'ROLE_COMPOSITION' } as const; export type CampaignEndedCampaignTypeEnum = typeof CampaignEndedCampaignTypeEnum[keyof typeof CampaignEndedCampaignTypeEnum]; export const CampaignEndedCampaignStatusEnum = { Completed: 'COMPLETED' } as const; export type CampaignEndedCampaignStatusEnum = typeof CampaignEndedCampaignStatusEnum[keyof typeof CampaignEndedCampaignStatusEnum]; /** * * @export * @interface CampaignGenerated */ export interface CampaignGenerated { /** * * @type {CampaignGeneratedCampaign} * @memberof CampaignGenerated */ 'campaign': CampaignGeneratedCampaign; } /** * Details about the campaign that was generated. * @export * @interface CampaignGeneratedCampaign */ export interface CampaignGeneratedCampaign { /** * The unique ID of the campaign. * @type {string} * @memberof CampaignGeneratedCampaign */ 'id': string; /** * Human friendly name of the campaign. * @type {string} * @memberof CampaignGeneratedCampaign */ 'name': string; /** * Extended description of the campaign. * @type {string} * @memberof CampaignGeneratedCampaign */ 'description': string; /** * The date and time the campaign was created. * @type {string} * @memberof CampaignGeneratedCampaign */ 'created': string; /** * The date and time the campaign was last modified. * @type {string} * @memberof CampaignGeneratedCampaign */ 'modified'?: string | null; /** * The date and time when the campaign must be finished by. * @type {string} * @memberof CampaignGeneratedCampaign */ 'deadline'?: string | null; /** * The type of campaign that was generated. * @type {string} * @memberof CampaignGeneratedCampaign */ 'type': CampaignGeneratedCampaignTypeEnum; /** * * @type {CampaignGeneratedCampaignCampaignOwner} * @memberof CampaignGeneratedCampaign */ 'campaignOwner': CampaignGeneratedCampaignCampaignOwner; /** * The current status of the campaign. * @type {string} * @memberof CampaignGeneratedCampaign */ 'status': CampaignGeneratedCampaignStatusEnum; } export const CampaignGeneratedCampaignTypeEnum = { Manager: 'MANAGER', SourceOwner: 'SOURCE_OWNER', Search: 'SEARCH', RoleComposition: 'ROLE_COMPOSITION' } as const; export type CampaignGeneratedCampaignTypeEnum = typeof CampaignGeneratedCampaignTypeEnum[keyof typeof CampaignGeneratedCampaignTypeEnum]; export const CampaignGeneratedCampaignStatusEnum = { Staged: 'STAGED', Activating: 'ACTIVATING', Active: 'ACTIVE' } as const; export type CampaignGeneratedCampaignStatusEnum = typeof CampaignGeneratedCampaignStatusEnum[keyof typeof CampaignGeneratedCampaignStatusEnum]; /** * The identity that owns the campaign. * @export * @interface CampaignGeneratedCampaignCampaignOwner */ export interface CampaignGeneratedCampaignCampaignOwner { /** * The unique ID of the identity. * @type {string} * @memberof CampaignGeneratedCampaignCampaignOwner */ 'id': string; /** * The display name of the identity. * @type {string} * @memberof CampaignGeneratedCampaignCampaignOwner */ 'displayName': string; /** * The primary email address of the identity. * @type {string} * @memberof CampaignGeneratedCampaignCampaignOwner */ 'email': string; } /** * * @export * @interface CampaignReference */ export interface CampaignReference { /** * The unique ID of the campaign. * @type {string} * @memberof CampaignReference */ 'id': string; /** * The name of the campaign. * @type {string} * @memberof CampaignReference */ 'name': string; /** * The type of object that is being referenced. * @type {string} * @memberof CampaignReference */ 'type': CampaignReferenceTypeEnum; /** * The type of the campaign. * @type {string} * @memberof CampaignReference */ 'campaignType': CampaignReferenceCampaignTypeEnum; /** * The description of the campaign set by the admin who created it. * @type {string} * @memberof CampaignReference */ 'description': string | null; /** * The correlatedStatus of the campaign. Only SOURCE_OWNER campaigns can be Uncorrelated. An Uncorrelated certification campaign only includes Uncorrelated identities (An identity is uncorrelated if it has no accounts on an authoritative source). * @type {string} * @memberof CampaignReference */ 'correlatedStatus': CampaignReferenceCorrelatedStatusEnum; /** * Determines whether comments are required for decisions during certification reviews. You can require comments for all decisions, revoke-only decisions, or no decisions. By default, comments are not required for decisions. * @type {string} * @memberof CampaignReference */ 'mandatoryCommentRequirement': CampaignReferenceMandatoryCommentRequirementEnum; } export const CampaignReferenceTypeEnum = { Campaign: 'CAMPAIGN' } as const; export type CampaignReferenceTypeEnum = typeof CampaignReferenceTypeEnum[keyof typeof CampaignReferenceTypeEnum]; export const CampaignReferenceCampaignTypeEnum = { Manager: 'MANAGER', SourceOwner: 'SOURCE_OWNER', Search: 'SEARCH', RoleComposition: 'ROLE_COMPOSITION', MachineAccount: 'MACHINE_ACCOUNT' } as const; export type CampaignReferenceCampaignTypeEnum = typeof CampaignReferenceCampaignTypeEnum[keyof typeof CampaignReferenceCampaignTypeEnum]; export const CampaignReferenceCorrelatedStatusEnum = { Correlated: 'CORRELATED', Uncorrelated: 'UNCORRELATED' } as const; export type CampaignReferenceCorrelatedStatusEnum = typeof CampaignReferenceCorrelatedStatusEnum[keyof typeof CampaignReferenceCorrelatedStatusEnum]; export const CampaignReferenceMandatoryCommentRequirementEnum = { AllDecisions: 'ALL_DECISIONS', RevokeOnlyDecisions: 'REVOKE_ONLY_DECISIONS', NoDecisions: 'NO_DECISIONS' } as const; export type CampaignReferenceMandatoryCommentRequirementEnum = typeof CampaignReferenceMandatoryCommentRequirementEnum[keyof typeof CampaignReferenceMandatoryCommentRequirementEnum]; /** * * @export * @interface CertificationDto */ export interface CertificationDto { /** * * @type {CampaignReference} * @memberof CertificationDto */ 'campaignRef': CampaignReference; /** * * @type {CertificationPhase} * @memberof CertificationDto */ 'phase': CertificationPhase; /** * The due date of the certification. * @type {string} * @memberof CertificationDto */ 'due': string; /** * The date the reviewer signed off on the certification. * @type {string} * @memberof CertificationDto */ 'signed': string; /** * * @type {Reviewer} * @memberof CertificationDto */ 'reviewer': Reviewer; /** * * @type {Reassignment} * @memberof CertificationDto */ 'reassignment'?: Reassignment | null; /** * Indicates it the certification has any errors. * @type {boolean} * @memberof CertificationDto */ 'hasErrors': boolean; /** * A message indicating what the error is. * @type {string} * @memberof CertificationDto */ 'errorMessage'?: string | null; /** * Indicates if all certification decisions have been made. * @type {boolean} * @memberof CertificationDto */ 'completed': boolean; /** * The number of approve/revoke/acknowledge decisions that have been made by the reviewer. * @type {number} * @memberof CertificationDto */ 'decisionsMade': number; /** * The total number of approve/revoke/acknowledge decisions for the certification. * @type {number} * @memberof CertificationDto */ 'decisionsTotal': number; /** * The number of entities (identities, access profiles, roles, etc.) for which all decisions have been made and are complete. * @type {number} * @memberof CertificationDto */ 'entitiesCompleted': number; /** * The total number of entities (identities, access profiles, roles, etc.) in the certification, both complete and incomplete. * @type {number} * @memberof CertificationDto */ 'entitiesTotal': number; } /** * The current phase of the campaign. * `STAGED`: The campaign is waiting to be activated. * `ACTIVE`: The campaign is active. * `SIGNED`: The reviewer has signed off on the campaign, and it is considered complete. * @export * @enum {string} */ export const CertificationPhase = { Staged: 'STAGED', Active: 'ACTIVE', Signed: 'SIGNED' } as const; export type CertificationPhase = typeof CertificationPhase[keyof typeof CertificationPhase]; /** * * @export * @interface CertificationReference */ export interface CertificationReference { /** * The id of the certification. * @type {string} * @memberof CertificationReference */ 'id'?: string; /** * The name of the certification. * @type {string} * @memberof CertificationReference */ 'name'?: string; /** * * @type {string} * @memberof CertificationReference */ 'type'?: CertificationReferenceTypeEnum; /** * * @type {Reviewer} * @memberof CertificationReference */ 'reviewer'?: Reviewer; } export const CertificationReferenceTypeEnum = { Certification: 'CERTIFICATION' } as const; export type CertificationReferenceTypeEnum = typeof CertificationReferenceTypeEnum[keyof typeof CertificationReferenceTypeEnum]; /** * * @export * @interface CertificationSignedOff */ export interface CertificationSignedOff { /** * * @type {CertificationSignedOffCertification} * @memberof CertificationSignedOff */ 'certification': CertificationSignedOffCertification; } /** * The certification campaign that was signed off on. * @export * @interface CertificationSignedOffCertification */ export interface CertificationSignedOffCertification { /** * Unique ID of the certification. * @type {string} * @memberof CertificationSignedOffCertification */ 'id': string; /** * The name of the certification. * @type {string} * @memberof CertificationSignedOffCertification */ 'name': string; /** * The date and time the certification was created. * @type {string} * @memberof CertificationSignedOffCertification */ 'created': string; /** * The date and time the certification was last modified. * @type {string} * @memberof CertificationSignedOffCertification */ 'modified'?: string | null; /** * * @type {CampaignReference} * @memberof CertificationSignedOffCertification */ 'campaignRef': CampaignReference; /** * * @type {CertificationPhase} * @memberof CertificationSignedOffCertification */ 'phase': CertificationPhase; /** * The due date of the certification. * @type {string} * @memberof CertificationSignedOffCertification */ 'due': string; /** * The date the reviewer signed off on the certification. * @type {string} * @memberof CertificationSignedOffCertification */ 'signed': string; /** * * @type {Reviewer} * @memberof CertificationSignedOffCertification */ 'reviewer': Reviewer; /** * * @type {Reassignment} * @memberof CertificationSignedOffCertification */ 'reassignment'?: Reassignment | null; /** * Indicates it the certification has any errors. * @type {boolean} * @memberof CertificationSignedOffCertification */ 'hasErrors': boolean; /** * A message indicating what the error is. * @type {string} * @memberof CertificationSignedOffCertification */ 'errorMessage'?: string | null; /** * Indicates if all certification decisions have been made. * @type {boolean} * @memberof CertificationSignedOffCertification */ 'completed': boolean; /** * The number of approve/revoke/acknowledge decisions that have been made by the reviewer. * @type {number} * @memberof CertificationSignedOffCertification */ 'decisionsMade': number; /** * The total number of approve/revoke/acknowledge decisions for the certification. * @type {number} * @memberof CertificationSignedOffCertification */ 'decisionsTotal': number; /** * The number of entities (identities, access profiles, roles, etc.) for which all decisions have been made and are complete. * @type {number} * @memberof CertificationSignedOffCertification */ 'entitiesCompleted': number; /** * The total number of entities (identities, access profiles, roles, etc.) in the certification, both complete and incomplete. * @type {number} * @memberof CertificationSignedOffCertification */ 'entitiesTotal': number; } /** * * @export * @interface CompleteInvocation */ export interface CompleteInvocation { /** * Unique invocation secret that was generated when the invocation was created. Required to authenticate to the endpoint. * @type {string} * @memberof CompleteInvocation */ 'secret': string; /** * The error message to indicate a failed invocation or error if any. * @type {string} * @memberof CompleteInvocation */ 'error'?: string; /** * Trigger output to complete the invocation. Its schema is defined in the trigger definition. * @type {object} * @memberof CompleteInvocation */ 'output': object; } /** * * @export * @interface CompleteInvocationInput */ export interface CompleteInvocationInput { /** * * @type {LocalizedMessage} * @memberof CompleteInvocationInput */ 'localizedError'?: LocalizedMessage | null; /** * Trigger output that completed the invocation. Its schema is defined in the trigger definition. * @type {object} * @memberof CompleteInvocationInput */ 'output'?: object | null; } /** * * @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 EventBridgeConfig */ export interface EventBridgeConfig { /** * AWS Account Number (12-digit number) that has the EventBridge Partner Event Source Resource. * @type {string} * @memberof EventBridgeConfig */ 'awsAccount': string; /** * AWS Region that has the EventBridge Partner Event Source Resource. See https://docs.aws.amazon.com/general/latest/gr/rande.html for a full list of available values. * @type {string} * @memberof EventBridgeConfig */ 'awsRegion': string; } /** * Defines the HTTP Authentication type. Additional values may be added in the future. If *NO_AUTH* is selected, no extra information will be in HttpConfig. If *BASIC_AUTH* is selected, HttpConfig will include BasicAuthConfig with Username and Password as strings. If *BEARER_TOKEN* is selected, HttpConfig will include BearerTokenAuthConfig with Token as string. * @export * @enum {string} */ export const HttpAuthenticationType = { NoAuth: 'NO_AUTH', BasicAuth: 'BASIC_AUTH', BearerToken: 'BEARER_TOKEN' } as const; export type HttpAuthenticationType = typeof HttpAuthenticationType[keyof typeof HttpAuthenticationType]; /** * * @export * @interface HttpConfig */ export interface HttpConfig { /** * URL of the external/custom integration. * @type {string} * @memberof HttpConfig */ 'url': string; /** * * @type {HttpDispatchMode} * @memberof HttpConfig */ 'httpDispatchMode': HttpDispatchMode; /** * * @type {HttpAuthenticationType} * @memberof HttpConfig */ 'httpAuthenticationType'?: HttpAuthenticationType; /** * * @type {BasicAuthConfig} * @memberof HttpConfig */ 'basicAuthConfig'?: BasicAuthConfig | null; /** * * @type {BearerTokenAuthConfig} * @memberof HttpConfig */ 'bearerTokenAuthConfig'?: BearerTokenAuthConfig | null; } /** * HTTP response modes, i.e. SYNC, ASYNC, or DYNAMIC. * @export * @enum {string} */ export const HttpDispatchMode = { Sync: 'SYNC', Async: 'ASYNC', Dynamic: 'DYNAMIC' } as const; export type HttpDispatchMode = typeof HttpDispatchMode[keyof typeof HttpDispatchMode]; /** * * @export * @interface IdentityAttributesChanged */ export interface IdentityAttributesChanged { /** * * @type {IdentityAttributesChangedIdentity} * @memberof IdentityAttributesChanged */ 'identity': IdentityAttributesChangedIdentity; /** * A list of one or more identity attributes that changed on the identity. * @type {Array} * @memberof IdentityAttributesChanged */ 'changes': Array; } /** * * @export * @interface IdentityAttributesChangedChangesInner */ export interface IdentityAttributesChangedChangesInner { /** * The name of the identity attribute that changed. * @type {string} * @memberof IdentityAttributesChangedChangesInner */ 'attribute': string; /** * * @type {IdentityAttributesChangedChangesInnerOldValue} * @memberof IdentityAttributesChangedChangesInner */ 'oldValue'?: IdentityAttributesChangedChangesInnerOldValue | null; /** * * @type {IdentityAttributesChangedChangesInnerNewValue} * @memberof IdentityAttributesChangedChangesInner */ 'newValue'?: IdentityAttributesChangedChangesInnerNewValue; } /** * @type IdentityAttributesChangedChangesInnerNewValue * The value of the identity attribute after it changed. * @export */ export type IdentityAttributesChangedChangesInnerNewValue = Array | boolean | string | { [key: string]: IdentityAttributesChangedChangesInnerOldValueOneOfValue; }; /** * @type IdentityAttributesChangedChangesInnerOldValue * The value of the identity attribute before it changed. * @export */ export type IdentityAttributesChangedChangesInnerOldValue = Array | boolean | string | { [key: string]: IdentityAttributesChangedChangesInnerOldValueOneOfValue; }; /** * @type IdentityAttributesChangedChangesInnerOldValueOneOfValue * @export */ export type IdentityAttributesChangedChangesInnerOldValueOneOfValue = boolean | number | string; /** * Identity whose attributes changed. * @export * @interface IdentityAttributesChangedIdentity */ export interface IdentityAttributesChangedIdentity { /** * DTO type of identity whose attributes changed. * @type {string} * @memberof IdentityAttributesChangedIdentity */ 'type': IdentityAttributesChangedIdentityTypeEnum; /** * ID of identity whose attributes changed. * @type {string} * @memberof IdentityAttributesChangedIdentity */ 'id': string; /** * Display name of identity whose attributes changed. * @type {string} * @memberof IdentityAttributesChangedIdentity */ 'name': string; } export const IdentityAttributesChangedIdentityTypeEnum = { Identity: 'IDENTITY' } as const; export type IdentityAttributesChangedIdentityTypeEnum = typeof IdentityAttributesChangedIdentityTypeEnum[keyof typeof IdentityAttributesChangedIdentityTypeEnum]; /** * * @export * @interface IdentityCreated */ export interface IdentityCreated { /** * * @type {IdentityCreatedIdentity} * @memberof IdentityCreated */ 'identity': IdentityCreatedIdentity; /** * The attributes assigned to the identity. Attributes are determined by the identity profile. * @type {{ [key: string]: any; }} * @memberof IdentityCreated */ 'attributes': { [key: string]: any; }; } /** * Created identity. * @export * @interface IdentityCreatedIdentity */ export interface IdentityCreatedIdentity { /** * Created identity\'s DTO type. * @type {string} * @memberof IdentityCreatedIdentity */ 'type': IdentityCreatedIdentityTypeEnum; /** * Created identity ID. * @type {string} * @memberof IdentityCreatedIdentity */ 'id': string; /** * Created identity\'s display name. * @type {string} * @memberof IdentityCreatedIdentity */ 'name': string; } export const IdentityCreatedIdentityTypeEnum = { Identity: 'IDENTITY' } as const; export type IdentityCreatedIdentityTypeEnum = typeof IdentityCreatedIdentityTypeEnum[keyof typeof IdentityCreatedIdentityTypeEnum]; /** * * @export * @interface IdentityDeleted */ export interface IdentityDeleted { /** * * @type {IdentityDeletedIdentity} * @memberof IdentityDeleted */ 'identity': IdentityDeletedIdentity; /** * The attributes assigned to the identity. Attributes are determined by the identity profile. * @type {{ [key: string]: any; }} * @memberof IdentityDeleted */ 'attributes': { [key: string]: any; }; } /** * Deleted identity. * @export * @interface IdentityDeletedIdentity */ export interface IdentityDeletedIdentity { /** * Deleted identity\'s DTO type. * @type {string} * @memberof IdentityDeletedIdentity */ 'type': IdentityDeletedIdentityTypeEnum; /** * Deleted identity ID. * @type {string} * @memberof IdentityDeletedIdentity */ 'id': string; /** * Deleted identity\'s display name. * @type {string} * @memberof IdentityDeletedIdentity */ 'name': string; } export const IdentityDeletedIdentityTypeEnum = { Identity: 'IDENTITY' } as const; export type IdentityDeletedIdentityTypeEnum = typeof IdentityDeletedIdentityTypeEnum[keyof typeof IdentityDeletedIdentityTypeEnum]; /** * Details about the identity correlated with the account. * @export * @interface IdentityReference2 */ export interface IdentityReference2 { /** * The ID of the identity that is correlated with this account. * @type {string} * @memberof IdentityReference2 */ 'id': string; /** * The name of the identity that is correlated with this account. * @type {string} * @memberof IdentityReference2 */ 'name': string; /** * The alias of the identity. * @type {string} * @memberof IdentityReference2 */ 'alias': string; /** * The email of the identity. * @type {string} * @memberof IdentityReference2 */ 'email': string; } /** * * @export * @interface Invocation */ export interface Invocation { /** * Invocation ID * @type {string} * @memberof Invocation */ 'id'?: string; /** * Trigger ID * @type {string} * @memberof Invocation */ 'triggerId'?: string; /** * Unique invocation secret. * @type {string} * @memberof Invocation */ 'secret'?: string; /** * JSON map of invocation metadata. * @type {object} * @memberof Invocation */ 'contentJson'?: object; } /** * * @export * @interface InvocationStatus */ export interface InvocationStatus { /** * Invocation ID * @type {string} * @memberof InvocationStatus */ 'id': string; /** * Trigger ID * @type {string} * @memberof InvocationStatus */ 'triggerId': string; /** * Subscription name * @type {string} * @memberof InvocationStatus */ 'subscriptionName': string; /** * Subscription ID * @type {string} * @memberof InvocationStatus */ 'subscriptionId': string; /** * * @type {InvocationStatusType} * @memberof InvocationStatus */ 'type': InvocationStatusType; /** * Invocation created timestamp. ISO-8601 in UTC. * @type {string} * @memberof InvocationStatus */ 'created': string; /** * Invocation completed timestamp; empty fields imply invocation is in-flight or not completed. ISO-8601 in UTC. * @type {string} * @memberof InvocationStatus */ 'completed'?: string; /** * * @type {StartInvocationInput} * @memberof InvocationStatus */ 'startInvocationInput': StartInvocationInput; /** * * @type {CompleteInvocationInput} * @memberof InvocationStatus */ 'completeInvocationInput'?: CompleteInvocationInput; } /** * Defines the Invocation type. **TEST** The trigger was invocated as a test, either via the test subscription button in the UI or via the start test invocation API. **REAL_TIME** The trigger subscription is live and was invocated by a real event in IdentityNow. * @export * @enum {string} */ export const InvocationStatusType = { Test: 'TEST', RealTime: 'REAL_TIME' } as const; export type InvocationStatusType = typeof InvocationStatusType[keyof typeof InvocationStatusType]; /** * * @export * @interface ListTriggersV1401Response */ export interface ListTriggersV1401Response { /** * A message describing the error * @type {any} * @memberof ListTriggersV1401Response */ 'error'?: any; } /** * * @export * @interface ListTriggersV1429Response */ export interface ListTriggersV1429Response { /** * A message describing the error * @type {any} * @memberof ListTriggersV1429Response */ '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 const LocaleOrigin = { Default: 'DEFAULT', Request: 'REQUEST' } as const; export type LocaleOrigin = typeof LocaleOrigin[keyof typeof LocaleOrigin]; /** * Localized error message to indicate a failed invocation or error if any. * @export * @interface LocalizedMessage */ export interface LocalizedMessage { /** * Message locale * @type {string} * @memberof LocalizedMessage */ 'locale': string; /** * Message text * @type {string} * @memberof LocalizedMessage */ 'message': string; } /** * * @export * @interface MachineIdentityCreated */ export interface MachineIdentityCreated { /** * Type of the event. * @type {string} * @memberof MachineIdentityCreated */ 'eventType': MachineIdentityCreatedEventTypeEnum; /** * * @type {MachineIdentityCreatedMachineIdentity} * @memberof MachineIdentityCreated */ 'machineIdentity': MachineIdentityCreatedMachineIdentity; } export const MachineIdentityCreatedEventTypeEnum = { MachineIdentityCreated: 'MACHINE_IDENTITY_CREATED' } as const; export type MachineIdentityCreatedEventTypeEnum = typeof MachineIdentityCreatedEventTypeEnum[keyof typeof MachineIdentityCreatedEventTypeEnum]; /** * Details of the created machine identity. * @export * @interface MachineIdentityCreatedMachineIdentity */ export interface MachineIdentityCreatedMachineIdentity { /** * Unique identifier for the machine identity. * @type {string} * @memberof MachineIdentityCreatedMachineIdentity */ 'id': string; /** * Name of the machine identity. * @type {string} * @memberof MachineIdentityCreatedMachineIdentity */ 'name'?: string; /** * Creation timestamp. * @type {string} * @memberof MachineIdentityCreatedMachineIdentity */ 'created': string; /** * Last modified timestamp. * @type {string} * @memberof MachineIdentityCreatedMachineIdentity */ 'modified': string; /** * Associated business application. * @type {string} * @memberof MachineIdentityCreatedMachineIdentity */ 'businessApplication'?: string; /** * Description of the machine identity. * @type {string} * @memberof MachineIdentityCreatedMachineIdentity */ 'description'?: string; /** * The attributes assigned to the identity. * @type {{ [key: string]: any; }} * @memberof MachineIdentityCreatedMachineIdentity */ 'attributes'?: { [key: string]: any; }; /** * Subtype of the machine identity. * @type {string} * @memberof MachineIdentityCreatedMachineIdentity */ 'subtype': MachineIdentityCreatedMachineIdentitySubtypeEnum; /** * List of owners. * @type {Array} * @memberof MachineIdentityCreatedMachineIdentity */ 'owners'?: Array; /** * Source identifier. * @type {string} * @memberof MachineIdentityCreatedMachineIdentity */ 'sourceId'?: string; /** * UUID of the machine identity. * @type {string} * @memberof MachineIdentityCreatedMachineIdentity */ 'uuid'?: string; /** * Native identity value. * @type {string} * @memberof MachineIdentityCreatedMachineIdentity */ 'nativeIdentity'?: string; /** * Indicates if manually edited. * @type {boolean} * @memberof MachineIdentityCreatedMachineIdentity */ 'manuallyEdited': boolean; /** * Indicates if manually created. * @type {boolean} * @memberof MachineIdentityCreatedMachineIdentity */ 'manuallyCreated'?: boolean; /** * Dataset identifier. * @type {string} * @memberof MachineIdentityCreatedMachineIdentity */ 'datasetId'?: string; /** * * @type {MachineIdentitySourceReference} * @memberof MachineIdentityCreatedMachineIdentity */ 'source'?: MachineIdentitySourceReference; /** * List of user entitlements. * @type {Array} * @memberof MachineIdentityCreatedMachineIdentity */ 'userEntitlements'?: Array; /** * Existence status on source. * @type {string} * @memberof MachineIdentityCreatedMachineIdentity */ 'existsOnSource'?: string; } export const MachineIdentityCreatedMachineIdentitySubtypeEnum = { AiAgent: 'AI Agent', Application: 'Application' } as const; export type MachineIdentityCreatedMachineIdentitySubtypeEnum = typeof MachineIdentityCreatedMachineIdentitySubtypeEnum[keyof typeof MachineIdentityCreatedMachineIdentitySubtypeEnum]; /** * * @export * @interface MachineIdentityDeleted */ export interface MachineIdentityDeleted { /** * Type of the event. * @type {string} * @memberof MachineIdentityDeleted */ 'eventType': MachineIdentityDeletedEventTypeEnum; /** * * @type {MachineIdentityDeletedMachineIdentity} * @memberof MachineIdentityDeleted */ 'machineIdentity': MachineIdentityDeletedMachineIdentity; } export const MachineIdentityDeletedEventTypeEnum = { MachineIdentityDeleted: 'MACHINE_IDENTITY_DELETED' } as const; export type MachineIdentityDeletedEventTypeEnum = typeof MachineIdentityDeletedEventTypeEnum[keyof typeof MachineIdentityDeletedEventTypeEnum]; /** * Details of the deleted machine identity. * @export * @interface MachineIdentityDeletedMachineIdentity */ export interface MachineIdentityDeletedMachineIdentity { /** * Unique identifier for the machine identity. * @type {string} * @memberof MachineIdentityDeletedMachineIdentity */ 'id': string; /** * Name of the machine identity. * @type {string} * @memberof MachineIdentityDeletedMachineIdentity */ 'name'?: string; /** * Creation timestamp. * @type {string} * @memberof MachineIdentityDeletedMachineIdentity */ 'created': string; /** * Last modified timestamp. * @type {string} * @memberof MachineIdentityDeletedMachineIdentity */ 'modified': string; /** * Associated business application. * @type {string} * @memberof MachineIdentityDeletedMachineIdentity */ 'businessApplication'?: string; /** * Description of the machine identity. * @type {string} * @memberof MachineIdentityDeletedMachineIdentity */ 'description'?: string; /** * The attributes assigned to the identity. * @type {{ [key: string]: any; }} * @memberof MachineIdentityDeletedMachineIdentity */ 'attributes'?: { [key: string]: any; }; /** * Subtype of the machine identity. * @type {string} * @memberof MachineIdentityDeletedMachineIdentity */ 'subtype': MachineIdentityDeletedMachineIdentitySubtypeEnum; /** * List of owners. * @type {Array} * @memberof MachineIdentityDeletedMachineIdentity */ 'owners'?: Array; /** * Source identifier. * @type {string} * @memberof MachineIdentityDeletedMachineIdentity */ 'sourceId'?: string; /** * UUID of the machine identity. * @type {string} * @memberof MachineIdentityDeletedMachineIdentity */ 'uuid'?: string; /** * Native identity value. * @type {string} * @memberof MachineIdentityDeletedMachineIdentity */ 'nativeIdentity'?: string; /** * Indicates if manually edited. * @type {boolean} * @memberof MachineIdentityDeletedMachineIdentity */ 'manuallyEdited': boolean; /** * Indicates if manually created. * @type {boolean} * @memberof MachineIdentityDeletedMachineIdentity */ 'manuallyCreated'?: boolean; /** * Dataset identifier. * @type {string} * @memberof MachineIdentityDeletedMachineIdentity */ 'datasetId'?: string; /** * * @type {MachineIdentitySourceReference} * @memberof MachineIdentityDeletedMachineIdentity */ 'source'?: MachineIdentitySourceReference; /** * List of user entitlements. * @type {Array} * @memberof MachineIdentityDeletedMachineIdentity */ 'userEntitlements'?: Array; /** * Existence status on source. * @type {string} * @memberof MachineIdentityDeletedMachineIdentity */ 'existsOnSource'?: string; } export const MachineIdentityDeletedMachineIdentitySubtypeEnum = { AiAgent: 'AI Agent', Application: 'Application' } as const; export type MachineIdentityDeletedMachineIdentitySubtypeEnum = typeof MachineIdentityDeletedMachineIdentitySubtypeEnum[keyof typeof MachineIdentityDeletedMachineIdentitySubtypeEnum]; /** * Reference to an owner of the machine identity. * @export * @interface MachineIdentityOwnerReference */ export interface MachineIdentityOwnerReference { [key: string]: any; /** * Owner\'s type. * @type {string} * @memberof MachineIdentityOwnerReference */ 'type': string; /** * Owner ID. * @type {string} * @memberof MachineIdentityOwnerReference */ 'id': string; /** * Owner\'s display name. * @type {string} * @memberof MachineIdentityOwnerReference */ 'name': string; /** * Indicates if this owner is the primary owner. * @type {boolean} * @memberof MachineIdentityOwnerReference */ 'isPrimary'?: boolean; } /** * Reference to a source of entity. * @export * @interface MachineIdentitySourceReference */ export interface MachineIdentitySourceReference { [key: string]: any; /** * Source Type. * @type {string} * @memberof MachineIdentitySourceReference */ 'type': string; /** * Unique identifier. * @type {string} * @memberof MachineIdentitySourceReference */ 'id': string; /** * Display name. * @type {string} * @memberof MachineIdentitySourceReference */ 'name': string; } /** * * @export * @interface MachineIdentityUpdated */ export interface MachineIdentityUpdated { /** * Type of the event. * @type {string} * @memberof MachineIdentityUpdated */ 'eventType': MachineIdentityUpdatedEventTypeEnum; /** * * @type {MachineIdentityUpdatedMachineIdentity} * @memberof MachineIdentityUpdated */ 'machineIdentity': MachineIdentityUpdatedMachineIdentity; /** * Types of changes that occurred to the machine identity. * @type {Array} * @memberof MachineIdentityUpdated */ 'machineIdentityChangeTypes': Array; /** * * @type {MachineIdentityUpdatedUserEntitlementChanges} * @memberof MachineIdentityUpdated */ 'userEntitlementChanges': MachineIdentityUpdatedUserEntitlementChanges; /** * * @type {MachineIdentityUpdatedOwnerChanges} * @memberof MachineIdentityUpdated */ 'ownerChanges': MachineIdentityUpdatedOwnerChanges; /** * Details about the single-value attribute changes that occurred. * @type {Array} * @memberof MachineIdentityUpdated */ 'singleValueAttributeChanges': Array | null; } export const MachineIdentityUpdatedEventTypeEnum = { MachineIdentityUpdated: 'MACHINE_IDENTITY_UPDATED' } as const; export type MachineIdentityUpdatedEventTypeEnum = typeof MachineIdentityUpdatedEventTypeEnum[keyof typeof MachineIdentityUpdatedEventTypeEnum]; export const MachineIdentityUpdatedMachineIdentityChangeTypesEnum = { AttributesChanged: 'ATTRIBUTES_CHANGED', UserEntitlementsAdded: 'USER_ENTITLEMENTS_ADDED', UserEntitlementsRemoved: 'USER_ENTITLEMENTS_REMOVED', OwnersAdded: 'OWNERS_ADDED', OwnersRemoved: 'OWNERS_REMOVED' } as const; export type MachineIdentityUpdatedMachineIdentityChangeTypesEnum = typeof MachineIdentityUpdatedMachineIdentityChangeTypesEnum[keyof typeof MachineIdentityUpdatedMachineIdentityChangeTypesEnum]; /** * Details of the updated machine identity. * @export * @interface MachineIdentityUpdatedMachineIdentity */ export interface MachineIdentityUpdatedMachineIdentity { /** * Unique identifier for the machine identity. * @type {string} * @memberof MachineIdentityUpdatedMachineIdentity */ 'id': string; /** * Name of the machine identity. * @type {string} * @memberof MachineIdentityUpdatedMachineIdentity */ 'name'?: string; /** * Creation timestamp. * @type {string} * @memberof MachineIdentityUpdatedMachineIdentity */ 'created': string; /** * Last modified timestamp. * @type {string} * @memberof MachineIdentityUpdatedMachineIdentity */ 'modified': string; /** * Associated business application. * @type {string} * @memberof MachineIdentityUpdatedMachineIdentity */ 'businessApplication'?: string; /** * Description of the machine identity. * @type {string} * @memberof MachineIdentityUpdatedMachineIdentity */ 'description'?: string; /** * The attributes assigned to the identity. * @type {{ [key: string]: any; }} * @memberof MachineIdentityUpdatedMachineIdentity */ 'attributes'?: { [key: string]: any; }; /** * Subtype of the machine identity. * @type {string} * @memberof MachineIdentityUpdatedMachineIdentity */ 'subtype': MachineIdentityUpdatedMachineIdentitySubtypeEnum; /** * List of owners. * @type {Array} * @memberof MachineIdentityUpdatedMachineIdentity */ 'owners'?: Array; /** * Source identifier. * @type {string} * @memberof MachineIdentityUpdatedMachineIdentity */ 'sourceId'?: string; /** * UUID of the machine identity. * @type {string} * @memberof MachineIdentityUpdatedMachineIdentity */ 'uuid'?: string; /** * Native identity value. * @type {string} * @memberof MachineIdentityUpdatedMachineIdentity */ 'nativeIdentity'?: string; /** * Indicates if manually edited. * @type {boolean} * @memberof MachineIdentityUpdatedMachineIdentity */ 'manuallyEdited': boolean; /** * Indicates if manually created. * @type {boolean} * @memberof MachineIdentityUpdatedMachineIdentity */ 'manuallyCreated'?: boolean; /** * Dataset identifier. * @type {string} * @memberof MachineIdentityUpdatedMachineIdentity */ 'datasetId'?: string; /** * * @type {MachineIdentitySourceReference} * @memberof MachineIdentityUpdatedMachineIdentity */ 'source'?: MachineIdentitySourceReference; /** * List of user entitlements. * @type {Array} * @memberof MachineIdentityUpdatedMachineIdentity */ 'userEntitlements'?: Array; /** * Existence status on source. * @type {string} * @memberof MachineIdentityUpdatedMachineIdentity */ 'existsOnSource'?: string; } export const MachineIdentityUpdatedMachineIdentitySubtypeEnum = { AiAgent: 'AI Agent', Application: 'Application' } as const; export type MachineIdentityUpdatedMachineIdentitySubtypeEnum = typeof MachineIdentityUpdatedMachineIdentitySubtypeEnum[keyof typeof MachineIdentityUpdatedMachineIdentitySubtypeEnum]; /** * Changes to owners. * @export * @interface MachineIdentityUpdatedOwnerChanges */ export interface MachineIdentityUpdatedOwnerChanges { /** * Name of the attribute that changed. * @type {string} * @memberof MachineIdentityUpdatedOwnerChanges */ 'attributeName'?: string; /** * Owners that were added. * @type {Array} * @memberof MachineIdentityUpdatedOwnerChanges */ 'added'?: Array; /** * Owners that were removed. * @type {Array} * @memberof MachineIdentityUpdatedOwnerChanges */ 'removed'?: Array; } /** * * @export * @interface MachineIdentityUpdatedSingleValueAttributeChangesInner */ export interface MachineIdentityUpdatedSingleValueAttributeChangesInner { /** * The name of the attribute that was changed. * @type {string} * @memberof MachineIdentityUpdatedSingleValueAttributeChangesInner */ 'name': string; /** * * @type {MachineIdentityUpdatedSingleValueAttributeChangesInnerOldValue} * @memberof MachineIdentityUpdatedSingleValueAttributeChangesInner */ 'oldValue': MachineIdentityUpdatedSingleValueAttributeChangesInnerOldValue | null; /** * * @type {MachineIdentityUpdatedSingleValueAttributeChangesInnerNewValue} * @memberof MachineIdentityUpdatedSingleValueAttributeChangesInner */ 'newValue': MachineIdentityUpdatedSingleValueAttributeChangesInnerNewValue | null; } /** * @type MachineIdentityUpdatedSingleValueAttributeChangesInnerNewValue * The new value of the attribute after the change. * @export */ export type MachineIdentityUpdatedSingleValueAttributeChangesInnerNewValue = Array | boolean | number | string; /** * @type MachineIdentityUpdatedSingleValueAttributeChangesInnerOldValue * The old value of the attribute before the change. * @export */ export type MachineIdentityUpdatedSingleValueAttributeChangesInnerOldValue = Array | boolean | number | string; /** * Changes to user entitlements. * @export * @interface MachineIdentityUpdatedUserEntitlementChanges */ export interface MachineIdentityUpdatedUserEntitlementChanges { /** * Name of the attribute that changed. * @type {string} * @memberof MachineIdentityUpdatedUserEntitlementChanges */ 'attributeName'?: string; /** * User entitlements that were added. * @type {Array} * @memberof MachineIdentityUpdatedUserEntitlementChanges */ 'added'?: Array; /** * User entitlements that were removed. * @type {Array} * @memberof MachineIdentityUpdatedUserEntitlementChanges */ 'removed'?: Array; } /** * Reference to a user entitlement. * @export * @interface MachineIdentityUserEntitlements */ export interface MachineIdentityUserEntitlements { [key: string]: any; /** * Entitlement identifier. * @type {string} * @memberof MachineIdentityUserEntitlements */ 'entitlementId': string; /** * Display name of the entitlement. * @type {string} * @memberof MachineIdentityUserEntitlements */ 'displayName': string; /** * * @type {MachineIdentitySourceReference} * @memberof MachineIdentityUserEntitlements */ 'source': MachineIdentitySourceReference; } /** * * @export * @interface ProvisioningCompleted */ export interface ProvisioningCompleted { /** * The reference number of the provisioning request. Useful for tracking status in the Account Activity search interface. * @type {string} * @memberof ProvisioningCompleted */ 'trackingNumber': string; /** * One or more sources that the provisioning transaction(s) were done against. Sources are comma separated. * @type {string} * @memberof ProvisioningCompleted */ 'sources': string; /** * Origin of where the provisioning request came from. * @type {string} * @memberof ProvisioningCompleted */ 'action'?: string | null; /** * A list of any accumulated error messages that occurred during provisioning. * @type {Array} * @memberof ProvisioningCompleted */ 'errors'?: Array | null; /** * A list of any accumulated warning messages that occurred during provisioning. * @type {Array} * @memberof ProvisioningCompleted */ 'warnings'?: Array | null; /** * * @type {ProvisioningCompletedRecipient} * @memberof ProvisioningCompleted */ 'recipient': ProvisioningCompletedRecipient; /** * * @type {ProvisioningCompletedRequester} * @memberof ProvisioningCompleted */ 'requester'?: ProvisioningCompletedRequester | null; /** * A list of provisioning instructions to be executed on a per-account basis. The order in which operations are executed may not always be predictable. * @type {Array} * @memberof ProvisioningCompleted */ 'accountRequests': Array; } /** * * @export * @interface ProvisioningCompletedAccountRequestsInner */ export interface ProvisioningCompletedAccountRequestsInner { /** * * @type {ProvisioningCompletedAccountRequestsInnerSource} * @memberof ProvisioningCompletedAccountRequestsInner */ 'source': ProvisioningCompletedAccountRequestsInnerSource; /** * The unique idenfier of the account being provisioned. * @type {string} * @memberof ProvisioningCompletedAccountRequestsInner */ 'accountId'?: string; /** * The provisioning operation; typically Create, Modify, Enable, Disable, Unlock, or Delete. * @type {string} * @memberof ProvisioningCompletedAccountRequestsInner */ 'accountOperation': string; /** * The overall result of the provisioning transaction; this could be success, pending, failed, etc. * @type {string} * @memberof ProvisioningCompletedAccountRequestsInner */ 'provisioningResult': ProvisioningCompletedAccountRequestsInnerProvisioningResultEnum; /** * The name of the provisioning channel selected; this could be the same as the source, or could be a Service Desk Integration Module (SDIM). * @type {string} * @memberof ProvisioningCompletedAccountRequestsInner */ 'provisioningTarget': string; /** * A reference to a tracking number, if this is sent to a Service Desk Integration Module (SDIM). * @type {string} * @memberof ProvisioningCompletedAccountRequestsInner */ 'ticketId'?: string | null; /** * A list of attributes as part of the provisioning transaction. * @type {Array} * @memberof ProvisioningCompletedAccountRequestsInner */ 'attributeRequests'?: Array | null; } export const ProvisioningCompletedAccountRequestsInnerProvisioningResultEnum = { Success: 'SUCCESS', Pending: 'PENDING', Failed: 'FAILED' } as const; export type ProvisioningCompletedAccountRequestsInnerProvisioningResultEnum = typeof ProvisioningCompletedAccountRequestsInnerProvisioningResultEnum[keyof typeof ProvisioningCompletedAccountRequestsInnerProvisioningResultEnum]; /** * * @export * @interface ProvisioningCompletedAccountRequestsInnerAttributeRequestsInner */ export interface ProvisioningCompletedAccountRequestsInnerAttributeRequestsInner { /** * The name of the attribute being provisioned. * @type {string} * @memberof ProvisioningCompletedAccountRequestsInnerAttributeRequestsInner */ 'attributeName': string; /** * The value of the attribute being provisioned. * @type {string} * @memberof ProvisioningCompletedAccountRequestsInnerAttributeRequestsInner */ 'attributeValue'?: string | null; /** * The operation to handle the attribute. * @type {string} * @memberof ProvisioningCompletedAccountRequestsInnerAttributeRequestsInner */ 'operation': ProvisioningCompletedAccountRequestsInnerAttributeRequestsInnerOperationEnum; } export const ProvisioningCompletedAccountRequestsInnerAttributeRequestsInnerOperationEnum = { Add: 'Add', Set: 'Set', Remove: 'Remove' } as const; export type ProvisioningCompletedAccountRequestsInnerAttributeRequestsInnerOperationEnum = typeof ProvisioningCompletedAccountRequestsInnerAttributeRequestsInnerOperationEnum[keyof typeof ProvisioningCompletedAccountRequestsInnerAttributeRequestsInnerOperationEnum]; /** * Reference to the source being provisioned against. * @export * @interface ProvisioningCompletedAccountRequestsInnerSource */ export interface ProvisioningCompletedAccountRequestsInnerSource { /** * ID of the object to which this reference applies * @type {string} * @memberof ProvisioningCompletedAccountRequestsInnerSource */ 'id': string; /** * The type of object that is referenced * @type {string} * @memberof ProvisioningCompletedAccountRequestsInnerSource */ 'type': ProvisioningCompletedAccountRequestsInnerSourceTypeEnum; /** * Human-readable display name of the object to which this reference applies * @type {string} * @memberof ProvisioningCompletedAccountRequestsInnerSource */ 'name': string; } export const ProvisioningCompletedAccountRequestsInnerSourceTypeEnum = { Source: 'SOURCE' } as const; export type ProvisioningCompletedAccountRequestsInnerSourceTypeEnum = typeof ProvisioningCompletedAccountRequestsInnerSourceTypeEnum[keyof typeof ProvisioningCompletedAccountRequestsInnerSourceTypeEnum]; /** * Provisioning recpient. * @export * @interface ProvisioningCompletedRecipient */ export interface ProvisioningCompletedRecipient { /** * Provisioning recipient DTO type. * @type {string} * @memberof ProvisioningCompletedRecipient */ 'type': ProvisioningCompletedRecipientTypeEnum; /** * Provisioning recipient\'s identity ID. * @type {string} * @memberof ProvisioningCompletedRecipient */ 'id': string; /** * Provisioning recipient\'s display name. * @type {string} * @memberof ProvisioningCompletedRecipient */ 'name': string; } export const ProvisioningCompletedRecipientTypeEnum = { Identity: 'IDENTITY' } as const; export type ProvisioningCompletedRecipientTypeEnum = typeof ProvisioningCompletedRecipientTypeEnum[keyof typeof ProvisioningCompletedRecipientTypeEnum]; /** * Provisioning requester\'s identity. * @export * @interface ProvisioningCompletedRequester */ export interface ProvisioningCompletedRequester { /** * Provisioning requester\'s DTO type. * @type {string} * @memberof ProvisioningCompletedRequester */ 'type': ProvisioningCompletedRequesterTypeEnum; /** * Provisioning requester\'s identity ID. * @type {string} * @memberof ProvisioningCompletedRequester */ 'id': string; /** * Provisioning owner\'s human-readable display name. * @type {string} * @memberof ProvisioningCompletedRequester */ 'name': string; } export const ProvisioningCompletedRequesterTypeEnum = { Identity: 'IDENTITY' } as const; export type ProvisioningCompletedRequesterTypeEnum = typeof ProvisioningCompletedRequesterTypeEnum[keyof typeof ProvisioningCompletedRequesterTypeEnum]; /** * * @export * @interface Reassignment */ export interface Reassignment { /** * * @type {CertificationReference} * @memberof Reassignment */ 'from'?: CertificationReference; /** * The comment entered when the Certification was reassigned * @type {string} * @memberof Reassignment */ 'comment'?: string; } /** * * @export * @interface Reviewer */ export interface Reviewer { /** * The id of the reviewer. * @type {string} * @memberof Reviewer */ 'id'?: string; /** * The name of the reviewer. * @type {string} * @memberof Reviewer */ 'name'?: string; /** * The email of the reviewing identity. This is only applicable to reviewers of the `IDENTITY` type. * @type {string} * @memberof Reviewer */ 'email'?: string | null; /** * The type of the reviewing identity. * @type {string} * @memberof Reviewer */ 'type'?: ReviewerTypeEnum; /** * The created date of the reviewing identity. * @type {string} * @memberof Reviewer */ 'created'?: string | null; /** * The modified date of the reviewing identity. * @type {string} * @memberof Reviewer */ 'modified'?: string | null; } export const ReviewerTypeEnum = { Identity: 'IDENTITY', GovernanceGroup: 'GOVERNANCE_GROUP' } as const; export type ReviewerTypeEnum = typeof ReviewerTypeEnum[keyof typeof ReviewerTypeEnum]; /** * * @export * @interface SavedSearchComplete */ export interface SavedSearchComplete { /** * A name for the report file. * @type {string} * @memberof SavedSearchComplete */ 'fileName': string; /** * The email address of the identity that owns the saved search. * @type {string} * @memberof SavedSearchComplete */ 'ownerEmail': string; /** * The name of the identity that owns the saved search. * @type {string} * @memberof SavedSearchComplete */ 'ownerName': string; /** * The search query that was used to generate the report. * @type {string} * @memberof SavedSearchComplete */ 'query': string; /** * The name of the saved search. * @type {string} * @memberof SavedSearchComplete */ 'searchName': string; /** * * @type {SavedSearchCompleteSearchResults} * @memberof SavedSearchComplete */ 'searchResults': SavedSearchCompleteSearchResults; /** * The Amazon S3 URL to download the report from. * @type {string} * @memberof SavedSearchComplete */ 'signedS3Url': string; } /** * A preview of the search results for each object type. This includes a count as well as headers, and the first several rows of data, per object type. * @export * @interface SavedSearchCompleteSearchResults */ export interface SavedSearchCompleteSearchResults { /** * * @type {SavedSearchCompleteSearchResultsAccount} * @memberof SavedSearchCompleteSearchResults */ 'Account'?: SavedSearchCompleteSearchResultsAccount | null; /** * * @type {SavedSearchCompleteSearchResultsEntitlement} * @memberof SavedSearchCompleteSearchResults */ 'Entitlement'?: SavedSearchCompleteSearchResultsEntitlement | null; /** * * @type {SavedSearchCompleteSearchResultsIdentity} * @memberof SavedSearchCompleteSearchResults */ 'Identity'?: SavedSearchCompleteSearchResultsIdentity | null; } /** * A table of accounts that match the search criteria. * @export * @interface SavedSearchCompleteSearchResultsAccount */ export interface SavedSearchCompleteSearchResultsAccount { /** * The number of rows in the table. * @type {string} * @memberof SavedSearchCompleteSearchResultsAccount */ 'count': string; /** * The type of object represented in the table. * @type {string} * @memberof SavedSearchCompleteSearchResultsAccount */ 'noun': string; /** * A sample of the data in the table. * @type {Array>} * @memberof SavedSearchCompleteSearchResultsAccount */ 'preview': Array>; } /** * A table of entitlements that match the search criteria. * @export * @interface SavedSearchCompleteSearchResultsEntitlement */ export interface SavedSearchCompleteSearchResultsEntitlement { /** * The number of rows in the table. * @type {string} * @memberof SavedSearchCompleteSearchResultsEntitlement */ 'count': string; /** * The type of object represented in the table. * @type {string} * @memberof SavedSearchCompleteSearchResultsEntitlement */ 'noun': string; /** * A sample of the data in the table. * @type {Array>} * @memberof SavedSearchCompleteSearchResultsEntitlement */ 'preview': Array>; } /** * A table of identities that match the search criteria. * @export * @interface SavedSearchCompleteSearchResultsIdentity */ export interface SavedSearchCompleteSearchResultsIdentity { /** * The number of rows in the table. * @type {string} * @memberof SavedSearchCompleteSearchResultsIdentity */ 'count': string; /** * The type of object represented in the table. * @type {string} * @memberof SavedSearchCompleteSearchResultsIdentity */ 'noun': string; /** * A sample of the data in the table. * @type {Array>} * @memberof SavedSearchCompleteSearchResultsIdentity */ 'preview': Array>; } /** * * @export * @interface SourceAccountCreated */ export interface SourceAccountCreated { /** * Source unique identifier for the identity. UUID is generated by the source system. * @type {string} * @memberof SourceAccountCreated */ 'uuid'?: string; /** * SailPoint generated unique identifier. * @type {string} * @memberof SourceAccountCreated */ 'id': string; /** * Unique ID of the account on the source. * @type {string} * @memberof SourceAccountCreated */ 'nativeIdentifier': string; /** * The ID of the source. * @type {string} * @memberof SourceAccountCreated */ 'sourceId': string; /** * The name of the source. * @type {string} * @memberof SourceAccountCreated */ 'sourceName': string; /** * The ID of the identity that is correlated with this account. * @type {string} * @memberof SourceAccountCreated */ 'identityId': string; /** * The name of the identity that is correlated with this account. * @type {string} * @memberof SourceAccountCreated */ 'identityName': string; /** * The attributes of the account. The contents of attributes depends on the account schema for the source. * @type {{ [key: string]: any; }} * @memberof SourceAccountCreated */ 'attributes': { [key: string]: any; }; } /** * * @export * @interface SourceAccountDeleted */ export interface SourceAccountDeleted { /** * Source unique identifier for the identity. UUID is generated by the source system. * @type {string} * @memberof SourceAccountDeleted */ 'uuid'?: string; /** * SailPoint generated unique identifier. * @type {string} * @memberof SourceAccountDeleted */ 'id': string; /** * Unique ID of the account on the source. * @type {string} * @memberof SourceAccountDeleted */ 'nativeIdentifier': string; /** * The ID of the source. * @type {string} * @memberof SourceAccountDeleted */ 'sourceId': string; /** * The name of the source. * @type {string} * @memberof SourceAccountDeleted */ 'sourceName': string; /** * The ID of the identity that is correlated with this account. * @type {string} * @memberof SourceAccountDeleted */ 'identityId': string; /** * The name of the identity that is correlated with this account. * @type {string} * @memberof SourceAccountDeleted */ 'identityName': string; /** * The attributes of the account. The contents of attributes depends on the account schema for the source. * @type {{ [key: string]: any; }} * @memberof SourceAccountDeleted */ 'attributes': { [key: string]: any; }; } /** * * @export * @interface SourceAccountUpdated */ export interface SourceAccountUpdated { /** * Source unique identifier for the identity. UUID is generated by the source system. * @type {string} * @memberof SourceAccountUpdated */ 'uuid'?: string; /** * SailPoint generated unique identifier. * @type {string} * @memberof SourceAccountUpdated */ 'id': string; /** * Unique ID of the account on the source. * @type {string} * @memberof SourceAccountUpdated */ 'nativeIdentifier': string; /** * The ID of the source. * @type {string} * @memberof SourceAccountUpdated */ 'sourceId': string; /** * The name of the source. * @type {string} * @memberof SourceAccountUpdated */ 'sourceName': string; /** * The ID of the identity that is correlated with this account. * @type {string} * @memberof SourceAccountUpdated */ 'identityId': string; /** * The name of the identity that is correlated with this account. * @type {string} * @memberof SourceAccountUpdated */ 'identityName': string; /** * The attributes of the account. The contents of attributes depends on the account schema for the source. * @type {{ [key: string]: any; }} * @memberof SourceAccountUpdated */ 'attributes': { [key: string]: any; }; } /** * * @export * @interface SourceCreated */ export interface SourceCreated { /** * The unique ID of the source. * @type {string} * @memberof SourceCreated */ 'id': string; /** * Human friendly name of the source. * @type {string} * @memberof SourceCreated */ 'name': string; /** * The connection type. * @type {string} * @memberof SourceCreated */ 'type': string; /** * The date and time the source was created. * @type {string} * @memberof SourceCreated */ 'created': string; /** * The connector type used to connect to the source. * @type {string} * @memberof SourceCreated */ 'connector': string; /** * * @type {SourceCreatedActor} * @memberof SourceCreated */ 'actor': SourceCreatedActor; } /** * Identity who created the source. * @export * @interface SourceCreatedActor */ export interface SourceCreatedActor { /** * DTO type of identity who created the source. * @type {string} * @memberof SourceCreatedActor */ 'type': SourceCreatedActorTypeEnum; /** * ID of identity who created the source. * @type {string} * @memberof SourceCreatedActor */ 'id': string; /** * Display name of identity who created the source. * @type {string} * @memberof SourceCreatedActor */ 'name': string; } export const SourceCreatedActorTypeEnum = { Identity: 'IDENTITY' } as const; export type SourceCreatedActorTypeEnum = typeof SourceCreatedActorTypeEnum[keyof typeof SourceCreatedActorTypeEnum]; /** * * @export * @interface SourceDeleted */ export interface SourceDeleted { /** * The unique ID of the source. * @type {string} * @memberof SourceDeleted */ 'id': string; /** * Human friendly name of the source. * @type {string} * @memberof SourceDeleted */ 'name': string; /** * The connection type. * @type {string} * @memberof SourceDeleted */ 'type': string; /** * The date and time the source was deleted. * @type {string} * @memberof SourceDeleted */ 'deleted': string; /** * The connector type used to connect to the source. * @type {string} * @memberof SourceDeleted */ 'connector': string; /** * * @type {SourceDeletedActor} * @memberof SourceDeleted */ 'actor': SourceDeletedActor; } /** * Identity who deleted the source. * @export * @interface SourceDeletedActor */ export interface SourceDeletedActor { /** * DTO type of identity who deleted the source. * @type {string} * @memberof SourceDeletedActor */ 'type': SourceDeletedActorTypeEnum; /** * ID of identity who deleted the source. * @type {string} * @memberof SourceDeletedActor */ 'id': string; /** * Display name of identity who deleted the source. * @type {string} * @memberof SourceDeletedActor */ 'name': string; } export const SourceDeletedActorTypeEnum = { Identity: 'IDENTITY' } as const; export type SourceDeletedActorTypeEnum = typeof SourceDeletedActorTypeEnum[keyof typeof SourceDeletedActorTypeEnum]; /** * * @export * @interface SourceUpdated */ export interface SourceUpdated { /** * The unique ID of the source. * @type {string} * @memberof SourceUpdated */ 'id': string; /** * The user friendly name of the source. * @type {string} * @memberof SourceUpdated */ 'name': string; /** * The connection type of the source. * @type {string} * @memberof SourceUpdated */ 'type': string; /** * The date and time the source was modified. * @type {string} * @memberof SourceUpdated */ 'modified': string; /** * The connector type used to connect to the source. * @type {string} * @memberof SourceUpdated */ 'connector': string; /** * * @type {SourceUpdatedActor} * @memberof SourceUpdated */ 'actor': SourceUpdatedActor; } /** * Identity who updated the source. * @export * @interface SourceUpdatedActor */ export interface SourceUpdatedActor { /** * DTO type of identity who updated the source. * @type {string} * @memberof SourceUpdatedActor */ 'type': SourceUpdatedActorTypeEnum; /** * ID of identity who updated the source. * @type {string} * @memberof SourceUpdatedActor */ 'id'?: string; /** * Display name of identity who updated the source. * @type {string} * @memberof SourceUpdatedActor */ 'name': string; } export const SourceUpdatedActorTypeEnum = { Identity: 'IDENTITY' } as const; export type SourceUpdatedActorTypeEnum = typeof SourceUpdatedActorTypeEnum[keyof typeof SourceUpdatedActorTypeEnum]; /** * * @export * @interface StartInvocationInput */ export interface StartInvocationInput { /** * Trigger ID * @type {string} * @memberof StartInvocationInput */ 'triggerId'?: string; /** * Trigger input payload. Its schema is defined in the trigger definition. * @type {object} * @memberof StartInvocationInput */ 'input'?: object; /** * JSON map of invocation metadata * @type {object} * @memberof StartInvocationInput */ 'contentJson'?: object; } /** * * @export * @interface Subscription */ export interface Subscription { /** * Subscription ID. * @type {string} * @memberof Subscription */ 'id': string; /** * Subscription name. * @type {string} * @memberof Subscription */ 'name': string; /** * Subscription description. * @type {string} * @memberof Subscription */ 'description'?: string; /** * ID of trigger subscribed to. * @type {string} * @memberof Subscription */ 'triggerId': string; /** * Trigger name of trigger subscribed to. * @type {string} * @memberof Subscription */ 'triggerName': string; /** * * @type {SubscriptionType} * @memberof Subscription */ 'type': SubscriptionType; /** * Deadline for completing REQUEST_RESPONSE trigger invocation, represented in ISO-8601 duration format. * @type {string} * @memberof Subscription */ 'responseDeadline'?: string; /** * * @type {HttpConfig} * @memberof Subscription */ 'httpConfig'?: HttpConfig; /** * * @type {EventBridgeConfig} * @memberof Subscription */ 'eventBridgeConfig'?: EventBridgeConfig; /** * Whether subscription should receive real-time trigger invocations or not. Test trigger invocations are always enabled regardless of this option. * @type {boolean} * @memberof Subscription */ 'enabled': boolean; /** * JSONPath filter to conditionally invoke trigger when expression evaluates to true. * @type {string} * @memberof Subscription */ 'filter'?: string; } /** * A JSONPatch Operation as defined by [RFC 6902 - JSON Patch](https://tools.ietf.org/html/rfc6902) * @export * @interface SubscriptionPatchRequestInner */ export interface SubscriptionPatchRequestInner { /** * The operation to be performed * @type {string} * @memberof SubscriptionPatchRequestInner */ 'op': SubscriptionPatchRequestInnerOpEnum; /** * A string JSON Pointer representing the target path to an element to be affected by the operation * @type {string} * @memberof SubscriptionPatchRequestInner */ 'path': string; /** * * @type {SubscriptionPatchRequestInnerValue} * @memberof SubscriptionPatchRequestInner */ 'value'?: SubscriptionPatchRequestInnerValue; } export const SubscriptionPatchRequestInnerOpEnum = { Add: 'add', Remove: 'remove', Replace: 'replace', Move: 'move', Copy: 'copy' } as const; export type SubscriptionPatchRequestInnerOpEnum = typeof SubscriptionPatchRequestInnerOpEnum[keyof typeof SubscriptionPatchRequestInnerOpEnum]; /** * The value to be used for the operation, required for \"add\" and \"replace\" operations * @export * @interface SubscriptionPatchRequestInnerValue */ export interface SubscriptionPatchRequestInnerValue { } /** * * @export * @interface SubscriptionPatchRequestInnerValueAnyOfInner */ export interface SubscriptionPatchRequestInnerValueAnyOfInner { } /** * * @export * @interface SubscriptionPostRequest */ export interface SubscriptionPostRequest { /** * Subscription name. * @type {string} * @memberof SubscriptionPostRequest */ 'name': string; /** * Subscription description. * @type {string} * @memberof SubscriptionPostRequest */ 'description'?: string; /** * ID of trigger subscribed to. * @type {string} * @memberof SubscriptionPostRequest */ 'triggerId': string; /** * * @type {SubscriptionType} * @memberof SubscriptionPostRequest */ 'type': SubscriptionType; /** * Deadline for completing REQUEST_RESPONSE trigger invocation, represented in ISO-8601 duration format. * @type {string} * @memberof SubscriptionPostRequest */ 'responseDeadline'?: string; /** * * @type {HttpConfig} * @memberof SubscriptionPostRequest */ 'httpConfig'?: HttpConfig; /** * * @type {EventBridgeConfig} * @memberof SubscriptionPostRequest */ 'eventBridgeConfig'?: EventBridgeConfig; /** * Whether subscription should receive real-time trigger invocations or not. Test trigger invocations are always enabled regardless of this option. * @type {boolean} * @memberof SubscriptionPostRequest */ 'enabled'?: boolean; /** * JSONPath filter to conditionally invoke trigger when expression evaluates to true. * @type {string} * @memberof SubscriptionPostRequest */ 'filter'?: string; } /** * * @export * @interface SubscriptionPutRequest */ export interface SubscriptionPutRequest { /** * Subscription name. * @type {string} * @memberof SubscriptionPutRequest */ 'name'?: string; /** * Subscription description. * @type {string} * @memberof SubscriptionPutRequest */ 'description'?: string; /** * * @type {SubscriptionType} * @memberof SubscriptionPutRequest */ 'type'?: SubscriptionType; /** * Deadline for completing REQUEST_RESPONSE trigger invocation, represented in ISO-8601 duration format. * @type {string} * @memberof SubscriptionPutRequest */ 'responseDeadline'?: string; /** * * @type {HttpConfig} * @memberof SubscriptionPutRequest */ 'httpConfig'?: HttpConfig; /** * * @type {EventBridgeConfig} * @memberof SubscriptionPutRequest */ 'eventBridgeConfig'?: EventBridgeConfig; /** * Whether subscription should receive real-time trigger invocations or not. Test trigger invocations are always enabled regardless of this option. * @type {boolean} * @memberof SubscriptionPutRequest */ 'enabled'?: boolean; /** * JSONPath filter to conditionally invoke trigger when expression evaluates to true. * @type {string} * @memberof SubscriptionPutRequest */ 'filter'?: string; } /** * Subscription type. **NOTE** If type is EVENTBRIDGE, then eventBridgeConfig is required. If type is HTTP, then httpConfig is required. * @export * @enum {string} */ export const SubscriptionType = { Http: 'HTTP', Eventbridge: 'EVENTBRIDGE', Inline: 'INLINE', Script: 'SCRIPT', Workflow: 'WORKFLOW' } as const; export type SubscriptionType = typeof SubscriptionType[keyof typeof SubscriptionType]; /** * * @export * @interface TestInvocation */ export interface TestInvocation { /** * Trigger ID * @type {string} * @memberof TestInvocation */ 'triggerId': string; /** * Mock input to use for test invocation. This must adhere to the input schema defined in the trigger being invoked. If this property is omitted, then the default trigger sample payload will be sent. * @type {object} * @memberof TestInvocation */ 'input'?: object; /** * JSON map of invocation metadata. * @type {object} * @memberof TestInvocation */ 'contentJson': object; /** * Only send the test event to the subscription IDs listed. If omitted, the test event will be sent to all subscribers. * @type {Array} * @memberof TestInvocation */ 'subscriptionIds'?: Array; } /** * * @export * @interface Trigger */ export interface Trigger { /** * Unique identifier of the trigger. * @type {string} * @memberof Trigger */ 'id': string; /** * Trigger Name. * @type {string} * @memberof Trigger */ 'name': string; /** * * @type {TriggerType} * @memberof Trigger */ 'type': TriggerType; /** * Trigger Description. * @type {string} * @memberof Trigger */ 'description'?: string; /** * The JSON schema of the payload that will be sent by the trigger to the subscribed service. * @type {string} * @memberof Trigger */ 'inputSchema': string; /** * * @type {TriggerExampleInput} * @memberof Trigger */ 'exampleInput': TriggerExampleInput; /** * The JSON schema of the response that will be sent by the subscribed service to the trigger in response to an event. This only applies to a trigger type of `REQUEST_RESPONSE`. * @type {string} * @memberof Trigger */ 'outputSchema'?: string | null; /** * * @type {TriggerExampleOutput} * @memberof Trigger */ 'exampleOutput'?: TriggerExampleOutput | null; } /** * @type TriggerExampleInput * An example of the JSON payload that will be sent by the trigger to the subscribed service. * @export */ export type TriggerExampleInput = AccessRequestDynamicApprover | AccessRequestPostApproval | AccessRequestPreApproval | AccountAggregationCompleted | AccountAttributesChanged | AccountCorrelated | AccountCreated | AccountDeleted | AccountUncorrelated | AccountUpdated | AccountsCollectedForAggregation | CampaignActivated | CampaignEnded | CampaignGenerated | CertificationSignedOff | IdentityAttributesChanged | IdentityCreated | IdentityDeleted | MachineIdentityCreated | MachineIdentityDeleted | MachineIdentityUpdated | ProvisioningCompleted | SavedSearchComplete | SourceAccountCreated | SourceAccountDeleted | SourceAccountUpdated | SourceCreated | SourceDeleted | SourceUpdated | VAClusterStatusChangeEvent; /** * @type TriggerExampleOutput * An example of the JSON payload that will be sent by the subscribed service to the trigger in response to an event. * @export */ export type TriggerExampleOutput = AccessRequestDynamicApprover2 | AccessRequestPreApproval2; /** * The type of trigger. * @export * @enum {string} */ export const TriggerType = { RequestResponse: 'REQUEST_RESPONSE', FireAndForget: 'FIRE_AND_FORGET' } as const; export type TriggerType = typeof TriggerType[keyof typeof TriggerType]; /** * * @export * @interface VAClusterStatusChangeEvent */ export interface VAClusterStatusChangeEvent { /** * The date and time the status change occurred. * @type {string} * @memberof VAClusterStatusChangeEvent */ 'created': string; /** * The type of the object that initiated this event. * @type {string} * @memberof VAClusterStatusChangeEvent */ 'type': VAClusterStatusChangeEventTypeEnum; /** * * @type {VAClusterStatusChangeEventApplication} * @memberof VAClusterStatusChangeEvent */ 'application': VAClusterStatusChangeEventApplication; /** * * @type {VAClusterStatusChangeEventHealthCheckResult} * @memberof VAClusterStatusChangeEvent */ 'healthCheckResult': VAClusterStatusChangeEventHealthCheckResult; /** * * @type {VAClusterStatusChangeEventPreviousHealthCheckResult} * @memberof VAClusterStatusChangeEvent */ 'previousHealthCheckResult': VAClusterStatusChangeEventPreviousHealthCheckResult; } export const VAClusterStatusChangeEventTypeEnum = { Source: 'SOURCE', Cluster: 'CLUSTER' } as const; export type VAClusterStatusChangeEventTypeEnum = typeof VAClusterStatusChangeEventTypeEnum[keyof typeof VAClusterStatusChangeEventTypeEnum]; /** * Details about the `CLUSTER` or `SOURCE` that initiated this event. * @export * @interface VAClusterStatusChangeEventApplication */ export interface VAClusterStatusChangeEventApplication { /** * The GUID of the application * @type {string} * @memberof VAClusterStatusChangeEventApplication */ 'id': string; /** * The name of the application * @type {string} * @memberof VAClusterStatusChangeEventApplication */ 'name': string; /** * Custom map of attributes for a source. This will only be populated if type is `SOURCE` and the source has a proxy. * @type {{ [key: string]: any; }} * @memberof VAClusterStatusChangeEventApplication */ 'attributes': { [key: string]: any; } | null; } /** * The results of the most recent health check. * @export * @interface VAClusterStatusChangeEventHealthCheckResult */ export interface VAClusterStatusChangeEventHealthCheckResult { /** * Detailed message of the result of the health check. * @type {string} * @memberof VAClusterStatusChangeEventHealthCheckResult */ 'message': string; /** * The type of the health check result. * @type {string} * @memberof VAClusterStatusChangeEventHealthCheckResult */ 'resultType': string; /** * The status of the health check. * @type {string} * @memberof VAClusterStatusChangeEventHealthCheckResult */ 'status': VAClusterStatusChangeEventHealthCheckResultStatusEnum; } export const VAClusterStatusChangeEventHealthCheckResultStatusEnum = { Succeeded: 'Succeeded', Failed: 'Failed' } as const; export type VAClusterStatusChangeEventHealthCheckResultStatusEnum = typeof VAClusterStatusChangeEventHealthCheckResultStatusEnum[keyof typeof VAClusterStatusChangeEventHealthCheckResultStatusEnum]; /** * The results of the last health check. * @export * @interface VAClusterStatusChangeEventPreviousHealthCheckResult */ export interface VAClusterStatusChangeEventPreviousHealthCheckResult { /** * Detailed message of the result of the health check. * @type {string} * @memberof VAClusterStatusChangeEventPreviousHealthCheckResult */ 'message': string; /** * The type of the health check result. * @type {string} * @memberof VAClusterStatusChangeEventPreviousHealthCheckResult */ 'resultType': string; /** * The status of the health check. * @type {string} * @memberof VAClusterStatusChangeEventPreviousHealthCheckResult */ 'status': VAClusterStatusChangeEventPreviousHealthCheckResultStatusEnum; } export const VAClusterStatusChangeEventPreviousHealthCheckResultStatusEnum = { Succeeded: 'Succeeded', Failed: 'Failed' } as const; export type VAClusterStatusChangeEventPreviousHealthCheckResultStatusEnum = typeof VAClusterStatusChangeEventPreviousHealthCheckResultStatusEnum[keyof typeof VAClusterStatusChangeEventPreviousHealthCheckResultStatusEnum]; /** * * @export * @interface ValidateFilterInputDto */ export interface ValidateFilterInputDto { /** * Mock input to evaluate filter expression against. * @type {object} * @memberof ValidateFilterInputDto */ 'input': object; /** * JSONPath filter to conditionally invoke trigger when expression evaluates to true. * @type {string} * @memberof ValidateFilterInputDto */ 'filter': string; } /** * * @export * @interface ValidateFilterOutputDto */ export interface ValidateFilterOutputDto { /** * When this field is true, the filter expression is valid against the input. * @type {boolean} * @memberof ValidateFilterOutputDto */ 'isValid'?: boolean; /** * When this field is true, the filter expression is using a valid JSON path. * @type {boolean} * @memberof ValidateFilterOutputDto */ 'isValidJSONPath'?: boolean; /** * When this field is true, the filter expression is using an existing path. * @type {boolean} * @memberof ValidateFilterOutputDto */ 'isPathExist'?: boolean; } /** * TriggersApi - axios parameter creator * @export */ export const TriggersApiAxiosParamCreator = function (configuration?: Configuration) { return { /** * Completes an invocation to a REQUEST_RESPONSE type trigger. * @summary Complete trigger invocation * @param {string} id The ID of the invocation to complete. * @param {CompleteInvocation} completeInvocation * @param {*} [axiosOptions] Override http request option. * @throws {RequiredError} */ completeTriggerInvocationV1: async (id: string, completeInvocation: CompleteInvocation, axiosOptions: RawAxiosRequestConfig = {}): Promise => { // verify required parameter 'id' is not null or undefined assertParamExists('completeTriggerInvocationV1', 'id', id) // verify required parameter 'completeInvocation' is not null or undefined assertParamExists('completeTriggerInvocationV1', 'completeInvocation', completeInvocation) const localVarPath = `/trigger-invocations/v1/{id}/complete` .replace(`{${"id"}}`, encodeURIComponent(String(id))); // use dummy base URL string because the URL constructor only accepts absolute URLs. const localVarUrlObj = new URL(localVarPath, DUMMY_BASE_URL); let baseOptions; if (configuration) { baseOptions = configuration.baseOptions; } const localVarRequestOptions = { method: 'POST', ...baseOptions, ...axiosOptions}; const localVarHeaderParameter = {} as any; const localVarQueryParameter = {} as any; localVarHeaderParameter['Content-Type'] = 'application/json'; setSearchParams(localVarUrlObj, localVarQueryParameter); let headersFromBaseOptions = baseOptions && baseOptions.headers ? baseOptions.headers : {}; localVarRequestOptions.headers = {...localVarHeaderParameter, ...headersFromBaseOptions, ...axiosOptions.headers}; localVarRequestOptions.data = serializeDataIfNeeded(completeInvocation, localVarRequestOptions, configuration) return { url: toPathString(localVarUrlObj), axiosOptions: localVarRequestOptions, }; }, /** * This API creates a new subscription to a trigger and defines trigger invocation details. The type of subscription determines which config object is required: * HTTP subscriptions require httpConfig * EventBridge subscriptions require eventBridgeConfig * @summary Create a subscription * @param {SubscriptionPostRequest} subscriptionPostRequest * @param {*} [axiosOptions] Override http request option. * @throws {RequiredError} */ createSubscriptionV1: async (subscriptionPostRequest: SubscriptionPostRequest, axiosOptions: RawAxiosRequestConfig = {}): Promise => { // verify required parameter 'subscriptionPostRequest' is not null or undefined assertParamExists('createSubscriptionV1', 'subscriptionPostRequest', subscriptionPostRequest) const localVarPath = `/trigger-subscriptions/v1`; // use dummy base URL string because the URL constructor only accepts absolute URLs. const localVarUrlObj = new URL(localVarPath, DUMMY_BASE_URL); let baseOptions; if (configuration) { baseOptions = configuration.baseOptions; } const localVarRequestOptions = { method: 'POST', ...baseOptions, ...axiosOptions}; const localVarHeaderParameter = {} as any; const localVarQueryParameter = {} as any; localVarHeaderParameter['Content-Type'] = 'application/json'; setSearchParams(localVarUrlObj, localVarQueryParameter); let headersFromBaseOptions = baseOptions && baseOptions.headers ? baseOptions.headers : {}; localVarRequestOptions.headers = {...localVarHeaderParameter, ...headersFromBaseOptions, ...axiosOptions.headers}; localVarRequestOptions.data = serializeDataIfNeeded(subscriptionPostRequest, localVarRequestOptions, configuration) return { url: toPathString(localVarUrlObj), axiosOptions: localVarRequestOptions, }; }, /** * Deletes an existing subscription to a trigger. * @summary Delete a subscription * @param {string} id Subscription ID * @param {*} [axiosOptions] Override http request option. * @throws {RequiredError} */ deleteSubscriptionV1: async (id: string, axiosOptions: RawAxiosRequestConfig = {}): Promise => { // verify required parameter 'id' is not null or undefined assertParamExists('deleteSubscriptionV1', 'id', id) const localVarPath = `/trigger-subscriptions/v1/{id}` .replace(`{${"id"}}`, encodeURIComponent(String(id))); // use dummy base URL string because the URL constructor only accepts absolute URLs. const localVarUrlObj = new URL(localVarPath, DUMMY_BASE_URL); let baseOptions; if (configuration) { baseOptions = configuration.baseOptions; } const localVarRequestOptions = { method: 'DELETE', ...baseOptions, ...axiosOptions}; const localVarHeaderParameter = {} as any; const localVarQueryParameter = {} as any; setSearchParams(localVarUrlObj, localVarQueryParameter); let headersFromBaseOptions = baseOptions && baseOptions.headers ? baseOptions.headers : {}; localVarRequestOptions.headers = {...localVarHeaderParameter, ...headersFromBaseOptions, ...axiosOptions.headers}; return { url: toPathString(localVarUrlObj), axiosOptions: localVarRequestOptions, }; }, /** * Gets a list of all trigger subscriptions. * @summary List subscriptions * @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: **id**: *eq* **triggerId**: *eq* **type**: *eq, le* * @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: **triggerId, triggerName** * @param {*} [axiosOptions] Override http request option. * @throws {RequiredError} */ listSubscriptionsV1: async (limit?: number, offset?: number, count?: boolean, filters?: string, sorters?: string, axiosOptions: RawAxiosRequestConfig = {}): Promise => { const localVarPath = `/trigger-subscriptions/v1`; // use dummy base URL string because the URL constructor only accepts absolute URLs. const localVarUrlObj = new URL(localVarPath, DUMMY_BASE_URL); let baseOptions; if (configuration) { baseOptions = configuration.baseOptions; } const localVarRequestOptions = { method: 'GET', ...baseOptions, ...axiosOptions}; const localVarHeaderParameter = {} as any; const localVarQueryParameter = {} as any; if (limit !== undefined) { localVarQueryParameter['limit'] = limit; } if (offset !== undefined) { localVarQueryParameter['offset'] = offset; } if (count !== undefined) { localVarQueryParameter['count'] = count; } if (filters !== undefined) { localVarQueryParameter['filters'] = filters; } if (sorters !== undefined) { localVarQueryParameter['sorters'] = sorters; } setSearchParams(localVarUrlObj, localVarQueryParameter); let headersFromBaseOptions = baseOptions && baseOptions.headers ? baseOptions.headers : {}; localVarRequestOptions.headers = {...localVarHeaderParameter, ...headersFromBaseOptions, ...axiosOptions.headers}; return { url: toPathString(localVarUrlObj), axiosOptions: localVarRequestOptions, }; }, /** * Gets a list of latest invocation statuses. Statuses of successful invocations are available for up to 24 hours. Statuses of failed invocations are available for up to 48 hours. This endpoint may only fetch up to 2000 invocations, and should not be treated as a representation of the full history of invocations. * @summary List latest invocation statuses * @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: **triggerId**: *eq* **subscriptionId**: *eq* * @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: **triggerId, subscriptionName, created, completed** * @param {*} [axiosOptions] Override http request option. * @throws {RequiredError} */ listTriggerInvocationStatusV1: async (limit?: number, offset?: number, count?: boolean, filters?: string, sorters?: string, axiosOptions: RawAxiosRequestConfig = {}): Promise => { const localVarPath = `/trigger-invocations/v1/status`; // use dummy base URL string because the URL constructor only accepts absolute URLs. const localVarUrlObj = new URL(localVarPath, DUMMY_BASE_URL); let baseOptions; if (configuration) { baseOptions = configuration.baseOptions; } const localVarRequestOptions = { method: 'GET', ...baseOptions, ...axiosOptions}; const localVarHeaderParameter = {} as any; const localVarQueryParameter = {} as any; if (limit !== undefined) { localVarQueryParameter['limit'] = limit; } if (offset !== undefined) { localVarQueryParameter['offset'] = offset; } if (count !== undefined) { localVarQueryParameter['count'] = count; } if (filters !== undefined) { localVarQueryParameter['filters'] = filters; } if (sorters !== undefined) { localVarQueryParameter['sorters'] = sorters; } setSearchParams(localVarUrlObj, localVarQueryParameter); let headersFromBaseOptions = baseOptions && baseOptions.headers ? baseOptions.headers : {}; localVarRequestOptions.headers = {...localVarHeaderParameter, ...headersFromBaseOptions, ...axiosOptions.headers}; return { url: toPathString(localVarUrlObj), axiosOptions: localVarRequestOptions, }; }, /** * Gets a list of triggers that are available in the tenant. * @summary List triggers * @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: **id**: *eq, ge, le* * @param {string} [sorters] Sort results using the standard syntax described in [V3 API Standard Collection Parameters](https://developer.sailpoint.com/idn/api/standard-collection-parameters#sorting-results) Sorting is supported for the following fields: **id, name** * @param {*} [axiosOptions] Override http request option. * @throws {RequiredError} */ listTriggersV1: async (limit?: number, offset?: number, count?: boolean, filters?: string, sorters?: string, axiosOptions: RawAxiosRequestConfig = {}): Promise => { const localVarPath = `/triggers/v1`; // use dummy base URL string because the URL constructor only accepts absolute URLs. const localVarUrlObj = new URL(localVarPath, DUMMY_BASE_URL); let baseOptions; if (configuration) { baseOptions = configuration.baseOptions; } const localVarRequestOptions = { method: 'GET', ...baseOptions, ...axiosOptions}; const localVarHeaderParameter = {} as any; const localVarQueryParameter = {} as any; if (limit !== undefined) { localVarQueryParameter['limit'] = limit; } if (offset !== undefined) { localVarQueryParameter['offset'] = offset; } if (count !== undefined) { localVarQueryParameter['count'] = count; } if (filters !== undefined) { localVarQueryParameter['filters'] = filters; } if (sorters !== undefined) { localVarQueryParameter['sorters'] = sorters; } setSearchParams(localVarUrlObj, localVarQueryParameter); let headersFromBaseOptions = baseOptions && baseOptions.headers ? baseOptions.headers : {}; localVarRequestOptions.headers = {...localVarHeaderParameter, ...headersFromBaseOptions, ...axiosOptions.headers}; return { url: toPathString(localVarUrlObj), axiosOptions: localVarRequestOptions, }; }, /** * This API updates a trigger subscription in IdentityNow, using a set of instructions to modify a subscription partially. The following fields are patchable: **name**, **description**, **enabled**, **type**, **filter**, **responseDeadline**, **httpConfig**, **eventBridgeConfig**, **workflowConfig** * @summary Patch a subscription * @param {string} id ID of the Subscription to patch * @param {Array} subscriptionPatchRequestInner * @param {*} [axiosOptions] Override http request option. * @throws {RequiredError} */ patchSubscriptionV1: async (id: string, subscriptionPatchRequestInner: Array, axiosOptions: RawAxiosRequestConfig = {}): Promise => { // verify required parameter 'id' is not null or undefined assertParamExists('patchSubscriptionV1', 'id', id) // verify required parameter 'subscriptionPatchRequestInner' is not null or undefined assertParamExists('patchSubscriptionV1', 'subscriptionPatchRequestInner', subscriptionPatchRequestInner) const localVarPath = `/trigger-subscriptions/v1/{id}` .replace(`{${"id"}}`, encodeURIComponent(String(id))); // use dummy base URL string because the URL constructor only accepts absolute URLs. const localVarUrlObj = new URL(localVarPath, DUMMY_BASE_URL); let baseOptions; if (configuration) { baseOptions = configuration.baseOptions; } const localVarRequestOptions = { method: 'PATCH', ...baseOptions, ...axiosOptions}; const localVarHeaderParameter = {} as any; const localVarQueryParameter = {} as any; localVarHeaderParameter['Content-Type'] = 'application/json-patch+json'; setSearchParams(localVarUrlObj, localVarQueryParameter); let headersFromBaseOptions = baseOptions && baseOptions.headers ? baseOptions.headers : {}; localVarRequestOptions.headers = {...localVarHeaderParameter, ...headersFromBaseOptions, ...axiosOptions.headers}; localVarRequestOptions.data = serializeDataIfNeeded(subscriptionPatchRequestInner, localVarRequestOptions, configuration) return { url: toPathString(localVarUrlObj), axiosOptions: localVarRequestOptions, }; }, /** * Initiate a test event for all subscribers of the specified event trigger. If there are no subscribers to the specified trigger in the tenant, then no test event will be sent. * @summary Start a test invocation * @param {TestInvocation} testInvocation * @param {*} [axiosOptions] Override http request option. * @throws {RequiredError} */ startTestTriggerInvocationV1: async (testInvocation: TestInvocation, axiosOptions: RawAxiosRequestConfig = {}): Promise => { // verify required parameter 'testInvocation' is not null or undefined assertParamExists('startTestTriggerInvocationV1', 'testInvocation', testInvocation) const localVarPath = `/trigger-invocations/v1/test`; // use dummy base URL string because the URL constructor only accepts absolute URLs. const localVarUrlObj = new URL(localVarPath, DUMMY_BASE_URL); let baseOptions; if (configuration) { baseOptions = configuration.baseOptions; } const localVarRequestOptions = { method: 'POST', ...baseOptions, ...axiosOptions}; const localVarHeaderParameter = {} as any; const localVarQueryParameter = {} as any; localVarHeaderParameter['Content-Type'] = 'application/json'; setSearchParams(localVarUrlObj, localVarQueryParameter); let headersFromBaseOptions = baseOptions && baseOptions.headers ? baseOptions.headers : {}; localVarRequestOptions.headers = {...localVarHeaderParameter, ...headersFromBaseOptions, ...axiosOptions.headers}; localVarRequestOptions.data = serializeDataIfNeeded(testInvocation, localVarRequestOptions, configuration) return { url: toPathString(localVarUrlObj), axiosOptions: localVarRequestOptions, }; }, /** * Validates a JSONPath filter expression against a provided mock input. Request requires a security scope of: * @summary Validate a subscription filter * @param {ValidateFilterInputDto} validateFilterInputDto * @param {*} [axiosOptions] Override http request option. * @throws {RequiredError} */ testSubscriptionFilterV1: async (validateFilterInputDto: ValidateFilterInputDto, axiosOptions: RawAxiosRequestConfig = {}): Promise => { // verify required parameter 'validateFilterInputDto' is not null or undefined assertParamExists('testSubscriptionFilterV1', 'validateFilterInputDto', validateFilterInputDto) const localVarPath = `/trigger-subscriptions/v1/validate-filter`; // use dummy base URL string because the URL constructor only accepts absolute URLs. const localVarUrlObj = new URL(localVarPath, DUMMY_BASE_URL); let baseOptions; if (configuration) { baseOptions = configuration.baseOptions; } const localVarRequestOptions = { method: 'POST', ...baseOptions, ...axiosOptions}; const localVarHeaderParameter = {} as any; const localVarQueryParameter = {} as any; localVarHeaderParameter['Content-Type'] = 'application/json'; setSearchParams(localVarUrlObj, localVarQueryParameter); let headersFromBaseOptions = baseOptions && baseOptions.headers ? baseOptions.headers : {}; localVarRequestOptions.headers = {...localVarHeaderParameter, ...headersFromBaseOptions, ...axiosOptions.headers}; localVarRequestOptions.data = serializeDataIfNeeded(validateFilterInputDto, localVarRequestOptions, configuration) return { url: toPathString(localVarUrlObj), axiosOptions: localVarRequestOptions, }; }, /** * This API updates a trigger subscription in IdentityNow, using a full object representation. In other words, the existing Subscription is completely replaced. The following fields are immutable: * id * triggerId Attempts to modify these fields result in 400. * @summary Update a subscription * @param {string} id Subscription ID * @param {SubscriptionPutRequest} subscriptionPutRequest * @param {*} [axiosOptions] Override http request option. * @throws {RequiredError} */ updateSubscriptionV1: async (id: string, subscriptionPutRequest: SubscriptionPutRequest, axiosOptions: RawAxiosRequestConfig = {}): Promise => { // verify required parameter 'id' is not null or undefined assertParamExists('updateSubscriptionV1', 'id', id) // verify required parameter 'subscriptionPutRequest' is not null or undefined assertParamExists('updateSubscriptionV1', 'subscriptionPutRequest', subscriptionPutRequest) const localVarPath = `/trigger-subscriptions/v1/{id}` .replace(`{${"id"}}`, encodeURIComponent(String(id))); // use dummy base URL string because the URL constructor only accepts absolute URLs. const localVarUrlObj = new URL(localVarPath, DUMMY_BASE_URL); let baseOptions; if (configuration) { baseOptions = configuration.baseOptions; } const localVarRequestOptions = { method: 'PUT', ...baseOptions, ...axiosOptions}; const localVarHeaderParameter = {} as any; const localVarQueryParameter = {} as any; localVarHeaderParameter['Content-Type'] = 'application/json'; setSearchParams(localVarUrlObj, localVarQueryParameter); let headersFromBaseOptions = baseOptions && baseOptions.headers ? baseOptions.headers : {}; localVarRequestOptions.headers = {...localVarHeaderParameter, ...headersFromBaseOptions, ...axiosOptions.headers}; localVarRequestOptions.data = serializeDataIfNeeded(subscriptionPutRequest, localVarRequestOptions, configuration) return { url: toPathString(localVarUrlObj), axiosOptions: localVarRequestOptions, }; }, } }; /** * TriggersApi - functional programming interface * @export */ export const TriggersApiFp = function(configuration?: Configuration) { const localVarAxiosParamCreator = TriggersApiAxiosParamCreator(configuration) return { /** * Completes an invocation to a REQUEST_RESPONSE type trigger. * @summary Complete trigger invocation * @param {string} id The ID of the invocation to complete. * @param {CompleteInvocation} completeInvocation * @param {*} [axiosOptions] Override http request option. * @throws {RequiredError} */ async completeTriggerInvocationV1(id: string, completeInvocation: CompleteInvocation, axiosOptions?: RawAxiosRequestConfig): Promise<(axios?: AxiosInstance, basePath?: string) => AxiosPromise> { const localVarAxiosArgs = await localVarAxiosParamCreator.completeTriggerInvocationV1(id, completeInvocation, axiosOptions); const localVarOperationServerIndex = configuration?.serverIndex ?? 0; const localVarOperationServerBasePath = operationServerMap['TriggersApi.completeTriggerInvocationV1']?.[localVarOperationServerIndex]?.url; return (axios, basePath) => createRequestFunction(localVarAxiosArgs, globalAxios, BASE_PATH, configuration)(axios, localVarOperationServerBasePath || basePath); }, /** * This API creates a new subscription to a trigger and defines trigger invocation details. The type of subscription determines which config object is required: * HTTP subscriptions require httpConfig * EventBridge subscriptions require eventBridgeConfig * @summary Create a subscription * @param {SubscriptionPostRequest} subscriptionPostRequest * @param {*} [axiosOptions] Override http request option. * @throws {RequiredError} */ async createSubscriptionV1(subscriptionPostRequest: SubscriptionPostRequest, axiosOptions?: RawAxiosRequestConfig): Promise<(axios?: AxiosInstance, basePath?: string) => AxiosPromise> { const localVarAxiosArgs = await localVarAxiosParamCreator.createSubscriptionV1(subscriptionPostRequest, axiosOptions); const localVarOperationServerIndex = configuration?.serverIndex ?? 0; const localVarOperationServerBasePath = operationServerMap['TriggersApi.createSubscriptionV1']?.[localVarOperationServerIndex]?.url; return (axios, basePath) => createRequestFunction(localVarAxiosArgs, globalAxios, BASE_PATH, configuration)(axios, localVarOperationServerBasePath || basePath); }, /** * Deletes an existing subscription to a trigger. * @summary Delete a subscription * @param {string} id Subscription ID * @param {*} [axiosOptions] Override http request option. * @throws {RequiredError} */ async deleteSubscriptionV1(id: string, axiosOptions?: RawAxiosRequestConfig): Promise<(axios?: AxiosInstance, basePath?: string) => AxiosPromise> { const localVarAxiosArgs = await localVarAxiosParamCreator.deleteSubscriptionV1(id, axiosOptions); const localVarOperationServerIndex = configuration?.serverIndex ?? 0; const localVarOperationServerBasePath = operationServerMap['TriggersApi.deleteSubscriptionV1']?.[localVarOperationServerIndex]?.url; return (axios, basePath) => createRequestFunction(localVarAxiosArgs, globalAxios, BASE_PATH, configuration)(axios, localVarOperationServerBasePath || basePath); }, /** * Gets a list of all trigger subscriptions. * @summary List subscriptions * @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: **id**: *eq* **triggerId**: *eq* **type**: *eq, le* * @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: **triggerId, triggerName** * @param {*} [axiosOptions] Override http request option. * @throws {RequiredError} */ async listSubscriptionsV1(limit?: number, offset?: number, count?: boolean, filters?: string, sorters?: string, axiosOptions?: RawAxiosRequestConfig): Promise<(axios?: AxiosInstance, basePath?: string) => AxiosPromise>> { const localVarAxiosArgs = await localVarAxiosParamCreator.listSubscriptionsV1(limit, offset, count, filters, sorters, axiosOptions); const localVarOperationServerIndex = configuration?.serverIndex ?? 0; const localVarOperationServerBasePath = operationServerMap['TriggersApi.listSubscriptionsV1']?.[localVarOperationServerIndex]?.url; return (axios, basePath) => createRequestFunction(localVarAxiosArgs, globalAxios, BASE_PATH, configuration)(axios, localVarOperationServerBasePath || basePath); }, /** * Gets a list of latest invocation statuses. Statuses of successful invocations are available for up to 24 hours. Statuses of failed invocations are available for up to 48 hours. This endpoint may only fetch up to 2000 invocations, and should not be treated as a representation of the full history of invocations. * @summary List latest invocation statuses * @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: **triggerId**: *eq* **subscriptionId**: *eq* * @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: **triggerId, subscriptionName, created, completed** * @param {*} [axiosOptions] Override http request option. * @throws {RequiredError} */ async listTriggerInvocationStatusV1(limit?: number, offset?: number, count?: boolean, filters?: string, sorters?: string, axiosOptions?: RawAxiosRequestConfig): Promise<(axios?: AxiosInstance, basePath?: string) => AxiosPromise>> { const localVarAxiosArgs = await localVarAxiosParamCreator.listTriggerInvocationStatusV1(limit, offset, count, filters, sorters, axiosOptions); const localVarOperationServerIndex = configuration?.serverIndex ?? 0; const localVarOperationServerBasePath = operationServerMap['TriggersApi.listTriggerInvocationStatusV1']?.[localVarOperationServerIndex]?.url; return (axios, basePath) => createRequestFunction(localVarAxiosArgs, globalAxios, BASE_PATH, configuration)(axios, localVarOperationServerBasePath || basePath); }, /** * Gets a list of triggers that are available in the tenant. * @summary List triggers * @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: **id**: *eq, ge, le* * @param {string} [sorters] Sort results using the standard syntax described in [V3 API Standard Collection Parameters](https://developer.sailpoint.com/idn/api/standard-collection-parameters#sorting-results) Sorting is supported for the following fields: **id, name** * @param {*} [axiosOptions] Override http request option. * @throws {RequiredError} */ async listTriggersV1(limit?: number, offset?: number, count?: boolean, filters?: string, sorters?: string, axiosOptions?: RawAxiosRequestConfig): Promise<(axios?: AxiosInstance, basePath?: string) => AxiosPromise>> { const localVarAxiosArgs = await localVarAxiosParamCreator.listTriggersV1(limit, offset, count, filters, sorters, axiosOptions); const localVarOperationServerIndex = configuration?.serverIndex ?? 0; const localVarOperationServerBasePath = operationServerMap['TriggersApi.listTriggersV1']?.[localVarOperationServerIndex]?.url; return (axios, basePath) => createRequestFunction(localVarAxiosArgs, globalAxios, BASE_PATH, configuration)(axios, localVarOperationServerBasePath || basePath); }, /** * This API updates a trigger subscription in IdentityNow, using a set of instructions to modify a subscription partially. The following fields are patchable: **name**, **description**, **enabled**, **type**, **filter**, **responseDeadline**, **httpConfig**, **eventBridgeConfig**, **workflowConfig** * @summary Patch a subscription * @param {string} id ID of the Subscription to patch * @param {Array} subscriptionPatchRequestInner * @param {*} [axiosOptions] Override http request option. * @throws {RequiredError} */ async patchSubscriptionV1(id: string, subscriptionPatchRequestInner: Array, axiosOptions?: RawAxiosRequestConfig): Promise<(axios?: AxiosInstance, basePath?: string) => AxiosPromise> { const localVarAxiosArgs = await localVarAxiosParamCreator.patchSubscriptionV1(id, subscriptionPatchRequestInner, axiosOptions); const localVarOperationServerIndex = configuration?.serverIndex ?? 0; const localVarOperationServerBasePath = operationServerMap['TriggersApi.patchSubscriptionV1']?.[localVarOperationServerIndex]?.url; return (axios, basePath) => createRequestFunction(localVarAxiosArgs, globalAxios, BASE_PATH, configuration)(axios, localVarOperationServerBasePath || basePath); }, /** * Initiate a test event for all subscribers of the specified event trigger. If there are no subscribers to the specified trigger in the tenant, then no test event will be sent. * @summary Start a test invocation * @param {TestInvocation} testInvocation * @param {*} [axiosOptions] Override http request option. * @throws {RequiredError} */ async startTestTriggerInvocationV1(testInvocation: TestInvocation, axiosOptions?: RawAxiosRequestConfig): Promise<(axios?: AxiosInstance, basePath?: string) => AxiosPromise>> { const localVarAxiosArgs = await localVarAxiosParamCreator.startTestTriggerInvocationV1(testInvocation, axiosOptions); const localVarOperationServerIndex = configuration?.serverIndex ?? 0; const localVarOperationServerBasePath = operationServerMap['TriggersApi.startTestTriggerInvocationV1']?.[localVarOperationServerIndex]?.url; return (axios, basePath) => createRequestFunction(localVarAxiosArgs, globalAxios, BASE_PATH, configuration)(axios, localVarOperationServerBasePath || basePath); }, /** * Validates a JSONPath filter expression against a provided mock input. Request requires a security scope of: * @summary Validate a subscription filter * @param {ValidateFilterInputDto} validateFilterInputDto * @param {*} [axiosOptions] Override http request option. * @throws {RequiredError} */ async testSubscriptionFilterV1(validateFilterInputDto: ValidateFilterInputDto, axiosOptions?: RawAxiosRequestConfig): Promise<(axios?: AxiosInstance, basePath?: string) => AxiosPromise> { const localVarAxiosArgs = await localVarAxiosParamCreator.testSubscriptionFilterV1(validateFilterInputDto, axiosOptions); const localVarOperationServerIndex = configuration?.serverIndex ?? 0; const localVarOperationServerBasePath = operationServerMap['TriggersApi.testSubscriptionFilterV1']?.[localVarOperationServerIndex]?.url; return (axios, basePath) => createRequestFunction(localVarAxiosArgs, globalAxios, BASE_PATH, configuration)(axios, localVarOperationServerBasePath || basePath); }, /** * This API updates a trigger subscription in IdentityNow, using a full object representation. In other words, the existing Subscription is completely replaced. The following fields are immutable: * id * triggerId Attempts to modify these fields result in 400. * @summary Update a subscription * @param {string} id Subscription ID * @param {SubscriptionPutRequest} subscriptionPutRequest * @param {*} [axiosOptions] Override http request option. * @throws {RequiredError} */ async updateSubscriptionV1(id: string, subscriptionPutRequest: SubscriptionPutRequest, axiosOptions?: RawAxiosRequestConfig): Promise<(axios?: AxiosInstance, basePath?: string) => AxiosPromise> { const localVarAxiosArgs = await localVarAxiosParamCreator.updateSubscriptionV1(id, subscriptionPutRequest, axiosOptions); const localVarOperationServerIndex = configuration?.serverIndex ?? 0; const localVarOperationServerBasePath = operationServerMap['TriggersApi.updateSubscriptionV1']?.[localVarOperationServerIndex]?.url; return (axios, basePath) => createRequestFunction(localVarAxiosArgs, globalAxios, BASE_PATH, configuration)(axios, localVarOperationServerBasePath || basePath); }, } }; /** * TriggersApi - factory interface * @export */ export const TriggersApiFactory = function (configuration?: Configuration, basePath?: string, axios?: AxiosInstance) { const localVarFp = TriggersApiFp(configuration) return { /** * Completes an invocation to a REQUEST_RESPONSE type trigger. * @summary Complete trigger invocation * @param {TriggersApiCompleteTriggerInvocationV1Request} requestParameters Request parameters. * @param {*} [axiosOptions] Override http request option. * @throws {RequiredError} */ completeTriggerInvocationV1(requestParameters: TriggersApiCompleteTriggerInvocationV1Request, axiosOptions?: RawAxiosRequestConfig): AxiosPromise { return localVarFp.completeTriggerInvocationV1(requestParameters.id, requestParameters.completeInvocation, axiosOptions).then((request) => request(axios, basePath)); }, /** * This API creates a new subscription to a trigger and defines trigger invocation details. The type of subscription determines which config object is required: * HTTP subscriptions require httpConfig * EventBridge subscriptions require eventBridgeConfig * @summary Create a subscription * @param {TriggersApiCreateSubscriptionV1Request} requestParameters Request parameters. * @param {*} [axiosOptions] Override http request option. * @throws {RequiredError} */ createSubscriptionV1(requestParameters: TriggersApiCreateSubscriptionV1Request, axiosOptions?: RawAxiosRequestConfig): AxiosPromise { return localVarFp.createSubscriptionV1(requestParameters.subscriptionPostRequest, axiosOptions).then((request) => request(axios, basePath)); }, /** * Deletes an existing subscription to a trigger. * @summary Delete a subscription * @param {TriggersApiDeleteSubscriptionV1Request} requestParameters Request parameters. * @param {*} [axiosOptions] Override http request option. * @throws {RequiredError} */ deleteSubscriptionV1(requestParameters: TriggersApiDeleteSubscriptionV1Request, axiosOptions?: RawAxiosRequestConfig): AxiosPromise { return localVarFp.deleteSubscriptionV1(requestParameters.id, axiosOptions).then((request) => request(axios, basePath)); }, /** * Gets a list of all trigger subscriptions. * @summary List subscriptions * @param {TriggersApiListSubscriptionsV1Request} requestParameters Request parameters. * @param {*} [axiosOptions] Override http request option. * @throws {RequiredError} */ listSubscriptionsV1(requestParameters: TriggersApiListSubscriptionsV1Request = {}, axiosOptions?: RawAxiosRequestConfig): AxiosPromise> { return localVarFp.listSubscriptionsV1(requestParameters.limit, requestParameters.offset, requestParameters.count, requestParameters.filters, requestParameters.sorters, axiosOptions).then((request) => request(axios, basePath)); }, /** * Gets a list of latest invocation statuses. Statuses of successful invocations are available for up to 24 hours. Statuses of failed invocations are available for up to 48 hours. This endpoint may only fetch up to 2000 invocations, and should not be treated as a representation of the full history of invocations. * @summary List latest invocation statuses * @param {TriggersApiListTriggerInvocationStatusV1Request} requestParameters Request parameters. * @param {*} [axiosOptions] Override http request option. * @throws {RequiredError} */ listTriggerInvocationStatusV1(requestParameters: TriggersApiListTriggerInvocationStatusV1Request = {}, axiosOptions?: RawAxiosRequestConfig): AxiosPromise> { return localVarFp.listTriggerInvocationStatusV1(requestParameters.limit, requestParameters.offset, requestParameters.count, requestParameters.filters, requestParameters.sorters, axiosOptions).then((request) => request(axios, basePath)); }, /** * Gets a list of triggers that are available in the tenant. * @summary List triggers * @param {TriggersApiListTriggersV1Request} requestParameters Request parameters. * @param {*} [axiosOptions] Override http request option. * @throws {RequiredError} */ listTriggersV1(requestParameters: TriggersApiListTriggersV1Request = {}, axiosOptions?: RawAxiosRequestConfig): AxiosPromise> { return localVarFp.listTriggersV1(requestParameters.limit, requestParameters.offset, requestParameters.count, requestParameters.filters, requestParameters.sorters, axiosOptions).then((request) => request(axios, basePath)); }, /** * This API updates a trigger subscription in IdentityNow, using a set of instructions to modify a subscription partially. The following fields are patchable: **name**, **description**, **enabled**, **type**, **filter**, **responseDeadline**, **httpConfig**, **eventBridgeConfig**, **workflowConfig** * @summary Patch a subscription * @param {TriggersApiPatchSubscriptionV1Request} requestParameters Request parameters. * @param {*} [axiosOptions] Override http request option. * @throws {RequiredError} */ patchSubscriptionV1(requestParameters: TriggersApiPatchSubscriptionV1Request, axiosOptions?: RawAxiosRequestConfig): AxiosPromise { return localVarFp.patchSubscriptionV1(requestParameters.id, requestParameters.subscriptionPatchRequestInner, axiosOptions).then((request) => request(axios, basePath)); }, /** * Initiate a test event for all subscribers of the specified event trigger. If there are no subscribers to the specified trigger in the tenant, then no test event will be sent. * @summary Start a test invocation * @param {TriggersApiStartTestTriggerInvocationV1Request} requestParameters Request parameters. * @param {*} [axiosOptions] Override http request option. * @throws {RequiredError} */ startTestTriggerInvocationV1(requestParameters: TriggersApiStartTestTriggerInvocationV1Request, axiosOptions?: RawAxiosRequestConfig): AxiosPromise> { return localVarFp.startTestTriggerInvocationV1(requestParameters.testInvocation, axiosOptions).then((request) => request(axios, basePath)); }, /** * Validates a JSONPath filter expression against a provided mock input. Request requires a security scope of: * @summary Validate a subscription filter * @param {TriggersApiTestSubscriptionFilterV1Request} requestParameters Request parameters. * @param {*} [axiosOptions] Override http request option. * @throws {RequiredError} */ testSubscriptionFilterV1(requestParameters: TriggersApiTestSubscriptionFilterV1Request, axiosOptions?: RawAxiosRequestConfig): AxiosPromise { return localVarFp.testSubscriptionFilterV1(requestParameters.validateFilterInputDto, axiosOptions).then((request) => request(axios, basePath)); }, /** * This API updates a trigger subscription in IdentityNow, using a full object representation. In other words, the existing Subscription is completely replaced. The following fields are immutable: * id * triggerId Attempts to modify these fields result in 400. * @summary Update a subscription * @param {TriggersApiUpdateSubscriptionV1Request} requestParameters Request parameters. * @param {*} [axiosOptions] Override http request option. * @throws {RequiredError} */ updateSubscriptionV1(requestParameters: TriggersApiUpdateSubscriptionV1Request, axiosOptions?: RawAxiosRequestConfig): AxiosPromise { return localVarFp.updateSubscriptionV1(requestParameters.id, requestParameters.subscriptionPutRequest, axiosOptions).then((request) => request(axios, basePath)); }, }; }; /** * Request parameters for completeTriggerInvocationV1 operation in TriggersApi. * @export * @interface TriggersApiCompleteTriggerInvocationV1Request */ export interface TriggersApiCompleteTriggerInvocationV1Request { /** * The ID of the invocation to complete. * @type {string} * @memberof TriggersApiCompleteTriggerInvocationV1 */ readonly id: string /** * * @type {CompleteInvocation} * @memberof TriggersApiCompleteTriggerInvocationV1 */ readonly completeInvocation: CompleteInvocation } /** * Request parameters for createSubscriptionV1 operation in TriggersApi. * @export * @interface TriggersApiCreateSubscriptionV1Request */ export interface TriggersApiCreateSubscriptionV1Request { /** * * @type {SubscriptionPostRequest} * @memberof TriggersApiCreateSubscriptionV1 */ readonly subscriptionPostRequest: SubscriptionPostRequest } /** * Request parameters for deleteSubscriptionV1 operation in TriggersApi. * @export * @interface TriggersApiDeleteSubscriptionV1Request */ export interface TriggersApiDeleteSubscriptionV1Request { /** * Subscription ID * @type {string} * @memberof TriggersApiDeleteSubscriptionV1 */ readonly id: string } /** * Request parameters for listSubscriptionsV1 operation in TriggersApi. * @export * @interface TriggersApiListSubscriptionsV1Request */ export interface TriggersApiListSubscriptionsV1Request { /** * 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 TriggersApiListSubscriptionsV1 */ 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 TriggersApiListSubscriptionsV1 */ 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 TriggersApiListSubscriptionsV1 */ 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: **id**: *eq* **triggerId**: *eq* **type**: *eq, le* * @type {string} * @memberof TriggersApiListSubscriptionsV1 */ 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: **triggerId, triggerName** * @type {string} * @memberof TriggersApiListSubscriptionsV1 */ readonly sorters?: string } /** * Request parameters for listTriggerInvocationStatusV1 operation in TriggersApi. * @export * @interface TriggersApiListTriggerInvocationStatusV1Request */ export interface TriggersApiListTriggerInvocationStatusV1Request { /** * 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 TriggersApiListTriggerInvocationStatusV1 */ 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 TriggersApiListTriggerInvocationStatusV1 */ 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 TriggersApiListTriggerInvocationStatusV1 */ 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: **triggerId**: *eq* **subscriptionId**: *eq* * @type {string} * @memberof TriggersApiListTriggerInvocationStatusV1 */ 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: **triggerId, subscriptionName, created, completed** * @type {string} * @memberof TriggersApiListTriggerInvocationStatusV1 */ readonly sorters?: string } /** * Request parameters for listTriggersV1 operation in TriggersApi. * @export * @interface TriggersApiListTriggersV1Request */ export interface TriggersApiListTriggersV1Request { /** * 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 TriggersApiListTriggersV1 */ 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 TriggersApiListTriggersV1 */ 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 TriggersApiListTriggersV1 */ 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: **id**: *eq, ge, le* * @type {string} * @memberof TriggersApiListTriggersV1 */ readonly filters?: string /** * Sort results using the standard syntax described in [V3 API Standard Collection Parameters](https://developer.sailpoint.com/idn/api/standard-collection-parameters#sorting-results) Sorting is supported for the following fields: **id, name** * @type {string} * @memberof TriggersApiListTriggersV1 */ readonly sorters?: string } /** * Request parameters for patchSubscriptionV1 operation in TriggersApi. * @export * @interface TriggersApiPatchSubscriptionV1Request */ export interface TriggersApiPatchSubscriptionV1Request { /** * ID of the Subscription to patch * @type {string} * @memberof TriggersApiPatchSubscriptionV1 */ readonly id: string /** * * @type {Array} * @memberof TriggersApiPatchSubscriptionV1 */ readonly subscriptionPatchRequestInner: Array } /** * Request parameters for startTestTriggerInvocationV1 operation in TriggersApi. * @export * @interface TriggersApiStartTestTriggerInvocationV1Request */ export interface TriggersApiStartTestTriggerInvocationV1Request { /** * * @type {TestInvocation} * @memberof TriggersApiStartTestTriggerInvocationV1 */ readonly testInvocation: TestInvocation } /** * Request parameters for testSubscriptionFilterV1 operation in TriggersApi. * @export * @interface TriggersApiTestSubscriptionFilterV1Request */ export interface TriggersApiTestSubscriptionFilterV1Request { /** * * @type {ValidateFilterInputDto} * @memberof TriggersApiTestSubscriptionFilterV1 */ readonly validateFilterInputDto: ValidateFilterInputDto } /** * Request parameters for updateSubscriptionV1 operation in TriggersApi. * @export * @interface TriggersApiUpdateSubscriptionV1Request */ export interface TriggersApiUpdateSubscriptionV1Request { /** * Subscription ID * @type {string} * @memberof TriggersApiUpdateSubscriptionV1 */ readonly id: string /** * * @type {SubscriptionPutRequest} * @memberof TriggersApiUpdateSubscriptionV1 */ readonly subscriptionPutRequest: SubscriptionPutRequest } /** * TriggersApi - object-oriented interface * @export * @class TriggersApi * @extends {BaseAPI} */ export class TriggersApi extends BaseAPI { /** * Completes an invocation to a REQUEST_RESPONSE type trigger. * @summary Complete trigger invocation * @param {TriggersApiCompleteTriggerInvocationV1Request} requestParameters Request parameters. * @param {*} [axiosOptions] Override http request option. * @throws {RequiredError} * @memberof TriggersApi */ public completeTriggerInvocationV1(requestParameters: TriggersApiCompleteTriggerInvocationV1Request, axiosOptions?: RawAxiosRequestConfig) { return TriggersApiFp(this.configuration).completeTriggerInvocationV1(requestParameters.id, requestParameters.completeInvocation, axiosOptions).then((request) => request(this.axios, this.basePath)); } /** * This API creates a new subscription to a trigger and defines trigger invocation details. The type of subscription determines which config object is required: * HTTP subscriptions require httpConfig * EventBridge subscriptions require eventBridgeConfig * @summary Create a subscription * @param {TriggersApiCreateSubscriptionV1Request} requestParameters Request parameters. * @param {*} [axiosOptions] Override http request option. * @throws {RequiredError} * @memberof TriggersApi */ public createSubscriptionV1(requestParameters: TriggersApiCreateSubscriptionV1Request, axiosOptions?: RawAxiosRequestConfig) { return TriggersApiFp(this.configuration).createSubscriptionV1(requestParameters.subscriptionPostRequest, axiosOptions).then((request) => request(this.axios, this.basePath)); } /** * Deletes an existing subscription to a trigger. * @summary Delete a subscription * @param {TriggersApiDeleteSubscriptionV1Request} requestParameters Request parameters. * @param {*} [axiosOptions] Override http request option. * @throws {RequiredError} * @memberof TriggersApi */ public deleteSubscriptionV1(requestParameters: TriggersApiDeleteSubscriptionV1Request, axiosOptions?: RawAxiosRequestConfig) { return TriggersApiFp(this.configuration).deleteSubscriptionV1(requestParameters.id, axiosOptions).then((request) => request(this.axios, this.basePath)); } /** * Gets a list of all trigger subscriptions. * @summary List subscriptions * @param {TriggersApiListSubscriptionsV1Request} requestParameters Request parameters. * @param {*} [axiosOptions] Override http request option. * @throws {RequiredError} * @memberof TriggersApi */ public listSubscriptionsV1(requestParameters: TriggersApiListSubscriptionsV1Request = {}, axiosOptions?: RawAxiosRequestConfig) { return TriggersApiFp(this.configuration).listSubscriptionsV1(requestParameters.limit, requestParameters.offset, requestParameters.count, requestParameters.filters, requestParameters.sorters, axiosOptions).then((request) => request(this.axios, this.basePath)); } /** * Gets a list of latest invocation statuses. Statuses of successful invocations are available for up to 24 hours. Statuses of failed invocations are available for up to 48 hours. This endpoint may only fetch up to 2000 invocations, and should not be treated as a representation of the full history of invocations. * @summary List latest invocation statuses * @param {TriggersApiListTriggerInvocationStatusV1Request} requestParameters Request parameters. * @param {*} [axiosOptions] Override http request option. * @throws {RequiredError} * @memberof TriggersApi */ public listTriggerInvocationStatusV1(requestParameters: TriggersApiListTriggerInvocationStatusV1Request = {}, axiosOptions?: RawAxiosRequestConfig) { return TriggersApiFp(this.configuration).listTriggerInvocationStatusV1(requestParameters.limit, requestParameters.offset, requestParameters.count, requestParameters.filters, requestParameters.sorters, axiosOptions).then((request) => request(this.axios, this.basePath)); } /** * Gets a list of triggers that are available in the tenant. * @summary List triggers * @param {TriggersApiListTriggersV1Request} requestParameters Request parameters. * @param {*} [axiosOptions] Override http request option. * @throws {RequiredError} * @memberof TriggersApi */ public listTriggersV1(requestParameters: TriggersApiListTriggersV1Request = {}, axiosOptions?: RawAxiosRequestConfig) { return TriggersApiFp(this.configuration).listTriggersV1(requestParameters.limit, requestParameters.offset, requestParameters.count, requestParameters.filters, requestParameters.sorters, axiosOptions).then((request) => request(this.axios, this.basePath)); } /** * This API updates a trigger subscription in IdentityNow, using a set of instructions to modify a subscription partially. The following fields are patchable: **name**, **description**, **enabled**, **type**, **filter**, **responseDeadline**, **httpConfig**, **eventBridgeConfig**, **workflowConfig** * @summary Patch a subscription * @param {TriggersApiPatchSubscriptionV1Request} requestParameters Request parameters. * @param {*} [axiosOptions] Override http request option. * @throws {RequiredError} * @memberof TriggersApi */ public patchSubscriptionV1(requestParameters: TriggersApiPatchSubscriptionV1Request, axiosOptions?: RawAxiosRequestConfig) { return TriggersApiFp(this.configuration).patchSubscriptionV1(requestParameters.id, requestParameters.subscriptionPatchRequestInner, axiosOptions).then((request) => request(this.axios, this.basePath)); } /** * Initiate a test event for all subscribers of the specified event trigger. If there are no subscribers to the specified trigger in the tenant, then no test event will be sent. * @summary Start a test invocation * @param {TriggersApiStartTestTriggerInvocationV1Request} requestParameters Request parameters. * @param {*} [axiosOptions] Override http request option. * @throws {RequiredError} * @memberof TriggersApi */ public startTestTriggerInvocationV1(requestParameters: TriggersApiStartTestTriggerInvocationV1Request, axiosOptions?: RawAxiosRequestConfig) { return TriggersApiFp(this.configuration).startTestTriggerInvocationV1(requestParameters.testInvocation, axiosOptions).then((request) => request(this.axios, this.basePath)); } /** * Validates a JSONPath filter expression against a provided mock input. Request requires a security scope of: * @summary Validate a subscription filter * @param {TriggersApiTestSubscriptionFilterV1Request} requestParameters Request parameters. * @param {*} [axiosOptions] Override http request option. * @throws {RequiredError} * @memberof TriggersApi */ public testSubscriptionFilterV1(requestParameters: TriggersApiTestSubscriptionFilterV1Request, axiosOptions?: RawAxiosRequestConfig) { return TriggersApiFp(this.configuration).testSubscriptionFilterV1(requestParameters.validateFilterInputDto, axiosOptions).then((request) => request(this.axios, this.basePath)); } /** * This API updates a trigger subscription in IdentityNow, using a full object representation. In other words, the existing Subscription is completely replaced. The following fields are immutable: * id * triggerId Attempts to modify these fields result in 400. * @summary Update a subscription * @param {TriggersApiUpdateSubscriptionV1Request} requestParameters Request parameters. * @param {*} [axiosOptions] Override http request option. * @throws {RequiredError} * @memberof TriggersApi */ public updateSubscriptionV1(requestParameters: TriggersApiUpdateSubscriptionV1Request, axiosOptions?: RawAxiosRequestConfig) { return TriggersApiFp(this.configuration).updateSubscriptionV1(requestParameters.id, requestParameters.subscriptionPutRequest, axiosOptions).then((request) => request(this.axios, this.basePath)); } }