/* tslint:disable */ /* eslint-disable */ /** * Identity Security Cloud API - Identities * 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'; /** * * @export * @interface AccessRequestContext */ export interface AccessRequestContext { /** * * @type {Array} * @memberof AccessRequestContext */ 'contextAttributes'?: Array; } /** * * @export * @interface AccountInfoDto */ export interface AccountInfoDto { /** * The unique ID of the account generated by the source system * @type {string} * @memberof AccountInfoDto */ 'nativeIdentity'?: string; /** * Display name for this account * @type {string} * @memberof AccountInfoDto */ 'displayName'?: string; /** * UUID associated with this account * @type {string} * @memberof AccountInfoDto */ 'uuid'?: string; } /** * * @export * @interface AssignmentContextDto */ export interface AssignmentContextDto { /** * * @type {AccessRequestContext} * @memberof AssignmentContextDto */ 'requested'?: AccessRequestContext; /** * * @type {Array} * @memberof AssignmentContextDto */ 'matched'?: Array; /** * Date that the assignment will was evaluated * @type {string} * @memberof AssignmentContextDto */ 'computedDate'?: string; } /** * * @export * @interface BaseReferenceDto */ export interface BaseReferenceDto { /** * * @type {DtoType} * @memberof BaseReferenceDto */ 'type'?: DtoType; /** * ID of the object to which this reference applies * @type {string} * @memberof BaseReferenceDto */ 'id'?: string; /** * Human-readable display name of the object to which this reference applies * @type {string} * @memberof BaseReferenceDto */ 'name'?: string; } /** * * @export * @interface ContextAttributeDto */ export interface ContextAttributeDto { /** * The name of the attribute * @type {string} * @memberof ContextAttributeDto */ 'attribute'?: string; /** * * @type {ContextAttributeDtoValue} * @memberof ContextAttributeDto */ 'value'?: ContextAttributeDtoValue; /** * True if the attribute was derived. * @type {boolean} * @memberof ContextAttributeDto */ 'derived'?: boolean; } /** * @type ContextAttributeDtoValue * The value of the attribute. This can be either a string or a multi-valued string * @export */ export type ContextAttributeDtoValue = Array | string; /** * An enumeration of the types of DTOs supported within the IdentityNow infrastructure. * @export * @enum {string} */ export const DtoType = { AccountCorrelationConfig: 'ACCOUNT_CORRELATION_CONFIG', AccessProfile: 'ACCESS_PROFILE', AccessRequestApproval: 'ACCESS_REQUEST_APPROVAL', Account: 'ACCOUNT', Application: 'APPLICATION', Campaign: 'CAMPAIGN', CampaignFilter: 'CAMPAIGN_FILTER', Certification: 'CERTIFICATION', Cluster: 'CLUSTER', ConnectorSchema: 'CONNECTOR_SCHEMA', Entitlement: 'ENTITLEMENT', GovernanceGroup: 'GOVERNANCE_GROUP', Identity: 'IDENTITY', IdentityProfile: 'IDENTITY_PROFILE', IdentityRequest: 'IDENTITY_REQUEST', MachineIdentity: 'MACHINE_IDENTITY', LifecycleState: 'LIFECYCLE_STATE', PasswordPolicy: 'PASSWORD_POLICY', Role: 'ROLE', Rule: 'RULE', SodPolicy: 'SOD_POLICY', Source: 'SOURCE', Tag: 'TAG', TagCategory: 'TAG_CATEGORY', TaskResult: 'TASK_RESULT', ReportResult: 'REPORT_RESULT', SodViolation: 'SOD_VIOLATION', AccountActivity: 'ACCOUNT_ACTIVITY', Workgroup: 'WORKGROUP' } as const; export type DtoType = typeof DtoType[keyof typeof DtoType]; /** * * @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 GetRoleAssignmentsV1200ResponseInner */ export interface GetRoleAssignmentsV1200ResponseInner { /** * Assignment Id * @type {string} * @memberof GetRoleAssignmentsV1200ResponseInner */ 'id'?: string; /** * * @type {BaseReferenceDto} * @memberof GetRoleAssignmentsV1200ResponseInner */ 'role'?: BaseReferenceDto; /** * Date that the assignment was added * @type {string} * @memberof GetRoleAssignmentsV1200ResponseInner */ 'addedDate'?: string; /** * Date when assignment will be active, if access was requested with a future start date. If null, assignment is active immediately * @type {string} * @memberof GetRoleAssignmentsV1200ResponseInner */ 'startDate'?: string | null; /** * Date that the assignment will be removed * @type {string} * @memberof GetRoleAssignmentsV1200ResponseInner */ 'removeDate'?: string | null; /** * Comments added by the user when the assignment was made * @type {string} * @memberof GetRoleAssignmentsV1200ResponseInner */ 'comments'?: string | null; /** * Source describing how this assignment was made * @type {string} * @memberof GetRoleAssignmentsV1200ResponseInner */ 'assignmentSource'?: string; /** * * @type {RoleAssignmentDtoAssigner} * @memberof GetRoleAssignmentsV1200ResponseInner */ 'assigner'?: RoleAssignmentDtoAssigner; /** * Dimensions assigned related to this role * @type {Array} * @memberof GetRoleAssignmentsV1200ResponseInner */ 'assignedDimensions'?: Array; /** * * @type {RoleAssignmentDtoAssignmentContext} * @memberof GetRoleAssignmentsV1200ResponseInner */ 'assignmentContext'?: RoleAssignmentDtoAssignmentContext; /** * * @type {Array} * @memberof GetRoleAssignmentsV1200ResponseInner */ 'accountTargets'?: Array; } /** * * @export * @interface Identity */ export interface Identity { /** * System-generated unique ID of the identity * @type {string} * @memberof Identity */ 'id'?: string; /** * The identity\'s name is equivalent to its Display Name attribute. * @type {string} * @memberof Identity */ 'name': string; /** * Creation date of the identity * @type {string} * @memberof Identity */ 'created'?: string; /** * Last modification date of the identity * @type {string} * @memberof Identity */ 'modified'?: string; /** * The identity\'s alternate unique identifier is equivalent to its Account Name on the authoritative source account schema. * @type {string} * @memberof Identity */ 'alias'?: string; /** * The email address of the identity * @type {string} * @memberof Identity */ 'emailAddress'?: string | null; /** * The processing state of the identity * @type {string} * @memberof Identity */ 'processingState'?: IdentityProcessingStateEnum | null; /** * The identity\'s status in the system * @type {string} * @memberof Identity */ 'identityStatus'?: IdentityIdentityStatusEnum; /** * * @type {IdentityManagerRef} * @memberof Identity */ 'managerRef'?: IdentityManagerRef | null; /** * Whether this identity is a manager of another identity * @type {boolean} * @memberof Identity */ 'isManager'?: boolean; /** * The last time the identity was refreshed by the system * @type {string} * @memberof Identity */ 'lastRefresh'?: string; /** * A map with the identity attributes for the identity * @type {object} * @memberof Identity */ 'attributes'?: object; /** * * @type {IdentityLifecycleState} * @memberof Identity */ 'lifecycleState'?: IdentityLifecycleState; } export const IdentityProcessingStateEnum = { Error: 'ERROR', Ok: 'OK' } as const; export type IdentityProcessingStateEnum = typeof IdentityProcessingStateEnum[keyof typeof IdentityProcessingStateEnum]; export const IdentityIdentityStatusEnum = { Unregistered: 'UNREGISTERED', Registered: 'REGISTERED', Pending: 'PENDING', Warning: 'WARNING', Disabled: 'DISABLED', Active: 'ACTIVE', Deactivated: 'DEACTIVATED', Terminated: 'TERMINATED', Error: 'ERROR', Locked: 'LOCKED' } as const; export type IdentityIdentityStatusEnum = typeof IdentityIdentityStatusEnum[keyof typeof IdentityIdentityStatusEnum]; /** * * @export * @interface IdentityAssociationDetails */ export interface IdentityAssociationDetails { /** * any additional context information of the http call result * @type {string} * @memberof IdentityAssociationDetails */ 'message'?: string; /** * list of all the resource associations for the identity * @type {Array} * @memberof IdentityAssociationDetails */ 'associationDetails'?: Array; } /** * * @export * @interface IdentityAssociationDetailsAssociationDetailsInner */ export interface IdentityAssociationDetailsAssociationDetailsInner { /** * association type with the identity * @type {string} * @memberof IdentityAssociationDetailsAssociationDetailsInner */ 'associationType'?: string; /** * the specific resource this identity has ownership on * @type {Array} * @memberof IdentityAssociationDetailsAssociationDetailsInner */ 'entities'?: Array; } /** * * @export * @interface IdentityEntities */ export interface IdentityEntities { /** * * @type {IdentityEntitiesIdentityEntity} * @memberof IdentityEntities */ 'identityEntity'?: IdentityEntitiesIdentityEntity; } /** * * @export * @interface IdentityEntitiesIdentityEntity */ export interface IdentityEntitiesIdentityEntity { /** * id of the resource to which the identity is associated * @type {string} * @memberof IdentityEntitiesIdentityEntity */ 'id'?: string; /** * name of the resource to which the identity is associated * @type {string} * @memberof IdentityEntitiesIdentityEntity */ 'name'?: string; /** * type of the resource to which the identity is associated * @type {string} * @memberof IdentityEntitiesIdentityEntity */ 'type'?: string; } /** * * @export * @interface IdentityEntitlements */ export interface IdentityEntitlements { /** * * @type {TaggedObjectDto} * @memberof IdentityEntitlements */ 'objectRef'?: TaggedObjectDto; /** * Labels to be applied to object. * @type {Array} * @memberof IdentityEntitlements */ 'tags'?: Array; } /** * * @export * @interface IdentityLifecycleState */ export interface IdentityLifecycleState { /** * The name of the lifecycle state * @type {string} * @memberof IdentityLifecycleState */ 'stateName': string; /** * Whether the lifecycle state has been manually or automatically set * @type {boolean} * @memberof IdentityLifecycleState */ 'manuallyUpdated': boolean; } /** * Identity\'s manager * @export * @interface IdentityManagerRef */ export interface IdentityManagerRef { /** * DTO type of identity\'s manager * @type {string} * @memberof IdentityManagerRef */ 'type'?: IdentityManagerRefTypeEnum; /** * ID of identity\'s manager * @type {string} * @memberof IdentityManagerRef */ 'id'?: string; /** * Human-readable display name of identity\'s manager * @type {string} * @memberof IdentityManagerRef */ 'name'?: string; } export const IdentityManagerRefTypeEnum = { Identity: 'IDENTITY' } as const; export type IdentityManagerRefTypeEnum = typeof IdentityManagerRefTypeEnum[keyof typeof IdentityManagerRefTypeEnum]; /** * * @export * @interface IdentityOwnershipAssociationDetails */ export interface IdentityOwnershipAssociationDetails { /** * list of all the resource associations for the identity * @type {Array} * @memberof IdentityOwnershipAssociationDetails */ 'associationDetails'?: Array; } /** * * @export * @interface IdentityOwnershipAssociationDetailsAssociationDetailsInner */ export interface IdentityOwnershipAssociationDetailsAssociationDetailsInner { /** * association type with the identity * @type {string} * @memberof IdentityOwnershipAssociationDetailsAssociationDetailsInner */ 'associationType'?: string; /** * the specific resource this identity has ownership on * @type {Array} * @memberof IdentityOwnershipAssociationDetailsAssociationDetailsInner */ 'entities'?: Array; } /** * * @export * @interface IdentitySyncJob */ export interface IdentitySyncJob { /** * Job ID. * @type {string} * @memberof IdentitySyncJob */ 'id': string; /** * The job status. * @type {string} * @memberof IdentitySyncJob */ 'status': IdentitySyncJobStatusEnum; /** * * @type {IdentitySyncPayload} * @memberof IdentitySyncJob */ 'payload': IdentitySyncPayload; } export const IdentitySyncJobStatusEnum = { Queued: 'QUEUED', InProgress: 'IN_PROGRESS', Success: 'SUCCESS', Error: 'ERROR' } as const; export type IdentitySyncJobStatusEnum = typeof IdentitySyncJobStatusEnum[keyof typeof IdentitySyncJobStatusEnum]; /** * * @export * @interface IdentitySyncPayload */ export interface IdentitySyncPayload { /** * Payload type. * @type {string} * @memberof IdentitySyncPayload */ 'type': string; /** * Payload type. * @type {string} * @memberof IdentitySyncPayload */ 'dataJson': string; } /** * * @export * @interface InviteIdentitiesRequest */ export interface InviteIdentitiesRequest { /** * The list of Identities IDs to invite - required when \'uninvited\' is false * @type {Array} * @memberof InviteIdentitiesRequest */ 'ids'?: Array | null; /** * indicator (optional) to invite all unregistered identities in the system within a limit 1000. This parameter makes sense only when \'ids\' is empty. * @type {boolean} * @memberof InviteIdentitiesRequest */ 'uninvited'?: boolean; } /** * * @export * @interface LifecycleStateDto */ export interface LifecycleStateDto { /** * The name of the lifecycle state * @type {string} * @memberof LifecycleStateDto */ 'stateName': string; /** * Whether the lifecycle state has been manually or automatically set * @type {boolean} * @memberof LifecycleStateDto */ 'manuallyUpdated': boolean; } /** * * @export * @interface ListIdentitiesV1401Response */ export interface ListIdentitiesV1401Response { /** * A message describing the error * @type {any} * @memberof ListIdentitiesV1401Response */ 'error'?: any; } /** * * @export * @interface ListIdentitiesV1429Response */ export interface ListIdentitiesV1429Response { /** * A message describing the error * @type {any} * @memberof ListIdentitiesV1429Response */ '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 ProcessIdentitiesRequest */ export interface ProcessIdentitiesRequest { /** * List of up to 250 identity IDs to process. * @type {Array} * @memberof ProcessIdentitiesRequest */ 'identityIds'?: Array; } /** * * @export * @interface RoleAssignmentDto */ export interface RoleAssignmentDto { /** * Assignment Id * @type {string} * @memberof RoleAssignmentDto */ 'id'?: string; /** * * @type {BaseReferenceDto} * @memberof RoleAssignmentDto */ 'role'?: BaseReferenceDto; /** * Comments added by the user when the assignment was made * @type {string} * @memberof RoleAssignmentDto */ 'comments'?: string | null; /** * Source describing how this assignment was made * @type {string} * @memberof RoleAssignmentDto */ 'assignmentSource'?: string; /** * * @type {RoleAssignmentDtoAssigner} * @memberof RoleAssignmentDto */ 'assigner'?: RoleAssignmentDtoAssigner; /** * Dimensions assigned related to this role * @type {Array} * @memberof RoleAssignmentDto */ 'assignedDimensions'?: Array; /** * * @type {RoleAssignmentDtoAssignmentContext} * @memberof RoleAssignmentDto */ 'assignmentContext'?: RoleAssignmentDtoAssignmentContext; /** * * @type {Array} * @memberof RoleAssignmentDto */ 'accountTargets'?: Array; /** * Date when assignment will be active, if access was requested with a future start date. If null, assignment is active immediately * @type {string} * @memberof RoleAssignmentDto */ 'startDate'?: string | null; /** * Date that the assignment will be removed * @type {string} * @memberof RoleAssignmentDto */ 'removeDate'?: string | null; /** * Date that the assignment was added * @type {string} * @memberof RoleAssignmentDto */ 'addedDate'?: string; } /** * The identity that performed the assignment. This could be blank or system * @export * @interface RoleAssignmentDtoAssigner */ export interface RoleAssignmentDtoAssigner { /** * Object type * @type {string} * @memberof RoleAssignmentDtoAssigner */ 'type'?: RoleAssignmentDtoAssignerTypeEnum; /** * ID of the object to which this reference applies * @type {string} * @memberof RoleAssignmentDtoAssigner */ 'id'?: string; /** * Human-readable display name of the object to which this reference applies * @type {string} * @memberof RoleAssignmentDtoAssigner */ 'name'?: string | null; } export const RoleAssignmentDtoAssignerTypeEnum = { Identity: 'IDENTITY', Unknown: 'UNKNOWN' } as const; export type RoleAssignmentDtoAssignerTypeEnum = typeof RoleAssignmentDtoAssignerTypeEnum[keyof typeof RoleAssignmentDtoAssignerTypeEnum]; /** * * @export * @interface RoleAssignmentDtoAssignmentContext */ export interface RoleAssignmentDtoAssignmentContext { /** * * @type {AccessRequestContext} * @memberof RoleAssignmentDtoAssignmentContext */ 'requested'?: AccessRequestContext; /** * * @type {Array} * @memberof RoleAssignmentDtoAssignmentContext */ 'matched'?: Array; /** * Date that the assignment will was evaluated * @type {string} * @memberof RoleAssignmentDtoAssignmentContext */ 'computedDate'?: string; } /** * * @export * @interface RoleAssignmentRef */ export interface RoleAssignmentRef { /** * Assignment Id * @type {string} * @memberof RoleAssignmentRef */ 'id'?: string; /** * * @type {BaseReferenceDto} * @memberof RoleAssignmentRef */ 'role'?: BaseReferenceDto; /** * Date that the assignment was added * @type {string} * @memberof RoleAssignmentRef */ 'addedDate'?: string; /** * Date when assignment will be active, if requested with a future date. If null, assignment is active immediately * @type {string} * @memberof RoleAssignmentRef */ 'startDate'?: string | null; /** * Date that the assignment will be removed * @type {string} * @memberof RoleAssignmentRef */ 'removeDate'?: string | null; } /** * * @export * @interface RoleMatchDto */ export interface RoleMatchDto { /** * * @type {BaseReferenceDto} * @memberof RoleMatchDto */ 'roleRef'?: BaseReferenceDto; /** * * @type {Array} * @memberof RoleMatchDto */ 'matchedAttributes'?: Array; } /** * * @export * @interface RoleTargetDto */ export interface RoleTargetDto { /** * * @type {BaseReferenceDto} * @memberof RoleTargetDto */ 'source'?: BaseReferenceDto; /** * * @type {AccountInfoDto} * @memberof RoleTargetDto */ 'accountInfo'?: AccountInfoDto; /** * * @type {BaseReferenceDto} * @memberof RoleTargetDto */ 'role'?: BaseReferenceDto; } /** * * @export * @interface SendAccountVerificationRequest */ export interface SendAccountVerificationRequest { /** * The source name where identity account password should be reset * @type {string} * @memberof SendAccountVerificationRequest */ 'sourceName'?: string | null; /** * The method to send notification * @type {string} * @memberof SendAccountVerificationRequest */ 'via': SendAccountVerificationRequestViaEnum; } export const SendAccountVerificationRequestViaEnum = { EmailWork: 'EMAIL_WORK', EmailPersonal: 'EMAIL_PERSONAL', LinkWork: 'LINK_WORK', LinkPersonal: 'LINK_PERSONAL' } as const; export type SendAccountVerificationRequestViaEnum = typeof SendAccountVerificationRequestViaEnum[keyof typeof SendAccountVerificationRequestViaEnum]; /** * * @export * @interface TaggedObjectDto */ export interface TaggedObjectDto { /** * DTO type * @type {string} * @memberof TaggedObjectDto */ 'type'?: TaggedObjectDtoTypeEnum; /** * ID of the object this reference applies to * @type {string} * @memberof TaggedObjectDto */ 'id'?: string; /** * Human-readable display name of the object this reference applies to * @type {string} * @memberof TaggedObjectDto */ 'name'?: string | null; } export const TaggedObjectDtoTypeEnum = { AccessProfile: 'ACCESS_PROFILE', Application: 'APPLICATION', Campaign: 'CAMPAIGN', Entitlement: 'ENTITLEMENT', Identity: 'IDENTITY', Role: 'ROLE', SodPolicy: 'SOD_POLICY', Source: 'SOURCE' } as const; export type TaggedObjectDtoTypeEnum = typeof TaggedObjectDtoTypeEnum[keyof typeof TaggedObjectDtoTypeEnum]; /** * * @export * @interface Target */ export interface Target { /** * Target ID * @type {string} * @memberof Target */ 'id'?: string; /** * Target type * @type {string} * @memberof Target */ 'type'?: TargetTypeEnum | null; /** * Target name * @type {string} * @memberof Target */ 'name'?: string; } export const TargetTypeEnum = { Application: 'APPLICATION', Identity: 'IDENTITY' } as const; export type TargetTypeEnum = typeof TargetTypeEnum[keyof typeof TargetTypeEnum]; /** * Definition of a type of task, used to invoke tasks * @export * @interface TaskDefinitionSummary */ export interface TaskDefinitionSummary { /** * System-generated unique ID of the TaskDefinition * @type {string} * @memberof TaskDefinitionSummary */ 'id': string; /** * Name of the TaskDefinition * @type {string} * @memberof TaskDefinitionSummary */ 'uniqueName': string; /** * Description of the TaskDefinition * @type {string} * @memberof TaskDefinitionSummary */ 'description': string | null; /** * Name of the parent of the TaskDefinition * @type {string} * @memberof TaskDefinitionSummary */ 'parentName': string; /** * Executor of the TaskDefinition * @type {string} * @memberof TaskDefinitionSummary */ 'executor': string | null; /** * Formal parameters of the TaskDefinition, without values * @type {{ [key: string]: any; }} * @memberof TaskDefinitionSummary */ 'arguments': { [key: string]: any; }; } /** * * @export * @interface TaskResultResponse */ export interface TaskResultResponse { /** * the type of response reference * @type {string} * @memberof TaskResultResponse */ 'type'?: string; /** * the task ID * @type {string} * @memberof TaskResultResponse */ 'id'?: string; /** * the task name (not used in this endpoint, always null) * @type {string} * @memberof TaskResultResponse */ 'name'?: string; } /** * Task return details * @export * @interface TaskReturnDetails */ export interface TaskReturnDetails { /** * Display name of the TaskReturnDetails * @type {string} * @memberof TaskReturnDetails */ 'name': string; /** * Attribute the TaskReturnDetails is for * @type {string} * @memberof TaskReturnDetails */ 'attributeName': string; } /** * Details and current status of a specific task * @export * @interface TaskStatus */ export interface TaskStatus { /** * System-generated unique ID of the task this TaskStatus represents * @type {string} * @memberof TaskStatus */ 'id': string; /** * Type of task this TaskStatus represents * @type {string} * @memberof TaskStatus */ 'type': TaskStatusTypeEnum; /** * Name of the task this TaskStatus represents * @type {string} * @memberof TaskStatus */ 'uniqueName': string; /** * Description of the task this TaskStatus represents * @type {string} * @memberof TaskStatus */ 'description': string; /** * Name of the parent of the task this TaskStatus represents * @type {string} * @memberof TaskStatus */ 'parentName': string | null; /** * Service to execute the task this TaskStatus represents * @type {string} * @memberof TaskStatus */ 'launcher': string; /** * * @type {Target} * @memberof TaskStatus */ 'target'?: Target | null; /** * Creation date of the task this TaskStatus represents * @type {string} * @memberof TaskStatus */ 'created': string; /** * Last modification date of the task this TaskStatus represents * @type {string} * @memberof TaskStatus */ 'modified': string | null; /** * Launch date of the task this TaskStatus represents * @type {string} * @memberof TaskStatus */ 'launched': string | null; /** * Completion date of the task this TaskStatus represents * @type {string} * @memberof TaskStatus */ 'completed': string | null; /** * Completion status of the task this TaskStatus represents * @type {string} * @memberof TaskStatus */ 'completionStatus': TaskStatusCompletionStatusEnum | null; /** * Messages associated with the task this TaskStatus represents * @type {Array} * @memberof TaskStatus */ 'messages': Array; /** * Return values from the task this TaskStatus represents * @type {Array} * @memberof TaskStatus */ 'returns': Array; /** * Attributes of the task this TaskStatus represents * @type {{ [key: string]: any; }} * @memberof TaskStatus */ 'attributes': { [key: string]: any; }; /** * Current progress of the task this TaskStatus represents * @type {string} * @memberof TaskStatus */ 'progress': string | null; /** * Current percentage completion of the task this TaskStatus represents * @type {number} * @memberof TaskStatus */ 'percentComplete': number; /** * * @type {TaskDefinitionSummary} * @memberof TaskStatus */ 'taskDefinitionSummary'?: TaskDefinitionSummary; } export const TaskStatusTypeEnum = { Quartz: 'QUARTZ', Qpoc: 'QPOC', QueuedTask: 'QUEUED_TASK' } as const; export type TaskStatusTypeEnum = typeof TaskStatusTypeEnum[keyof typeof TaskStatusTypeEnum]; export const TaskStatusCompletionStatusEnum = { Success: 'SUCCESS', Warning: 'WARNING', Error: 'ERROR', Terminated: 'TERMINATED', Temperror: 'TEMPERROR' } as const; export type TaskStatusCompletionStatusEnum = typeof TaskStatusCompletionStatusEnum[keyof typeof TaskStatusCompletionStatusEnum]; /** * TaskStatus Message * @export * @interface TaskStatusMessage */ export interface TaskStatusMessage { /** * Type of the message * @type {string} * @memberof TaskStatusMessage */ 'type': TaskStatusMessageTypeEnum; /** * * @type {LocalizedMessage} * @memberof TaskStatusMessage */ 'localizedText': LocalizedMessage | null; /** * Key of the message * @type {string} * @memberof TaskStatusMessage */ 'key': string; /** * Message parameters for internationalization * @type {Array} * @memberof TaskStatusMessage */ 'parameters': Array | null; } export const TaskStatusMessageTypeEnum = { Info: 'INFO', Warn: 'WARN', Error: 'ERROR' } as const; export type TaskStatusMessageTypeEnum = typeof TaskStatusMessageTypeEnum[keyof typeof TaskStatusMessageTypeEnum]; /** * * @export * @interface TaskStatusMessageParametersInner */ export interface TaskStatusMessageParametersInner { } /** * IdentitiesApi - axios parameter creator * @export */ export const IdentitiesApiAxiosParamCreator = function (configuration?: Configuration) { return { /** * The API returns successful response if the requested identity was deleted. * @summary Delete identity * @param {string} id Identity Id * @param {*} [axiosOptions] Override http request option. * @throws {RequiredError} */ deleteIdentityV1: async (id: string, axiosOptions: RawAxiosRequestConfig = {}): Promise => { // verify required parameter 'id' is not null or undefined assertParamExists('deleteIdentityV1', 'id', id) const localVarPath = `/identities/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, }; }, /** * Use this API to return an identity\'s owned objects that will cause problems for deleting the identity. Use this API as a checklist of objects that you need to reassign to a different identity before you can delete the identity. For a full list of objects owned by an identity, use the [Search API](https://developer.sailpoint.com/docs/api/search-post-v-1). When you search for identities, the returned identities have a property, `owns`, that contains a more comprehensive list of identity\'s owned objects. * @summary Get ownership details * @param {string} identityId Identity ID. * @param {*} [axiosOptions] Override http request option. * @throws {RequiredError} */ getIdentityOwnershipDetailsV1: async (identityId: string, axiosOptions: RawAxiosRequestConfig = {}): Promise => { // verify required parameter 'identityId' is not null or undefined assertParamExists('getIdentityOwnershipDetailsV1', 'identityId', identityId) const localVarPath = `/identities/v1/{identityId}/ownership` .replace(`{${"identityId"}}`, encodeURIComponent(String(identityId))); // 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; setSearchParams(localVarUrlObj, localVarQueryParameter); let headersFromBaseOptions = baseOptions && baseOptions.headers ? baseOptions.headers : {}; localVarRequestOptions.headers = {...localVarHeaderParameter, ...headersFromBaseOptions, ...axiosOptions.headers}; return { url: toPathString(localVarUrlObj), axiosOptions: localVarRequestOptions, }; }, /** * This API returns a single identity using the Identity ID. * @summary Identity details * @param {string} id Identity Id * @param {*} [axiosOptions] Override http request option. * @throws {RequiredError} */ getIdentityV1: async (id: string, axiosOptions: RawAxiosRequestConfig = {}): Promise => { // verify required parameter 'id' is not null or undefined assertParamExists('getIdentityV1', 'id', id) const localVarPath = `/identities/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: 'GET', ...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, }; }, /** * * @summary Role assignment details * @param {string} identityId Identity Id * @param {string} assignmentId Assignment Id * @param {*} [axiosOptions] Override http request option. * @throws {RequiredError} */ getRoleAssignmentV1: async (identityId: string, assignmentId: string, axiosOptions: RawAxiosRequestConfig = {}): Promise => { // verify required parameter 'identityId' is not null or undefined assertParamExists('getRoleAssignmentV1', 'identityId', identityId) // verify required parameter 'assignmentId' is not null or undefined assertParamExists('getRoleAssignmentV1', 'assignmentId', assignmentId) const localVarPath = `/identities/v1/{identityId}/role-assignments/{assignmentId}` .replace(`{${"identityId"}}`, encodeURIComponent(String(identityId))) .replace(`{${"assignmentId"}}`, encodeURIComponent(String(assignmentId))); // 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; setSearchParams(localVarUrlObj, localVarQueryParameter); let headersFromBaseOptions = baseOptions && baseOptions.headers ? baseOptions.headers : {}; localVarRequestOptions.headers = {...localVarHeaderParameter, ...headersFromBaseOptions, ...axiosOptions.headers}; return { url: toPathString(localVarUrlObj), axiosOptions: localVarRequestOptions, }; }, /** * This returns either a list of Role Assignments when querying with either a Role Id or Role Name, or a list of Role Assignment References if querying with only identity Id. * @summary List role assignments * @param {string} identityId Identity Id to get the role assignments for * @param {string} [roleId] Role Id to filter the role assignments with * @param {string} [roleName] Role name to filter the role assignments with * @param {*} [axiosOptions] Override http request option. * @throws {RequiredError} */ getRoleAssignmentsV1: async (identityId: string, roleId?: string, roleName?: string, axiosOptions: RawAxiosRequestConfig = {}): Promise => { // verify required parameter 'identityId' is not null or undefined assertParamExists('getRoleAssignmentsV1', 'identityId', identityId) const localVarPath = `/identities/v1/{identityId}/role-assignments` .replace(`{${"identityId"}}`, encodeURIComponent(String(identityId))); // 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 (roleId !== undefined) { localVarQueryParameter['roleId'] = roleId; } if (roleName !== undefined) { localVarQueryParameter['roleName'] = roleName; } setSearchParams(localVarUrlObj, localVarQueryParameter); let headersFromBaseOptions = baseOptions && baseOptions.headers ? baseOptions.headers : {}; localVarRequestOptions.headers = {...localVarHeaderParameter, ...headersFromBaseOptions, ...axiosOptions.headers}; return { url: toPathString(localVarUrlObj), axiosOptions: localVarRequestOptions, }; }, /** * The API returns a list of all entitlements assigned to an identity, either directly or through the role or access profile. A token with ORG_ADMIN or API authority is required to call this API. * @summary List of entitlements by identity. * @param {string} id Identity Id * @param {number} [limit] Max number of results to return. See [V3 API Standard Collection Parameters](https://developer.sailpoint.com/idn/api/standard-collection-parameters) for more information. * @param {number} [offset] Offset into the full result set. Usually specified with *limit* to paginate through the results. See [V3 API Standard Collection Parameters](https://developer.sailpoint.com/idn/api/standard-collection-parameters) for more information. * @param {boolean} [count] If *true* it will populate the *X-Total-Count* response header with the number of results that would be returned if *limit* and *offset* were ignored. Since requesting a total count can have a performance impact, it is recommended not to send **count=true** if that value will not be used. See [V3 API Standard Collection Parameters](https://developer.sailpoint.com/idn/api/standard-collection-parameters) for more information. * @param {*} [axiosOptions] Override http request option. * @throws {RequiredError} */ listEntitlementsByIdentityV1: async (id: string, limit?: number, offset?: number, count?: boolean, axiosOptions: RawAxiosRequestConfig = {}): Promise => { // verify required parameter 'id' is not null or undefined assertParamExists('listEntitlementsByIdentityV1', 'id', id) const localVarPath = `/entitlements/v1/identities/{id}/entitlements` .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: '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; } setSearchParams(localVarUrlObj, localVarQueryParameter); let headersFromBaseOptions = baseOptions && baseOptions.headers ? baseOptions.headers : {}; localVarRequestOptions.headers = {...localVarHeaderParameter, ...headersFromBaseOptions, ...axiosOptions.headers}; return { url: toPathString(localVarUrlObj), axiosOptions: localVarRequestOptions, }; }, /** * This API returns a list of identities. * @summary List identities * @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, in* **name**: *eq, sw* **alias**: *eq, sw* **firstname**: *eq, sw* **lastname**: *eq, sw* **email**: *eq, sw* **cloudStatus**: *eq* **processingState**: *eq* **correlated**: *eq* **protected**: *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: **name, alias, cloudStatus** * @param {ListIdentitiesV1DefaultFilterEnum} [defaultFilter] Adds additional filter to filters query parameter. CORRELATED_ONLY adds correlated=true and returns only identities that are correlated. NONE does not add any and returns all identities that satisfy filters query parameter. * @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 {number} [limit] Max number of results to return. See [V3 API Standard Collection Parameters](https://developer.sailpoint.com/idn/api/standard-collection-parameters) for more information. * @param {number} [offset] Offset into the full result set. Usually specified with *limit* to paginate through the results. See [V3 API Standard Collection Parameters](https://developer.sailpoint.com/idn/api/standard-collection-parameters) for more information. * @param {*} [axiosOptions] Override http request option. * @throws {RequiredError} */ listIdentitiesV1: async (filters?: string, sorters?: string, defaultFilter?: ListIdentitiesV1DefaultFilterEnum, count?: boolean, limit?: number, offset?: number, axiosOptions: RawAxiosRequestConfig = {}): Promise => { const localVarPath = `/identities/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 (filters !== undefined) { localVarQueryParameter['filters'] = filters; } if (sorters !== undefined) { localVarQueryParameter['sorters'] = sorters; } if (defaultFilter !== undefined) { localVarQueryParameter['defaultFilter'] = defaultFilter; } if (count !== undefined) { localVarQueryParameter['count'] = count; } if (limit !== undefined) { localVarQueryParameter['limit'] = limit; } if (offset !== undefined) { localVarQueryParameter['offset'] = offset; } setSearchParams(localVarUrlObj, localVarQueryParameter); let headersFromBaseOptions = baseOptions && baseOptions.headers ? baseOptions.headers : {}; localVarRequestOptions.headers = {...localVarHeaderParameter, ...headersFromBaseOptions, ...axiosOptions.headers}; return { url: toPathString(localVarUrlObj), axiosOptions: localVarRequestOptions, }; }, /** * Use this endpoint to reset a user\'s identity if they have forgotten their authentication information like their answers to knowledge-based questions. Resetting an identity de-registers the user and removes any elevated user levels they have. * @summary Reset an identity * @param {string} id Identity Id * @param {*} [axiosOptions] Override http request option. * @throws {RequiredError} */ resetIdentityV1: async (id: string, axiosOptions: RawAxiosRequestConfig = {}): Promise => { // verify required parameter 'id' is not null or undefined assertParamExists('resetIdentityV1', 'id', id) const localVarPath = `/identities/v1/{id}/reset` .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; setSearchParams(localVarUrlObj, localVarQueryParameter); let headersFromBaseOptions = baseOptions && baseOptions.headers ? baseOptions.headers : {}; localVarRequestOptions.headers = {...localVarHeaderParameter, ...headersFromBaseOptions, ...axiosOptions.headers}; return { url: toPathString(localVarUrlObj), axiosOptions: localVarRequestOptions, }; }, /** * This API sends an email with the link to start Password Reset. After selecting the link an identity will be able to set up a new password. Emails expire after 2 hours. * @summary Send password reset email * @param {string} id Identity ID * @param {SendAccountVerificationRequest} sendAccountVerificationRequest * @param {string} [xSailPointExperimental] Use this header to enable this experimental API. * @param {*} [axiosOptions] Override http request option. * @throws {RequiredError} */ sendIdentityVerificationAccountTokenV1: async (id: string, sendAccountVerificationRequest: SendAccountVerificationRequest, xSailPointExperimental?: string, axiosOptions: RawAxiosRequestConfig = {}): Promise => { // verify required parameter 'id' is not null or undefined assertParamExists('sendIdentityVerificationAccountTokenV1', 'id', id) // verify required parameter 'sendAccountVerificationRequest' is not null or undefined assertParamExists('sendIdentityVerificationAccountTokenV1', 'sendAccountVerificationRequest', sendAccountVerificationRequest) if (xSailPointExperimental === undefined) { xSailPointExperimental = 'true'; } const localVarPath = `/identities/v1/{id}/verification/account/send` .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'; if (xSailPointExperimental != null) { localVarHeaderParameter['X-SailPoint-Experimental'] = String(xSailPointExperimental); } setSearchParams(localVarUrlObj, localVarQueryParameter); let headersFromBaseOptions = baseOptions && baseOptions.headers ? baseOptions.headers : {}; localVarRequestOptions.headers = {...localVarHeaderParameter, ...headersFromBaseOptions, ...axiosOptions.headers}; localVarRequestOptions.data = serializeDataIfNeeded(sendAccountVerificationRequest, localVarRequestOptions, configuration) return { url: toPathString(localVarUrlObj), axiosOptions: localVarRequestOptions, }; }, /** * This API submits a task for inviting given identities via email to complete registration. The invitation email will include the link. After selecting the link an identity will be able to set up password and log in into the system. Invitations expire after 7 days. By default invitations send to the work identity email. It can be changed in Admin > Identities > Identity Profiles by selecting corresponding profile and editing Invitation Options. This task will send an invitation email only for unregistered identities. The executed task status can be checked by Task Management > [Get task status by ID](https://developer.sailpoint.com/docs/api/get-task-status-v-1). * @summary Invite identities to register * @param {InviteIdentitiesRequest} inviteIdentitiesRequest * @param {string} [xSailPointExperimental] Use this header to enable this experimental API. * @param {*} [axiosOptions] Override http request option. * @throws {RequiredError} */ startIdentitiesInviteV1: async (inviteIdentitiesRequest: InviteIdentitiesRequest, xSailPointExperimental?: string, axiosOptions: RawAxiosRequestConfig = {}): Promise => { // verify required parameter 'inviteIdentitiesRequest' is not null or undefined assertParamExists('startIdentitiesInviteV1', 'inviteIdentitiesRequest', inviteIdentitiesRequest) if (xSailPointExperimental === undefined) { xSailPointExperimental = 'true'; } const localVarPath = `/identities/v1/invite`; // 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'; if (xSailPointExperimental != null) { localVarHeaderParameter['X-SailPoint-Experimental'] = String(xSailPointExperimental); } setSearchParams(localVarUrlObj, localVarQueryParameter); let headersFromBaseOptions = baseOptions && baseOptions.headers ? baseOptions.headers : {}; localVarRequestOptions.headers = {...localVarHeaderParameter, ...headersFromBaseOptions, ...axiosOptions.headers}; localVarRequestOptions.data = serializeDataIfNeeded(inviteIdentitiesRequest, localVarRequestOptions, configuration) return { url: toPathString(localVarUrlObj), axiosOptions: localVarRequestOptions, }; }, /** * This operation should not be used to schedule your own identity processing or to perform system wide identity refreshes. The system will use a combination of [event-based processing](https://documentation.sailpoint.com/saas/help/setup/identity_processing.html?h=process#event-based-processing) and [scheduled processing](https://documentation.sailpoint.com/saas/help/setup/identity_processing.html?h=process#scheduled-processing) that runs every day at 8:00 AM and 8:00 PM in the tenant\'s timezone to keep your identities synchronized. This endpoint will perform the following tasks: 1. Calculate identity attributes, including applying or running any rules or transforms (e.g. calculate Lifecycle State at a point-in-time it\'s expected to change). 2. Evaluate role assignments, leading to assignment of new roles and removal of existing roles. 3. Enforce provisioning for any assigned accesses that haven\'t been fulfilled (e.g. failure due to source health). 4. Recalculate manager relationships. 5. Potentially clean-up identity processing errors, assuming the error has been resolved. * @summary Process a list of identityids * @param {ProcessIdentitiesRequest} processIdentitiesRequest * @param {string} [xSailPointExperimental] Use this header to enable this experimental API. * @param {*} [axiosOptions] Override http request option. * @throws {RequiredError} */ startIdentityProcessingV1: async (processIdentitiesRequest: ProcessIdentitiesRequest, xSailPointExperimental?: string, axiosOptions: RawAxiosRequestConfig = {}): Promise => { // verify required parameter 'processIdentitiesRequest' is not null or undefined assertParamExists('startIdentityProcessingV1', 'processIdentitiesRequest', processIdentitiesRequest) if (xSailPointExperimental === undefined) { xSailPointExperimental = 'true'; } const localVarPath = `/identities/v1/process`; // 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'; if (xSailPointExperimental != null) { localVarHeaderParameter['X-SailPoint-Experimental'] = String(xSailPointExperimental); } setSearchParams(localVarUrlObj, localVarQueryParameter); let headersFromBaseOptions = baseOptions && baseOptions.headers ? baseOptions.headers : {}; localVarRequestOptions.headers = {...localVarHeaderParameter, ...headersFromBaseOptions, ...axiosOptions.headers}; localVarRequestOptions.data = serializeDataIfNeeded(processIdentitiesRequest, localVarRequestOptions, configuration) return { url: toPathString(localVarUrlObj), axiosOptions: localVarRequestOptions, }; }, /** * This end-point performs attribute synchronization for a selected identity. The endpoint can be called once in 10 seconds per identity. * @summary Attribute synchronization for single identity. * @param {string} identityId The Identity id * @param {string} [xSailPointExperimental] Use this header to enable this experimental API. * @param {*} [axiosOptions] Override http request option. * @throws {RequiredError} */ synchronizeAttributesForIdentityV1: async (identityId: string, xSailPointExperimental?: string, axiosOptions: RawAxiosRequestConfig = {}): Promise => { // verify required parameter 'identityId' is not null or undefined assertParamExists('synchronizeAttributesForIdentityV1', 'identityId', identityId) if (xSailPointExperimental === undefined) { xSailPointExperimental = 'true'; } const localVarPath = `/identities/v1/{identityId}/synchronize-attributes` .replace(`{${"identityId"}}`, encodeURIComponent(String(identityId))); // 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; if (xSailPointExperimental != null) { localVarHeaderParameter['X-SailPoint-Experimental'] = String(xSailPointExperimental); } setSearchParams(localVarUrlObj, localVarQueryParameter); let headersFromBaseOptions = baseOptions && baseOptions.headers ? baseOptions.headers : {}; localVarRequestOptions.headers = {...localVarHeaderParameter, ...headersFromBaseOptions, ...axiosOptions.headers}; return { url: toPathString(localVarUrlObj), axiosOptions: localVarRequestOptions, }; }, } }; /** * IdentitiesApi - functional programming interface * @export */ export const IdentitiesApiFp = function(configuration?: Configuration) { const localVarAxiosParamCreator = IdentitiesApiAxiosParamCreator(configuration) return { /** * The API returns successful response if the requested identity was deleted. * @summary Delete identity * @param {string} id Identity Id * @param {*} [axiosOptions] Override http request option. * @throws {RequiredError} */ async deleteIdentityV1(id: string, axiosOptions?: RawAxiosRequestConfig): Promise<(axios?: AxiosInstance, basePath?: string) => AxiosPromise> { const localVarAxiosArgs = await localVarAxiosParamCreator.deleteIdentityV1(id, axiosOptions); const localVarOperationServerIndex = configuration?.serverIndex ?? 0; const localVarOperationServerBasePath = operationServerMap['IdentitiesApi.deleteIdentityV1']?.[localVarOperationServerIndex]?.url; return (axios, basePath) => createRequestFunction(localVarAxiosArgs, globalAxios, BASE_PATH, configuration)(axios, localVarOperationServerBasePath || basePath); }, /** * Use this API to return an identity\'s owned objects that will cause problems for deleting the identity. Use this API as a checklist of objects that you need to reassign to a different identity before you can delete the identity. For a full list of objects owned by an identity, use the [Search API](https://developer.sailpoint.com/docs/api/search-post-v-1). When you search for identities, the returned identities have a property, `owns`, that contains a more comprehensive list of identity\'s owned objects. * @summary Get ownership details * @param {string} identityId Identity ID. * @param {*} [axiosOptions] Override http request option. * @throws {RequiredError} */ async getIdentityOwnershipDetailsV1(identityId: string, axiosOptions?: RawAxiosRequestConfig): Promise<(axios?: AxiosInstance, basePath?: string) => AxiosPromise> { const localVarAxiosArgs = await localVarAxiosParamCreator.getIdentityOwnershipDetailsV1(identityId, axiosOptions); const localVarOperationServerIndex = configuration?.serverIndex ?? 0; const localVarOperationServerBasePath = operationServerMap['IdentitiesApi.getIdentityOwnershipDetailsV1']?.[localVarOperationServerIndex]?.url; return (axios, basePath) => createRequestFunction(localVarAxiosArgs, globalAxios, BASE_PATH, configuration)(axios, localVarOperationServerBasePath || basePath); }, /** * This API returns a single identity using the Identity ID. * @summary Identity details * @param {string} id Identity Id * @param {*} [axiosOptions] Override http request option. * @throws {RequiredError} */ async getIdentityV1(id: string, axiosOptions?: RawAxiosRequestConfig): Promise<(axios?: AxiosInstance, basePath?: string) => AxiosPromise> { const localVarAxiosArgs = await localVarAxiosParamCreator.getIdentityV1(id, axiosOptions); const localVarOperationServerIndex = configuration?.serverIndex ?? 0; const localVarOperationServerBasePath = operationServerMap['IdentitiesApi.getIdentityV1']?.[localVarOperationServerIndex]?.url; return (axios, basePath) => createRequestFunction(localVarAxiosArgs, globalAxios, BASE_PATH, configuration)(axios, localVarOperationServerBasePath || basePath); }, /** * * @summary Role assignment details * @param {string} identityId Identity Id * @param {string} assignmentId Assignment Id * @param {*} [axiosOptions] Override http request option. * @throws {RequiredError} */ async getRoleAssignmentV1(identityId: string, assignmentId: string, axiosOptions?: RawAxiosRequestConfig): Promise<(axios?: AxiosInstance, basePath?: string) => AxiosPromise> { const localVarAxiosArgs = await localVarAxiosParamCreator.getRoleAssignmentV1(identityId, assignmentId, axiosOptions); const localVarOperationServerIndex = configuration?.serverIndex ?? 0; const localVarOperationServerBasePath = operationServerMap['IdentitiesApi.getRoleAssignmentV1']?.[localVarOperationServerIndex]?.url; return (axios, basePath) => createRequestFunction(localVarAxiosArgs, globalAxios, BASE_PATH, configuration)(axios, localVarOperationServerBasePath || basePath); }, /** * This returns either a list of Role Assignments when querying with either a Role Id or Role Name, or a list of Role Assignment References if querying with only identity Id. * @summary List role assignments * @param {string} identityId Identity Id to get the role assignments for * @param {string} [roleId] Role Id to filter the role assignments with * @param {string} [roleName] Role name to filter the role assignments with * @param {*} [axiosOptions] Override http request option. * @throws {RequiredError} */ async getRoleAssignmentsV1(identityId: string, roleId?: string, roleName?: string, axiosOptions?: RawAxiosRequestConfig): Promise<(axios?: AxiosInstance, basePath?: string) => AxiosPromise>> { const localVarAxiosArgs = await localVarAxiosParamCreator.getRoleAssignmentsV1(identityId, roleId, roleName, axiosOptions); const localVarOperationServerIndex = configuration?.serverIndex ?? 0; const localVarOperationServerBasePath = operationServerMap['IdentitiesApi.getRoleAssignmentsV1']?.[localVarOperationServerIndex]?.url; return (axios, basePath) => createRequestFunction(localVarAxiosArgs, globalAxios, BASE_PATH, configuration)(axios, localVarOperationServerBasePath || basePath); }, /** * The API returns a list of all entitlements assigned to an identity, either directly or through the role or access profile. A token with ORG_ADMIN or API authority is required to call this API. * @summary List of entitlements by identity. * @param {string} id Identity Id * @param {number} [limit] Max number of results to return. See [V3 API Standard Collection Parameters](https://developer.sailpoint.com/idn/api/standard-collection-parameters) for more information. * @param {number} [offset] Offset into the full result set. Usually specified with *limit* to paginate through the results. See [V3 API Standard Collection Parameters](https://developer.sailpoint.com/idn/api/standard-collection-parameters) for more information. * @param {boolean} [count] If *true* it will populate the *X-Total-Count* response header with the number of results that would be returned if *limit* and *offset* were ignored. Since requesting a total count can have a performance impact, it is recommended not to send **count=true** if that value will not be used. See [V3 API Standard Collection Parameters](https://developer.sailpoint.com/idn/api/standard-collection-parameters) for more information. * @param {*} [axiosOptions] Override http request option. * @throws {RequiredError} */ async listEntitlementsByIdentityV1(id: string, limit?: number, offset?: number, count?: boolean, axiosOptions?: RawAxiosRequestConfig): Promise<(axios?: AxiosInstance, basePath?: string) => AxiosPromise>> { const localVarAxiosArgs = await localVarAxiosParamCreator.listEntitlementsByIdentityV1(id, limit, offset, count, axiosOptions); const localVarOperationServerIndex = configuration?.serverIndex ?? 0; const localVarOperationServerBasePath = operationServerMap['IdentitiesApi.listEntitlementsByIdentityV1']?.[localVarOperationServerIndex]?.url; return (axios, basePath) => createRequestFunction(localVarAxiosArgs, globalAxios, BASE_PATH, configuration)(axios, localVarOperationServerBasePath || basePath); }, /** * This API returns a list of identities. * @summary List identities * @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, in* **name**: *eq, sw* **alias**: *eq, sw* **firstname**: *eq, sw* **lastname**: *eq, sw* **email**: *eq, sw* **cloudStatus**: *eq* **processingState**: *eq* **correlated**: *eq* **protected**: *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: **name, alias, cloudStatus** * @param {ListIdentitiesV1DefaultFilterEnum} [defaultFilter] Adds additional filter to filters query parameter. CORRELATED_ONLY adds correlated=true and returns only identities that are correlated. NONE does not add any and returns all identities that satisfy filters query parameter. * @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 {number} [limit] Max number of results to return. See [V3 API Standard Collection Parameters](https://developer.sailpoint.com/idn/api/standard-collection-parameters) for more information. * @param {number} [offset] Offset into the full result set. Usually specified with *limit* to paginate through the results. See [V3 API Standard Collection Parameters](https://developer.sailpoint.com/idn/api/standard-collection-parameters) for more information. * @param {*} [axiosOptions] Override http request option. * @throws {RequiredError} */ async listIdentitiesV1(filters?: string, sorters?: string, defaultFilter?: ListIdentitiesV1DefaultFilterEnum, count?: boolean, limit?: number, offset?: number, axiosOptions?: RawAxiosRequestConfig): Promise<(axios?: AxiosInstance, basePath?: string) => AxiosPromise>> { const localVarAxiosArgs = await localVarAxiosParamCreator.listIdentitiesV1(filters, sorters, defaultFilter, count, limit, offset, axiosOptions); const localVarOperationServerIndex = configuration?.serverIndex ?? 0; const localVarOperationServerBasePath = operationServerMap['IdentitiesApi.listIdentitiesV1']?.[localVarOperationServerIndex]?.url; return (axios, basePath) => createRequestFunction(localVarAxiosArgs, globalAxios, BASE_PATH, configuration)(axios, localVarOperationServerBasePath || basePath); }, /** * Use this endpoint to reset a user\'s identity if they have forgotten their authentication information like their answers to knowledge-based questions. Resetting an identity de-registers the user and removes any elevated user levels they have. * @summary Reset an identity * @param {string} id Identity Id * @param {*} [axiosOptions] Override http request option. * @throws {RequiredError} */ async resetIdentityV1(id: string, axiosOptions?: RawAxiosRequestConfig): Promise<(axios?: AxiosInstance, basePath?: string) => AxiosPromise> { const localVarAxiosArgs = await localVarAxiosParamCreator.resetIdentityV1(id, axiosOptions); const localVarOperationServerIndex = configuration?.serverIndex ?? 0; const localVarOperationServerBasePath = operationServerMap['IdentitiesApi.resetIdentityV1']?.[localVarOperationServerIndex]?.url; return (axios, basePath) => createRequestFunction(localVarAxiosArgs, globalAxios, BASE_PATH, configuration)(axios, localVarOperationServerBasePath || basePath); }, /** * This API sends an email with the link to start Password Reset. After selecting the link an identity will be able to set up a new password. Emails expire after 2 hours. * @summary Send password reset email * @param {string} id Identity ID * @param {SendAccountVerificationRequest} sendAccountVerificationRequest * @param {string} [xSailPointExperimental] Use this header to enable this experimental API. * @param {*} [axiosOptions] Override http request option. * @throws {RequiredError} */ async sendIdentityVerificationAccountTokenV1(id: string, sendAccountVerificationRequest: SendAccountVerificationRequest, xSailPointExperimental?: string, axiosOptions?: RawAxiosRequestConfig): Promise<(axios?: AxiosInstance, basePath?: string) => AxiosPromise> { const localVarAxiosArgs = await localVarAxiosParamCreator.sendIdentityVerificationAccountTokenV1(id, sendAccountVerificationRequest, xSailPointExperimental, axiosOptions); const localVarOperationServerIndex = configuration?.serverIndex ?? 0; const localVarOperationServerBasePath = operationServerMap['IdentitiesApi.sendIdentityVerificationAccountTokenV1']?.[localVarOperationServerIndex]?.url; return (axios, basePath) => createRequestFunction(localVarAxiosArgs, globalAxios, BASE_PATH, configuration)(axios, localVarOperationServerBasePath || basePath); }, /** * This API submits a task for inviting given identities via email to complete registration. The invitation email will include the link. After selecting the link an identity will be able to set up password and log in into the system. Invitations expire after 7 days. By default invitations send to the work identity email. It can be changed in Admin > Identities > Identity Profiles by selecting corresponding profile and editing Invitation Options. This task will send an invitation email only for unregistered identities. The executed task status can be checked by Task Management > [Get task status by ID](https://developer.sailpoint.com/docs/api/get-task-status-v-1). * @summary Invite identities to register * @param {InviteIdentitiesRequest} inviteIdentitiesRequest * @param {string} [xSailPointExperimental] Use this header to enable this experimental API. * @param {*} [axiosOptions] Override http request option. * @throws {RequiredError} */ async startIdentitiesInviteV1(inviteIdentitiesRequest: InviteIdentitiesRequest, xSailPointExperimental?: string, axiosOptions?: RawAxiosRequestConfig): Promise<(axios?: AxiosInstance, basePath?: string) => AxiosPromise> { const localVarAxiosArgs = await localVarAxiosParamCreator.startIdentitiesInviteV1(inviteIdentitiesRequest, xSailPointExperimental, axiosOptions); const localVarOperationServerIndex = configuration?.serverIndex ?? 0; const localVarOperationServerBasePath = operationServerMap['IdentitiesApi.startIdentitiesInviteV1']?.[localVarOperationServerIndex]?.url; return (axios, basePath) => createRequestFunction(localVarAxiosArgs, globalAxios, BASE_PATH, configuration)(axios, localVarOperationServerBasePath || basePath); }, /** * This operation should not be used to schedule your own identity processing or to perform system wide identity refreshes. The system will use a combination of [event-based processing](https://documentation.sailpoint.com/saas/help/setup/identity_processing.html?h=process#event-based-processing) and [scheduled processing](https://documentation.sailpoint.com/saas/help/setup/identity_processing.html?h=process#scheduled-processing) that runs every day at 8:00 AM and 8:00 PM in the tenant\'s timezone to keep your identities synchronized. This endpoint will perform the following tasks: 1. Calculate identity attributes, including applying or running any rules or transforms (e.g. calculate Lifecycle State at a point-in-time it\'s expected to change). 2. Evaluate role assignments, leading to assignment of new roles and removal of existing roles. 3. Enforce provisioning for any assigned accesses that haven\'t been fulfilled (e.g. failure due to source health). 4. Recalculate manager relationships. 5. Potentially clean-up identity processing errors, assuming the error has been resolved. * @summary Process a list of identityids * @param {ProcessIdentitiesRequest} processIdentitiesRequest * @param {string} [xSailPointExperimental] Use this header to enable this experimental API. * @param {*} [axiosOptions] Override http request option. * @throws {RequiredError} */ async startIdentityProcessingV1(processIdentitiesRequest: ProcessIdentitiesRequest, xSailPointExperimental?: string, axiosOptions?: RawAxiosRequestConfig): Promise<(axios?: AxiosInstance, basePath?: string) => AxiosPromise> { const localVarAxiosArgs = await localVarAxiosParamCreator.startIdentityProcessingV1(processIdentitiesRequest, xSailPointExperimental, axiosOptions); const localVarOperationServerIndex = configuration?.serverIndex ?? 0; const localVarOperationServerBasePath = operationServerMap['IdentitiesApi.startIdentityProcessingV1']?.[localVarOperationServerIndex]?.url; return (axios, basePath) => createRequestFunction(localVarAxiosArgs, globalAxios, BASE_PATH, configuration)(axios, localVarOperationServerBasePath || basePath); }, /** * This end-point performs attribute synchronization for a selected identity. The endpoint can be called once in 10 seconds per identity. * @summary Attribute synchronization for single identity. * @param {string} identityId The Identity id * @param {string} [xSailPointExperimental] Use this header to enable this experimental API. * @param {*} [axiosOptions] Override http request option. * @throws {RequiredError} */ async synchronizeAttributesForIdentityV1(identityId: string, xSailPointExperimental?: string, axiosOptions?: RawAxiosRequestConfig): Promise<(axios?: AxiosInstance, basePath?: string) => AxiosPromise> { const localVarAxiosArgs = await localVarAxiosParamCreator.synchronizeAttributesForIdentityV1(identityId, xSailPointExperimental, axiosOptions); const localVarOperationServerIndex = configuration?.serverIndex ?? 0; const localVarOperationServerBasePath = operationServerMap['IdentitiesApi.synchronizeAttributesForIdentityV1']?.[localVarOperationServerIndex]?.url; return (axios, basePath) => createRequestFunction(localVarAxiosArgs, globalAxios, BASE_PATH, configuration)(axios, localVarOperationServerBasePath || basePath); }, } }; /** * IdentitiesApi - factory interface * @export */ export const IdentitiesApiFactory = function (configuration?: Configuration, basePath?: string, axios?: AxiosInstance) { const localVarFp = IdentitiesApiFp(configuration) return { /** * The API returns successful response if the requested identity was deleted. * @summary Delete identity * @param {IdentitiesApiDeleteIdentityV1Request} requestParameters Request parameters. * @param {*} [axiosOptions] Override http request option. * @throws {RequiredError} */ deleteIdentityV1(requestParameters: IdentitiesApiDeleteIdentityV1Request, axiosOptions?: RawAxiosRequestConfig): AxiosPromise { return localVarFp.deleteIdentityV1(requestParameters.id, axiosOptions).then((request) => request(axios, basePath)); }, /** * Use this API to return an identity\'s owned objects that will cause problems for deleting the identity. Use this API as a checklist of objects that you need to reassign to a different identity before you can delete the identity. For a full list of objects owned by an identity, use the [Search API](https://developer.sailpoint.com/docs/api/search-post-v-1). When you search for identities, the returned identities have a property, `owns`, that contains a more comprehensive list of identity\'s owned objects. * @summary Get ownership details * @param {IdentitiesApiGetIdentityOwnershipDetailsV1Request} requestParameters Request parameters. * @param {*} [axiosOptions] Override http request option. * @throws {RequiredError} */ getIdentityOwnershipDetailsV1(requestParameters: IdentitiesApiGetIdentityOwnershipDetailsV1Request, axiosOptions?: RawAxiosRequestConfig): AxiosPromise { return localVarFp.getIdentityOwnershipDetailsV1(requestParameters.identityId, axiosOptions).then((request) => request(axios, basePath)); }, /** * This API returns a single identity using the Identity ID. * @summary Identity details * @param {IdentitiesApiGetIdentityV1Request} requestParameters Request parameters. * @param {*} [axiosOptions] Override http request option. * @throws {RequiredError} */ getIdentityV1(requestParameters: IdentitiesApiGetIdentityV1Request, axiosOptions?: RawAxiosRequestConfig): AxiosPromise { return localVarFp.getIdentityV1(requestParameters.id, axiosOptions).then((request) => request(axios, basePath)); }, /** * * @summary Role assignment details * @param {IdentitiesApiGetRoleAssignmentV1Request} requestParameters Request parameters. * @param {*} [axiosOptions] Override http request option. * @throws {RequiredError} */ getRoleAssignmentV1(requestParameters: IdentitiesApiGetRoleAssignmentV1Request, axiosOptions?: RawAxiosRequestConfig): AxiosPromise { return localVarFp.getRoleAssignmentV1(requestParameters.identityId, requestParameters.assignmentId, axiosOptions).then((request) => request(axios, basePath)); }, /** * This returns either a list of Role Assignments when querying with either a Role Id or Role Name, or a list of Role Assignment References if querying with only identity Id. * @summary List role assignments * @param {IdentitiesApiGetRoleAssignmentsV1Request} requestParameters Request parameters. * @param {*} [axiosOptions] Override http request option. * @throws {RequiredError} */ getRoleAssignmentsV1(requestParameters: IdentitiesApiGetRoleAssignmentsV1Request, axiosOptions?: RawAxiosRequestConfig): AxiosPromise> { return localVarFp.getRoleAssignmentsV1(requestParameters.identityId, requestParameters.roleId, requestParameters.roleName, axiosOptions).then((request) => request(axios, basePath)); }, /** * The API returns a list of all entitlements assigned to an identity, either directly or through the role or access profile. A token with ORG_ADMIN or API authority is required to call this API. * @summary List of entitlements by identity. * @param {IdentitiesApiListEntitlementsByIdentityV1Request} requestParameters Request parameters. * @param {*} [axiosOptions] Override http request option. * @throws {RequiredError} */ listEntitlementsByIdentityV1(requestParameters: IdentitiesApiListEntitlementsByIdentityV1Request, axiosOptions?: RawAxiosRequestConfig): AxiosPromise> { return localVarFp.listEntitlementsByIdentityV1(requestParameters.id, requestParameters.limit, requestParameters.offset, requestParameters.count, axiosOptions).then((request) => request(axios, basePath)); }, /** * This API returns a list of identities. * @summary List identities * @param {IdentitiesApiListIdentitiesV1Request} requestParameters Request parameters. * @param {*} [axiosOptions] Override http request option. * @throws {RequiredError} */ listIdentitiesV1(requestParameters: IdentitiesApiListIdentitiesV1Request = {}, axiosOptions?: RawAxiosRequestConfig): AxiosPromise> { return localVarFp.listIdentitiesV1(requestParameters.filters, requestParameters.sorters, requestParameters.defaultFilter, requestParameters.count, requestParameters.limit, requestParameters.offset, axiosOptions).then((request) => request(axios, basePath)); }, /** * Use this endpoint to reset a user\'s identity if they have forgotten their authentication information like their answers to knowledge-based questions. Resetting an identity de-registers the user and removes any elevated user levels they have. * @summary Reset an identity * @param {IdentitiesApiResetIdentityV1Request} requestParameters Request parameters. * @param {*} [axiosOptions] Override http request option. * @throws {RequiredError} */ resetIdentityV1(requestParameters: IdentitiesApiResetIdentityV1Request, axiosOptions?: RawAxiosRequestConfig): AxiosPromise { return localVarFp.resetIdentityV1(requestParameters.id, axiosOptions).then((request) => request(axios, basePath)); }, /** * This API sends an email with the link to start Password Reset. After selecting the link an identity will be able to set up a new password. Emails expire after 2 hours. * @summary Send password reset email * @param {IdentitiesApiSendIdentityVerificationAccountTokenV1Request} requestParameters Request parameters. * @param {*} [axiosOptions] Override http request option. * @throws {RequiredError} */ sendIdentityVerificationAccountTokenV1(requestParameters: IdentitiesApiSendIdentityVerificationAccountTokenV1Request, axiosOptions?: RawAxiosRequestConfig): AxiosPromise { return localVarFp.sendIdentityVerificationAccountTokenV1(requestParameters.id, requestParameters.sendAccountVerificationRequest, requestParameters.xSailPointExperimental, axiosOptions).then((request) => request(axios, basePath)); }, /** * This API submits a task for inviting given identities via email to complete registration. The invitation email will include the link. After selecting the link an identity will be able to set up password and log in into the system. Invitations expire after 7 days. By default invitations send to the work identity email. It can be changed in Admin > Identities > Identity Profiles by selecting corresponding profile and editing Invitation Options. This task will send an invitation email only for unregistered identities. The executed task status can be checked by Task Management > [Get task status by ID](https://developer.sailpoint.com/docs/api/get-task-status-v-1). * @summary Invite identities to register * @param {IdentitiesApiStartIdentitiesInviteV1Request} requestParameters Request parameters. * @param {*} [axiosOptions] Override http request option. * @throws {RequiredError} */ startIdentitiesInviteV1(requestParameters: IdentitiesApiStartIdentitiesInviteV1Request, axiosOptions?: RawAxiosRequestConfig): AxiosPromise { return localVarFp.startIdentitiesInviteV1(requestParameters.inviteIdentitiesRequest, requestParameters.xSailPointExperimental, axiosOptions).then((request) => request(axios, basePath)); }, /** * This operation should not be used to schedule your own identity processing or to perform system wide identity refreshes. The system will use a combination of [event-based processing](https://documentation.sailpoint.com/saas/help/setup/identity_processing.html?h=process#event-based-processing) and [scheduled processing](https://documentation.sailpoint.com/saas/help/setup/identity_processing.html?h=process#scheduled-processing) that runs every day at 8:00 AM and 8:00 PM in the tenant\'s timezone to keep your identities synchronized. This endpoint will perform the following tasks: 1. Calculate identity attributes, including applying or running any rules or transforms (e.g. calculate Lifecycle State at a point-in-time it\'s expected to change). 2. Evaluate role assignments, leading to assignment of new roles and removal of existing roles. 3. Enforce provisioning for any assigned accesses that haven\'t been fulfilled (e.g. failure due to source health). 4. Recalculate manager relationships. 5. Potentially clean-up identity processing errors, assuming the error has been resolved. * @summary Process a list of identityids * @param {IdentitiesApiStartIdentityProcessingV1Request} requestParameters Request parameters. * @param {*} [axiosOptions] Override http request option. * @throws {RequiredError} */ startIdentityProcessingV1(requestParameters: IdentitiesApiStartIdentityProcessingV1Request, axiosOptions?: RawAxiosRequestConfig): AxiosPromise { return localVarFp.startIdentityProcessingV1(requestParameters.processIdentitiesRequest, requestParameters.xSailPointExperimental, axiosOptions).then((request) => request(axios, basePath)); }, /** * This end-point performs attribute synchronization for a selected identity. The endpoint can be called once in 10 seconds per identity. * @summary Attribute synchronization for single identity. * @param {IdentitiesApiSynchronizeAttributesForIdentityV1Request} requestParameters Request parameters. * @param {*} [axiosOptions] Override http request option. * @throws {RequiredError} */ synchronizeAttributesForIdentityV1(requestParameters: IdentitiesApiSynchronizeAttributesForIdentityV1Request, axiosOptions?: RawAxiosRequestConfig): AxiosPromise { return localVarFp.synchronizeAttributesForIdentityV1(requestParameters.identityId, requestParameters.xSailPointExperimental, axiosOptions).then((request) => request(axios, basePath)); }, }; }; /** * Request parameters for deleteIdentityV1 operation in IdentitiesApi. * @export * @interface IdentitiesApiDeleteIdentityV1Request */ export interface IdentitiesApiDeleteIdentityV1Request { /** * Identity Id * @type {string} * @memberof IdentitiesApiDeleteIdentityV1 */ readonly id: string } /** * Request parameters for getIdentityOwnershipDetailsV1 operation in IdentitiesApi. * @export * @interface IdentitiesApiGetIdentityOwnershipDetailsV1Request */ export interface IdentitiesApiGetIdentityOwnershipDetailsV1Request { /** * Identity ID. * @type {string} * @memberof IdentitiesApiGetIdentityOwnershipDetailsV1 */ readonly identityId: string } /** * Request parameters for getIdentityV1 operation in IdentitiesApi. * @export * @interface IdentitiesApiGetIdentityV1Request */ export interface IdentitiesApiGetIdentityV1Request { /** * Identity Id * @type {string} * @memberof IdentitiesApiGetIdentityV1 */ readonly id: string } /** * Request parameters for getRoleAssignmentV1 operation in IdentitiesApi. * @export * @interface IdentitiesApiGetRoleAssignmentV1Request */ export interface IdentitiesApiGetRoleAssignmentV1Request { /** * Identity Id * @type {string} * @memberof IdentitiesApiGetRoleAssignmentV1 */ readonly identityId: string /** * Assignment Id * @type {string} * @memberof IdentitiesApiGetRoleAssignmentV1 */ readonly assignmentId: string } /** * Request parameters for getRoleAssignmentsV1 operation in IdentitiesApi. * @export * @interface IdentitiesApiGetRoleAssignmentsV1Request */ export interface IdentitiesApiGetRoleAssignmentsV1Request { /** * Identity Id to get the role assignments for * @type {string} * @memberof IdentitiesApiGetRoleAssignmentsV1 */ readonly identityId: string /** * Role Id to filter the role assignments with * @type {string} * @memberof IdentitiesApiGetRoleAssignmentsV1 */ readonly roleId?: string /** * Role name to filter the role assignments with * @type {string} * @memberof IdentitiesApiGetRoleAssignmentsV1 */ readonly roleName?: string } /** * Request parameters for listEntitlementsByIdentityV1 operation in IdentitiesApi. * @export * @interface IdentitiesApiListEntitlementsByIdentityV1Request */ export interface IdentitiesApiListEntitlementsByIdentityV1Request { /** * Identity Id * @type {string} * @memberof IdentitiesApiListEntitlementsByIdentityV1 */ readonly id: string /** * Max number of results to return. See [V3 API Standard Collection Parameters](https://developer.sailpoint.com/idn/api/standard-collection-parameters) for more information. * @type {number} * @memberof IdentitiesApiListEntitlementsByIdentityV1 */ 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 IdentitiesApiListEntitlementsByIdentityV1 */ 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 IdentitiesApiListEntitlementsByIdentityV1 */ readonly count?: boolean } /** * Request parameters for listIdentitiesV1 operation in IdentitiesApi. * @export * @interface IdentitiesApiListIdentitiesV1Request */ export interface IdentitiesApiListIdentitiesV1Request { /** * 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, in* **name**: *eq, sw* **alias**: *eq, sw* **firstname**: *eq, sw* **lastname**: *eq, sw* **email**: *eq, sw* **cloudStatus**: *eq* **processingState**: *eq* **correlated**: *eq* **protected**: *eq* * @type {string} * @memberof IdentitiesApiListIdentitiesV1 */ 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: **name, alias, cloudStatus** * @type {string} * @memberof IdentitiesApiListIdentitiesV1 */ readonly sorters?: string /** * Adds additional filter to filters query parameter. CORRELATED_ONLY adds correlated=true and returns only identities that are correlated. NONE does not add any and returns all identities that satisfy filters query parameter. * @type {'CORRELATED_ONLY' | 'NONE'} * @memberof IdentitiesApiListIdentitiesV1 */ readonly defaultFilter?: ListIdentitiesV1DefaultFilterEnum /** * 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 IdentitiesApiListIdentitiesV1 */ readonly count?: boolean /** * 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 IdentitiesApiListIdentitiesV1 */ 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 IdentitiesApiListIdentitiesV1 */ readonly offset?: number } /** * Request parameters for resetIdentityV1 operation in IdentitiesApi. * @export * @interface IdentitiesApiResetIdentityV1Request */ export interface IdentitiesApiResetIdentityV1Request { /** * Identity Id * @type {string} * @memberof IdentitiesApiResetIdentityV1 */ readonly id: string } /** * Request parameters for sendIdentityVerificationAccountTokenV1 operation in IdentitiesApi. * @export * @interface IdentitiesApiSendIdentityVerificationAccountTokenV1Request */ export interface IdentitiesApiSendIdentityVerificationAccountTokenV1Request { /** * Identity ID * @type {string} * @memberof IdentitiesApiSendIdentityVerificationAccountTokenV1 */ readonly id: string /** * * @type {SendAccountVerificationRequest} * @memberof IdentitiesApiSendIdentityVerificationAccountTokenV1 */ readonly sendAccountVerificationRequest: SendAccountVerificationRequest /** * Use this header to enable this experimental API. * @type {string} * @memberof IdentitiesApiSendIdentityVerificationAccountTokenV1 */ readonly xSailPointExperimental?: string } /** * Request parameters for startIdentitiesInviteV1 operation in IdentitiesApi. * @export * @interface IdentitiesApiStartIdentitiesInviteV1Request */ export interface IdentitiesApiStartIdentitiesInviteV1Request { /** * * @type {InviteIdentitiesRequest} * @memberof IdentitiesApiStartIdentitiesInviteV1 */ readonly inviteIdentitiesRequest: InviteIdentitiesRequest /** * Use this header to enable this experimental API. * @type {string} * @memberof IdentitiesApiStartIdentitiesInviteV1 */ readonly xSailPointExperimental?: string } /** * Request parameters for startIdentityProcessingV1 operation in IdentitiesApi. * @export * @interface IdentitiesApiStartIdentityProcessingV1Request */ export interface IdentitiesApiStartIdentityProcessingV1Request { /** * * @type {ProcessIdentitiesRequest} * @memberof IdentitiesApiStartIdentityProcessingV1 */ readonly processIdentitiesRequest: ProcessIdentitiesRequest /** * Use this header to enable this experimental API. * @type {string} * @memberof IdentitiesApiStartIdentityProcessingV1 */ readonly xSailPointExperimental?: string } /** * Request parameters for synchronizeAttributesForIdentityV1 operation in IdentitiesApi. * @export * @interface IdentitiesApiSynchronizeAttributesForIdentityV1Request */ export interface IdentitiesApiSynchronizeAttributesForIdentityV1Request { /** * The Identity id * @type {string} * @memberof IdentitiesApiSynchronizeAttributesForIdentityV1 */ readonly identityId: string /** * Use this header to enable this experimental API. * @type {string} * @memberof IdentitiesApiSynchronizeAttributesForIdentityV1 */ readonly xSailPointExperimental?: string } /** * IdentitiesApi - object-oriented interface * @export * @class IdentitiesApi * @extends {BaseAPI} */ export class IdentitiesApi extends BaseAPI { /** * The API returns successful response if the requested identity was deleted. * @summary Delete identity * @param {IdentitiesApiDeleteIdentityV1Request} requestParameters Request parameters. * @param {*} [axiosOptions] Override http request option. * @throws {RequiredError} * @memberof IdentitiesApi */ public deleteIdentityV1(requestParameters: IdentitiesApiDeleteIdentityV1Request, axiosOptions?: RawAxiosRequestConfig) { return IdentitiesApiFp(this.configuration).deleteIdentityV1(requestParameters.id, axiosOptions).then((request) => request(this.axios, this.basePath)); } /** * Use this API to return an identity\'s owned objects that will cause problems for deleting the identity. Use this API as a checklist of objects that you need to reassign to a different identity before you can delete the identity. For a full list of objects owned by an identity, use the [Search API](https://developer.sailpoint.com/docs/api/search-post-v-1). When you search for identities, the returned identities have a property, `owns`, that contains a more comprehensive list of identity\'s owned objects. * @summary Get ownership details * @param {IdentitiesApiGetIdentityOwnershipDetailsV1Request} requestParameters Request parameters. * @param {*} [axiosOptions] Override http request option. * @throws {RequiredError} * @memberof IdentitiesApi */ public getIdentityOwnershipDetailsV1(requestParameters: IdentitiesApiGetIdentityOwnershipDetailsV1Request, axiosOptions?: RawAxiosRequestConfig) { return IdentitiesApiFp(this.configuration).getIdentityOwnershipDetailsV1(requestParameters.identityId, axiosOptions).then((request) => request(this.axios, this.basePath)); } /** * This API returns a single identity using the Identity ID. * @summary Identity details * @param {IdentitiesApiGetIdentityV1Request} requestParameters Request parameters. * @param {*} [axiosOptions] Override http request option. * @throws {RequiredError} * @memberof IdentitiesApi */ public getIdentityV1(requestParameters: IdentitiesApiGetIdentityV1Request, axiosOptions?: RawAxiosRequestConfig) { return IdentitiesApiFp(this.configuration).getIdentityV1(requestParameters.id, axiosOptions).then((request) => request(this.axios, this.basePath)); } /** * * @summary Role assignment details * @param {IdentitiesApiGetRoleAssignmentV1Request} requestParameters Request parameters. * @param {*} [axiosOptions] Override http request option. * @throws {RequiredError} * @memberof IdentitiesApi */ public getRoleAssignmentV1(requestParameters: IdentitiesApiGetRoleAssignmentV1Request, axiosOptions?: RawAxiosRequestConfig) { return IdentitiesApiFp(this.configuration).getRoleAssignmentV1(requestParameters.identityId, requestParameters.assignmentId, axiosOptions).then((request) => request(this.axios, this.basePath)); } /** * This returns either a list of Role Assignments when querying with either a Role Id or Role Name, or a list of Role Assignment References if querying with only identity Id. * @summary List role assignments * @param {IdentitiesApiGetRoleAssignmentsV1Request} requestParameters Request parameters. * @param {*} [axiosOptions] Override http request option. * @throws {RequiredError} * @memberof IdentitiesApi */ public getRoleAssignmentsV1(requestParameters: IdentitiesApiGetRoleAssignmentsV1Request, axiosOptions?: RawAxiosRequestConfig) { return IdentitiesApiFp(this.configuration).getRoleAssignmentsV1(requestParameters.identityId, requestParameters.roleId, requestParameters.roleName, axiosOptions).then((request) => request(this.axios, this.basePath)); } /** * The API returns a list of all entitlements assigned to an identity, either directly or through the role or access profile. A token with ORG_ADMIN or API authority is required to call this API. * @summary List of entitlements by identity. * @param {IdentitiesApiListEntitlementsByIdentityV1Request} requestParameters Request parameters. * @param {*} [axiosOptions] Override http request option. * @throws {RequiredError} * @memberof IdentitiesApi */ public listEntitlementsByIdentityV1(requestParameters: IdentitiesApiListEntitlementsByIdentityV1Request, axiosOptions?: RawAxiosRequestConfig) { return IdentitiesApiFp(this.configuration).listEntitlementsByIdentityV1(requestParameters.id, requestParameters.limit, requestParameters.offset, requestParameters.count, axiosOptions).then((request) => request(this.axios, this.basePath)); } /** * This API returns a list of identities. * @summary List identities * @param {IdentitiesApiListIdentitiesV1Request} requestParameters Request parameters. * @param {*} [axiosOptions] Override http request option. * @throws {RequiredError} * @memberof IdentitiesApi */ public listIdentitiesV1(requestParameters: IdentitiesApiListIdentitiesV1Request = {}, axiosOptions?: RawAxiosRequestConfig) { return IdentitiesApiFp(this.configuration).listIdentitiesV1(requestParameters.filters, requestParameters.sorters, requestParameters.defaultFilter, requestParameters.count, requestParameters.limit, requestParameters.offset, axiosOptions).then((request) => request(this.axios, this.basePath)); } /** * Use this endpoint to reset a user\'s identity if they have forgotten their authentication information like their answers to knowledge-based questions. Resetting an identity de-registers the user and removes any elevated user levels they have. * @summary Reset an identity * @param {IdentitiesApiResetIdentityV1Request} requestParameters Request parameters. * @param {*} [axiosOptions] Override http request option. * @throws {RequiredError} * @memberof IdentitiesApi */ public resetIdentityV1(requestParameters: IdentitiesApiResetIdentityV1Request, axiosOptions?: RawAxiosRequestConfig) { return IdentitiesApiFp(this.configuration).resetIdentityV1(requestParameters.id, axiosOptions).then((request) => request(this.axios, this.basePath)); } /** * This API sends an email with the link to start Password Reset. After selecting the link an identity will be able to set up a new password. Emails expire after 2 hours. * @summary Send password reset email * @param {IdentitiesApiSendIdentityVerificationAccountTokenV1Request} requestParameters Request parameters. * @param {*} [axiosOptions] Override http request option. * @throws {RequiredError} * @memberof IdentitiesApi */ public sendIdentityVerificationAccountTokenV1(requestParameters: IdentitiesApiSendIdentityVerificationAccountTokenV1Request, axiosOptions?: RawAxiosRequestConfig) { return IdentitiesApiFp(this.configuration).sendIdentityVerificationAccountTokenV1(requestParameters.id, requestParameters.sendAccountVerificationRequest, requestParameters.xSailPointExperimental, axiosOptions).then((request) => request(this.axios, this.basePath)); } /** * This API submits a task for inviting given identities via email to complete registration. The invitation email will include the link. After selecting the link an identity will be able to set up password and log in into the system. Invitations expire after 7 days. By default invitations send to the work identity email. It can be changed in Admin > Identities > Identity Profiles by selecting corresponding profile and editing Invitation Options. This task will send an invitation email only for unregistered identities. The executed task status can be checked by Task Management > [Get task status by ID](https://developer.sailpoint.com/docs/api/get-task-status-v-1). * @summary Invite identities to register * @param {IdentitiesApiStartIdentitiesInviteV1Request} requestParameters Request parameters. * @param {*} [axiosOptions] Override http request option. * @throws {RequiredError} * @memberof IdentitiesApi */ public startIdentitiesInviteV1(requestParameters: IdentitiesApiStartIdentitiesInviteV1Request, axiosOptions?: RawAxiosRequestConfig) { return IdentitiesApiFp(this.configuration).startIdentitiesInviteV1(requestParameters.inviteIdentitiesRequest, requestParameters.xSailPointExperimental, axiosOptions).then((request) => request(this.axios, this.basePath)); } /** * This operation should not be used to schedule your own identity processing or to perform system wide identity refreshes. The system will use a combination of [event-based processing](https://documentation.sailpoint.com/saas/help/setup/identity_processing.html?h=process#event-based-processing) and [scheduled processing](https://documentation.sailpoint.com/saas/help/setup/identity_processing.html?h=process#scheduled-processing) that runs every day at 8:00 AM and 8:00 PM in the tenant\'s timezone to keep your identities synchronized. This endpoint will perform the following tasks: 1. Calculate identity attributes, including applying or running any rules or transforms (e.g. calculate Lifecycle State at a point-in-time it\'s expected to change). 2. Evaluate role assignments, leading to assignment of new roles and removal of existing roles. 3. Enforce provisioning for any assigned accesses that haven\'t been fulfilled (e.g. failure due to source health). 4. Recalculate manager relationships. 5. Potentially clean-up identity processing errors, assuming the error has been resolved. * @summary Process a list of identityids * @param {IdentitiesApiStartIdentityProcessingV1Request} requestParameters Request parameters. * @param {*} [axiosOptions] Override http request option. * @throws {RequiredError} * @memberof IdentitiesApi */ public startIdentityProcessingV1(requestParameters: IdentitiesApiStartIdentityProcessingV1Request, axiosOptions?: RawAxiosRequestConfig) { return IdentitiesApiFp(this.configuration).startIdentityProcessingV1(requestParameters.processIdentitiesRequest, requestParameters.xSailPointExperimental, axiosOptions).then((request) => request(this.axios, this.basePath)); } /** * This end-point performs attribute synchronization for a selected identity. The endpoint can be called once in 10 seconds per identity. * @summary Attribute synchronization for single identity. * @param {IdentitiesApiSynchronizeAttributesForIdentityV1Request} requestParameters Request parameters. * @param {*} [axiosOptions] Override http request option. * @throws {RequiredError} * @memberof IdentitiesApi */ public synchronizeAttributesForIdentityV1(requestParameters: IdentitiesApiSynchronizeAttributesForIdentityV1Request, axiosOptions?: RawAxiosRequestConfig) { return IdentitiesApiFp(this.configuration).synchronizeAttributesForIdentityV1(requestParameters.identityId, requestParameters.xSailPointExperimental, axiosOptions).then((request) => request(this.axios, this.basePath)); } } /** * @export */ export const ListIdentitiesV1DefaultFilterEnum = { CorrelatedOnly: 'CORRELATED_ONLY', None: 'NONE' } as const; export type ListIdentitiesV1DefaultFilterEnum = typeof ListIdentitiesV1DefaultFilterEnum[keyof typeof ListIdentitiesV1DefaultFilterEnum];