/** * Identity Security Cloud API - Sources * Use these APIs to interact with the Identity Security Cloud platform to achieve repeatable, automated processes with greater scalability. We encourage you to join the SailPoint Developer Community forum at https://developer.sailpoint.com/discuss to connect with other developers using our APIs. * * The version of the OpenAPI document: v1 * * * NOTE: This class is auto generated by OpenAPI Generator (https://openapi-generator.tech). * https://openapi-generator.tech * Do not edit the class manually. */ import type { Configuration } from '../configuration'; import type { AxiosPromise, AxiosInstance, RawAxiosRequestConfig } from 'axios'; import type { RequestArgs } from './base'; import { BaseAPI } from './base'; /** * detailed information about account delete approval config * @export * @interface AccountDeleteConfigDto */ export interface AccountDeleteConfigDto { /** * Specifies if an account deletion request requires approval. * @type {boolean} * @memberof AccountDeleteConfigDto */ 'approvalRequired'?: boolean; /** * * @type {ApprovalConfig} * @memberof AccountDeleteConfigDto */ 'approvalConfig'?: ApprovalConfig; } /** * Approval config Object * @export * @interface ApprovalConfig */ export interface ApprovalConfig { /** * * @type {ApprovalConfigReminderConfig} * @memberof ApprovalConfig */ 'reminderConfig'?: ApprovalConfigReminderConfig; /** * * @type {ApprovalConfigEscalationConfig} * @memberof ApprovalConfig */ 'escalationConfig'?: ApprovalConfigEscalationConfig; /** * * @type {ApprovalConfigTimeoutConfig} * @memberof ApprovalConfig */ 'timeoutConfig'?: ApprovalConfigTimeoutConfig; /** * * @type {ApprovalConfigCronTimezone} * @memberof ApprovalConfig */ 'cronTimezone'?: ApprovalConfigCronTimezone; /** * If the approval request has an approvalCriteria of SERIAL this chain will be used to determine the assignment order. * @type {Array} * @memberof ApprovalConfig */ 'serialChain'?: Array; /** * Determines whether a comment is required when approving or rejecting the approval request. * @type {string} * @memberof ApprovalConfig */ 'requiresComment'?: ApprovalConfigRequiresCommentEnum; /** * * @type {ApprovalConfigFallbackApprover} * @memberof ApprovalConfig */ 'fallbackApprover'?: ApprovalConfigFallbackApprover; /** * Specifies how to treat the identity type \"MANAGER_OF\" when the requestee is a machine identity. * @type {string} * @memberof ApprovalConfig */ 'machineIdentityManagerAssignment'?: ApprovalConfigMachineIdentityManagerAssignmentEnum; /** * When true, all approvals will be created with the status \"PASSED\". * @type {boolean} * @memberof ApprovalConfig */ 'circumventApprovalProcess'?: boolean; /** * OFF will prevent the approval request from being assigned to the requester or requestee by assigning it to their manager instead. DIRECT will cause approval requests to be auto-approved when assigned directly and only to the requester. INDIRECT will auto-approve when the requester appears anywhere in the list of approvers, including in a governance group. This field will only be effective if requestedTarget.reauthRequired is set to false, otherwise the approval will have to be manually approved. * @type {string} * @memberof ApprovalConfig */ 'autoApprove'?: ApprovalConfigAutoApproveEnum; } export declare const ApprovalConfigRequiresCommentEnum: { readonly Approval: "APPROVAL"; readonly Rejection: "REJECTION"; readonly All: "ALL"; readonly Off: "OFF"; }; export type ApprovalConfigRequiresCommentEnum = typeof ApprovalConfigRequiresCommentEnum[keyof typeof ApprovalConfigRequiresCommentEnum]; export declare const ApprovalConfigMachineIdentityManagerAssignmentEnum: { readonly ManagerOfRequester: "MANAGER_OF_REQUESTER"; readonly MachineIdentityOwner: "MACHINE_IDENTITY_OWNER"; readonly ManagerOfMachineIdentityOwner: "MANAGER_OF_MACHINE_IDENTITY_OWNER"; readonly RequestedTargetOwner: "REQUESTED_TARGET_OWNER"; readonly ManagerOfRequestedTargetOwner: "MANAGER_OF_REQUESTED_TARGET_OWNER"; readonly AccountOwner: "ACCOUNT_OWNER"; readonly ManagerOfAccountOwner: "MANAGER_OF_ACCOUNT_OWNER"; }; export type ApprovalConfigMachineIdentityManagerAssignmentEnum = typeof ApprovalConfigMachineIdentityManagerAssignmentEnum[keyof typeof ApprovalConfigMachineIdentityManagerAssignmentEnum]; export declare const ApprovalConfigAutoApproveEnum: { readonly Off: "OFF"; readonly Direct: "DIRECT"; readonly Indirect: "INDIRECT"; }; export type ApprovalConfigAutoApproveEnum = typeof ApprovalConfigAutoApproveEnum[keyof typeof ApprovalConfigAutoApproveEnum]; /** * Timezone configuration for cron schedules. * @export * @interface ApprovalConfigCronTimezone */ export interface ApprovalConfigCronTimezone { /** * Timezone location for cron schedules. * @type {string} * @memberof ApprovalConfigCronTimezone */ 'location'?: string; /** * Timezone offset for cron schedules. * @type {string} * @memberof ApprovalConfigCronTimezone */ 'offset'?: string; } /** * Configuration for escalations. * @export * @interface ApprovalConfigEscalationConfig */ export interface ApprovalConfigEscalationConfig { /** * Indicates if escalations are enabled. * @type {boolean} * @memberof ApprovalConfigEscalationConfig */ 'enabled'?: boolean; /** * Number of days until the first escalation. * @type {number} * @memberof ApprovalConfigEscalationConfig */ 'daysUntilFirstEscalation'?: number; /** * Cron schedule for escalations. * @type {string} * @memberof ApprovalConfigEscalationConfig */ 'escalationCronSchedule'?: string; /** * Escalation chain configuration. * @type {Array} * @memberof ApprovalConfigEscalationConfig */ 'escalationChain'?: Array; } /** * * @export * @interface ApprovalConfigEscalationConfigEscalationChainInner */ export interface ApprovalConfigEscalationConfigEscalationChainInner { /** * Starting at 1 defines the order in which the identities will get assigned * @type {number} * @memberof ApprovalConfigEscalationConfigEscalationChainInner */ 'tier'?: number; /** * Optional Identity ID of the type of identity defined in the \'identityType\' field. * @type {string} * @memberof ApprovalConfigEscalationConfigEscalationChainInner */ 'identityId'?: string; /** * Type of identityId in the escalation chain. * @type {string} * @memberof ApprovalConfigEscalationConfigEscalationChainInner */ 'identityType'?: ApprovalConfigEscalationConfigEscalationChainInnerIdentityTypeEnum; } export declare const ApprovalConfigEscalationConfigEscalationChainInnerIdentityTypeEnum: { readonly Identity: "IDENTITY"; readonly ManagerOf: "MANAGER_OF"; readonly AccountOwner: "ACCOUNT_OWNER"; readonly MachineAccountOwner: "MACHINE_ACCOUNT_OWNER"; readonly MachineIdentityOwner: "MACHINE_IDENTITY_OWNER"; readonly ManagerOfRequestedTargetOwner: "MANAGER_OF_REQUESTED_TARGET_OWNER"; readonly ManagerOfMachineIdentityOwner: "MANAGER_OF_MACHINE_IDENTITY_OWNER"; readonly ManagerOfAccountOwner: "MANAGER_OF_ACCOUNT_OWNER"; readonly ManagerOfMachineAccountOwner: "MANAGER_OF_MACHINE_ACCOUNT_OWNER"; readonly ManagerOfRequester: "MANAGER_OF_REQUESTER"; readonly ManagerOfRequesterOwner: "MANAGER_OF_REQUESTER_OWNER"; readonly ManagerOfOwner: "MANAGER_OF_OWNER"; readonly AccessProfileOwner: "ACCESS_PROFILE_OWNER"; readonly ApplicationOwner: "APPLICATION_OWNER"; readonly EntitlementOwner: "ENTITLEMENT_OWNER"; readonly RoleOwner: "ROLE_OWNER"; readonly SourceOwner: "SOURCE_OWNER"; readonly AccessProfilePrimaryOwner: "ACCESS_PROFILE_PRIMARY_OWNER"; readonly ApplicationPrimaryOwner: "APPLICATION_PRIMARY_OWNER"; readonly EntitlementPrimaryOwner: "ENTITLEMENT_PRIMARY_OWNER"; readonly RolePrimaryOwner: "ROLE_PRIMARY_OWNER"; readonly SourcePrimaryOwner: "SOURCE_PRIMARY_OWNER"; }; export type ApprovalConfigEscalationConfigEscalationChainInnerIdentityTypeEnum = typeof ApprovalConfigEscalationConfigEscalationChainInnerIdentityTypeEnum[keyof typeof ApprovalConfigEscalationConfigEscalationChainInnerIdentityTypeEnum]; /** * Configuration for fallback approver. Used if the user cannot be found for whatever reason and escalation config does not exist. * @export * @interface ApprovalConfigFallbackApprover */ export interface ApprovalConfigFallbackApprover { /** * Optional Identity ID of the type of identity defined in the \'type\' field. * @type {string} * @memberof ApprovalConfigFallbackApprover */ 'identityID'?: string; /** * Type of identityID for the fallback approver. * @type {string} * @memberof ApprovalConfigFallbackApprover */ 'type'?: ApprovalConfigFallbackApproverTypeEnum; } export declare const ApprovalConfigFallbackApproverTypeEnum: { readonly Identity: "IDENTITY"; readonly ManagerOf: "MANAGER_OF"; readonly AccountOwner: "ACCOUNT_OWNER"; readonly MachineAccountOwner: "MACHINE_ACCOUNT_OWNER"; readonly MachineIdentityOwner: "MACHINE_IDENTITY_OWNER"; readonly ManagerOfRequestedTargetOwner: "MANAGER_OF_REQUESTED_TARGET_OWNER"; readonly ManagerOfMachineIdentityOwner: "MANAGER_OF_MACHINE_IDENTITY_OWNER"; readonly ManagerOfAccountOwner: "MANAGER_OF_ACCOUNT_OWNER"; readonly ManagerOfMachineAccountOwner: "MANAGER_OF_MACHINE_ACCOUNT_OWNER"; readonly ManagerOfRequester: "MANAGER_OF_REQUESTER"; readonly ManagerOfRequesterOwner: "MANAGER_OF_REQUESTER_OWNER"; readonly ManagerOfOwner: "MANAGER_OF_OWNER"; readonly AccessProfileOwner: "ACCESS_PROFILE_OWNER"; readonly ApplicationOwner: "APPLICATION_OWNER"; readonly EntitlementOwner: "ENTITLEMENT_OWNER"; readonly RoleOwner: "ROLE_OWNER"; readonly SourceOwner: "SOURCE_OWNER"; readonly RequestedTargetOwner: "REQUESTED_TARGET_OWNER"; readonly AccessProfilePrimaryOwner: "ACCESS_PROFILE_PRIMARY_OWNER"; readonly ApplicationPrimaryOwner: "APPLICATION_PRIMARY_OWNER"; readonly EntitlementPrimaryOwner: "ENTITLEMENT_PRIMARY_OWNER"; readonly RolePrimaryOwner: "ROLE_PRIMARY_OWNER"; readonly SourcePrimaryOwner: "SOURCE_PRIMARY_OWNER"; readonly RequestedTargetPrimaryOwner: "REQUESTED_TARGET_PRIMARY_OWNER"; }; export type ApprovalConfigFallbackApproverTypeEnum = typeof ApprovalConfigFallbackApproverTypeEnum[keyof typeof ApprovalConfigFallbackApproverTypeEnum]; /** * Configuration for reminders. * @export * @interface ApprovalConfigReminderConfig */ export interface ApprovalConfigReminderConfig { /** * Indicates if reminders are enabled. * @type {boolean} * @memberof ApprovalConfigReminderConfig */ 'enabled'?: boolean; /** * Number of days until the first reminder. * @type {number} * @memberof ApprovalConfigReminderConfig */ 'daysUntilFirstReminder'?: number; /** * Cron schedule for reminders. * @type {string} * @memberof ApprovalConfigReminderConfig */ 'reminderCronSchedule'?: string; /** * Maximum number of reminders. Max is 20. * @type {number} * @memberof ApprovalConfigReminderConfig */ 'maxReminders'?: number; } /** * * @export * @interface ApprovalConfigSerialChainInner */ export interface ApprovalConfigSerialChainInner { /** * Starting at 1 defines the order in which the identities will get assigned * @type {number} * @memberof ApprovalConfigSerialChainInner */ 'tier'?: number; /** * Optional Identity ID of the type of identity defined in the \'identityType\' field. * @type {string} * @memberof ApprovalConfigSerialChainInner */ 'identityId'?: string; /** * Type of identityId in the serial chain. * @type {string} * @memberof ApprovalConfigSerialChainInner */ 'identityType'?: ApprovalConfigSerialChainInnerIdentityTypeEnum; } export declare const ApprovalConfigSerialChainInnerIdentityTypeEnum: { readonly Identity: "IDENTITY"; readonly GovernanceGroup: "GOVERNANCE_GROUP"; readonly ManagerOf: "MANAGER_OF"; readonly AccountOwner: "ACCOUNT_OWNER"; readonly MachineAccountOwner: "MACHINE_ACCOUNT_OWNER"; readonly MachineIdentityOwner: "MACHINE_IDENTITY_OWNER"; readonly ManagerOfRequestedTargetOwner: "MANAGER_OF_REQUESTED_TARGET_OWNER"; readonly ManagerOfMachineIdentityOwner: "MANAGER_OF_MACHINE_IDENTITY_OWNER"; readonly ManagerOfAccountOwner: "MANAGER_OF_ACCOUNT_OWNER"; readonly ManagerOfMachineAccountOwner: "MANAGER_OF_MACHINE_ACCOUNT_OWNER"; readonly ManagerOfRequester: "MANAGER_OF_REQUESTER"; readonly ManagerOfRequesterOwner: "MANAGER_OF_REQUESTER_OWNER"; readonly ManagerOfOwner: "MANAGER_OF_OWNER"; readonly AccessProfileOwner: "ACCESS_PROFILE_OWNER"; readonly ApplicationOwner: "APPLICATION_OWNER"; readonly EntitlementOwner: "ENTITLEMENT_OWNER"; readonly RoleOwner: "ROLE_OWNER"; readonly SourceOwner: "SOURCE_OWNER"; readonly RequestedTargetOwner: "REQUESTED_TARGET_OWNER"; readonly AccessProfilePrimaryOwner: "ACCESS_PROFILE_PRIMARY_OWNER"; readonly ApplicationPrimaryOwner: "APPLICATION_PRIMARY_OWNER"; readonly EntitlementPrimaryOwner: "ENTITLEMENT_PRIMARY_OWNER"; readonly RolePrimaryOwner: "ROLE_PRIMARY_OWNER"; readonly SourcePrimaryOwner: "SOURCE_PRIMARY_OWNER"; readonly RequestedTargetPrimaryOwner: "REQUESTED_TARGET_PRIMARY_OWNER"; readonly AccessProfileSecondaryOwnerGroup: "ACCESS_PROFILE_SECONDARY_OWNER_GROUP"; readonly ApplicationSecondaryOwnerGroup: "APPLICATION_SECONDARY_OWNER_GROUP"; readonly EntitlementSecondaryOwnerGroup: "ENTITLEMENT_SECONDARY_OWNER_GROUP"; readonly RoleSecondaryOwnerGroup: "ROLE_SECONDARY_OWNER_GROUP"; readonly SourceSecondaryOwnerGroup: "SOURCE_SECONDARY_OWNER_GROUP"; readonly RequestedTargetSecondaryOwnerGroup: "REQUESTED_TARGET_SECONDARY_OWNER_GROUP"; readonly AccessProfileAllOwnerGroup: "ACCESS_PROFILE_ALL_OWNER_GROUP"; readonly ApplicationAllOwnerGroup: "APPLICATION_ALL_OWNER_GROUP"; readonly EntitlementAllOwnerGroup: "ENTITLEMENT_ALL_OWNER_GROUP"; readonly RoleAllOwnerGroup: "ROLE_ALL_OWNER_GROUP"; readonly SourceAllOwnerGroup: "SOURCE_ALL_OWNER_GROUP"; readonly RequestedTargetAllOwnerGroup: "REQUESTED_TARGET_ALL_OWNER_GROUP"; }; export type ApprovalConfigSerialChainInnerIdentityTypeEnum = typeof ApprovalConfigSerialChainInnerIdentityTypeEnum[keyof typeof ApprovalConfigSerialChainInnerIdentityTypeEnum]; /** * TimeoutConfig contains configurations around when the approval request should expire. * @export * @interface ApprovalConfigTimeoutConfig */ export interface ApprovalConfigTimeoutConfig { /** * Indicates if timeout is enabled. * @type {boolean} * @memberof ApprovalConfigTimeoutConfig */ 'enabled'?: boolean; /** * Number of days until approval request times out. Max value is 90. * @type {number} * @memberof ApprovalConfigTimeoutConfig */ 'daysUntilTimeout'?: number; /** * Result of timeout. * @type {string} * @memberof ApprovalConfigTimeoutConfig */ 'timeoutResult'?: ApprovalConfigTimeoutConfigTimeoutResultEnum; } export declare const ApprovalConfigTimeoutConfigTimeoutResultEnum: { readonly Expired: "EXPIRED"; readonly Approved: "APPROVED"; }; export type ApprovalConfigTimeoutConfigTimeoutResultEnum = typeof ApprovalConfigTimeoutConfigTimeoutResultEnum[keyof typeof ApprovalConfigTimeoutConfigTimeoutResultEnum]; /** * * @export * @interface ArrayInner */ export interface ArrayInner { } /** * Target source for attribute synchronization. * @export * @interface AttrSyncSource */ export interface AttrSyncSource { /** * DTO type of target source for attribute synchronization. * @type {string} * @memberof AttrSyncSource */ 'type'?: AttrSyncSourceTypeEnum; /** * ID of target source for attribute synchronization. * @type {string} * @memberof AttrSyncSource */ 'id'?: string; /** * Human-readable name of target source for attribute synchronization. * @type {string} * @memberof AttrSyncSource */ 'name'?: string | null; } export declare const AttrSyncSourceTypeEnum: { readonly Source: "SOURCE"; }; export type AttrSyncSourceTypeEnum = typeof AttrSyncSourceTypeEnum[keyof typeof AttrSyncSourceTypeEnum]; /** * Specification of source attribute sync mapping configuration for an identity attribute * @export * @interface AttrSyncSourceAttributeConfig */ export interface AttrSyncSourceAttributeConfig { /** * Name of the identity attribute * @type {string} * @memberof AttrSyncSourceAttributeConfig */ 'name': string; /** * Display name of the identity attribute * @type {string} * @memberof AttrSyncSourceAttributeConfig */ 'displayName': string; /** * Determines whether or not the attribute is enabled for synchronization * @type {boolean} * @memberof AttrSyncSourceAttributeConfig */ 'enabled': boolean; /** * Name of the source account attribute to which the identity attribute value will be synchronized if enabled * @type {string} * @memberof AttrSyncSourceAttributeConfig */ 'target': string; } /** * Specification of attribute sync configuration for a source * @export * @interface AttrSyncSourceConfig */ export interface AttrSyncSourceConfig { /** * * @type {AttrSyncSource} * @memberof AttrSyncSourceConfig */ 'source': AttrSyncSource; /** * Attribute synchronization configuration for specific identity attributes in the context of a source * @type {Array} * @memberof AttrSyncSourceConfig */ 'attributes': Array; } /** * * @export * @interface AttributeDefinition */ export interface AttributeDefinition { /** * The name of the attribute. * @type {string} * @memberof AttributeDefinition */ 'name'?: string; /** * Attribute name in the native system. * @type {string} * @memberof AttributeDefinition */ 'nativeName'?: string | null; /** * * @type {AttributeDefinitionType} * @memberof AttributeDefinition */ 'type'?: AttributeDefinitionType; /** * * @type {AttributeDefinitionSchema} * @memberof AttributeDefinition */ 'schema'?: AttributeDefinitionSchema | null; /** * A human-readable description of the attribute. * @type {string} * @memberof AttributeDefinition */ 'description'?: string; /** * Flag indicating whether or not the attribute is multi-valued. * @type {boolean} * @memberof AttributeDefinition */ 'isMulti'?: boolean; /** * Flag indicating whether or not the attribute is an entitlement. * @type {boolean} * @memberof AttributeDefinition */ 'isEntitlement'?: boolean; /** * Flag indicating whether or not the attribute represents a group. This can only be `true` if `isEntitlement` is also `true` **and** there is a schema defined for the attribute.. * @type {boolean} * @memberof AttributeDefinition */ 'isGroup'?: boolean; } /** * A reference to the schema on the source to the attribute values map to. * @export * @interface AttributeDefinitionSchema */ export interface AttributeDefinitionSchema { /** * The type of object being referenced * @type {string} * @memberof AttributeDefinitionSchema */ 'type'?: AttributeDefinitionSchemaTypeEnum; /** * The object ID this reference applies to. * @type {string} * @memberof AttributeDefinitionSchema */ 'id'?: string; /** * The human-readable display name of the object. * @type {string} * @memberof AttributeDefinitionSchema */ 'name'?: string; } export declare const AttributeDefinitionSchemaTypeEnum: { readonly ConnectorSchema: "CONNECTOR_SCHEMA"; }; export type AttributeDefinitionSchemaTypeEnum = typeof AttributeDefinitionSchemaTypeEnum[keyof typeof AttributeDefinitionSchemaTypeEnum]; /** * The underlying type of the value which an AttributeDefinition represents. * @export * @enum {string} */ export declare const AttributeDefinitionType: { readonly String: "STRING"; readonly Long: "LONG"; readonly Int: "INT"; readonly Boolean: "BOOLEAN"; readonly Date: "DATE"; }; export type AttributeDefinitionType = typeof AttributeDefinitionType[keyof typeof AttributeDefinitionType]; /** * * @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 ConnectorDetail */ export interface ConnectorDetail { /** * The connector name * @type {string} * @memberof ConnectorDetail */ 'name'?: string; /** * The connector type * @type {string} * @memberof ConnectorDetail */ 'type'?: string; /** * The connector class name * @type {string} * @memberof ConnectorDetail */ 'className'?: string; /** * The connector script name * @type {string} * @memberof ConnectorDetail */ 'scriptName'?: string; /** * The connector application xml * @type {string} * @memberof ConnectorDetail */ 'applicationXml'?: string; /** * The connector correlation config xml * @type {string} * @memberof ConnectorDetail */ 'correlationConfigXml'?: string; /** * The connector source config xml * @type {string} * @memberof ConnectorDetail */ 'sourceConfigXml'?: string; /** * The connector source config * @type {string} * @memberof ConnectorDetail */ 'sourceConfig'?: string | null; /** * The connector source config origin * @type {string} * @memberof ConnectorDetail */ 'sourceConfigFrom'?: string | null; /** * storage path key for this connector * @type {string} * @memberof ConnectorDetail */ 's3Location'?: string; /** * The list of uploaded files supported by the connector. If there was any executable files uploaded to thee connector. Typically this be empty as the executable be uploaded at source creation. * @type {Array} * @memberof ConnectorDetail */ 'uploadedFiles'?: Array | null; /** * true if the source is file upload * @type {boolean} * @memberof ConnectorDetail */ 'fileUpload'?: boolean; /** * true if the source is a direct connect source * @type {boolean} * @memberof ConnectorDetail */ 'directConnect'?: boolean; /** * A map containing translation attributes by loacale key * @type {{ [key: string]: any; }} * @memberof ConnectorDetail */ 'translationProperties'?: { [key: string]: any; }; /** * A map containing metadata pertinent to the UI to be used * @type {{ [key: string]: any; }} * @memberof ConnectorDetail */ 'connectorMetadata'?: { [key: string]: any; }; /** * The connector status * @type {string} * @memberof ConnectorDetail */ 'status'?: ConnectorDetailStatusEnum; } export declare const ConnectorDetailStatusEnum: { readonly Deprecated: "DEPRECATED"; readonly Development: "DEVELOPMENT"; readonly Demo: "DEMO"; readonly Released: "RELEASED"; }; export type ConnectorDetailStatusEnum = typeof ConnectorDetailStatusEnum[keyof typeof ConnectorDetailStatusEnum]; /** * Source configuration information that is used by correlation process. * @export * @interface CorrelationConfig */ export interface CorrelationConfig { /** * The ID of the correlation configuration. * @type {string} * @memberof CorrelationConfig */ 'id'?: string | null; /** * The name of the correlation configuration. * @type {string} * @memberof CorrelationConfig */ 'name'?: string | null; /** * The list of attribute assignments of the correlation configuration. * @type {Array} * @memberof CorrelationConfig */ 'attributeAssignments'?: Array | null; } /** * The attribute assignment of the correlation configuration. * @export * @interface CorrelationConfigAttributeAssignmentsInner */ export interface CorrelationConfigAttributeAssignmentsInner { /** * The property of the attribute assignment. * @type {string} * @memberof CorrelationConfigAttributeAssignmentsInner */ 'property'?: string; /** * The value of the attribute assignment. * @type {string} * @memberof CorrelationConfigAttributeAssignmentsInner */ 'value'?: string; /** * The operation of the attribute assignment. * @type {string} * @memberof CorrelationConfigAttributeAssignmentsInner */ 'operation'?: CorrelationConfigAttributeAssignmentsInnerOperationEnum; /** * Whether or not the it\'s a complex attribute assignment. * @type {boolean} * @memberof CorrelationConfigAttributeAssignmentsInner */ 'complex'?: boolean; /** * Whether or not the attribute assignment should ignore case. * @type {boolean} * @memberof CorrelationConfigAttributeAssignmentsInner */ 'ignoreCase'?: boolean; /** * The match mode of the attribute assignment. * @type {string} * @memberof CorrelationConfigAttributeAssignmentsInner */ 'matchMode'?: CorrelationConfigAttributeAssignmentsInnerMatchModeEnum; /** * The filter string of the attribute assignment. * @type {string} * @memberof CorrelationConfigAttributeAssignmentsInner */ 'filterString'?: string; } export declare const CorrelationConfigAttributeAssignmentsInnerOperationEnum: { readonly Eq: "EQ"; }; export type CorrelationConfigAttributeAssignmentsInnerOperationEnum = typeof CorrelationConfigAttributeAssignmentsInnerOperationEnum[keyof typeof CorrelationConfigAttributeAssignmentsInnerOperationEnum]; export declare const CorrelationConfigAttributeAssignmentsInnerMatchModeEnum: { readonly Anywhere: "ANYWHERE"; readonly Start: "START"; readonly End: "END"; }; export type CorrelationConfigAttributeAssignmentsInnerMatchModeEnum = typeof CorrelationConfigAttributeAssignmentsInnerMatchModeEnum[keyof typeof CorrelationConfigAttributeAssignmentsInnerMatchModeEnum]; /** * * @export * @interface DeleteSourceV1202Response */ export interface DeleteSourceV1202Response { /** * Type of object being referenced. * @type {string} * @memberof DeleteSourceV1202Response */ 'type'?: DeleteSourceV1202ResponseTypeEnum; /** * Task result ID. * @type {string} * @memberof DeleteSourceV1202Response */ 'id'?: string; /** * Task result\'s human-readable display name (this should be null/empty). * @type {string} * @memberof DeleteSourceV1202Response */ 'name'?: string; } export declare const DeleteSourceV1202ResponseTypeEnum: { readonly TaskResult: "TASK_RESULT"; }; export type DeleteSourceV1202ResponseTypeEnum = typeof DeleteSourceV1202ResponseTypeEnum[keyof typeof DeleteSourceV1202ResponseTypeEnum]; /** * * @export * @interface DependantAppConnections */ export interface DependantAppConnections { /** * Id of the connected Application * @type {string} * @memberof DependantAppConnections */ 'cloudAppId'?: string; /** * Description of the connected Application * @type {string} * @memberof DependantAppConnections */ 'description'?: string; /** * Is the Application enabled * @type {boolean} * @memberof DependantAppConnections */ 'enabled'?: boolean; /** * Is Provisioning enabled for connected Application * @type {boolean} * @memberof DependantAppConnections */ 'provisionRequestEnabled'?: boolean; /** * * @type {DependantAppConnectionsAccountSource} * @memberof DependantAppConnections */ 'accountSource'?: DependantAppConnectionsAccountSource; /** * The amount of launchers for connected Application (long type) * @type {number} * @memberof DependantAppConnections */ 'launcherCount'?: number; /** * Is Provisioning enabled for connected Application * @type {boolean} * @memberof DependantAppConnections */ 'matchAllAccount'?: boolean; /** * The owner of the connected Application * @type {Array} * @memberof DependantAppConnections */ 'owner'?: Array; /** * Is App Center enabled for connected Application * @type {boolean} * @memberof DependantAppConnections */ 'appCenterEnabled'?: boolean; } /** * The Account Source of the connected Application * @export * @interface DependantAppConnectionsAccountSource */ export interface DependantAppConnectionsAccountSource { /** * Use this Account Source for password management * @type {boolean} * @memberof DependantAppConnectionsAccountSource */ 'useForPasswordManagement'?: boolean; /** * A list of Password Policies for this Account Source * @type {Array} * @memberof DependantAppConnectionsAccountSource */ 'passwordPolicies'?: Array; } /** * * @export * @interface DependantAppConnectionsAccountSourcePasswordPoliciesInner */ export interface DependantAppConnectionsAccountSourcePasswordPoliciesInner { /** * DTO type * @type {string} * @memberof DependantAppConnectionsAccountSourcePasswordPoliciesInner */ 'type'?: string; /** * ID of the object to which this reference applies * @type {string} * @memberof DependantAppConnectionsAccountSourcePasswordPoliciesInner */ 'id'?: string; /** * Human-readable display name of the object to which this reference applies * @type {string} * @memberof DependantAppConnectionsAccountSourcePasswordPoliciesInner */ 'name'?: string; } /** * * @export * @interface DependantConnectionsMissingDto */ export interface DependantConnectionsMissingDto { /** * The type of dependency type that is missing in the SourceConnections * @type {string} * @memberof DependantConnectionsMissingDto */ 'dependencyType'?: DependantConnectionsMissingDtoDependencyTypeEnum; /** * The reason why this dependency is missing * @type {string} * @memberof DependantConnectionsMissingDto */ 'reason'?: string; } export declare const DependantConnectionsMissingDtoDependencyTypeEnum: { readonly IdentityProfiles: "identityProfiles"; readonly CredentialProfiles: "credentialProfiles"; readonly MappingProfiles: "mappingProfiles"; readonly SourceAttributes: "sourceAttributes"; readonly DependantCustomTransforms: "dependantCustomTransforms"; readonly DependantApps: "dependantApps"; }; export type DependantConnectionsMissingDtoDependencyTypeEnum = typeof DependantConnectionsMissingDtoDependencyTypeEnum[keyof typeof DependantConnectionsMissingDtoDependencyTypeEnum]; /** * An enumeration of the types of DTOs supported within the IdentityNow infrastructure. * @export * @enum {string} */ export declare const DtoType: { readonly AccountCorrelationConfig: "ACCOUNT_CORRELATION_CONFIG"; readonly AccessProfile: "ACCESS_PROFILE"; readonly AccessRequestApproval: "ACCESS_REQUEST_APPROVAL"; readonly Account: "ACCOUNT"; readonly Application: "APPLICATION"; readonly Campaign: "CAMPAIGN"; readonly CampaignFilter: "CAMPAIGN_FILTER"; readonly Certification: "CERTIFICATION"; readonly Cluster: "CLUSTER"; readonly ConnectorSchema: "CONNECTOR_SCHEMA"; readonly Entitlement: "ENTITLEMENT"; readonly GovernanceGroup: "GOVERNANCE_GROUP"; readonly Identity: "IDENTITY"; readonly IdentityProfile: "IDENTITY_PROFILE"; readonly IdentityRequest: "IDENTITY_REQUEST"; readonly MachineIdentity: "MACHINE_IDENTITY"; readonly LifecycleState: "LIFECYCLE_STATE"; readonly PasswordPolicy: "PASSWORD_POLICY"; readonly Role: "ROLE"; readonly Rule: "RULE"; readonly SodPolicy: "SOD_POLICY"; readonly Source: "SOURCE"; readonly Tag: "TAG"; readonly TagCategory: "TAG_CATEGORY"; readonly TaskResult: "TASK_RESULT"; readonly ReportResult: "REPORT_RESULT"; readonly SodViolation: "SOD_VIOLATION"; readonly AccountActivity: "ACCOUNT_ACTIVITY"; readonly Workgroup: "WORKGROUP"; }; export type DtoType = typeof DtoType[keyof typeof DtoType]; /** * * @export * @interface EntitlementAccessRequestConfig */ export interface EntitlementAccessRequestConfig { /** * Ordered list of approval steps for the access request. Empty when no approval is required. * @type {Array} * @memberof EntitlementAccessRequestConfig */ 'approvalSchemes'?: Array; /** * If the requester must provide a comment during access request. * @type {boolean} * @memberof EntitlementAccessRequestConfig */ 'requestCommentRequired'?: boolean; /** * If the reviewer must provide a comment when denying the access request. * @type {boolean} * @memberof EntitlementAccessRequestConfig */ 'denialCommentRequired'?: boolean; /** * Is Reauthorization Required * @type {boolean} * @memberof EntitlementAccessRequestConfig */ 'reauthorizationRequired'?: boolean; /** * If true, then remove date or sunset date is required in access request of the entitlement. * @type {boolean} * @memberof EntitlementAccessRequestConfig */ 'requireEndDate'?: boolean; /** * * @type {EntitlementAccessRequestConfigMaxPermittedAccessDuration} * @memberof EntitlementAccessRequestConfig */ 'maxPermittedAccessDuration'?: EntitlementAccessRequestConfigMaxPermittedAccessDuration | null; } /** * The maximum duration for which the access is permitted. * @export * @interface EntitlementAccessRequestConfigMaxPermittedAccessDuration */ export interface EntitlementAccessRequestConfigMaxPermittedAccessDuration { /** * The numeric value of the duration. * @type {number} * @memberof EntitlementAccessRequestConfigMaxPermittedAccessDuration */ 'value'?: number; /** * The time unit for the duration. * @type {string} * @memberof EntitlementAccessRequestConfigMaxPermittedAccessDuration */ 'timeUnit'?: EntitlementAccessRequestConfigMaxPermittedAccessDurationTimeUnitEnum; } export declare const EntitlementAccessRequestConfigMaxPermittedAccessDurationTimeUnitEnum: { readonly Hours: "HOURS"; readonly Days: "DAYS"; readonly Weeks: "WEEKS"; readonly Months: "MONTHS"; }; export type EntitlementAccessRequestConfigMaxPermittedAccessDurationTimeUnitEnum = typeof EntitlementAccessRequestConfigMaxPermittedAccessDurationTimeUnitEnum[keyof typeof EntitlementAccessRequestConfigMaxPermittedAccessDurationTimeUnitEnum]; /** * * @export * @interface EntitlementApprovalScheme */ export interface EntitlementApprovalScheme { /** * Describes the individual or group that is responsible for an approval step. Values are as follows. **ENTITLEMENT_OWNER**: Owner of the associated Entitlement **SOURCE_OWNER**: Owner of the associated Source **MANAGER**: Manager of the Identity for whom the request is being made **GOVERNANCE_GROUP**: A Governance Group, the ID of which is specified by the **approverId** field **WORKFLOW**: A Workflow, the ID of which is specified by the **approverId** field, Workflows are exclusive to other types of approvals and License required. * @type {string} * @memberof EntitlementApprovalScheme */ 'approverType'?: EntitlementApprovalSchemeApproverTypeEnum; /** * Id of the specific approver, used only when approverType is GOVERNANCE_GROUP or WORKFLOW * @type {string} * @memberof EntitlementApprovalScheme */ 'approverId'?: string | null; } export declare const EntitlementApprovalSchemeApproverTypeEnum: { readonly EntitlementOwner: "ENTITLEMENT_OWNER"; readonly SourceOwner: "SOURCE_OWNER"; readonly Manager: "MANAGER"; readonly GovernanceGroup: "GOVERNANCE_GROUP"; readonly Workflow: "WORKFLOW"; }; export type EntitlementApprovalSchemeApproverTypeEnum = typeof EntitlementApprovalSchemeApproverTypeEnum[keyof typeof EntitlementApprovalSchemeApproverTypeEnum]; /** * * @export * @interface EntitlementRevocationRequestConfig */ export interface EntitlementRevocationRequestConfig { /** * Ordered list of approval steps for the access request. Empty when no approval is required. * @type {Array} * @memberof EntitlementRevocationRequestConfig */ 'approvalSchemes'?: Array; } /** * * @export * @interface ErrorMessageDto */ export interface ErrorMessageDto { /** * The locale for the message text, a BCP 47 language tag. * @type {string} * @memberof ErrorMessageDto */ 'locale'?: string | null; /** * * @type {LocaleOrigin} * @memberof ErrorMessageDto */ 'localeOrigin'?: LocaleOrigin | null; /** * Actual text of the error message in the indicated locale. * @type {string} * @memberof ErrorMessageDto */ 'text'?: string; } /** * * @export * @interface ErrorResponseDto */ export interface ErrorResponseDto { /** * Fine-grained error code providing more detail of the error. * @type {string} * @memberof ErrorResponseDto */ 'detailCode'?: string; /** * Unique tracking id for the error. * @type {string} * @memberof ErrorResponseDto */ 'trackingId'?: string; /** * Generic localized reason for error * @type {Array} * @memberof ErrorResponseDto */ 'messages'?: Array; /** * Plain-text descriptive reasons to provide additional detail to the text provided in the messages field * @type {Array} * @memberof ErrorResponseDto */ 'causes'?: Array; } /** * * @export * @interface FieldDetailsDto */ export interface FieldDetailsDto { /** * The name of the attribute. * @type {string} * @memberof FieldDetailsDto */ 'name'?: string; /** * The transform to apply to the field * @type {object} * @memberof FieldDetailsDto */ 'transform'?: object; /** * Attributes required for the transform * @type {object} * @memberof FieldDetailsDto */ 'attributes'?: object; /** * Flag indicating whether or not the attribute is required. * @type {boolean} * @memberof FieldDetailsDto */ 'isRequired'?: boolean; /** * The type of the attribute. string: For text-based data. int: For whole numbers. long: For larger whole numbers. date: For date and time values. boolean: For true/false values. secret: For sensitive data like passwords, which will be masked and encrypted. * @type {string} * @memberof FieldDetailsDto */ 'type'?: FieldDetailsDtoTypeEnum; /** * Flag indicating whether or not the attribute is multi-valued. * @type {boolean} * @memberof FieldDetailsDto */ 'isMultiValued'?: boolean; } export declare const FieldDetailsDtoTypeEnum: { readonly String: "string"; readonly Int: "int"; readonly Long: "long"; readonly Date: "date"; readonly Boolean: "boolean"; readonly Secret: "secret"; }; export type FieldDetailsDtoTypeEnum = typeof FieldDetailsDtoTypeEnum[keyof typeof FieldDetailsDtoTypeEnum]; /** * * @export * @interface FieldDetailsDtoV2 */ export interface FieldDetailsDtoV2 { /** * The name of the attribute. * @type {string} * @memberof FieldDetailsDtoV2 */ 'name'?: string; /** * The transform to apply to the field * @type {object} * @memberof FieldDetailsDtoV2 */ 'transform'?: object; /** * Attributes required for the transform * @type {object} * @memberof FieldDetailsDtoV2 */ 'attributes'?: object; /** * Flag indicating whether or not the attribute is required. * @type {boolean} * @memberof FieldDetailsDtoV2 */ 'isRequired'?: boolean; /** * The type of the attribute. string: For text-based data. int: For whole numbers. long: For larger whole numbers. date: For date and time values. boolean: For true/false values. secret: For sensitive data like passwords, which will be masked and encrypted. * @type {string} * @memberof FieldDetailsDtoV2 */ 'type'?: FieldDetailsDtoV2TypeEnum; /** * Flag indicating whether or not the attribute is multi-valued. * @type {boolean} * @memberof FieldDetailsDtoV2 */ 'isMultiValued'?: boolean; } export declare const FieldDetailsDtoV2TypeEnum: { readonly String: "string"; readonly Int: "int"; readonly Long: "long"; readonly Date: "date"; readonly Boolean: "boolean"; readonly Secret: "secret"; }; export type FieldDetailsDtoV2TypeEnum = typeof FieldDetailsDtoV2TypeEnum[keyof typeof FieldDetailsDtoV2TypeEnum]; /** * * @export * @interface IdentityProfilesConnections */ export interface IdentityProfilesConnections { /** * ID of the IdentityProfile this reference applies * @type {string} * @memberof IdentityProfilesConnections */ 'id'?: string; /** * Human-readable display name of the IdentityProfile to which this reference applies * @type {string} * @memberof IdentityProfilesConnections */ 'name'?: string; /** * The Number of Identities managed by this IdentityProfile * @type {number} * @memberof IdentityProfilesConnections */ 'identityCount'?: number; } /** * * @export * @interface ImportAccountsSchemaV1Request */ export interface ImportAccountsSchemaV1Request { /** * * @type {File} * @memberof ImportAccountsSchemaV1Request */ 'file'?: File; } /** * * @export * @interface ImportAccountsV1Request */ export interface ImportAccountsV1Request { /** * The CSV file containing the source accounts to aggregate. * @type {File} * @memberof ImportAccountsV1Request */ 'file'?: File; /** * Use this flag to reprocess every account whether or not the data has changed. * @type {string} * @memberof ImportAccountsV1Request */ 'disableOptimization'?: string; } /** * * @export * @interface ImportEntitlementsV1Request */ export interface ImportEntitlementsV1Request { /** * The CSV file containing the source entitlements to aggregate. * @type {File} * @memberof ImportEntitlementsV1Request */ 'file'?: File; } /** * A JSONPatch Operation as defined by [RFC 6902 - JSON Patch](https://tools.ietf.org/html/rfc6902) * @export * @interface JsonPatchOperation */ export interface JsonPatchOperation { /** * The operation to be performed * @type {string} * @memberof JsonPatchOperation */ 'op': JsonPatchOperationOpEnum; /** * A string JSON Pointer representing the target path to an element to be affected by the operation * @type {string} * @memberof JsonPatchOperation */ 'path': string; /** * * @type {JsonPatchOperationValue} * @memberof JsonPatchOperation */ 'value'?: JsonPatchOperationValue; } export declare const JsonPatchOperationOpEnum: { readonly Add: "add"; readonly Remove: "remove"; readonly Replace: "replace"; readonly Move: "move"; readonly Copy: "copy"; readonly Test: "test"; }; export type JsonPatchOperationOpEnum = typeof JsonPatchOperationOpEnum[keyof typeof JsonPatchOperationOpEnum]; /** * @type JsonPatchOperationValue * The value to be used for the operation, required for \"add\" and \"replace\" operations * @export */ export type JsonPatchOperationValue = Array | boolean | number | object | string; /** * * @export * @interface ListSourcesV1401Response */ export interface ListSourcesV1401Response { /** * A message describing the error * @type {any} * @memberof ListSourcesV1401Response */ 'error'?: any; } /** * * @export * @interface ListSourcesV1429Response */ export interface ListSourcesV1429Response { /** * A message describing the error * @type {any} * @memberof ListSourcesV1429Response */ 'message'?: any; } /** * * @export * @interface LoadAccountsTask */ export interface LoadAccountsTask { /** * The status of the result * @type {boolean} * @memberof LoadAccountsTask */ 'success'?: boolean; /** * * @type {LoadAccountsTaskTask} * @memberof LoadAccountsTask */ 'task'?: LoadAccountsTaskTask; } /** * * @export * @interface LoadAccountsTaskTask */ export interface LoadAccountsTaskTask { /** * System-generated unique ID of the task this taskStatus represents * @type {string} * @memberof LoadAccountsTaskTask */ 'id'?: string; /** * Type of task this task represents * @type {string} * @memberof LoadAccountsTaskTask */ 'type'?: string; /** * The name of the aggregation process * @type {string} * @memberof LoadAccountsTaskTask */ 'name'?: string; /** * The description of the task * @type {string} * @memberof LoadAccountsTaskTask */ 'description'?: string; /** * The user who initiated the task * @type {string} * @memberof LoadAccountsTaskTask */ 'launcher'?: string; /** * The Task creation date * @type {string} * @memberof LoadAccountsTaskTask */ 'created'?: string; /** * The task start date * @type {string} * @memberof LoadAccountsTaskTask */ 'launched'?: string | null; /** * The task completion date * @type {string} * @memberof LoadAccountsTaskTask */ 'completed'?: string | null; /** * Task completion status. * @type {string} * @memberof LoadAccountsTaskTask */ 'completionStatus'?: LoadAccountsTaskTaskCompletionStatusEnum | null; /** * Name of the parent task if exists. * @type {string} * @memberof LoadAccountsTaskTask */ 'parentName'?: string | null; /** * List of the messages dedicated to the report. From task definition perspective here usually should be warnings or errors. * @type {Array} * @memberof LoadAccountsTaskTask */ 'messages'?: Array; /** * Current task state. * @type {string} * @memberof LoadAccountsTaskTask */ 'progress'?: string | null; /** * * @type {LoadAccountsTaskTaskAttributes} * @memberof LoadAccountsTaskTask */ 'attributes'?: LoadAccountsTaskTaskAttributes; /** * Return values from the task * @type {Array} * @memberof LoadAccountsTaskTask */ 'returns'?: Array; } export declare const LoadAccountsTaskTaskCompletionStatusEnum: { readonly Success: "SUCCESS"; readonly Warning: "WARNING"; readonly Error: "ERROR"; readonly Terminated: "TERMINATED"; readonly TempError: "TEMP_ERROR"; }; export type LoadAccountsTaskTaskCompletionStatusEnum = typeof LoadAccountsTaskTaskCompletionStatusEnum[keyof typeof LoadAccountsTaskTaskCompletionStatusEnum]; /** * Extra attributes map(dictionary) for the task. * @export * @interface LoadAccountsTaskTaskAttributes */ export interface LoadAccountsTaskTaskAttributes { [key: string]: object | any; /** * The id of the source * @type {string} * @memberof LoadAccountsTaskTaskAttributes */ 'appId'?: string; /** * The indicator if the aggregation process was enabled/disabled for the aggregation job * @type {string} * @memberof LoadAccountsTaskTaskAttributes */ 'optimizedAggregation'?: string; } /** * * @export * @interface LoadAccountsTaskTaskMessagesInner */ export interface LoadAccountsTaskTaskMessagesInner { /** * Type of the message. * @type {string} * @memberof LoadAccountsTaskTaskMessagesInner */ 'type'?: LoadAccountsTaskTaskMessagesInnerTypeEnum; /** * Flag whether message is an error. * @type {boolean} * @memberof LoadAccountsTaskTaskMessagesInner */ 'error'?: boolean; /** * Flag whether message is a warning. * @type {boolean} * @memberof LoadAccountsTaskTaskMessagesInner */ 'warning'?: boolean; /** * Message string identifier. * @type {string} * @memberof LoadAccountsTaskTaskMessagesInner */ 'key'?: string; /** * Message context with the locale based language. * @type {string} * @memberof LoadAccountsTaskTaskMessagesInner */ 'localizedText'?: string; } export declare const LoadAccountsTaskTaskMessagesInnerTypeEnum: { readonly Info: "INFO"; readonly Warn: "WARN"; readonly Error: "ERROR"; }; export type LoadAccountsTaskTaskMessagesInnerTypeEnum = typeof LoadAccountsTaskTaskMessagesInnerTypeEnum[keyof typeof LoadAccountsTaskTaskMessagesInnerTypeEnum]; /** * * @export * @interface LoadAccountsTaskTaskReturnsInner */ export interface LoadAccountsTaskTaskReturnsInner { /** * The display label of the return value * @type {string} * @memberof LoadAccountsTaskTaskReturnsInner */ 'displayLabel'?: string; /** * The attribute name of the return value * @type {string} * @memberof LoadAccountsTaskTaskReturnsInner */ 'attributeName'?: string; } /** * * @export * @interface LoadEntitlementTask */ export interface LoadEntitlementTask { /** * System-generated unique ID of the task this taskStatus represents * @type {string} * @memberof LoadEntitlementTask */ 'id'?: string; /** * Type of task this task represents * @type {string} * @memberof LoadEntitlementTask */ 'type'?: string; /** * The name of the task * @type {string} * @memberof LoadEntitlementTask */ 'uniqueName'?: string; /** * The description of the task * @type {string} * @memberof LoadEntitlementTask */ 'description'?: string; /** * The user who initiated the task * @type {string} * @memberof LoadEntitlementTask */ 'launcher'?: string; /** * The creation date of the task * @type {string} * @memberof LoadEntitlementTask */ 'created'?: string; /** * Return values from the task * @type {Array} * @memberof LoadEntitlementTask */ 'returns'?: Array; } /** * * @export * @interface LoadEntitlementTaskReturnsInner */ export interface LoadEntitlementTaskReturnsInner { /** * The display label for the return value * @type {string} * @memberof LoadEntitlementTaskReturnsInner */ 'displayLabel'?: string; /** * The attribute name for the return value * @type {string} * @memberof LoadEntitlementTaskReturnsInner */ 'attributeName'?: string; } /** * * @export * @interface LoadUncorrelatedAccountsTask */ export interface LoadUncorrelatedAccountsTask { /** * The status of the result * @type {boolean} * @memberof LoadUncorrelatedAccountsTask */ 'success'?: boolean; /** * * @type {LoadUncorrelatedAccountsTaskTask} * @memberof LoadUncorrelatedAccountsTask */ 'task'?: LoadUncorrelatedAccountsTaskTask; } /** * * @export * @interface LoadUncorrelatedAccountsTaskTask */ export interface LoadUncorrelatedAccountsTaskTask { /** * System-generated unique ID of the task this taskStatus represents * @type {string} * @memberof LoadUncorrelatedAccountsTaskTask */ 'id'?: string; /** * Type of task this task represents * @type {string} * @memberof LoadUncorrelatedAccountsTaskTask */ 'type'?: string; /** * The name of uncorrelated accounts process * @type {string} * @memberof LoadUncorrelatedAccountsTaskTask */ 'name'?: string; /** * The description of the task * @type {string} * @memberof LoadUncorrelatedAccountsTaskTask */ 'description'?: string; /** * The user who initiated the task * @type {string} * @memberof LoadUncorrelatedAccountsTaskTask */ 'launcher'?: string; /** * The Task creation date * @type {string} * @memberof LoadUncorrelatedAccountsTaskTask */ 'created'?: string; /** * The task start date * @type {string} * @memberof LoadUncorrelatedAccountsTaskTask */ 'launched'?: string | null; /** * The task completion date * @type {string} * @memberof LoadUncorrelatedAccountsTaskTask */ 'completed'?: string | null; /** * Task completion status. * @type {string} * @memberof LoadUncorrelatedAccountsTaskTask */ 'completionStatus'?: LoadUncorrelatedAccountsTaskTaskCompletionStatusEnum | null; /** * Name of the parent task if exists. * @type {string} * @memberof LoadUncorrelatedAccountsTaskTask */ 'parentName'?: string | null; /** * List of the messages dedicated to the report. From task definition perspective here usually should be warnings or errors. * @type {Array} * @memberof LoadUncorrelatedAccountsTaskTask */ 'messages'?: Array; /** * Current task state. * @type {string} * @memberof LoadUncorrelatedAccountsTaskTask */ 'progress'?: string | null; /** * * @type {LoadUncorrelatedAccountsTaskTaskAttributes} * @memberof LoadUncorrelatedAccountsTaskTask */ 'attributes'?: LoadUncorrelatedAccountsTaskTaskAttributes; /** * Return values from the task * @type {object} * @memberof LoadUncorrelatedAccountsTaskTask */ 'returns'?: object; } export declare const LoadUncorrelatedAccountsTaskTaskCompletionStatusEnum: { readonly Success: "SUCCESS"; readonly Warning: "WARNING"; readonly Error: "ERROR"; readonly Terminated: "TERMINATED"; readonly TempError: "TEMP_ERROR"; }; export type LoadUncorrelatedAccountsTaskTaskCompletionStatusEnum = typeof LoadUncorrelatedAccountsTaskTaskCompletionStatusEnum[keyof typeof LoadUncorrelatedAccountsTaskTaskCompletionStatusEnum]; /** * Extra attributes map(dictionary) for the task. * @export * @interface LoadUncorrelatedAccountsTaskTaskAttributes */ export interface LoadUncorrelatedAccountsTaskTaskAttributes { /** * The id of qpoc job * @type {string} * @memberof LoadUncorrelatedAccountsTaskTaskAttributes */ 'qpocJobId'?: string; /** * the task start delay value * @type {any} * @memberof LoadUncorrelatedAccountsTaskTaskAttributes */ 'taskStartDelay'?: any; } /** * * @export * @interface LoadUncorrelatedAccountsTaskTaskMessagesInner */ export interface LoadUncorrelatedAccountsTaskTaskMessagesInner { /** * Type of the message. * @type {string} * @memberof LoadUncorrelatedAccountsTaskTaskMessagesInner */ 'type'?: LoadUncorrelatedAccountsTaskTaskMessagesInnerTypeEnum; /** * Flag whether message is an error. * @type {boolean} * @memberof LoadUncorrelatedAccountsTaskTaskMessagesInner */ 'error'?: boolean; /** * Flag whether message is a warning. * @type {boolean} * @memberof LoadUncorrelatedAccountsTaskTaskMessagesInner */ 'warning'?: boolean; /** * Message string identifier. * @type {string} * @memberof LoadUncorrelatedAccountsTaskTaskMessagesInner */ 'key'?: string; /** * Message context with the locale based language. * @type {string} * @memberof LoadUncorrelatedAccountsTaskTaskMessagesInner */ 'localizedText'?: string; } export declare const LoadUncorrelatedAccountsTaskTaskMessagesInnerTypeEnum: { readonly Info: "INFO"; readonly Warn: "WARN"; readonly Error: "ERROR"; }; export type LoadUncorrelatedAccountsTaskTaskMessagesInnerTypeEnum = typeof LoadUncorrelatedAccountsTaskTaskMessagesInnerTypeEnum[keyof typeof LoadUncorrelatedAccountsTaskTaskMessagesInnerTypeEnum]; /** * An indicator of how the locale was selected. *DEFAULT* means the locale is the system default. *REQUEST* means the locale was selected from the request context (i.e., best match based on the *Accept-Language* header). Additional values may be added in the future without notice. * @export * @enum {string} */ export declare const LocaleOrigin: { readonly Default: "DEFAULT"; readonly Request: "REQUEST"; }; export type LocaleOrigin = typeof LocaleOrigin[keyof typeof LocaleOrigin]; /** * * @export * @interface ManagerCorrelationMapping */ export interface ManagerCorrelationMapping { /** * Name of the attribute to use for manager correlation. The value found on the account attribute will be used to lookup the manager\'s identity. * @type {string} * @memberof ManagerCorrelationMapping */ 'accountAttributeName'?: string; /** * Name of the identity attribute to search when trying to find a manager using the value from the accountAttribute. * @type {string} * @memberof ManagerCorrelationMapping */ 'identityAttributeName'?: string; } /** * Source configuration information for Native Change Detection that is read and used by account aggregation process. * @export * @interface NativeChangeDetectionConfig */ export interface NativeChangeDetectionConfig { /** * A flag indicating if Native Change Detection is enabled for a source. * @type {boolean} * @memberof NativeChangeDetectionConfig */ 'enabled'?: boolean; /** * Operation types for which Native Change Detection is enabled for a source. * @type {Array} * @memberof NativeChangeDetectionConfig */ 'operations'?: Array; /** * A flag indicating that all entitlements participate in Native Change Detection. * @type {boolean} * @memberof NativeChangeDetectionConfig */ 'allEntitlements'?: boolean; /** * A flag indicating that all non-entitlement account attributes participate in Native Change Detection. * @type {boolean} * @memberof NativeChangeDetectionConfig */ 'allNonEntitlementAttributes'?: boolean; /** * If allEntitlements flag is off this field lists entitlements that participate in Native Change Detection. * @type {Array} * @memberof NativeChangeDetectionConfig */ 'selectedEntitlements'?: Array; /** * If allNonEntitlementAttributes flag is off this field lists non-entitlement account attributes that participate in Native Change Detection. * @type {Array} * @memberof NativeChangeDetectionConfig */ 'selectedNonEntitlementAttributes'?: Array; } export declare const NativeChangeDetectionConfigOperationsEnum: { readonly AccountUpdated: "ACCOUNT_UPDATED"; readonly AccountCreated: "ACCOUNT_CREATED"; readonly AccountDeleted: "ACCOUNT_DELETED"; }; export type NativeChangeDetectionConfigOperationsEnum = typeof NativeChangeDetectionConfigOperationsEnum[keyof typeof NativeChangeDetectionConfigOperationsEnum]; /** * * @export * @interface PasswordPolicyHoldersDtoAttributes */ export interface PasswordPolicyHoldersDtoAttributes { /** * Attributes of PasswordPolicyHoldersDto * @type {Array} * @memberof PasswordPolicyHoldersDtoAttributes */ 'identityAttr'?: Array; } /** * * @export * @interface PasswordPolicyHoldersDtoAttributesIdentityAttrInner */ export interface PasswordPolicyHoldersDtoAttributesIdentityAttrInner { /** * Attribute\'s name * @type {string} * @memberof PasswordPolicyHoldersDtoAttributesIdentityAttrInner */ 'name'?: string; /** * Attribute\'s value * @type {string} * @memberof PasswordPolicyHoldersDtoAttributesIdentityAttrInner */ 'value'?: string; } /** * * @export * @interface PasswordPolicyHoldersDtoInner */ export interface PasswordPolicyHoldersDtoInner { /** * The password policy Id. * @type {string} * @memberof PasswordPolicyHoldersDtoInner */ 'policyId'?: string; /** * The name of the password policy. * @type {string} * @memberof PasswordPolicyHoldersDtoInner */ 'policyName'?: string; /** * * @type {PasswordPolicyHoldersDtoAttributes} * @memberof PasswordPolicyHoldersDtoInner */ 'selectors'?: PasswordPolicyHoldersDtoAttributes; } /** * * @export * @interface ProvisioningPolicyDto */ export interface ProvisioningPolicyDto { /** * the provisioning policy name * @type {string} * @memberof ProvisioningPolicyDto */ 'name': string | null; /** * the description of the provisioning policy * @type {string} * @memberof ProvisioningPolicyDto */ 'description'?: string; /** * * @type {UsageType} * @memberof ProvisioningPolicyDto */ 'usageType'?: UsageType; /** * * @type {Array} * @memberof ProvisioningPolicyDto */ 'fields'?: Array; } /** * * @export * @interface ProvisioningPolicyDtoV2 */ export interface ProvisioningPolicyDtoV2 { /** * System-generated unique ID of the provisioning policy. * @type {string} * @memberof ProvisioningPolicyDtoV2 */ 'id'?: string; /** * the provisioning policy name * @type {string} * @memberof ProvisioningPolicyDtoV2 */ 'name': string | null; /** * Subtype ID for which provisioning policy will be created when usageType is CREATE_MACHINE_ACCOUNT. * @type {string} * @memberof ProvisioningPolicyDtoV2 */ 'subtypeId'?: string | null; /** * the description of the provisioning policy * @type {string} * @memberof ProvisioningPolicyDtoV2 */ 'description'?: string; /** * * @type {Usagetypev2} * @memberof ProvisioningPolicyDtoV2 */ 'usageType'?: Usagetypev2; /** * * @type {Array} * @memberof ProvisioningPolicyDtoV2 */ 'fields'?: Array; } /** * Representation of the object which is returned from source connectors. * @export * @interface ResourceObject */ export interface ResourceObject { /** * Identifier of the specific instance where this object resides. * @type {string} * @memberof ResourceObject */ 'instance'?: string; /** * Native identity of the object in the Source. * @type {string} * @memberof ResourceObject */ 'identity'?: string; /** * Universal unique identifier of the object in the Source. * @type {string} * @memberof ResourceObject */ 'uuid'?: string; /** * Native identity that the object has previously. * @type {string} * @memberof ResourceObject */ 'previousIdentity'?: string; /** * Display name for this object. * @type {string} * @memberof ResourceObject */ 'name'?: string; /** * Type of object. * @type {string} * @memberof ResourceObject */ 'objectType'?: string; /** * A flag indicating that this is an incomplete object. Used in special cases where the connector has to return account information in several phases and the objects might not have a complete set of all account attributes. The attributes in this object will replace the corresponding attributes in the Link, but no other Link attributes will be changed. * @type {boolean} * @memberof ResourceObject */ 'incomplete'?: boolean; /** * A flag indicating that this is an incremental change object. This is similar to incomplete but it also means that the values of any multi-valued attributes in this object should be merged with the existing values in the Link rather than replacing the existing Link value. * @type {boolean} * @memberof ResourceObject */ 'incremental'?: boolean; /** * A flag indicating that this object has been deleted. This is set only when doing delta aggregation and the connector supports detection of native deletes. * @type {boolean} * @memberof ResourceObject */ 'delete'?: boolean; /** * A flag set indicating that the values in the attributes represent things to remove rather than things to add. Setting this implies incremental. The values which are always for multi-valued attributes are removed from the current values. * @type {boolean} * @memberof ResourceObject */ 'remove'?: boolean; /** * A list of attribute names that are not included in this object. This is only used with SMConnector and will only contain \"groups\". * @type {Array} * @memberof ResourceObject */ 'missing'?: Array; /** * Attributes of this ResourceObject. * @type {object} * @memberof ResourceObject */ 'attributes'?: object; /** * In Aggregation, for sparse object the count for total accounts scanned identities updated is not incremented. * @type {boolean} * @memberof ResourceObject */ 'finalUpdate'?: boolean; } /** * Request model for peek resource objects from source connectors. * @export * @interface ResourceObjectsRequest */ export interface ResourceObjectsRequest { /** * The type of resource objects to iterate over. * @type {string} * @memberof ResourceObjectsRequest */ 'objectType'?: string; /** * The maximum number of resource objects to iterate over and return. * @type {number} * @memberof ResourceObjectsRequest */ 'maxCount'?: number; } /** * Response model for peek resource objects from source connectors. * @export * @interface ResourceObjectsResponse */ export interface ResourceObjectsResponse { /** * ID of the source * @type {string} * @memberof ResourceObjectsResponse */ 'id'?: string; /** * Name of the source * @type {string} * @memberof ResourceObjectsResponse */ 'name'?: string; /** * The number of objects that were fetched by the connector. * @type {number} * @memberof ResourceObjectsResponse */ 'objectCount'?: number; /** * The number of milliseconds spent on the entire request. * @type {number} * @memberof ResourceObjectsResponse */ 'elapsedMillis'?: number; /** * Fetched objects from the source connector. * @type {Array} * @memberof ResourceObjectsResponse */ 'resourceObjects'?: Array; } /** * * @export * @interface Schedule3 */ export interface Schedule3 { /** * The type of the Schedule. * @type {string} * @memberof Schedule3 */ 'type': Schedule3TypeEnum; /** * The cron expression of the schedule. * @type {string} * @memberof Schedule3 */ 'cronExpression': string; } export declare const Schedule3TypeEnum: { readonly AccountAggregation: "ACCOUNT_AGGREGATION"; readonly GroupAggregation: "GROUP_AGGREGATION"; }; export type Schedule3TypeEnum = typeof Schedule3TypeEnum[keyof typeof Schedule3TypeEnum]; /** * * @export * @interface Schema */ export interface Schema { /** * The id of the Schema. * @type {string} * @memberof Schema */ 'id'?: string; /** * The name of the Schema. * @type {string} * @memberof Schema */ 'name'?: string; /** * The name of the object type on the native system that the schema represents. * @type {string} * @memberof Schema */ 'nativeObjectType'?: string; /** * The name of the attribute used to calculate the unique identifier for an object in the schema. * @type {string} * @memberof Schema */ 'identityAttribute'?: string; /** * The name of the attribute used to calculate the display value for an object in the schema. * @type {string} * @memberof Schema */ 'displayAttribute'?: string; /** * The name of the attribute whose values represent other objects in a hierarchy. Only relevant to group schemas. * @type {string} * @memberof Schema */ 'hierarchyAttribute'?: string | null; /** * Flag indicating whether or not the include permissions with the object data when aggregating the schema. * @type {boolean} * @memberof Schema */ 'includePermissions'?: boolean; /** * Optional features that can be supported by a source. Modifying the features array may cause source configuration errors that are unsupportable. It is recommended to not modify this array for SailPoint supported connectors. * AUTHENTICATE: The source supports pass-through authentication. * COMPOSITE: The source supports composite source creation. * DIRECT_PERMISSIONS: The source supports returning DirectPermissions. * DISCOVER_SCHEMA: The source supports discovering schemas for users and groups. * ENABLE The source supports reading if an account is enabled or disabled. * MANAGER_LOOKUP: The source supports looking up managers as they are encountered in a feed. This is the opposite of NO_RANDOM_ACCESS. * NO_RANDOM_ACCESS: The source does not support random access and the getObject() methods should not be called and expected to perform. * PROXY: The source can serve as a proxy for another source. When an source has a proxy, all connector calls made with that source are redirected through the connector for the proxy source. * SEARCH * TEMPLATE * UNLOCK: The source supports reading if an account is locked or unlocked. * UNSTRUCTURED_TARGETS: The source supports returning unstructured Targets. * SHAREPOINT_TARGET: The source supports returning unstructured Target data for SharePoint. It will be typically used by AD, LDAP sources. * PROVISIONING: The source can both read and write accounts. Having this feature implies that the provision() method is implemented. It also means that direct and target permissions can also be provisioned if they can be returned by aggregation. * GROUP_PROVISIONING: The source can both read and write groups. Having this feature implies that the provision() method is implemented. * SYNC_PROVISIONING: The source can provision accounts synchronously. * PASSWORD: The source can provision password changes. Since sources can never read passwords, this is should only be used in conjunction with the PROVISIONING feature. * CURRENT_PASSWORD: Some source types support verification of the current password * ACCOUNT_ONLY_REQUEST: The source supports requesting accounts without entitlements. * ADDITIONAL_ACCOUNT_REQUEST: The source supports requesting additional accounts. * NO_AGGREGATION: A source that does not support aggregation. * GROUPS_HAVE_MEMBERS: The source models group memberships with a member attribute on the group object rather than a groups attribute on the account object. This effects the implementation of delta account aggregation. * NO_PERMISSIONS_PROVISIONING: Indicates that the connector cannot provision direct or target permissions for accounts. When DIRECT_PERMISSIONS and PROVISIONING features are present, it is assumed that the connector can also provision direct permissions. This feature disables that assumption and causes permission request to be converted to work items for accounts. * NO_GROUP_PERMISSIONS_PROVISIONING: Indicates that the connector cannot provision direct or target permissions for groups. When DIRECT_PERMISSIONS and PROVISIONING features are present, it is assumed that the connector can also provision direct permissions. This feature disables that assumption and causes permission request to be converted to work items for groups. * NO_UNSTRUCTURED_TARGETS_PROVISIONING: This string will be replaced by NO_GROUP_PERMISSIONS_PROVISIONING and NO_PERMISSIONS_PROVISIONING. * NO_DIRECT_PERMISSIONS_PROVISIONING: This string will be replaced by NO_GROUP_PERMISSIONS_PROVISIONING and NO_PERMISSIONS_PROVISIONING. * USES_UUID: Connectivity 2.0 flag used to indicate that the connector supports a compound naming structure. * PREFER_UUID: Used in ISC Provisioning AND Aggregation to decide if it should prefer account.uuid to account.nativeIdentity when data is read in through aggregation OR pushed out through provisioning. * ARM_SECURITY_EXTRACT: Indicates the application supports Security extracts for ARM * ARM_UTILIZATION_EXTRACT: Indicates the application supports Utilization extracts for ARM * ARM_CHANGELOG_EXTRACT: Indicates the application supports Change-log extracts for ARM * @type {Array} * @memberof Schema */ 'features'?: Array; /** * Holds any extra configuration data that the schema may require. * @type {object} * @memberof Schema */ 'configuration'?: object; /** * The attribute definitions which form the schema. * @type {Array} * @memberof Schema */ 'attributes'?: Array; /** * The date the Schema was created. * @type {string} * @memberof Schema */ 'created'?: string; /** * The date the Schema was last modified. * @type {string} * @memberof Schema */ 'modified'?: string | null; } export declare const SchemaFeaturesEnum: { readonly Authenticate: "AUTHENTICATE"; readonly Composite: "COMPOSITE"; readonly DirectPermissions: "DIRECT_PERMISSIONS"; readonly DiscoverSchema: "DISCOVER_SCHEMA"; readonly Enable: "ENABLE"; readonly ManagerLookup: "MANAGER_LOOKUP"; readonly NoRandomAccess: "NO_RANDOM_ACCESS"; readonly Proxy: "PROXY"; readonly Search: "SEARCH"; readonly Template: "TEMPLATE"; readonly Unlock: "UNLOCK"; readonly UnstructuredTargets: "UNSTRUCTURED_TARGETS"; readonly SharepointTarget: "SHAREPOINT_TARGET"; readonly Provisioning: "PROVISIONING"; readonly GroupProvisioning: "GROUP_PROVISIONING"; readonly SyncProvisioning: "SYNC_PROVISIONING"; readonly Password: "PASSWORD"; readonly CurrentPassword: "CURRENT_PASSWORD"; readonly AccountOnlyRequest: "ACCOUNT_ONLY_REQUEST"; readonly AdditionalAccountRequest: "ADDITIONAL_ACCOUNT_REQUEST"; readonly NoAggregation: "NO_AGGREGATION"; readonly GroupsHaveMembers: "GROUPS_HAVE_MEMBERS"; readonly NoPermissionsProvisioning: "NO_PERMISSIONS_PROVISIONING"; readonly NoGroupPermissionsProvisioning: "NO_GROUP_PERMISSIONS_PROVISIONING"; readonly NoUnstructuredTargetsProvisioning: "NO_UNSTRUCTURED_TARGETS_PROVISIONING"; readonly NoDirectPermissionsProvisioning: "NO_DIRECT_PERMISSIONS_PROVISIONING"; readonly PreferUuid: "PREFER_UUID"; readonly ArmSecurityExtract: "ARM_SECURITY_EXTRACT"; readonly ArmUtilizationExtract: "ARM_UTILIZATION_EXTRACT"; readonly ArmChangelogExtract: "ARM_CHANGELOG_EXTRACT"; readonly UsesUuid: "USES_UUID"; readonly ApplicationDiscovery: "APPLICATION_DISCOVERY"; readonly Delete: "DELETE"; }; export type SchemaFeaturesEnum = typeof SchemaFeaturesEnum[keyof typeof SchemaFeaturesEnum]; /** * * @export * @interface Source */ export interface Source { /** * Source ID. * @type {string} * @memberof Source */ 'id'?: string; /** * Source\'s human-readable name. * @type {string} * @memberof Source */ 'name': string; /** * Source\'s human-readable description. * @type {string} * @memberof Source */ 'description'?: string; /** * * @type {SourceOwner} * @memberof Source */ 'owner': SourceOwner | null; /** * * @type {SourceCluster} * @memberof Source */ 'cluster'?: SourceCluster | null; /** * * @type {SourceAccountCorrelationConfig} * @memberof Source */ 'accountCorrelationConfig'?: SourceAccountCorrelationConfig | null; /** * * @type {SourceAccountCorrelationRule} * @memberof Source */ 'accountCorrelationRule'?: SourceAccountCorrelationRule | null; /** * * @type {SourceManagerCorrelationMapping} * @memberof Source */ 'managerCorrelationMapping'?: SourceManagerCorrelationMapping; /** * * @type {SourceManagerCorrelationRule} * @memberof Source */ 'managerCorrelationRule'?: SourceManagerCorrelationRule | null; /** * * @type {SourceBeforeProvisioningRule} * @memberof Source */ 'beforeProvisioningRule'?: SourceBeforeProvisioningRule | null; /** * List of references to schema objects. * @type {Array} * @memberof Source */ 'schemas'?: Array; /** * List of references to the associated PasswordPolicy objects. * @type {Array} * @memberof Source */ 'passwordPolicies'?: Array | null; /** * Optional features that can be supported by a source. Modifying the features array may cause source configuration errors that are unsupportable. It is recommended to not modify this array for SailPoint supported connectors. * AUTHENTICATE: The source supports pass-through authentication. * COMPOSITE: The source supports composite source creation. * DIRECT_PERMISSIONS: The source supports returning DirectPermissions. * DISCOVER_SCHEMA: The source supports discovering schemas for users and groups. * ENABLE The source supports reading if an account is enabled or disabled. * MANAGER_LOOKUP: The source supports looking up managers as they are encountered in a feed. This is the opposite of NO_RANDOM_ACCESS. * NO_RANDOM_ACCESS: The source does not support random access and the getObject() methods should not be called and expected to perform. * PROXY: The source can serve as a proxy for another source. When an source has a proxy, all connector calls made with that source are redirected through the connector for the proxy source. * SEARCH * TEMPLATE * UNLOCK: The source supports reading if an account is locked or unlocked. * UNSTRUCTURED_TARGETS: The source supports returning unstructured Targets. * SHAREPOINT_TARGET: The source supports returning unstructured Target data for SharePoint. It will be typically used by AD, LDAP sources. * PROVISIONING: The source can both read and write accounts. Having this feature implies that the provision() method is implemented. It also means that direct and target permissions can also be provisioned if they can be returned by aggregation. * GROUP_PROVISIONING: The source can both read and write groups. Having this feature implies that the provision() method is implemented. * SYNC_PROVISIONING: The source can provision accounts synchronously. * PASSWORD: The source can provision password changes. Since sources can never read passwords, this is should only be used in conjunction with the PROVISIONING feature. * CURRENT_PASSWORD: Some source types support verification of the current password * ACCOUNT_ONLY_REQUEST: The source supports requesting accounts without entitlements. * ADDITIONAL_ACCOUNT_REQUEST: The source supports requesting additional accounts. * NO_AGGREGATION: A source that does not support aggregation. * GROUPS_HAVE_MEMBERS: The source models group memberships with a member attribute on the group object rather than a groups attribute on the account object. This effects the implementation of delta account aggregation. * NO_PERMISSIONS_PROVISIONING: Indicates that the connector cannot provision direct or target permissions for accounts. When DIRECT_PERMISSIONS and PROVISIONING features are present, it is assumed that the connector can also provision direct permissions. This feature disables that assumption and causes permission request to be converted to work items for accounts. * NO_GROUP_PERMISSIONS_PROVISIONING: Indicates that the connector cannot provision direct or target permissions for groups. When DIRECT_PERMISSIONS and PROVISIONING features are present, it is assumed that the connector can also provision direct permissions. This feature disables that assumption and causes permission request to be converted to work items for groups. * NO_UNSTRUCTURED_TARGETS_PROVISIONING: This string will be replaced by NO_GROUP_PERMISSIONS_PROVISIONING and NO_PERMISSIONS_PROVISIONING. * NO_DIRECT_PERMISSIONS_PROVISIONING: This string will be replaced by NO_GROUP_PERMISSIONS_PROVISIONING and NO_PERMISSIONS_PROVISIONING. * USES_UUID: Connectivity 2.0 flag used to indicate that the connector supports a compound naming structure. * PREFER_UUID: Used in ISC Provisioning AND Aggregation to decide if it should prefer account.uuid to account.nativeIdentity when data is read in through aggregation OR pushed out through provisioning. * ARM_SECURITY_EXTRACT: Indicates the application supports Security extracts for ARM * ARM_UTILIZATION_EXTRACT: Indicates the application supports Utilization extracts for ARM * ARM_CHANGELOG_EXTRACT: Indicates the application supports Change-log extracts for ARM * @type {Array} * @memberof Source */ 'features'?: Array; /** * Specifies the type of system being managed e.g. Active Directory, Workday, etc.. If you are creating a delimited file source, you must set the `provisionasCsv` query parameter to `true`. * @type {string} * @memberof Source */ 'type'?: string; /** * Connector script name. * @type {string} * @memberof Source */ 'connector': string; /** * Fully qualified name of the Java class that implements the connector interface. * @type {string} * @memberof Source */ 'connectorClass'?: string; /** * Connector specific configuration. This configuration will differ from type to type. * @type {object} * @memberof Source */ 'connectorAttributes'?: object; /** * Number from 0 to 100 that specifies when to skip the delete phase. * @type {number} * @memberof Source */ 'deleteThreshold'?: number; /** * When this is true, it indicates that the source is referenced by an identity profile. * @type {boolean} * @memberof Source */ 'authoritative'?: boolean; /** * * @type {SourceManagementWorkgroup} * @memberof Source */ 'managementWorkgroup'?: SourceManagementWorkgroup | null; /** * When this is true, it indicates that the source is healthy. * @type {boolean} * @memberof Source */ 'healthy'?: boolean; /** * Status identifier that gives specific information about why a source is or isn\'t healthy. * @type {string} * @memberof Source */ 'status'?: SourceStatusEnum; /** * Timestamp that shows when a source health check was last performed. * @type {string} * @memberof Source */ 'since'?: string; /** * Connector ID * @type {string} * @memberof Source */ 'connectorId'?: string; /** * Name of the connector that was chosen during source creation. * @type {string} * @memberof Source */ 'connectorName'?: string; /** * Type of connection (direct or file). * @type {string} * @memberof Source */ 'connectionType'?: string; /** * Connector implementation ID. * @type {string} * @memberof Source */ 'connectorImplementationId'?: string; /** * Date-time when the source was created * @type {string} * @memberof Source */ 'created'?: string; /** * Date-time when the source was last modified. * @type {string} * @memberof Source */ 'modified'?: string; /** * If this is true, it enables a credential provider for the source. If credentialProvider is turned on, then the source can use credential provider(s) to fetch credentials. * @type {boolean} * @memberof Source */ 'credentialProviderEnabled'?: boolean; /** * Source category (e.g. null, CredentialProvider). * @type {string} * @memberof Source */ 'category'?: string | null; } export declare const SourceFeaturesEnum: { readonly Authenticate: "AUTHENTICATE"; readonly Composite: "COMPOSITE"; readonly DirectPermissions: "DIRECT_PERMISSIONS"; readonly DiscoverSchema: "DISCOVER_SCHEMA"; readonly Enable: "ENABLE"; readonly ManagerLookup: "MANAGER_LOOKUP"; readonly NoRandomAccess: "NO_RANDOM_ACCESS"; readonly Proxy: "PROXY"; readonly Search: "SEARCH"; readonly Template: "TEMPLATE"; readonly Unlock: "UNLOCK"; readonly UnstructuredTargets: "UNSTRUCTURED_TARGETS"; readonly SharepointTarget: "SHAREPOINT_TARGET"; readonly Provisioning: "PROVISIONING"; readonly GroupProvisioning: "GROUP_PROVISIONING"; readonly SyncProvisioning: "SYNC_PROVISIONING"; readonly Password: "PASSWORD"; readonly CurrentPassword: "CURRENT_PASSWORD"; readonly AccountOnlyRequest: "ACCOUNT_ONLY_REQUEST"; readonly AdditionalAccountRequest: "ADDITIONAL_ACCOUNT_REQUEST"; readonly NoAggregation: "NO_AGGREGATION"; readonly GroupsHaveMembers: "GROUPS_HAVE_MEMBERS"; readonly NoPermissionsProvisioning: "NO_PERMISSIONS_PROVISIONING"; readonly NoGroupPermissionsProvisioning: "NO_GROUP_PERMISSIONS_PROVISIONING"; readonly NoUnstructuredTargetsProvisioning: "NO_UNSTRUCTURED_TARGETS_PROVISIONING"; readonly NoDirectPermissionsProvisioning: "NO_DIRECT_PERMISSIONS_PROVISIONING"; readonly PreferUuid: "PREFER_UUID"; readonly ArmSecurityExtract: "ARM_SECURITY_EXTRACT"; readonly ArmUtilizationExtract: "ARM_UTILIZATION_EXTRACT"; readonly ArmChangelogExtract: "ARM_CHANGELOG_EXTRACT"; readonly UsesUuid: "USES_UUID"; readonly ApplicationDiscovery: "APPLICATION_DISCOVERY"; readonly Delete: "DELETE"; }; export type SourceFeaturesEnum = typeof SourceFeaturesEnum[keyof typeof SourceFeaturesEnum]; export declare const SourceStatusEnum: { readonly SourceStateErrorAccountFileImport: "SOURCE_STATE_ERROR_ACCOUNT_FILE_IMPORT"; readonly SourceStateErrorCluster: "SOURCE_STATE_ERROR_CLUSTER"; readonly SourceStateErrorSource: "SOURCE_STATE_ERROR_SOURCE"; readonly SourceStateErrorVa: "SOURCE_STATE_ERROR_VA"; readonly SourceStateFailureCluster: "SOURCE_STATE_FAILURE_CLUSTER"; readonly SourceStateFailureSource: "SOURCE_STATE_FAILURE_SOURCE"; readonly SourceStateHealthy: "SOURCE_STATE_HEALTHY"; readonly SourceStateUncheckedCluster: "SOURCE_STATE_UNCHECKED_CLUSTER"; readonly SourceStateUncheckedClusterNoSources: "SOURCE_STATE_UNCHECKED_CLUSTER_NO_SOURCES"; readonly SourceStateUncheckedSource: "SOURCE_STATE_UNCHECKED_SOURCE"; readonly SourceStateUncheckedSourceNoAccounts: "SOURCE_STATE_UNCHECKED_SOURCE_NO_ACCOUNTS"; }; export type SourceStatusEnum = typeof SourceStatusEnum[keyof typeof SourceStatusEnum]; /** * Reference to account correlation config object. * @export * @interface SourceAccountCorrelationConfig */ export interface SourceAccountCorrelationConfig { /** * Type of object being referenced. * @type {string} * @memberof SourceAccountCorrelationConfig */ 'type'?: SourceAccountCorrelationConfigTypeEnum; /** * Account correlation config ID. * @type {string} * @memberof SourceAccountCorrelationConfig */ 'id'?: string; /** * Account correlation config\'s human-readable display name. * @type {string} * @memberof SourceAccountCorrelationConfig */ 'name'?: string; } export declare const SourceAccountCorrelationConfigTypeEnum: { readonly AccountCorrelationConfig: "ACCOUNT_CORRELATION_CONFIG"; }; export type SourceAccountCorrelationConfigTypeEnum = typeof SourceAccountCorrelationConfigTypeEnum[keyof typeof SourceAccountCorrelationConfigTypeEnum]; /** * Reference to a rule that can do COMPLEX correlation. Only use this rule when you can\'t use accountCorrelationConfig. * @export * @interface SourceAccountCorrelationRule */ export interface SourceAccountCorrelationRule { /** * Type of object being referenced. * @type {string} * @memberof SourceAccountCorrelationRule */ 'type'?: SourceAccountCorrelationRuleTypeEnum; /** * Rule ID. * @type {string} * @memberof SourceAccountCorrelationRule */ 'id'?: string; /** * Rule\'s human-readable display name. * @type {string} * @memberof SourceAccountCorrelationRule */ 'name'?: string; } export declare const SourceAccountCorrelationRuleTypeEnum: { readonly Rule: "RULE"; }; export type SourceAccountCorrelationRuleTypeEnum = typeof SourceAccountCorrelationRuleTypeEnum[keyof typeof SourceAccountCorrelationRuleTypeEnum]; /** * Rule that runs on the CCG and allows for customization of provisioning plans before the API calls the connector. * @export * @interface SourceBeforeProvisioningRule */ export interface SourceBeforeProvisioningRule { /** * Type of object being referenced. * @type {string} * @memberof SourceBeforeProvisioningRule */ 'type'?: SourceBeforeProvisioningRuleTypeEnum; /** * Rule ID. * @type {string} * @memberof SourceBeforeProvisioningRule */ 'id'?: string; /** * Rule\'s human-readable display name. * @type {string} * @memberof SourceBeforeProvisioningRule */ 'name'?: string; } export declare const SourceBeforeProvisioningRuleTypeEnum: { readonly Rule: "RULE"; }; export type SourceBeforeProvisioningRuleTypeEnum = typeof SourceBeforeProvisioningRuleTypeEnum[keyof typeof SourceBeforeProvisioningRuleTypeEnum]; /** * Reference to the source\'s associated cluster. * @export * @interface SourceCluster */ export interface SourceCluster { /** * Type of object being referenced. * @type {string} * @memberof SourceCluster */ 'type': SourceClusterTypeEnum; /** * Cluster ID. * @type {string} * @memberof SourceCluster */ 'id': string; /** * Cluster\'s human-readable display name. * @type {string} * @memberof SourceCluster */ 'name': string; } export declare const SourceClusterTypeEnum: { readonly Cluster: "CLUSTER"; }; export type SourceClusterTypeEnum = typeof SourceClusterTypeEnum[keyof typeof SourceClusterTypeEnum]; /** * * @export * @interface SourceConnectionsDto */ export interface SourceConnectionsDto { /** * The IdentityProfile attached to this source * @type {Array} * @memberof SourceConnectionsDto */ 'identityProfiles'?: Array; /** * Name of the CredentialProfile attached to this source * @type {Array} * @memberof SourceConnectionsDto */ 'credentialProfiles'?: Array; /** * The attributes attached to this source * @type {Array} * @memberof SourceConnectionsDto */ 'sourceAttributes'?: Array; /** * The profiles attached to this source * @type {Array} * @memberof SourceConnectionsDto */ 'mappingProfiles'?: Array; /** * A list of custom transforms associated with this source. A transform will be considered associated with a source if any attributes of the transform specify the source as the sourceName. * @type {Array} * @memberof SourceConnectionsDto */ 'dependentCustomTransforms'?: Array; /** * * @type {Array} * @memberof SourceConnectionsDto */ 'dependentApps'?: Array; /** * * @type {Array} * @memberof SourceConnectionsDto */ 'missingDependents'?: Array; } /** * Entitlement Request Configuration * @export * @interface SourceEntitlementRequestConfig */ export interface SourceEntitlementRequestConfig { /** * * @type {EntitlementAccessRequestConfig} * @memberof SourceEntitlementRequestConfig */ 'accessRequestConfig'?: EntitlementAccessRequestConfig; /** * * @type {EntitlementRevocationRequestConfig} * @memberof SourceEntitlementRequestConfig */ 'revocationRequestConfig'?: EntitlementRevocationRequestConfig; } /** * Dto for source health data * @export * @interface SourceHealthDto */ export interface SourceHealthDto { /** * the id of the Source * @type {string} * @memberof SourceHealthDto */ 'id'?: string; /** * Specifies the type of system being managed e.g. Active Directory, Workday, etc.. If you are creating a Delimited File source, you must set the `provisionasCsv` query parameter to `true`. * @type {string} * @memberof SourceHealthDto */ 'type'?: string; /** * the name of the source * @type {string} * @memberof SourceHealthDto */ 'name'?: string; /** * source\'s org * @type {string} * @memberof SourceHealthDto */ 'org'?: string; /** * Is the source authoritative * @type {boolean} * @memberof SourceHealthDto */ 'isAuthoritative'?: boolean; /** * Is the source in a cluster * @type {boolean} * @memberof SourceHealthDto */ 'isCluster'?: boolean; /** * source\'s hostname * @type {string} * @memberof SourceHealthDto */ 'hostname'?: string; /** * source\'s pod * @type {string} * @memberof SourceHealthDto */ 'pod'?: string; /** * The version of the iqService * @type {string} * @memberof SourceHealthDto */ 'iqServiceVersion'?: string | null; /** * connection test result * @type {string} * @memberof SourceHealthDto */ 'status'?: SourceHealthDtoStatusEnum; } export declare const SourceHealthDtoStatusEnum: { readonly SourceStateErrorCluster: "SOURCE_STATE_ERROR_CLUSTER"; readonly SourceStateErrorSource: "SOURCE_STATE_ERROR_SOURCE"; readonly SourceStateErrorVa: "SOURCE_STATE_ERROR_VA"; readonly SourceStateFailureCluster: "SOURCE_STATE_FAILURE_CLUSTER"; readonly SourceStateFailureSource: "SOURCE_STATE_FAILURE_SOURCE"; readonly SourceStateHealthy: "SOURCE_STATE_HEALTHY"; readonly SourceStateUncheckedCluster: "SOURCE_STATE_UNCHECKED_CLUSTER"; readonly SourceStateUncheckedClusterNoSources: "SOURCE_STATE_UNCHECKED_CLUSTER_NO_SOURCES"; readonly SourceStateUncheckedSource: "SOURCE_STATE_UNCHECKED_SOURCE"; readonly SourceStateUncheckedSourceNoAccounts: "SOURCE_STATE_UNCHECKED_SOURCE_NO_ACCOUNTS"; readonly SourceStateErrorAccountFileImport: "SOURCE_STATE_ERROR_ACCOUNT_FILE_IMPORT"; }; export type SourceHealthDtoStatusEnum = typeof SourceHealthDtoStatusEnum[keyof typeof SourceHealthDtoStatusEnum]; /** * Reference to management workgroup for the source. * @export * @interface SourceManagementWorkgroup */ export interface SourceManagementWorkgroup { /** * Type of object being referenced. * @type {string} * @memberof SourceManagementWorkgroup */ 'type'?: SourceManagementWorkgroupTypeEnum; /** * Management workgroup ID. * @type {string} * @memberof SourceManagementWorkgroup */ 'id'?: string; /** * Management workgroup\'s human-readable display name. * @type {string} * @memberof SourceManagementWorkgroup */ 'name'?: string; } export declare const SourceManagementWorkgroupTypeEnum: { readonly GovernanceGroup: "GOVERNANCE_GROUP"; }; export type SourceManagementWorkgroupTypeEnum = typeof SourceManagementWorkgroupTypeEnum[keyof typeof SourceManagementWorkgroupTypeEnum]; /** * * @export * @interface SourceManagerCorrelationMapping */ export interface SourceManagerCorrelationMapping { /** * Name of the attribute to use for manager correlation. The value found on the account attribute will be used to lookup the manager\'s identity. * @type {string} * @memberof SourceManagerCorrelationMapping */ 'accountAttributeName'?: string; /** * Name of the identity attribute to search when trying to find a manager using the value from the accountAttribute. * @type {string} * @memberof SourceManagerCorrelationMapping */ 'identityAttributeName'?: string; } /** * Reference to the ManagerCorrelationRule. Only use this rule when a simple filter isn\'t sufficient. * @export * @interface SourceManagerCorrelationRule */ export interface SourceManagerCorrelationRule { /** * Type of object being referenced. * @type {string} * @memberof SourceManagerCorrelationRule */ 'type'?: SourceManagerCorrelationRuleTypeEnum; /** * Rule ID. * @type {string} * @memberof SourceManagerCorrelationRule */ 'id'?: string; /** * Rule\'s human-readable display name. * @type {string} * @memberof SourceManagerCorrelationRule */ 'name'?: string; } export declare const SourceManagerCorrelationRuleTypeEnum: { readonly Rule: "RULE"; }; export type SourceManagerCorrelationRuleTypeEnum = typeof SourceManagerCorrelationRuleTypeEnum[keyof typeof SourceManagerCorrelationRuleTypeEnum]; /** * Reference to identity object who owns the source. * @export * @interface SourceOwner */ export interface SourceOwner { /** * Type of object being referenced. * @type {string} * @memberof SourceOwner */ 'type'?: SourceOwnerTypeEnum; /** * Owner identity\'s ID. * @type {string} * @memberof SourceOwner */ 'id'?: string; /** * Owner identity\'s human-readable display name. * @type {string} * @memberof SourceOwner */ 'name'?: string; } export declare const SourceOwnerTypeEnum: { readonly Identity: "IDENTITY"; }; export type SourceOwnerTypeEnum = typeof SourceOwnerTypeEnum[keyof typeof SourceOwnerTypeEnum]; /** * * @export * @interface SourcePasswordPoliciesInner */ export interface SourcePasswordPoliciesInner { /** * Type of object being referenced. * @type {string} * @memberof SourcePasswordPoliciesInner */ 'type'?: SourcePasswordPoliciesInnerTypeEnum; /** * Policy ID. * @type {string} * @memberof SourcePasswordPoliciesInner */ 'id'?: string; /** * Policy\'s human-readable display name. * @type {string} * @memberof SourcePasswordPoliciesInner */ 'name'?: string; } export declare const SourcePasswordPoliciesInnerTypeEnum: { readonly PasswordPolicy: "PASSWORD_POLICY"; }; export type SourcePasswordPoliciesInnerTypeEnum = typeof SourcePasswordPoliciesInnerTypeEnum[keyof typeof SourcePasswordPoliciesInnerTypeEnum]; /** * * @export * @interface SourceSchemasInner */ export interface SourceSchemasInner { /** * Type of object being referenced. * @type {string} * @memberof SourceSchemasInner */ 'type'?: SourceSchemasInnerTypeEnum; /** * Schema ID. * @type {string} * @memberof SourceSchemasInner */ 'id'?: string; /** * Schema\'s human-readable display name. * @type {string} * @memberof SourceSchemasInner */ 'name'?: string; } export declare const SourceSchemasInnerTypeEnum: { readonly ConnectorSchema: "CONNECTOR_SCHEMA"; }; export type SourceSchemasInnerTypeEnum = typeof SourceSchemasInnerTypeEnum[keyof typeof SourceSchemasInnerTypeEnum]; /** * * @export * @interface SourceSyncJob */ export interface SourceSyncJob { /** * Job ID. * @type {string} * @memberof SourceSyncJob */ 'id': string; /** * The job status. * @type {string} * @memberof SourceSyncJob */ 'status': SourceSyncJobStatusEnum; /** * * @type {SourceSyncPayload} * @memberof SourceSyncJob */ 'payload': SourceSyncPayload; } export declare const SourceSyncJobStatusEnum: { readonly Queued: "QUEUED"; readonly InProgress: "IN_PROGRESS"; readonly Success: "SUCCESS"; readonly Error: "ERROR"; }; export type SourceSyncJobStatusEnum = typeof SourceSyncJobStatusEnum[keyof typeof SourceSyncJobStatusEnum]; /** * * @export * @interface SourceSyncPayload */ export interface SourceSyncPayload { /** * Payload type. * @type {string} * @memberof SourceSyncPayload */ 'type': string; /** * Payload type. * @type {string} * @memberof SourceSyncPayload */ 'dataJson': string; } /** * Response model for connection check, configuration test and ping of source connectors. * @export * @interface StatusResponse */ export interface StatusResponse { /** * ID of the source * @type {string} * @memberof StatusResponse */ 'id'?: string; /** * Name of the source * @type {string} * @memberof StatusResponse */ 'name'?: string; /** * The status of the health check. * @type {string} * @memberof StatusResponse */ 'status'?: StatusResponseStatusEnum; /** * The number of milliseconds spent on the entire request. * @type {number} * @memberof StatusResponse */ 'elapsedMillis'?: number; /** * The document contains the results of the health check. The schema of this document depends on the type of source used. * @type {object} * @memberof StatusResponse */ 'details'?: object; } export declare const StatusResponseStatusEnum: { readonly Success: "SUCCESS"; readonly Failure: "FAILURE"; }; export type StatusResponseStatusEnum = typeof StatusResponseStatusEnum[keyof typeof StatusResponseStatusEnum]; /** * Task result. * @export * @interface TaskResultDto */ export interface TaskResultDto { /** * Task result DTO type. * @type {string} * @memberof TaskResultDto */ 'type'?: TaskResultDtoTypeEnum; /** * Task result ID. * @type {string} * @memberof TaskResultDto */ 'id'?: string; /** * Task result display name. * @type {string} * @memberof TaskResultDto */ 'name'?: string | null; } export declare const TaskResultDtoTypeEnum: { readonly TaskResult: "TASK_RESULT"; }; export type TaskResultDtoTypeEnum = typeof TaskResultDtoTypeEnum[keyof typeof TaskResultDtoTypeEnum]; /** * The representation of an internally- or customer-defined transform. * @export * @interface Transform */ export interface Transform { /** * Unique name of this transform * @type {string} * @memberof Transform */ 'name': string; /** * The type of transform operation * @type {string} * @memberof Transform */ 'type': TransformTypeEnum; /** * Meta-data about the transform. Values in this list are specific to the type of transform to be executed. * @type {object} * @memberof Transform */ 'attributes': object | null; } export declare const TransformTypeEnum: { readonly AccountAttribute: "accountAttribute"; readonly Base64Decode: "base64Decode"; readonly Base64Encode: "base64Encode"; readonly Concat: "concat"; readonly Conditional: "conditional"; readonly DateCompare: "dateCompare"; readonly DateFormat: "dateFormat"; readonly DateMath: "dateMath"; readonly DecomposeDiacriticalMarks: "decomposeDiacriticalMarks"; readonly E164phone: "e164phone"; readonly FirstValid: "firstValid"; readonly Rule: "rule"; readonly IdentityAttribute: "identityAttribute"; readonly IndexOf: "indexOf"; readonly Iso3166: "iso3166"; readonly LastIndexOf: "lastIndexOf"; readonly LeftPad: "leftPad"; readonly Lookup: "lookup"; readonly Lower: "lower"; readonly NormalizeNames: "normalizeNames"; readonly RandomAlphaNumeric: "randomAlphaNumeric"; readonly RandomNumeric: "randomNumeric"; readonly Reference: "reference"; readonly ReplaceAll: "replaceAll"; readonly Replace: "replace"; readonly RightPad: "rightPad"; readonly Split: "split"; readonly Static: "static"; readonly Substring: "substring"; readonly Trim: "trim"; readonly Upper: "upper"; readonly UsernameGenerator: "usernameGenerator"; readonly Uuid: "uuid"; readonly DisplayName: "displayName"; readonly Rfc5646: "rfc5646"; }; export type TransformTypeEnum = typeof TransformTypeEnum[keyof typeof TransformTypeEnum]; /** * * @export * @interface TransformRead */ export interface TransformRead { /** * Unique name of this transform * @type {string} * @memberof TransformRead */ 'name': string; /** * The type of transform operation * @type {string} * @memberof TransformRead */ 'type': TransformReadTypeEnum; /** * Meta-data about the transform. Values in this list are specific to the type of transform to be executed. * @type {object} * @memberof TransformRead */ 'attributes': object | null; /** * Unique ID of this transform * @type {string} * @memberof TransformRead */ 'id': string; /** * Indicates whether this is an internal SailPoint-created transform or a customer-created transform * @type {boolean} * @memberof TransformRead */ 'internal': boolean; } export declare const TransformReadTypeEnum: { readonly AccountAttribute: "accountAttribute"; readonly Base64Decode: "base64Decode"; readonly Base64Encode: "base64Encode"; readonly Concat: "concat"; readonly Conditional: "conditional"; readonly DateCompare: "dateCompare"; readonly DateFormat: "dateFormat"; readonly DateMath: "dateMath"; readonly DecomposeDiacriticalMarks: "decomposeDiacriticalMarks"; readonly E164phone: "e164phone"; readonly FirstValid: "firstValid"; readonly Rule: "rule"; readonly IdentityAttribute: "identityAttribute"; readonly IndexOf: "indexOf"; readonly Iso3166: "iso3166"; readonly LastIndexOf: "lastIndexOf"; readonly LeftPad: "leftPad"; readonly Lookup: "lookup"; readonly Lower: "lower"; readonly NormalizeNames: "normalizeNames"; readonly RandomAlphaNumeric: "randomAlphaNumeric"; readonly RandomNumeric: "randomNumeric"; readonly Reference: "reference"; readonly ReplaceAll: "replaceAll"; readonly Replace: "replace"; readonly RightPad: "rightPad"; readonly Split: "split"; readonly Static: "static"; readonly Substring: "substring"; readonly Trim: "trim"; readonly Upper: "upper"; readonly UsernameGenerator: "usernameGenerator"; readonly Uuid: "uuid"; readonly DisplayName: "displayName"; readonly Rfc5646: "rfc5646"; }; export type TransformReadTypeEnum = typeof TransformReadTypeEnum[keyof typeof TransformReadTypeEnum]; /** * The type of provisioning policy usage. In IdentityNow, a source can support various provisioning operations. For example, when a joiner is added to a source, this may trigger both CREATE and UPDATE provisioning operations. Each usage type is considered a provisioning policy. A source can have any number of these provisioning policies defined. These are the common usage types: CREATE - This usage type relates to \'Create Account Profile\', the provisioning template for the account to be created. For example, this would be used for a joiner on a source. UPDATE - This usage type relates to \'Update Account Profile\', the provisioning template for the \'Update\' connector operations. For example, this would be used for an attribute sync on a source. ENABLE - This usage type relates to \'Enable Account Profile\', the provisioning template for the account to be enabled. For example, this could be used for a joiner on a source once the joiner\'s account is created. DISABLE - This usage type relates to \'Disable Account Profile\', the provisioning template for the account to be disabled. For example, this could be used when a leaver is removed temporarily from a source. You can use these usage types for all your provisioning policy needs. * @export * @enum {string} */ export declare const UsageType: { readonly Create: "CREATE"; readonly Update: "UPDATE"; readonly Enable: "ENABLE"; readonly Disable: "DISABLE"; readonly Delete: "DELETE"; readonly Assign: "ASSIGN"; readonly Unassign: "UNASSIGN"; readonly CreateGroup: "CREATE_GROUP"; readonly UpdateGroup: "UPDATE_GROUP"; readonly DeleteGroup: "DELETE_GROUP"; readonly Register: "REGISTER"; readonly CreateIdentity: "CREATE_IDENTITY"; readonly UpdateIdentity: "UPDATE_IDENTITY"; readonly EditGroup: "EDIT_GROUP"; readonly Unlock: "UNLOCK"; readonly ChangePassword: "CHANGE_PASSWORD"; }; export type UsageType = typeof UsageType[keyof typeof UsageType]; /** * The type of provisioning policy usage. In IdentityNow, a source can support various provisioning operations. For example, when a joiner is added to a source, this may trigger both CREATE and UPDATE provisioning operations. Each usage type is considered a provisioning policy. A source can have any number of these provisioning policies defined. These are the common usage types: CREATE - This usage type relates to \'Create Account Profile\', the provisioning template for the account to be created. For example, this would be used for a joiner on a source. UPDATE - This usage type relates to \'Update Account Profile\', the provisioning template for the \'Update\' connector operations. For example, this would be used for an attribute sync on a source. ENABLE - This usage type relates to \'Enable Account Profile\', the provisioning template for the account to be enabled. For example, this could be used for a joiner on a source once the joiner\'s account is created. DISABLE - This usage type relates to \'Disable Account Profile\', the provisioning template for the account to be disabled. For example, this could be used when a leaver is removed temporarily from a source. CREATE_MACHINE_ACCOUNT - This usage type can be used to create the provisioning template for a source subtype which will be used in creating a machine account. You can use these usage types for all your provisioning policy needs. * @export * @enum {string} */ export declare const Usagetypev2: { readonly Create: "CREATE"; readonly Update: "UPDATE"; readonly Enable: "ENABLE"; readonly Disable: "DISABLE"; readonly Delete: "DELETE"; readonly Assign: "ASSIGN"; readonly Unassign: "UNASSIGN"; readonly CreateGroup: "CREATE_GROUP"; readonly UpdateGroup: "UPDATE_GROUP"; readonly DeleteGroup: "DELETE_GROUP"; readonly Register: "REGISTER"; readonly CreateIdentity: "CREATE_IDENTITY"; readonly UpdateIdentity: "UPDATE_IDENTITY"; readonly EditGroup: "EDIT_GROUP"; readonly Unlock: "UNLOCK"; readonly ChangePassword: "CHANGE_PASSWORD"; readonly CreateMachineAccount: "CREATE_MACHINE_ACCOUNT"; }; export type Usagetypev2 = typeof Usagetypev2[keyof typeof Usagetypev2]; /** * SourcesApi - axios parameter creator * @export */ export declare const SourcesApiAxiosParamCreator: (configuration?: Configuration) => { /** * This API generates a create policy/template based on field value transforms. This API is intended for use when setting up JDBC Provisioning type sources, but it will also work on other source types. Transforms can be used in the provisioning policy to create a new attribute that you only need during provisioning. Refer to [Transforms in Provisioning Policies](https://developer.sailpoint.com/docs/extensibility/transforms/guides/transforms-in-provisioning-policies) for more information. * @summary Create provisioning policy * @param {string} sourceId The Source id * @param {ProvisioningPolicyDto} provisioningPolicyDto * @param {*} [axiosOptions] Override http request option. * @throws {RequiredError} */ createProvisioningPolicyV1: (sourceId: string, provisioningPolicyDto: ProvisioningPolicyDto, axiosOptions?: RawAxiosRequestConfig) => Promise; /** * This API generates a create policy/template based on field value transforms. This API is intended for use when setting up JDBC Provisioning type sources, but it will also work on other source types. Transforms can be used in the provisioning policy to create a new attribute that you only need during provisioning. The V2 API allows you to use a unique identifier (id) for each provisioning policy instead of usageType. This enables read, update, and delete operations on policies using their id. Note: The subtypeId field is required if usageType is CREATE_MACHINE_ACCOUNT. Refer to [Transforms in Provisioning Policies](https://developer.sailpoint.com/docs/extensibility/transforms/guides/transforms-in-provisioning-policies) for more information. * @summary Create provisioning policy * @param {string} sourceId The Source id * @param {ProvisioningPolicyDtoV2} provisioningPolicyDtoV2 * @param {boolean} [useDefaultFields] If passed as true, then it uses default fields from the connector template. * @param {string} [xSailPointExperimental] Use this header to enable this experimental API. * @param {*} [axiosOptions] Override http request option. * @throws {RequiredError} */ createProvisioningPolicyV2: (sourceId: string, provisioningPolicyDtoV2: ProvisioningPolicyDtoV2, useDefaultFields?: boolean, xSailPointExperimental?: string, axiosOptions?: RawAxiosRequestConfig) => Promise; /** * Use this API to create a new schedule for a type on the specified source in Identity Security Cloud (ISC). * @summary Create schedule on source * @param {string} sourceId Source ID. * @param {Schedule3} schedule3 * @param {*} [axiosOptions] Override http request option. * @throws {RequiredError} */ createSourceScheduleV1: (sourceId: string, schedule3: Schedule3, axiosOptions?: RawAxiosRequestConfig) => Promise; /** * Use this API to create a new schema on the specified source in Identity Security Cloud (ISC). * @summary Create schema on source * @param {string} sourceId Source ID. * @param {Schema} schema * @param {*} [axiosOptions] Override http request option. * @throws {RequiredError} */ createSourceSchemaV1: (sourceId: string, schema: Schema, axiosOptions?: RawAxiosRequestConfig) => Promise; /** * This creates a specific source with a full source JSON representation. Any passwords are submitted as plain-text and encrypted upon receipt in IdentityNow. * @summary Creates a source in identitynow. * @param {Source} source * @param {boolean} [provisionAsCsv] If this parameter is `true`, it configures the source as a Delimited File (CSV) source. Setting this to `true` will automatically set the `type` of the source to `DelimitedFile`. You must use this query parameter to create a Delimited File source as you would in the UI. If you don\'t set this query parameter and you attempt to set the `type` attribute directly, the request won\'t correctly generate the source. * @param {*} [axiosOptions] Override http request option. * @throws {RequiredError} */ createSourceV1: (source: Source, provisionAsCsv?: boolean, axiosOptions?: RawAxiosRequestConfig) => Promise; /** * Use this endpoint to remove all accounts from the system without provisioning changes to the source. Accounts that are removed could be re-created during the next aggregation. This endpoint is good for: * Removing accounts that no longer exist on the source. * Removing accounts that won\'t be aggregated following updates to the source configuration. * Forcing accounts to be re-created following the next aggregation to re-run account processing, support testing, etc. * @summary Remove all accounts in source * @param {string} id The source id * @param {*} [axiosOptions] Override http request option. * @throws {RequiredError} */ deleteAccountsAsyncV1: (id: string, axiosOptions?: RawAxiosRequestConfig) => Promise; /** * Deletes the native change detection configuration for the source specified by the given ID. * @summary Delete native change detection configuration * @param {string} sourceId The source id * @param {*} [axiosOptions] Override http request option. * @throws {RequiredError} */ deleteNativeChangeDetectionConfigV1: (sourceId: string, axiosOptions?: RawAxiosRequestConfig) => Promise; /** * Deletes the provisioning policy with the specified usage on an application. * @summary Delete provisioning policy by usagetype * @param {string} sourceId The Source ID. * @param {UsageType} usageType The type of provisioning policy usage. In IdentityNow, a source can support various provisioning operations. For example, when a joiner is added to a source, this may trigger both CREATE and UPDATE provisioning operations. Each usage type is considered a provisioning policy. A source can have any number of these provisioning policies defined. These are the common usage types: CREATE - This usage type relates to \'Create Account Profile\', the provisioning template for the account to be created. For example, this would be used for a joiner on a source. UPDATE - This usage type relates to \'Update Account Profile\', the provisioning template for the \'Update\' connector operations. For example, this would be used for an attribute sync on a source. ENABLE - This usage type relates to \'Enable Account Profile\', the provisioning template for the account to be enabled. For example, this could be used for a joiner on a source once the joiner\'s account is created. DISABLE - This usage type relates to \'Disable Account Profile\', the provisioning template for the account to be disabled. For example, this could be used when a leaver is removed temporarily from a source. You can use these four usage types for all your provisioning policy needs. * @param {*} [axiosOptions] Override http request option. * @throws {RequiredError} */ deleteProvisioningPolicyV1: (sourceId: string, usageType: UsageType, axiosOptions?: RawAxiosRequestConfig) => Promise; /** * Deletes the provisioning policy with the specified ID on an application. * @summary Delete provisioning policy by ID * @param {string} sourceId The Source ID. * @param {string} id The provisioning policy ID. * @param {string} [xSailPointExperimental] Use this header to enable this experimental API. * @param {*} [axiosOptions] Override http request option. * @throws {RequiredError} */ deleteProvisioningPolicyV2: (sourceId: string, id: string, xSailPointExperimental?: string, axiosOptions?: RawAxiosRequestConfig) => Promise; /** * * @summary Delete source schedule by type. * @param {string} sourceId The Source id. * @param {DeleteSourceScheduleV1ScheduleTypeEnum} scheduleType The Schedule type. * @param {*} [axiosOptions] Override http request option. * @throws {RequiredError} */ deleteSourceScheduleV1: (sourceId: string, scheduleType: DeleteSourceScheduleV1ScheduleTypeEnum, axiosOptions?: RawAxiosRequestConfig) => Promise; /** * * @summary Delete source schema by id * @param {string} sourceId The Source id. * @param {string} schemaId The Schema id. * @param {*} [axiosOptions] Override http request option. * @throws {RequiredError} */ deleteSourceSchemaV1: (sourceId: string, schemaId: string, axiosOptions?: RawAxiosRequestConfig) => Promise; /** * Use this API to delete a specific source in Identity Security Cloud (ISC). The API removes all the accounts on the source first, and then it deletes the source. You can retrieve the actual task execution status with this method: GET `/task-status/{id}` * @summary Delete source by id * @param {string} id Source ID. * @param {*} [axiosOptions] Override http request option. * @throws {RequiredError} */ deleteSourceV1: (id: string, axiosOptions?: RawAxiosRequestConfig) => Promise; /** * The endpoint retrieves the approval configuration for deleting human accounts from a specified source. It returns details such as whether approval is required, who the approvers are, and any additional approval settings. This helps administrators understand and manage the approval workflow for human account deletions in their organization. The response is provided as an AccountDeleteConfigDto object. * @summary Human Account Deletion Approval Config * @param {string} sourceId The Source id * @param {*} [axiosOptions] Override http request option. * @throws {RequiredError} */ getAccountDeleteApprovalConfigV1: (sourceId: string, axiosOptions?: RawAxiosRequestConfig) => Promise; /** * This API downloads the CSV schema that defines the account attributes on a source. >**NOTE: This API is designated only for Delimited File sources.** * @summary Downloads source accounts schema template * @param {string} id The Source id * @param {*} [axiosOptions] Override http request option. * @throws {RequiredError} */ getAccountsSchemaV1: (id: string, axiosOptions?: RawAxiosRequestConfig) => Promise; /** * This API returns the existing correlation configuration for a source specified by the given ID. * @summary Get source correlation configuration * @param {string} id The source id * @param {*} [axiosOptions] Override http request option. * @throws {RequiredError} */ getCorrelationConfigV1: (id: string, axiosOptions?: RawAxiosRequestConfig) => Promise; /** * This API downloads the CSV schema that defines the entitlement attributes on a source. >**NOTE: This API is designated only for Delimited File sources.** * @summary Downloads source entitlements schema template * @param {string} id The Source id * @param {string} [schemaName] Name of entitlement schema * @param {*} [axiosOptions] Override http request option. * @throws {RequiredError} */ getEntitlementsSchemaV1: (id: string, schemaName?: string, axiosOptions?: RawAxiosRequestConfig) => Promise; /** * Retrieves the machine account deletion approval configuration for a specific source. This endpoint returns details about the approval requirements, approvers, and comment settings that govern the deletion of machine accounts associated with the given source ID. * @summary Machine Account Deletion Approval Config * @param {string} sourceId source id. * @param {*} [axiosOptions] Override http request option. * @throws {RequiredError} */ getMachineAccountDeletionApprovalConfigBySourceV1: (sourceId: string, axiosOptions?: RawAxiosRequestConfig) => Promise; /** * This API returns the existing native change detection configuration for a source specified by the given ID. * @summary Native change detection configuration * @param {string} sourceId The source id * @param {*} [axiosOptions] Override http request option. * @throws {RequiredError} */ getNativeChangeDetectionConfigV1: (sourceId: string, axiosOptions?: RawAxiosRequestConfig) => Promise; /** * This end-point retrieves the ProvisioningPolicy with the specified usage on the specified Source in IdentityNow. * @summary Get provisioning policy by usagetype * @param {string} sourceId The Source ID. * @param {UsageType} usageType The type of provisioning policy usage. In IdentityNow, a source can support various provisioning operations. For example, when a joiner is added to a source, this may trigger both CREATE and UPDATE provisioning operations. Each usage type is considered a provisioning policy. A source can have any number of these provisioning policies defined. These are the common usage types: CREATE - This usage type relates to \'Create Account Profile\', the provisioning template for the account to be created. For example, this would be used for a joiner on a source. UPDATE - This usage type relates to \'Update Account Profile\', the provisioning template for the \'Update\' connector operations. For example, this would be used for an attribute sync on a source. ENABLE - This usage type relates to \'Enable Account Profile\', the provisioning template for the account to be enabled. For example, this could be used for a joiner on a source once the joiner\'s account is created. DISABLE - This usage type relates to \'Disable Account Profile\', the provisioning template for the account to be disabled. For example, this could be used when a leaver is removed temporarily from a source. You can use these four usage types for all your provisioning policy needs. * @param {*} [axiosOptions] Override http request option. * @throws {RequiredError} */ getProvisioningPolicyV1: (sourceId: string, usageType: UsageType, axiosOptions?: RawAxiosRequestConfig) => Promise; /** * This end-point retrieves the ProvisioningPolicy with the specified ID on the specified Source in Identity Security Cloud. * @summary Get provisioning policy by ID * @param {string} sourceId The Source ID. * @param {string} id The provisioning policy ID. * @param {string} [xSailPointExperimental] Use this header to enable this experimental API. * @param {*} [axiosOptions] Override http request option. * @throws {RequiredError} */ getProvisioningPolicyV2: (sourceId: string, id: string, xSailPointExperimental?: string, axiosOptions?: RawAxiosRequestConfig) => Promise; /** * This API returns the existing attribute synchronization configuration for a source specified by the given ID. The response contains all attributes, regardless of whether they enabled or not. * @summary Attribute sync config * @param {string} id The source id * @param {string} [xSailPointExperimental] Use this header to enable this experimental API. * @param {*} [axiosOptions] Override http request option. * @throws {RequiredError} */ getSourceAttrSyncConfigV1: (id: string, xSailPointExperimental?: string, axiosOptions?: RawAxiosRequestConfig) => Promise; /** * Looks up and returns the source config for the requested source id after populating the source config values and applying language translations. * @summary Gets source config with language-translations * @param {string} id The Source id * @param {GetSourceConfigV1LocaleEnum} [locale] The locale to apply to the config. If no viable locale is given, it will default to \"en\" * @param {*} [axiosOptions] Override http request option. * @throws {RequiredError} */ getSourceConfigV1: (id: string, locale?: GetSourceConfigV1LocaleEnum, axiosOptions?: RawAxiosRequestConfig) => Promise; /** * Use this API to get all dependent Profiles, Attributes, Applications and Custom Transforms for a source by a specified ID in Identity Security Cloud (ISC). * @summary Get source connections by id * @param {string} sourceId Source ID. * @param {*} [axiosOptions] Override http request option. * @throws {RequiredError} */ getSourceConnectionsV1: (sourceId: string, axiosOptions?: RawAxiosRequestConfig) => Promise; /** * This API gets the current entitlement request configuration for a source. This source-level configuration should apply for all the entitlements in the source. Access request to any entitlements in the source should follow this configuration unless a separate entitlement-level configuration is defined. - During access request, this source-level entitlement request configuration overrides the global organization-level configuration. - However, the entitlement-level configuration (if defined) overrides this source-level configuration. * @summary Get source entitlement request configuration * @param {string} id The Source id * @param {*} [axiosOptions] Override http request option. * @throws {RequiredError} */ getSourceEntitlementRequestConfigV1: (id: string, axiosOptions?: RawAxiosRequestConfig) => Promise; /** * This endpoint fetches source health by source\'s id * @summary Fetches source health by id * @param {string} sourceId The Source id. * @param {*} [axiosOptions] Override http request option. * @throws {RequiredError} */ getSourceHealthV1: (sourceId: string, axiosOptions?: RawAxiosRequestConfig) => Promise; /** * Get the source schedule by type in Identity Security Cloud (ISC). * @summary Get source schedule by type * @param {string} sourceId The Source id. * @param {GetSourceScheduleV1ScheduleTypeEnum} scheduleType The Schedule type. * @param {*} [axiosOptions] Override http request option. * @throws {RequiredError} */ getSourceScheduleV1: (sourceId: string, scheduleType: GetSourceScheduleV1ScheduleTypeEnum, axiosOptions?: RawAxiosRequestConfig) => Promise; /** * Use this API to list the schedules that exist on the specified source in Identity Security Cloud (ISC). :::info This endpoint uses a **cron expression** to schedule a task, following standard **cron job syntax**. For example, `0 0 12 1/1 * ? *` runs the task **daily at 12:00 PM**. **Days of the week are represented as 1-7 (Sunday-Saturday).** ::: * @summary List schedules on source * @param {string} sourceId Source ID. * @param {*} [axiosOptions] Override http request option. * @throws {RequiredError} */ getSourceSchedulesV1: (sourceId: string, axiosOptions?: RawAxiosRequestConfig) => Promise; /** * Get the Source Schema by ID in IdentityNow. * @summary Get source schema by id * @param {string} sourceId The Source id. * @param {string} schemaId The Schema id. * @param {*} [axiosOptions] Override http request option. * @throws {RequiredError} */ getSourceSchemaV1: (sourceId: string, schemaId: string, axiosOptions?: RawAxiosRequestConfig) => Promise; /** * Use this API to list the schemas that exist on the specified source in Identity Security Cloud (ISC). * @summary List schemas on source * @param {string} sourceId Source ID. * @param {GetSourceSchemasV1IncludeTypesEnum} [includeTypes] If set to \'group\', then the account schema is filtered and only group schemas are returned. Only a value of \'group\' is recognized presently. Note: The API will check whether include-types is group or not, if not, it will list schemas based on include-names, if include-names is not provided, it will list all schemas. * @param {string} [includeNames] A comma-separated list of schema names to filter result. * @param {*} [axiosOptions] Override http request option. * @throws {RequiredError} */ getSourceSchemasV1: (sourceId: string, includeTypes?: GetSourceSchemasV1IncludeTypesEnum, includeNames?: string, axiosOptions?: RawAxiosRequestConfig) => Promise; /** * Use this API to get a source by a specified ID in Identity Security Cloud (ISC). * @summary Get source by id * @param {string} id Source ID. * @param {*} [axiosOptions] Override http request option. * @throws {RequiredError} */ getSourceV1: (id: string, axiosOptions?: RawAxiosRequestConfig) => Promise; /** * This API uploads a source schema template file to configure a source\'s account attributes. To retrieve the file to modify and upload, log into Identity Now. Click **Admin** -> **Connections** -> **Sources** -> **`{SourceName}`** -> **Import Data** -> **Account Schema** -> **Options** -> **Download Schema** >**NOTE: This API is designated only for Delimited File sources.** * @summary Uploads source accounts schema template * @param {string} id The Source id * @param {File} [file] * @param {*} [axiosOptions] Override http request option. * @throws {RequiredError} */ importAccountsSchemaV1: (id: string, file?: File, axiosOptions?: RawAxiosRequestConfig) => Promise; /** * Starts an account aggregation on the specified source. If the target source is a delimited file source, then the CSV file needs to be included in the request body. You will also need to set the Content-Type header to `multipart/form-data`. * @summary Account aggregation * @param {string} id Source Id * @param {File} [file] The CSV file containing the source accounts to aggregate. * @param {string} [disableOptimization] Use this flag to reprocess every account whether or not the data has changed. * @param {*} [axiosOptions] Override http request option. * @throws {RequiredError} */ importAccountsV1: (id: string, file?: File, disableOptimization?: string, axiosOptions?: RawAxiosRequestConfig) => Promise; /** * This uploads a supplemental source connector file (like jdbc driver jars) to a source\'s S3 bucket. This also sends ETS and Audit events. * @summary Upload connector file to source * @param {string} sourceId The Source id. * @param {File} [file] * @param {*} [axiosOptions] Override http request option. * @throws {RequiredError} */ importConnectorFileV1: (sourceId: string, file?: File, axiosOptions?: RawAxiosRequestConfig) => Promise; /** * This API uploads a source schema template file to configure a source\'s entitlement attributes. To retrieve the file to modify and upload, log into Identity Now. Click **Admin** -> **Connections** -> **Sources** -> **`{SourceName}`** -> **Import Data** -> **Import Entitlements** -> **Download** >**NOTE: This API is designated only for Delimited File sources.** * @summary Uploads source entitlements schema template * @param {string} id The Source id * @param {string} [schemaName] Name of entitlement schema * @param {File} [file] * @param {*} [axiosOptions] Override http request option. * @throws {RequiredError} */ importEntitlementsSchemaV1: (id: string, schemaName?: string, file?: File, axiosOptions?: RawAxiosRequestConfig) => Promise; /** * Starts an entitlement aggregation on the specified source. If the target source is a delimited file source, then the CSV file needs to be included in the request body. You will also need to set the Content-Type header to `multipart/form-data`. A token with ORG_ADMIN, SOURCE_ADMIN, or SOURCE_SUBADMIN authority is required to call this API. * @summary Entitlement aggregation * @param {string} sourceId Source Id * @param {File} [file] The CSV file containing the source entitlements to aggregate. * @param {*} [axiosOptions] Override http request option. * @throws {RequiredError} */ importEntitlementsV1: (sourceId: string, file?: File, axiosOptions?: RawAxiosRequestConfig) => Promise; /** * File is required for upload. You will also need to set the Content-Type header to `multipart/form-data` * @summary Process uncorrelated accounts * @param {string} id Source Id * @param {File} [file] * @param {*} [axiosOptions] Override http request option. * @throws {RequiredError} */ importUncorrelatedAccountsV1: (id: string, file?: File, axiosOptions?: RawAxiosRequestConfig) => Promise; /** * This API can be used to get Password Policy in IdentityNow for the specified Source. Source must support PASSWORD feature. * @summary Get Password Policy for source * @param {string} sourceId The Source id * @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 {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 {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} */ listPasswordPolicyHoldersOnSourceV1: (sourceId: string, offset?: number, limit?: number, count?: boolean, axiosOptions?: RawAxiosRequestConfig) => Promise; /** * This end-point lists all the ProvisioningPolicies in IdentityNow. * @summary Lists provisioningpolicies * @param {string} sourceId The Source id * @param {number} [offset] Offset Integer specifying the offset of the first result from the beginning of the collection. The standard syntax described in [V3 API Standard Collection Parameters](https://developer.sailpoint.com/idn/api/standard-collection-parameters#paginating-results). The offset value is record-based, not page-based, and the index starts at 0. * @param {number} [limit] Limit Integer specifying the maximum number of records to return in a single API call. The standard syntax described in [V3 API Standard Collection Parameters](https://developer.sailpoint.com/idn/api/standard-collection-parameters#paginating-results). If it is not specified, a default limit is used. * @param {*} [axiosOptions] Override http request option. * @throws {RequiredError} */ listProvisioningPoliciesV1: (sourceId: string, offset?: number, limit?: number, axiosOptions?: RawAxiosRequestConfig) => Promise; /** * This end-point lists all the ProvisioningPolicies in IdentityNow. * @summary Lists Provisioning Policies * @param {string} sourceId The Source id * @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: **subtypeId**: *eq* **usageType**: *eq* * @param {number} [offset] Offset Integer specifying the offset of the first result from the beginning of the collection. The standard syntax described in [V3 API Standard Collection Parameters](https://developer.sailpoint.com/idn/api/standard-collection-parameters#paginating-results). The offset value is record-based, not page-based, and the index starts at 0. * @param {number} [limit] Limit Integer specifying the maximum number of records to return in a single API call. The standard syntax described in [V3 API Standard Collection Parameters](https://developer.sailpoint.com/idn/api/standard-collection-parameters#paginating-results). If it is not specified, a default limit is used. * @param {string} [xSailPointExperimental] Use this header to enable this experimental API. * @param {*} [axiosOptions] Override http request option. * @throws {RequiredError} */ listProvisioningPoliciesV2: (sourceId: string, filters?: string, offset?: number, limit?: number, xSailPointExperimental?: string, axiosOptions?: RawAxiosRequestConfig) => Promise; /** * This end-point lists all the sources in IdentityNow. * @summary Lists all sources in identitynow. * @param {number} [limit] Max number of results to return. See [V3 API Standard Collection Parameters](https://developer.sailpoint.com/idn/api/standard-collection-parameters) for more information. * @param {number} [offset] Offset into the full result set. Usually specified with *limit* to paginate through the results. See [V3 API Standard Collection Parameters](https://developer.sailpoint.com/idn/api/standard-collection-parameters) for more information. * @param {boolean} [count] If *true* it will populate the *X-Total-Count* response header with the number of results that would be returned if *limit* and *offset* were ignored. Since requesting a total count can have a performance impact, it is recommended not to send **count=true** if that value will not be used. See [V3 API Standard Collection Parameters](https://developer.sailpoint.com/idn/api/standard-collection-parameters) for more information. * @param {string} [filters] Filter results using the standard syntax described in [V3 API Standard Collection Parameters](https://developer.sailpoint.com/idn/api/standard-collection-parameters#filtering-results) Filtering is supported for the following fields and operators: **id**: *eq, in, ge, gt, le, lt, ne, isnull, sw* **name**: *co, eq, in, sw, ge, gt, ne, isnull* **type**: *eq, in, ge, gt, ne, isnull, sw* **owner.id**: *eq, in, ge, gt, le, lt, ne, isnull, sw* **features**: *ca, co* **created**: *eq, ge, gt, in, le, lt, ne, isnull, sw* **modified**: *eq, ge, gt, in, le, lt, ne, isnull, sw* **managementWorkgroup.id**: *eq, ge, gt, in, le, lt, ne, isnull, sw* **description**: *eq, sw* **authoritative**: *eq, ne, isnull* **healthy**: *isnull* **status**: *eq, in, ge, gt, le, lt, ne, isnull, sw* **connectionType**: *eq, ge, gt, in, le, lt, ne, isnull, sw* **connectorName**: *eq, ge, gt, in, ne, isnull, sw* **category**: *co, eq, ge, gt, in, le, lt, ne, sw* * @param {string} [sorters] Sort results using the standard syntax described in [V3 API Standard Collection Parameters](https://developer.sailpoint.com/idn/api/standard-collection-parameters#sorting-results) Sorting is supported for the following fields: **type, created, modified, name, owner.name, healthy, status, id, description, owner.id, accountCorrelationConfig.id, accountCorrelationConfig.name, managerCorrelationRule.type, managerCorrelationRule.id, managerCorrelationRule.name, authoritative, managementWorkgroup.id, connectorName, connectionType** * @param {string} [forSubadmin] Filter the returned list of sources for the identity specified by the parameter, which is the id of an identity with the role SOURCE_SUBADMIN. By convention, the value **me** indicates the identity id of the current user. Subadmins may only view Sources which they are able to administer; all other Sources will be filtered out when this parameter is set. If the current user is a SOURCE_SUBADMIN but fails to pass a valid value for this parameter, a 403 Forbidden is returned. * @param {boolean} [includeIDNSource] Include the IdentityNow source in the response. * @param {*} [axiosOptions] Override http request option. * @throws {RequiredError} */ listSourcesV1: (limit?: number, offset?: number, count?: boolean, filters?: string, sorters?: string, forSubadmin?: string, includeIDNSource?: boolean, axiosOptions?: RawAxiosRequestConfig) => Promise; /** * This endpoint validates that the cluster being used by the source is reachable from IdentityNow. * @summary Ping cluster for source connector * @param {string} sourceId The ID of the Source * @param {*} [axiosOptions] Override http request option. * @throws {RequiredError} */ pingClusterV1: (sourceId: string, axiosOptions?: RawAxiosRequestConfig) => Promise; /** * Replaces the correlation configuration for the source specified by the given ID with the configuration provided in the request body. * @summary Update source correlation configuration * @param {string} id The source id * @param {CorrelationConfig} correlationConfig * @param {*} [axiosOptions] Override http request option. * @throws {RequiredError} */ putCorrelationConfigV1: (id: string, correlationConfig: CorrelationConfig, axiosOptions?: RawAxiosRequestConfig) => Promise; /** * Replaces the native change detection configuration for the source specified by the given ID with the configuration provided in the request body. * @summary Update native change detection configuration * @param {string} sourceId The source id * @param {NativeChangeDetectionConfig} nativeChangeDetectionConfig * @param {*} [axiosOptions] Override http request option. * @throws {RequiredError} */ putNativeChangeDetectionConfigV1: (sourceId: string, nativeChangeDetectionConfig: NativeChangeDetectionConfig, axiosOptions?: RawAxiosRequestConfig) => Promise; /** * This end-point updates the provisioning policy with the specified usage on the specified source in IdentityNow. Transforms can be used in the provisioning policy to create a new attribute that you only need during provisioning. Refer to [Transforms in Provisioning Policies](https://developer.sailpoint.com/docs/extensibility/transforms/guides/transforms-in-provisioning-policies) for more information. * @summary Update provisioning policy by usagetype * @param {string} sourceId The Source ID. * @param {UsageType} usageType The type of provisioning policy usage. In IdentityNow, a source can support various provisioning operations. For example, when a joiner is added to a source, this may trigger both CREATE and UPDATE provisioning operations. Each usage type is considered a provisioning policy. A source can have any number of these provisioning policies defined. These are the common usage types: CREATE - This usage type relates to \'Create Account Profile\', the provisioning template for the account to be created. For example, this would be used for a joiner on a source. UPDATE - This usage type relates to \'Update Account Profile\', the provisioning template for the \'Update\' connector operations. For example, this would be used for an attribute sync on a source. ENABLE - This usage type relates to \'Enable Account Profile\', the provisioning template for the account to be enabled. For example, this could be used for a joiner on a source once the joiner\'s account is created. DISABLE - This usage type relates to \'Disable Account Profile\', the provisioning template for the account to be disabled. For example, this could be used when a leaver is removed temporarily from a source. You can use these four usage types for all your provisioning policy needs. * @param {ProvisioningPolicyDto} provisioningPolicyDto * @param {*} [axiosOptions] Override http request option. * @throws {RequiredError} */ putProvisioningPolicyV1: (sourceId: string, usageType: UsageType, provisioningPolicyDto: ProvisioningPolicyDto, axiosOptions?: RawAxiosRequestConfig) => Promise; /** * This end-point updates the provisioning policy with the specified ID on the specified source in Identity Security Cloud. Transforms can be used in the provisioning policy to create a new attribute that you only need during provisioning. Refer to [Transforms in Provisioning Policies](https://developer.sailpoint.com/docs/extensibility/transforms/guides/transforms-in-provisioning-policies) for more information. * @summary Update provisioning policy by ID * @param {string} sourceId The Source ID. * @param {string} id The provisioning policy ID. * @param {ProvisioningPolicyDtoV2} provisioningPolicyDtoV2 * @param {string} [xSailPointExperimental] Use this header to enable this experimental API. * @param {*} [axiosOptions] Override http request option. * @throws {RequiredError} */ putProvisioningPolicyV2: (sourceId: string, id: string, provisioningPolicyDtoV2: ProvisioningPolicyDtoV2, xSailPointExperimental?: string, axiosOptions?: RawAxiosRequestConfig) => Promise; /** * Replaces the attribute synchronization configuration for the source specified by the given ID with the configuration provided in the request body. Only the \"enabled\" field of the values in the \"attributes\" array is mutable. Attempting to change other attributes or add new values to the \"attributes\" array will result in an error. * @summary Update attribute sync config * @param {string} id The source id * @param {AttrSyncSourceConfig} attrSyncSourceConfig * @param {string} [xSailPointExperimental] Use this header to enable this experimental API. * @param {*} [axiosOptions] Override http request option. * @throws {RequiredError} */ putSourceAttrSyncConfigV1: (id: string, attrSyncSourceConfig: AttrSyncSourceConfig, xSailPointExperimental?: string, axiosOptions?: RawAxiosRequestConfig) => Promise; /** * This API will completely replace an existing Schema with the submitted payload. Some fields of the Schema cannot be updated. These fields are listed below. * id * name * created * modified Any attempt to modify these fields will result in an error response with a status code of 400. > `id` must remain in the request body, but it cannot be changed. If `id` is omitted from the request body, the result will be a 400 error. * @summary Update source schema (full) * @param {string} sourceId The Source id. * @param {string} schemaId The Schema id. * @param {Schema} schema * @param {*} [axiosOptions] Override http request option. * @throws {RequiredError} */ putSourceSchemaV1: (sourceId: string, schemaId: string, schema: Schema, axiosOptions?: RawAxiosRequestConfig) => Promise; /** * Use this API to update a source in Identity Security Cloud (ISC), using a full object representation. This means that when you use this API, it completely replaces the existing source configuration. These fields are immutable, so they cannot be changed: * id * type * authoritative * connector * connectorClass * passwordPolicies Attempts to modify these fields will result in a 400 error. * @summary Update source (full) * @param {string} id Source ID. * @param {Source} source * @param {*} [axiosOptions] Override http request option. * @throws {RequiredError} */ putSourceV1: (id: string, source: Source, axiosOptions?: RawAxiosRequestConfig) => Promise; /** * Retrieves a sample of data returned from account and group aggregation requests. * @summary Peek source connector\'s resource objects * @param {string} sourceId The ID of the Source * @param {ResourceObjectsRequest} resourceObjectsRequest * @param {*} [axiosOptions] Override http request option. * @throws {RequiredError} */ searchResourceObjectsV1: (sourceId: string, resourceObjectsRequest: ResourceObjectsRequest, axiosOptions?: RawAxiosRequestConfig) => Promise; /** * This end-point performs attribute synchronization for a selected source. * @summary Synchronize single source attributes. * @param {string} id The Source id * @param {string} [xSailPointExperimental] Use this header to enable this experimental API. * @param {*} [axiosOptions] Override http request option. * @throws {RequiredError} */ syncAttributesForSourceV1: (id: string, xSailPointExperimental?: string, axiosOptions?: RawAxiosRequestConfig) => Promise; /** * This endpoint performs a more detailed validation of the source\'\'s configuration that can take longer than the lighter weight credential validation performed by the checkConnection API. * @summary Test configuration for source connector * @param {string} sourceId The ID of the Source * @param {*} [axiosOptions] Override http request option. * @throws {RequiredError} */ testSourceConfigurationV1: (sourceId: string, axiosOptions?: RawAxiosRequestConfig) => Promise; /** * This endpoint validates that the configured credentials are valid and will properly authenticate with the source identified by the sourceId path parameter. * @summary Check connection for source connector. * @param {string} sourceId The ID of the Source. * @param {*} [axiosOptions] Override http request option. * @throws {RequiredError} */ testSourceConnectionV1: (sourceId: string, axiosOptions?: RawAxiosRequestConfig) => Promise; /** * Updates the approval configuration for deleting human accounts for a specific source, identified by source ID. This endpoint allows administrators to modify settings such as whether approval is required, who the approvers are, and other approval-related options. The update is performed using a JSON Patch payload, and the response returns the updated AccountDeleteConfigDto object reflecting the new approval workflow configuration. * @summary Human Account Deletion Approval Config * @param {string} sourceId Human account source ID. * @param {Array} jsonPatchOperation The JSONPatch payload used to update the object. * @param {*} [axiosOptions] Override http request option. * @throws {RequiredError} */ updateAccountDeletionApprovalConfigV1: (sourceId: string, jsonPatchOperation: Array, axiosOptions?: RawAxiosRequestConfig) => Promise; /** * Use this endpoint to update the machine account deletion approval configuration for a specific source. The update is performed using a JSON Patch payload, which allows partial modifications to the approval config. This operation is typically used to change approval requirements, approvers, or comments settings for machine account deletion. The endpoint expects the source ID as a path parameter and a valid JSON Patch array in the request body. * @summary Machine Account Deletion Approval Config * @param {string} sourceId machine account source ID. * @param {Array} jsonPatchOperation The JSONPatch payload used to update the object. * @param {*} [axiosOptions] Override http request option. * @throws {RequiredError} */ updateMachineAccountDeletionApprovalConfigV1: (sourceId: string, jsonPatchOperation: Array, axiosOptions?: RawAxiosRequestConfig) => Promise; /** * This API can be used to set up or update Password Policy in IdentityNow for the specified Source. Source must support PASSWORD feature. * @summary Update password policy * @param {string} sourceId The Source id * @param {Array} passwordPolicyHoldersDtoInner * @param {*} [axiosOptions] Override http request option. * @throws {RequiredError} */ updatePasswordPolicyHoldersV1: (sourceId: string, passwordPolicyHoldersDtoInner: Array, axiosOptions?: RawAxiosRequestConfig) => Promise; /** * This end-point updates a list of provisioning policies on the specified source in IdentityNow. * @summary Bulk update provisioning policies * @param {string} sourceId The Source id. * @param {Array} provisioningPolicyDto * @param {*} [axiosOptions] Override http request option. * @throws {RequiredError} */ updateProvisioningPoliciesInBulkV1: (sourceId: string, provisioningPolicyDto: Array, axiosOptions?: RawAxiosRequestConfig) => Promise; /** * This API selectively updates an existing Provisioning Policy using a JSONPatch payload. Transforms can be used in the provisioning policy to create a new attribute that you only need during provisioning. Refer to [Transforms in Provisioning Policies](https://developer.sailpoint.com/docs/extensibility/transforms/guides/transforms-in-provisioning-policies) for more information. * @summary Partial update of provisioning policy * @param {string} sourceId The Source id. * @param {UsageType} usageType The type of provisioning policy usage. In IdentityNow, a source can support various provisioning operations. For example, when a joiner is added to a source, this may trigger both CREATE and UPDATE provisioning operations. Each usage type is considered a provisioning policy. A source can have any number of these provisioning policies defined. These are the common usage types: CREATE - This usage type relates to \'Create Account Profile\', the provisioning template for the account to be created. For example, this would be used for a joiner on a source. UPDATE - This usage type relates to \'Update Account Profile\', the provisioning template for the \'Update\' connector operations. For example, this would be used for an attribute sync on a source. ENABLE - This usage type relates to \'Enable Account Profile\', the provisioning template for the account to be enabled. For example, this could be used for a joiner on a source once the joiner\'s account is created. DISABLE - This usage type relates to \'Disable Account Profile\', the provisioning template for the account to be disabled. For example, this could be used when a leaver is removed temporarily from a source. You can use these four usage types for all your provisioning policy needs. * @param {Array} jsonPatchOperation The JSONPatch payload used to update the schema. * @param {*} [axiosOptions] Override http request option. * @throws {RequiredError} */ updateProvisioningPolicyV1: (sourceId: string, usageType: UsageType, jsonPatchOperation: Array, axiosOptions?: RawAxiosRequestConfig) => Promise; /** * This API selectively updates an existing Provisioning Policy using a JSONPatch payload. Transforms can be used in the provisioning policy to create a new attribute that you only need during provisioning. Refer to [Transforms in Provisioning Policies](https://developer.sailpoint.com/docs/extensibility/transforms/guides/transforms-in-provisioning-policies) for more information. * @summary Partial update of provisioning policy * @param {string} sourceId The Source id. * @param {string} id The provisioning policy ID. * @param {Array} jsonPatchOperation The JSONPatch payload used to update the schema. * @param {string} [xSailPointExperimental] Use this header to enable this experimental API. * @param {*} [axiosOptions] Override http request option. * @throws {RequiredError} */ updateProvisioningPolicyV2: (sourceId: string, id: string, jsonPatchOperation: Array, xSailPointExperimental?: string, axiosOptions?: RawAxiosRequestConfig) => Promise; /** * This API replaces the current entitlement request configuration for a source. This source-level configuration should apply for all the entitlements in the source. Access request to any entitlements in the source should follow this configuration unless a separate entitlement-level configuration is defined. - During access request, this source-level entitlement request configuration overrides the global organization-level configuration. - However, the entitlement-level configuration (if defined) overrides this source-level configuration. * @summary Update source entitlement request configuration * @param {string} id The Source id * @param {SourceEntitlementRequestConfig} sourceEntitlementRequestConfig * @param {*} [axiosOptions] Override http request option. * @throws {RequiredError} */ updateSourceEntitlementRequestConfigV1: (id: string, sourceEntitlementRequestConfig: SourceEntitlementRequestConfig, axiosOptions?: RawAxiosRequestConfig) => Promise; /** * Use this API to selectively update an existing Schedule using a JSONPatch payload. The following schedule fields are immutable and cannot be updated: - type * @summary Update source schedule (partial) * @param {string} sourceId The Source id. * @param {UpdateSourceScheduleV1ScheduleTypeEnum} scheduleType The Schedule type. * @param {Array} jsonPatchOperation The JSONPatch payload used to update the schedule. * @param {*} [axiosOptions] Override http request option. * @throws {RequiredError} */ updateSourceScheduleV1: (sourceId: string, scheduleType: UpdateSourceScheduleV1ScheduleTypeEnum, jsonPatchOperation: Array, axiosOptions?: RawAxiosRequestConfig) => Promise; /** * Use this API to selectively update an existing Schema using a JSONPatch payload. The following schema fields are immutable and cannot be updated: - id - name - created - modified To switch an account attribute to a group entitlement, you need to have the following in place: - `isEntitlement: true` - Must define a schema for the group and [add it to the source](https://developer.sailpoint.com/docs/api/create-source-schema-v-1) before updating the `isGroup` flag. For example, here is the `group` account attribute referencing a schema that defines the group: ```json { \"name\": \"groups\", \"type\": \"STRING\", \"schema\": { \"type\": \"CONNECTOR_SCHEMA\", \"id\": \"2c9180887671ff8c01767b4671fc7d60\", \"name\": \"group\" }, \"description\": \"The groups, roles etc. that reference account group objects\", \"isMulti\": true, \"isEntitlement\": true, \"isGroup\": true } ``` * @summary Update source schema (partial) * @param {string} sourceId The Source id. * @param {string} schemaId The Schema id. * @param {Array} jsonPatchOperation The JSONPatch payload used to update the schema. * @param {*} [axiosOptions] Override http request option. * @throws {RequiredError} */ updateSourceSchemaV1: (sourceId: string, schemaId: string, jsonPatchOperation: Array, axiosOptions?: RawAxiosRequestConfig) => Promise; /** * Use this API to partially update a source in Identity Security Cloud (ISC), using a list of patch operations according to the [JSON Patch](https://tools.ietf.org/html/rfc6902) standard. These fields are immutable, so they cannot be changed: * id * type * authoritative * created * modified * connector * connectorClass * passwordPolicies Attempts to modify these fields will result in a 400 error. * @summary Update source (partial) * @param {string} id Source ID. * @param {Array} jsonPatchOperation A list of account update operations according to the [JSON Patch](https://tools.ietf.org/html/rfc6902) standard. Any password changes are submitted as plain-text and encrypted upon receipt in Identity Security Cloud (ISC). * @param {*} [axiosOptions] Override http request option. * @throws {RequiredError} */ updateSourceV1: (id: string, jsonPatchOperation: Array, axiosOptions?: RawAxiosRequestConfig) => Promise; }; /** * SourcesApi - functional programming interface * @export */ export declare const SourcesApiFp: (configuration?: Configuration) => { /** * This API generates a create policy/template based on field value transforms. This API is intended for use when setting up JDBC Provisioning type sources, but it will also work on other source types. Transforms can be used in the provisioning policy to create a new attribute that you only need during provisioning. Refer to [Transforms in Provisioning Policies](https://developer.sailpoint.com/docs/extensibility/transforms/guides/transforms-in-provisioning-policies) for more information. * @summary Create provisioning policy * @param {string} sourceId The Source id * @param {ProvisioningPolicyDto} provisioningPolicyDto * @param {*} [axiosOptions] Override http request option. * @throws {RequiredError} */ createProvisioningPolicyV1(sourceId: string, provisioningPolicyDto: ProvisioningPolicyDto, axiosOptions?: RawAxiosRequestConfig): Promise<(axios?: AxiosInstance, basePath?: string) => AxiosPromise>; /** * This API generates a create policy/template based on field value transforms. This API is intended for use when setting up JDBC Provisioning type sources, but it will also work on other source types. Transforms can be used in the provisioning policy to create a new attribute that you only need during provisioning. The V2 API allows you to use a unique identifier (id) for each provisioning policy instead of usageType. This enables read, update, and delete operations on policies using their id. Note: The subtypeId field is required if usageType is CREATE_MACHINE_ACCOUNT. Refer to [Transforms in Provisioning Policies](https://developer.sailpoint.com/docs/extensibility/transforms/guides/transforms-in-provisioning-policies) for more information. * @summary Create provisioning policy * @param {string} sourceId The Source id * @param {ProvisioningPolicyDtoV2} provisioningPolicyDtoV2 * @param {boolean} [useDefaultFields] If passed as true, then it uses default fields from the connector template. * @param {string} [xSailPointExperimental] Use this header to enable this experimental API. * @param {*} [axiosOptions] Override http request option. * @throws {RequiredError} */ createProvisioningPolicyV2(sourceId: string, provisioningPolicyDtoV2: ProvisioningPolicyDtoV2, useDefaultFields?: boolean, xSailPointExperimental?: string, axiosOptions?: RawAxiosRequestConfig): Promise<(axios?: AxiosInstance, basePath?: string) => AxiosPromise>; /** * Use this API to create a new schedule for a type on the specified source in Identity Security Cloud (ISC). * @summary Create schedule on source * @param {string} sourceId Source ID. * @param {Schedule3} schedule3 * @param {*} [axiosOptions] Override http request option. * @throws {RequiredError} */ createSourceScheduleV1(sourceId: string, schedule3: Schedule3, axiosOptions?: RawAxiosRequestConfig): Promise<(axios?: AxiosInstance, basePath?: string) => AxiosPromise>; /** * Use this API to create a new schema on the specified source in Identity Security Cloud (ISC). * @summary Create schema on source * @param {string} sourceId Source ID. * @param {Schema} schema * @param {*} [axiosOptions] Override http request option. * @throws {RequiredError} */ createSourceSchemaV1(sourceId: string, schema: Schema, axiosOptions?: RawAxiosRequestConfig): Promise<(axios?: AxiosInstance, basePath?: string) => AxiosPromise>; /** * This creates a specific source with a full source JSON representation. Any passwords are submitted as plain-text and encrypted upon receipt in IdentityNow. * @summary Creates a source in identitynow. * @param {Source} source * @param {boolean} [provisionAsCsv] If this parameter is `true`, it configures the source as a Delimited File (CSV) source. Setting this to `true` will automatically set the `type` of the source to `DelimitedFile`. You must use this query parameter to create a Delimited File source as you would in the UI. If you don\'t set this query parameter and you attempt to set the `type` attribute directly, the request won\'t correctly generate the source. * @param {*} [axiosOptions] Override http request option. * @throws {RequiredError} */ createSourceV1(source: Source, provisionAsCsv?: boolean, axiosOptions?: RawAxiosRequestConfig): Promise<(axios?: AxiosInstance, basePath?: string) => AxiosPromise>; /** * Use this endpoint to remove all accounts from the system without provisioning changes to the source. Accounts that are removed could be re-created during the next aggregation. This endpoint is good for: * Removing accounts that no longer exist on the source. * Removing accounts that won\'t be aggregated following updates to the source configuration. * Forcing accounts to be re-created following the next aggregation to re-run account processing, support testing, etc. * @summary Remove all accounts in source * @param {string} id The source id * @param {*} [axiosOptions] Override http request option. * @throws {RequiredError} */ deleteAccountsAsyncV1(id: string, axiosOptions?: RawAxiosRequestConfig): Promise<(axios?: AxiosInstance, basePath?: string) => AxiosPromise>; /** * Deletes the native change detection configuration for the source specified by the given ID. * @summary Delete native change detection configuration * @param {string} sourceId The source id * @param {*} [axiosOptions] Override http request option. * @throws {RequiredError} */ deleteNativeChangeDetectionConfigV1(sourceId: string, axiosOptions?: RawAxiosRequestConfig): Promise<(axios?: AxiosInstance, basePath?: string) => AxiosPromise>; /** * Deletes the provisioning policy with the specified usage on an application. * @summary Delete provisioning policy by usagetype * @param {string} sourceId The Source ID. * @param {UsageType} usageType The type of provisioning policy usage. In IdentityNow, a source can support various provisioning operations. For example, when a joiner is added to a source, this may trigger both CREATE and UPDATE provisioning operations. Each usage type is considered a provisioning policy. A source can have any number of these provisioning policies defined. These are the common usage types: CREATE - This usage type relates to \'Create Account Profile\', the provisioning template for the account to be created. For example, this would be used for a joiner on a source. UPDATE - This usage type relates to \'Update Account Profile\', the provisioning template for the \'Update\' connector operations. For example, this would be used for an attribute sync on a source. ENABLE - This usage type relates to \'Enable Account Profile\', the provisioning template for the account to be enabled. For example, this could be used for a joiner on a source once the joiner\'s account is created. DISABLE - This usage type relates to \'Disable Account Profile\', the provisioning template for the account to be disabled. For example, this could be used when a leaver is removed temporarily from a source. You can use these four usage types for all your provisioning policy needs. * @param {*} [axiosOptions] Override http request option. * @throws {RequiredError} */ deleteProvisioningPolicyV1(sourceId: string, usageType: UsageType, axiosOptions?: RawAxiosRequestConfig): Promise<(axios?: AxiosInstance, basePath?: string) => AxiosPromise>; /** * Deletes the provisioning policy with the specified ID on an application. * @summary Delete provisioning policy by ID * @param {string} sourceId The Source ID. * @param {string} id The provisioning policy ID. * @param {string} [xSailPointExperimental] Use this header to enable this experimental API. * @param {*} [axiosOptions] Override http request option. * @throws {RequiredError} */ deleteProvisioningPolicyV2(sourceId: string, id: string, xSailPointExperimental?: string, axiosOptions?: RawAxiosRequestConfig): Promise<(axios?: AxiosInstance, basePath?: string) => AxiosPromise>; /** * * @summary Delete source schedule by type. * @param {string} sourceId The Source id. * @param {DeleteSourceScheduleV1ScheduleTypeEnum} scheduleType The Schedule type. * @param {*} [axiosOptions] Override http request option. * @throws {RequiredError} */ deleteSourceScheduleV1(sourceId: string, scheduleType: DeleteSourceScheduleV1ScheduleTypeEnum, axiosOptions?: RawAxiosRequestConfig): Promise<(axios?: AxiosInstance, basePath?: string) => AxiosPromise>; /** * * @summary Delete source schema by id * @param {string} sourceId The Source id. * @param {string} schemaId The Schema id. * @param {*} [axiosOptions] Override http request option. * @throws {RequiredError} */ deleteSourceSchemaV1(sourceId: string, schemaId: string, axiosOptions?: RawAxiosRequestConfig): Promise<(axios?: AxiosInstance, basePath?: string) => AxiosPromise>; /** * Use this API to delete a specific source in Identity Security Cloud (ISC). The API removes all the accounts on the source first, and then it deletes the source. You can retrieve the actual task execution status with this method: GET `/task-status/{id}` * @summary Delete source by id * @param {string} id Source ID. * @param {*} [axiosOptions] Override http request option. * @throws {RequiredError} */ deleteSourceV1(id: string, axiosOptions?: RawAxiosRequestConfig): Promise<(axios?: AxiosInstance, basePath?: string) => AxiosPromise>; /** * The endpoint retrieves the approval configuration for deleting human accounts from a specified source. It returns details such as whether approval is required, who the approvers are, and any additional approval settings. This helps administrators understand and manage the approval workflow for human account deletions in their organization. The response is provided as an AccountDeleteConfigDto object. * @summary Human Account Deletion Approval Config * @param {string} sourceId The Source id * @param {*} [axiosOptions] Override http request option. * @throws {RequiredError} */ getAccountDeleteApprovalConfigV1(sourceId: string, axiosOptions?: RawAxiosRequestConfig): Promise<(axios?: AxiosInstance, basePath?: string) => AxiosPromise>; /** * This API downloads the CSV schema that defines the account attributes on a source. >**NOTE: This API is designated only for Delimited File sources.** * @summary Downloads source accounts schema template * @param {string} id The Source id * @param {*} [axiosOptions] Override http request option. * @throws {RequiredError} */ getAccountsSchemaV1(id: string, axiosOptions?: RawAxiosRequestConfig): Promise<(axios?: AxiosInstance, basePath?: string) => AxiosPromise>; /** * This API returns the existing correlation configuration for a source specified by the given ID. * @summary Get source correlation configuration * @param {string} id The source id * @param {*} [axiosOptions] Override http request option. * @throws {RequiredError} */ getCorrelationConfigV1(id: string, axiosOptions?: RawAxiosRequestConfig): Promise<(axios?: AxiosInstance, basePath?: string) => AxiosPromise>; /** * This API downloads the CSV schema that defines the entitlement attributes on a source. >**NOTE: This API is designated only for Delimited File sources.** * @summary Downloads source entitlements schema template * @param {string} id The Source id * @param {string} [schemaName] Name of entitlement schema * @param {*} [axiosOptions] Override http request option. * @throws {RequiredError} */ getEntitlementsSchemaV1(id: string, schemaName?: string, axiosOptions?: RawAxiosRequestConfig): Promise<(axios?: AxiosInstance, basePath?: string) => AxiosPromise>; /** * Retrieves the machine account deletion approval configuration for a specific source. This endpoint returns details about the approval requirements, approvers, and comment settings that govern the deletion of machine accounts associated with the given source ID. * @summary Machine Account Deletion Approval Config * @param {string} sourceId source id. * @param {*} [axiosOptions] Override http request option. * @throws {RequiredError} */ getMachineAccountDeletionApprovalConfigBySourceV1(sourceId: string, axiosOptions?: RawAxiosRequestConfig): Promise<(axios?: AxiosInstance, basePath?: string) => AxiosPromise>; /** * This API returns the existing native change detection configuration for a source specified by the given ID. * @summary Native change detection configuration * @param {string} sourceId The source id * @param {*} [axiosOptions] Override http request option. * @throws {RequiredError} */ getNativeChangeDetectionConfigV1(sourceId: string, axiosOptions?: RawAxiosRequestConfig): Promise<(axios?: AxiosInstance, basePath?: string) => AxiosPromise>; /** * This end-point retrieves the ProvisioningPolicy with the specified usage on the specified Source in IdentityNow. * @summary Get provisioning policy by usagetype * @param {string} sourceId The Source ID. * @param {UsageType} usageType The type of provisioning policy usage. In IdentityNow, a source can support various provisioning operations. For example, when a joiner is added to a source, this may trigger both CREATE and UPDATE provisioning operations. Each usage type is considered a provisioning policy. A source can have any number of these provisioning policies defined. These are the common usage types: CREATE - This usage type relates to \'Create Account Profile\', the provisioning template for the account to be created. For example, this would be used for a joiner on a source. UPDATE - This usage type relates to \'Update Account Profile\', the provisioning template for the \'Update\' connector operations. For example, this would be used for an attribute sync on a source. ENABLE - This usage type relates to \'Enable Account Profile\', the provisioning template for the account to be enabled. For example, this could be used for a joiner on a source once the joiner\'s account is created. DISABLE - This usage type relates to \'Disable Account Profile\', the provisioning template for the account to be disabled. For example, this could be used when a leaver is removed temporarily from a source. You can use these four usage types for all your provisioning policy needs. * @param {*} [axiosOptions] Override http request option. * @throws {RequiredError} */ getProvisioningPolicyV1(sourceId: string, usageType: UsageType, axiosOptions?: RawAxiosRequestConfig): Promise<(axios?: AxiosInstance, basePath?: string) => AxiosPromise>; /** * This end-point retrieves the ProvisioningPolicy with the specified ID on the specified Source in Identity Security Cloud. * @summary Get provisioning policy by ID * @param {string} sourceId The Source ID. * @param {string} id The provisioning policy ID. * @param {string} [xSailPointExperimental] Use this header to enable this experimental API. * @param {*} [axiosOptions] Override http request option. * @throws {RequiredError} */ getProvisioningPolicyV2(sourceId: string, id: string, xSailPointExperimental?: string, axiosOptions?: RawAxiosRequestConfig): Promise<(axios?: AxiosInstance, basePath?: string) => AxiosPromise>; /** * This API returns the existing attribute synchronization configuration for a source specified by the given ID. The response contains all attributes, regardless of whether they enabled or not. * @summary Attribute sync config * @param {string} id The source id * @param {string} [xSailPointExperimental] Use this header to enable this experimental API. * @param {*} [axiosOptions] Override http request option. * @throws {RequiredError} */ getSourceAttrSyncConfigV1(id: string, xSailPointExperimental?: string, axiosOptions?: RawAxiosRequestConfig): Promise<(axios?: AxiosInstance, basePath?: string) => AxiosPromise>; /** * Looks up and returns the source config for the requested source id after populating the source config values and applying language translations. * @summary Gets source config with language-translations * @param {string} id The Source id * @param {GetSourceConfigV1LocaleEnum} [locale] The locale to apply to the config. If no viable locale is given, it will default to \"en\" * @param {*} [axiosOptions] Override http request option. * @throws {RequiredError} */ getSourceConfigV1(id: string, locale?: GetSourceConfigV1LocaleEnum, axiosOptions?: RawAxiosRequestConfig): Promise<(axios?: AxiosInstance, basePath?: string) => AxiosPromise>; /** * Use this API to get all dependent Profiles, Attributes, Applications and Custom Transforms for a source by a specified ID in Identity Security Cloud (ISC). * @summary Get source connections by id * @param {string} sourceId Source ID. * @param {*} [axiosOptions] Override http request option. * @throws {RequiredError} */ getSourceConnectionsV1(sourceId: string, axiosOptions?: RawAxiosRequestConfig): Promise<(axios?: AxiosInstance, basePath?: string) => AxiosPromise>; /** * This API gets the current entitlement request configuration for a source. This source-level configuration should apply for all the entitlements in the source. Access request to any entitlements in the source should follow this configuration unless a separate entitlement-level configuration is defined. - During access request, this source-level entitlement request configuration overrides the global organization-level configuration. - However, the entitlement-level configuration (if defined) overrides this source-level configuration. * @summary Get source entitlement request configuration * @param {string} id The Source id * @param {*} [axiosOptions] Override http request option. * @throws {RequiredError} */ getSourceEntitlementRequestConfigV1(id: string, axiosOptions?: RawAxiosRequestConfig): Promise<(axios?: AxiosInstance, basePath?: string) => AxiosPromise>; /** * This endpoint fetches source health by source\'s id * @summary Fetches source health by id * @param {string} sourceId The Source id. * @param {*} [axiosOptions] Override http request option. * @throws {RequiredError} */ getSourceHealthV1(sourceId: string, axiosOptions?: RawAxiosRequestConfig): Promise<(axios?: AxiosInstance, basePath?: string) => AxiosPromise>; /** * Get the source schedule by type in Identity Security Cloud (ISC). * @summary Get source schedule by type * @param {string} sourceId The Source id. * @param {GetSourceScheduleV1ScheduleTypeEnum} scheduleType The Schedule type. * @param {*} [axiosOptions] Override http request option. * @throws {RequiredError} */ getSourceScheduleV1(sourceId: string, scheduleType: GetSourceScheduleV1ScheduleTypeEnum, axiosOptions?: RawAxiosRequestConfig): Promise<(axios?: AxiosInstance, basePath?: string) => AxiosPromise>; /** * Use this API to list the schedules that exist on the specified source in Identity Security Cloud (ISC). :::info This endpoint uses a **cron expression** to schedule a task, following standard **cron job syntax**. For example, `0 0 12 1/1 * ? *` runs the task **daily at 12:00 PM**. **Days of the week are represented as 1-7 (Sunday-Saturday).** ::: * @summary List schedules on source * @param {string} sourceId Source ID. * @param {*} [axiosOptions] Override http request option. * @throws {RequiredError} */ getSourceSchedulesV1(sourceId: string, axiosOptions?: RawAxiosRequestConfig): Promise<(axios?: AxiosInstance, basePath?: string) => AxiosPromise>>; /** * Get the Source Schema by ID in IdentityNow. * @summary Get source schema by id * @param {string} sourceId The Source id. * @param {string} schemaId The Schema id. * @param {*} [axiosOptions] Override http request option. * @throws {RequiredError} */ getSourceSchemaV1(sourceId: string, schemaId: string, axiosOptions?: RawAxiosRequestConfig): Promise<(axios?: AxiosInstance, basePath?: string) => AxiosPromise>; /** * Use this API to list the schemas that exist on the specified source in Identity Security Cloud (ISC). * @summary List schemas on source * @param {string} sourceId Source ID. * @param {GetSourceSchemasV1IncludeTypesEnum} [includeTypes] If set to \'group\', then the account schema is filtered and only group schemas are returned. Only a value of \'group\' is recognized presently. Note: The API will check whether include-types is group or not, if not, it will list schemas based on include-names, if include-names is not provided, it will list all schemas. * @param {string} [includeNames] A comma-separated list of schema names to filter result. * @param {*} [axiosOptions] Override http request option. * @throws {RequiredError} */ getSourceSchemasV1(sourceId: string, includeTypes?: GetSourceSchemasV1IncludeTypesEnum, includeNames?: string, axiosOptions?: RawAxiosRequestConfig): Promise<(axios?: AxiosInstance, basePath?: string) => AxiosPromise>>; /** * Use this API to get a source by a specified ID in Identity Security Cloud (ISC). * @summary Get source by id * @param {string} id Source ID. * @param {*} [axiosOptions] Override http request option. * @throws {RequiredError} */ getSourceV1(id: string, axiosOptions?: RawAxiosRequestConfig): Promise<(axios?: AxiosInstance, basePath?: string) => AxiosPromise>; /** * This API uploads a source schema template file to configure a source\'s account attributes. To retrieve the file to modify and upload, log into Identity Now. Click **Admin** -> **Connections** -> **Sources** -> **`{SourceName}`** -> **Import Data** -> **Account Schema** -> **Options** -> **Download Schema** >**NOTE: This API is designated only for Delimited File sources.** * @summary Uploads source accounts schema template * @param {string} id The Source id * @param {File} [file] * @param {*} [axiosOptions] Override http request option. * @throws {RequiredError} */ importAccountsSchemaV1(id: string, file?: File, axiosOptions?: RawAxiosRequestConfig): Promise<(axios?: AxiosInstance, basePath?: string) => AxiosPromise>; /** * Starts an account aggregation on the specified source. If the target source is a delimited file source, then the CSV file needs to be included in the request body. You will also need to set the Content-Type header to `multipart/form-data`. * @summary Account aggregation * @param {string} id Source Id * @param {File} [file] The CSV file containing the source accounts to aggregate. * @param {string} [disableOptimization] Use this flag to reprocess every account whether or not the data has changed. * @param {*} [axiosOptions] Override http request option. * @throws {RequiredError} */ importAccountsV1(id: string, file?: File, disableOptimization?: string, axiosOptions?: RawAxiosRequestConfig): Promise<(axios?: AxiosInstance, basePath?: string) => AxiosPromise>; /** * This uploads a supplemental source connector file (like jdbc driver jars) to a source\'s S3 bucket. This also sends ETS and Audit events. * @summary Upload connector file to source * @param {string} sourceId The Source id. * @param {File} [file] * @param {*} [axiosOptions] Override http request option. * @throws {RequiredError} */ importConnectorFileV1(sourceId: string, file?: File, axiosOptions?: RawAxiosRequestConfig): Promise<(axios?: AxiosInstance, basePath?: string) => AxiosPromise>; /** * This API uploads a source schema template file to configure a source\'s entitlement attributes. To retrieve the file to modify and upload, log into Identity Now. Click **Admin** -> **Connections** -> **Sources** -> **`{SourceName}`** -> **Import Data** -> **Import Entitlements** -> **Download** >**NOTE: This API is designated only for Delimited File sources.** * @summary Uploads source entitlements schema template * @param {string} id The Source id * @param {string} [schemaName] Name of entitlement schema * @param {File} [file] * @param {*} [axiosOptions] Override http request option. * @throws {RequiredError} */ importEntitlementsSchemaV1(id: string, schemaName?: string, file?: File, axiosOptions?: RawAxiosRequestConfig): Promise<(axios?: AxiosInstance, basePath?: string) => AxiosPromise>; /** * Starts an entitlement aggregation on the specified source. If the target source is a delimited file source, then the CSV file needs to be included in the request body. You will also need to set the Content-Type header to `multipart/form-data`. A token with ORG_ADMIN, SOURCE_ADMIN, or SOURCE_SUBADMIN authority is required to call this API. * @summary Entitlement aggregation * @param {string} sourceId Source Id * @param {File} [file] The CSV file containing the source entitlements to aggregate. * @param {*} [axiosOptions] Override http request option. * @throws {RequiredError} */ importEntitlementsV1(sourceId: string, file?: File, axiosOptions?: RawAxiosRequestConfig): Promise<(axios?: AxiosInstance, basePath?: string) => AxiosPromise>; /** * File is required for upload. You will also need to set the Content-Type header to `multipart/form-data` * @summary Process uncorrelated accounts * @param {string} id Source Id * @param {File} [file] * @param {*} [axiosOptions] Override http request option. * @throws {RequiredError} */ importUncorrelatedAccountsV1(id: string, file?: File, axiosOptions?: RawAxiosRequestConfig): Promise<(axios?: AxiosInstance, basePath?: string) => AxiosPromise>; /** * This API can be used to get Password Policy in IdentityNow for the specified Source. Source must support PASSWORD feature. * @summary Get Password Policy for source * @param {string} sourceId The Source id * @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 {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 {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} */ listPasswordPolicyHoldersOnSourceV1(sourceId: string, offset?: number, limit?: number, count?: boolean, axiosOptions?: RawAxiosRequestConfig): Promise<(axios?: AxiosInstance, basePath?: string) => AxiosPromise>>; /** * This end-point lists all the ProvisioningPolicies in IdentityNow. * @summary Lists provisioningpolicies * @param {string} sourceId The Source id * @param {number} [offset] Offset Integer specifying the offset of the first result from the beginning of the collection. The standard syntax described in [V3 API Standard Collection Parameters](https://developer.sailpoint.com/idn/api/standard-collection-parameters#paginating-results). The offset value is record-based, not page-based, and the index starts at 0. * @param {number} [limit] Limit Integer specifying the maximum number of records to return in a single API call. The standard syntax described in [V3 API Standard Collection Parameters](https://developer.sailpoint.com/idn/api/standard-collection-parameters#paginating-results). If it is not specified, a default limit is used. * @param {*} [axiosOptions] Override http request option. * @throws {RequiredError} */ listProvisioningPoliciesV1(sourceId: string, offset?: number, limit?: number, axiosOptions?: RawAxiosRequestConfig): Promise<(axios?: AxiosInstance, basePath?: string) => AxiosPromise>>; /** * This end-point lists all the ProvisioningPolicies in IdentityNow. * @summary Lists Provisioning Policies * @param {string} sourceId The Source id * @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: **subtypeId**: *eq* **usageType**: *eq* * @param {number} [offset] Offset Integer specifying the offset of the first result from the beginning of the collection. The standard syntax described in [V3 API Standard Collection Parameters](https://developer.sailpoint.com/idn/api/standard-collection-parameters#paginating-results). The offset value is record-based, not page-based, and the index starts at 0. * @param {number} [limit] Limit Integer specifying the maximum number of records to return in a single API call. The standard syntax described in [V3 API Standard Collection Parameters](https://developer.sailpoint.com/idn/api/standard-collection-parameters#paginating-results). If it is not specified, a default limit is used. * @param {string} [xSailPointExperimental] Use this header to enable this experimental API. * @param {*} [axiosOptions] Override http request option. * @throws {RequiredError} */ listProvisioningPoliciesV2(sourceId: string, filters?: string, offset?: number, limit?: number, xSailPointExperimental?: string, axiosOptions?: RawAxiosRequestConfig): Promise<(axios?: AxiosInstance, basePath?: string) => AxiosPromise>>; /** * This end-point lists all the sources in IdentityNow. * @summary Lists all sources in identitynow. * @param {number} [limit] Max number of results to return. See [V3 API Standard Collection Parameters](https://developer.sailpoint.com/idn/api/standard-collection-parameters) for more information. * @param {number} [offset] Offset into the full result set. Usually specified with *limit* to paginate through the results. See [V3 API Standard Collection Parameters](https://developer.sailpoint.com/idn/api/standard-collection-parameters) for more information. * @param {boolean} [count] If *true* it will populate the *X-Total-Count* response header with the number of results that would be returned if *limit* and *offset* were ignored. Since requesting a total count can have a performance impact, it is recommended not to send **count=true** if that value will not be used. See [V3 API Standard Collection Parameters](https://developer.sailpoint.com/idn/api/standard-collection-parameters) for more information. * @param {string} [filters] Filter results using the standard syntax described in [V3 API Standard Collection Parameters](https://developer.sailpoint.com/idn/api/standard-collection-parameters#filtering-results) Filtering is supported for the following fields and operators: **id**: *eq, in, ge, gt, le, lt, ne, isnull, sw* **name**: *co, eq, in, sw, ge, gt, ne, isnull* **type**: *eq, in, ge, gt, ne, isnull, sw* **owner.id**: *eq, in, ge, gt, le, lt, ne, isnull, sw* **features**: *ca, co* **created**: *eq, ge, gt, in, le, lt, ne, isnull, sw* **modified**: *eq, ge, gt, in, le, lt, ne, isnull, sw* **managementWorkgroup.id**: *eq, ge, gt, in, le, lt, ne, isnull, sw* **description**: *eq, sw* **authoritative**: *eq, ne, isnull* **healthy**: *isnull* **status**: *eq, in, ge, gt, le, lt, ne, isnull, sw* **connectionType**: *eq, ge, gt, in, le, lt, ne, isnull, sw* **connectorName**: *eq, ge, gt, in, ne, isnull, sw* **category**: *co, eq, ge, gt, in, le, lt, ne, sw* * @param {string} [sorters] Sort results using the standard syntax described in [V3 API Standard Collection Parameters](https://developer.sailpoint.com/idn/api/standard-collection-parameters#sorting-results) Sorting is supported for the following fields: **type, created, modified, name, owner.name, healthy, status, id, description, owner.id, accountCorrelationConfig.id, accountCorrelationConfig.name, managerCorrelationRule.type, managerCorrelationRule.id, managerCorrelationRule.name, authoritative, managementWorkgroup.id, connectorName, connectionType** * @param {string} [forSubadmin] Filter the returned list of sources for the identity specified by the parameter, which is the id of an identity with the role SOURCE_SUBADMIN. By convention, the value **me** indicates the identity id of the current user. Subadmins may only view Sources which they are able to administer; all other Sources will be filtered out when this parameter is set. If the current user is a SOURCE_SUBADMIN but fails to pass a valid value for this parameter, a 403 Forbidden is returned. * @param {boolean} [includeIDNSource] Include the IdentityNow source in the response. * @param {*} [axiosOptions] Override http request option. * @throws {RequiredError} */ listSourcesV1(limit?: number, offset?: number, count?: boolean, filters?: string, sorters?: string, forSubadmin?: string, includeIDNSource?: boolean, axiosOptions?: RawAxiosRequestConfig): Promise<(axios?: AxiosInstance, basePath?: string) => AxiosPromise>>; /** * This endpoint validates that the cluster being used by the source is reachable from IdentityNow. * @summary Ping cluster for source connector * @param {string} sourceId The ID of the Source * @param {*} [axiosOptions] Override http request option. * @throws {RequiredError} */ pingClusterV1(sourceId: string, axiosOptions?: RawAxiosRequestConfig): Promise<(axios?: AxiosInstance, basePath?: string) => AxiosPromise>; /** * Replaces the correlation configuration for the source specified by the given ID with the configuration provided in the request body. * @summary Update source correlation configuration * @param {string} id The source id * @param {CorrelationConfig} correlationConfig * @param {*} [axiosOptions] Override http request option. * @throws {RequiredError} */ putCorrelationConfigV1(id: string, correlationConfig: CorrelationConfig, axiosOptions?: RawAxiosRequestConfig): Promise<(axios?: AxiosInstance, basePath?: string) => AxiosPromise>; /** * Replaces the native change detection configuration for the source specified by the given ID with the configuration provided in the request body. * @summary Update native change detection configuration * @param {string} sourceId The source id * @param {NativeChangeDetectionConfig} nativeChangeDetectionConfig * @param {*} [axiosOptions] Override http request option. * @throws {RequiredError} */ putNativeChangeDetectionConfigV1(sourceId: string, nativeChangeDetectionConfig: NativeChangeDetectionConfig, axiosOptions?: RawAxiosRequestConfig): Promise<(axios?: AxiosInstance, basePath?: string) => AxiosPromise>; /** * This end-point updates the provisioning policy with the specified usage on the specified source in IdentityNow. Transforms can be used in the provisioning policy to create a new attribute that you only need during provisioning. Refer to [Transforms in Provisioning Policies](https://developer.sailpoint.com/docs/extensibility/transforms/guides/transforms-in-provisioning-policies) for more information. * @summary Update provisioning policy by usagetype * @param {string} sourceId The Source ID. * @param {UsageType} usageType The type of provisioning policy usage. In IdentityNow, a source can support various provisioning operations. For example, when a joiner is added to a source, this may trigger both CREATE and UPDATE provisioning operations. Each usage type is considered a provisioning policy. A source can have any number of these provisioning policies defined. These are the common usage types: CREATE - This usage type relates to \'Create Account Profile\', the provisioning template for the account to be created. For example, this would be used for a joiner on a source. UPDATE - This usage type relates to \'Update Account Profile\', the provisioning template for the \'Update\' connector operations. For example, this would be used for an attribute sync on a source. ENABLE - This usage type relates to \'Enable Account Profile\', the provisioning template for the account to be enabled. For example, this could be used for a joiner on a source once the joiner\'s account is created. DISABLE - This usage type relates to \'Disable Account Profile\', the provisioning template for the account to be disabled. For example, this could be used when a leaver is removed temporarily from a source. You can use these four usage types for all your provisioning policy needs. * @param {ProvisioningPolicyDto} provisioningPolicyDto * @param {*} [axiosOptions] Override http request option. * @throws {RequiredError} */ putProvisioningPolicyV1(sourceId: string, usageType: UsageType, provisioningPolicyDto: ProvisioningPolicyDto, axiosOptions?: RawAxiosRequestConfig): Promise<(axios?: AxiosInstance, basePath?: string) => AxiosPromise>; /** * This end-point updates the provisioning policy with the specified ID on the specified source in Identity Security Cloud. Transforms can be used in the provisioning policy to create a new attribute that you only need during provisioning. Refer to [Transforms in Provisioning Policies](https://developer.sailpoint.com/docs/extensibility/transforms/guides/transforms-in-provisioning-policies) for more information. * @summary Update provisioning policy by ID * @param {string} sourceId The Source ID. * @param {string} id The provisioning policy ID. * @param {ProvisioningPolicyDtoV2} provisioningPolicyDtoV2 * @param {string} [xSailPointExperimental] Use this header to enable this experimental API. * @param {*} [axiosOptions] Override http request option. * @throws {RequiredError} */ putProvisioningPolicyV2(sourceId: string, id: string, provisioningPolicyDtoV2: ProvisioningPolicyDtoV2, xSailPointExperimental?: string, axiosOptions?: RawAxiosRequestConfig): Promise<(axios?: AxiosInstance, basePath?: string) => AxiosPromise>; /** * Replaces the attribute synchronization configuration for the source specified by the given ID with the configuration provided in the request body. Only the \"enabled\" field of the values in the \"attributes\" array is mutable. Attempting to change other attributes or add new values to the \"attributes\" array will result in an error. * @summary Update attribute sync config * @param {string} id The source id * @param {AttrSyncSourceConfig} attrSyncSourceConfig * @param {string} [xSailPointExperimental] Use this header to enable this experimental API. * @param {*} [axiosOptions] Override http request option. * @throws {RequiredError} */ putSourceAttrSyncConfigV1(id: string, attrSyncSourceConfig: AttrSyncSourceConfig, xSailPointExperimental?: string, axiosOptions?: RawAxiosRequestConfig): Promise<(axios?: AxiosInstance, basePath?: string) => AxiosPromise>; /** * This API will completely replace an existing Schema with the submitted payload. Some fields of the Schema cannot be updated. These fields are listed below. * id * name * created * modified Any attempt to modify these fields will result in an error response with a status code of 400. > `id` must remain in the request body, but it cannot be changed. If `id` is omitted from the request body, the result will be a 400 error. * @summary Update source schema (full) * @param {string} sourceId The Source id. * @param {string} schemaId The Schema id. * @param {Schema} schema * @param {*} [axiosOptions] Override http request option. * @throws {RequiredError} */ putSourceSchemaV1(sourceId: string, schemaId: string, schema: Schema, axiosOptions?: RawAxiosRequestConfig): Promise<(axios?: AxiosInstance, basePath?: string) => AxiosPromise>; /** * Use this API to update a source in Identity Security Cloud (ISC), using a full object representation. This means that when you use this API, it completely replaces the existing source configuration. These fields are immutable, so they cannot be changed: * id * type * authoritative * connector * connectorClass * passwordPolicies Attempts to modify these fields will result in a 400 error. * @summary Update source (full) * @param {string} id Source ID. * @param {Source} source * @param {*} [axiosOptions] Override http request option. * @throws {RequiredError} */ putSourceV1(id: string, source: Source, axiosOptions?: RawAxiosRequestConfig): Promise<(axios?: AxiosInstance, basePath?: string) => AxiosPromise>; /** * Retrieves a sample of data returned from account and group aggregation requests. * @summary Peek source connector\'s resource objects * @param {string} sourceId The ID of the Source * @param {ResourceObjectsRequest} resourceObjectsRequest * @param {*} [axiosOptions] Override http request option. * @throws {RequiredError} */ searchResourceObjectsV1(sourceId: string, resourceObjectsRequest: ResourceObjectsRequest, axiosOptions?: RawAxiosRequestConfig): Promise<(axios?: AxiosInstance, basePath?: string) => AxiosPromise>; /** * This end-point performs attribute synchronization for a selected source. * @summary Synchronize single source attributes. * @param {string} id The Source id * @param {string} [xSailPointExperimental] Use this header to enable this experimental API. * @param {*} [axiosOptions] Override http request option. * @throws {RequiredError} */ syncAttributesForSourceV1(id: string, xSailPointExperimental?: string, axiosOptions?: RawAxiosRequestConfig): Promise<(axios?: AxiosInstance, basePath?: string) => AxiosPromise>; /** * This endpoint performs a more detailed validation of the source\'\'s configuration that can take longer than the lighter weight credential validation performed by the checkConnection API. * @summary Test configuration for source connector * @param {string} sourceId The ID of the Source * @param {*} [axiosOptions] Override http request option. * @throws {RequiredError} */ testSourceConfigurationV1(sourceId: string, axiosOptions?: RawAxiosRequestConfig): Promise<(axios?: AxiosInstance, basePath?: string) => AxiosPromise>; /** * This endpoint validates that the configured credentials are valid and will properly authenticate with the source identified by the sourceId path parameter. * @summary Check connection for source connector. * @param {string} sourceId The ID of the Source. * @param {*} [axiosOptions] Override http request option. * @throws {RequiredError} */ testSourceConnectionV1(sourceId: string, axiosOptions?: RawAxiosRequestConfig): Promise<(axios?: AxiosInstance, basePath?: string) => AxiosPromise>; /** * Updates the approval configuration for deleting human accounts for a specific source, identified by source ID. This endpoint allows administrators to modify settings such as whether approval is required, who the approvers are, and other approval-related options. The update is performed using a JSON Patch payload, and the response returns the updated AccountDeleteConfigDto object reflecting the new approval workflow configuration. * @summary Human Account Deletion Approval Config * @param {string} sourceId Human account source ID. * @param {Array} jsonPatchOperation The JSONPatch payload used to update the object. * @param {*} [axiosOptions] Override http request option. * @throws {RequiredError} */ updateAccountDeletionApprovalConfigV1(sourceId: string, jsonPatchOperation: Array, axiosOptions?: RawAxiosRequestConfig): Promise<(axios?: AxiosInstance, basePath?: string) => AxiosPromise>; /** * Use this endpoint to update the machine account deletion approval configuration for a specific source. The update is performed using a JSON Patch payload, which allows partial modifications to the approval config. This operation is typically used to change approval requirements, approvers, or comments settings for machine account deletion. The endpoint expects the source ID as a path parameter and a valid JSON Patch array in the request body. * @summary Machine Account Deletion Approval Config * @param {string} sourceId machine account source ID. * @param {Array} jsonPatchOperation The JSONPatch payload used to update the object. * @param {*} [axiosOptions] Override http request option. * @throws {RequiredError} */ updateMachineAccountDeletionApprovalConfigV1(sourceId: string, jsonPatchOperation: Array, axiosOptions?: RawAxiosRequestConfig): Promise<(axios?: AxiosInstance, basePath?: string) => AxiosPromise>; /** * This API can be used to set up or update Password Policy in IdentityNow for the specified Source. Source must support PASSWORD feature. * @summary Update password policy * @param {string} sourceId The Source id * @param {Array} passwordPolicyHoldersDtoInner * @param {*} [axiosOptions] Override http request option. * @throws {RequiredError} */ updatePasswordPolicyHoldersV1(sourceId: string, passwordPolicyHoldersDtoInner: Array, axiosOptions?: RawAxiosRequestConfig): Promise<(axios?: AxiosInstance, basePath?: string) => AxiosPromise>>; /** * This end-point updates a list of provisioning policies on the specified source in IdentityNow. * @summary Bulk update provisioning policies * @param {string} sourceId The Source id. * @param {Array} provisioningPolicyDto * @param {*} [axiosOptions] Override http request option. * @throws {RequiredError} */ updateProvisioningPoliciesInBulkV1(sourceId: string, provisioningPolicyDto: Array, axiosOptions?: RawAxiosRequestConfig): Promise<(axios?: AxiosInstance, basePath?: string) => AxiosPromise>>; /** * This API selectively updates an existing Provisioning Policy using a JSONPatch payload. Transforms can be used in the provisioning policy to create a new attribute that you only need during provisioning. Refer to [Transforms in Provisioning Policies](https://developer.sailpoint.com/docs/extensibility/transforms/guides/transforms-in-provisioning-policies) for more information. * @summary Partial update of provisioning policy * @param {string} sourceId The Source id. * @param {UsageType} usageType The type of provisioning policy usage. In IdentityNow, a source can support various provisioning operations. For example, when a joiner is added to a source, this may trigger both CREATE and UPDATE provisioning operations. Each usage type is considered a provisioning policy. A source can have any number of these provisioning policies defined. These are the common usage types: CREATE - This usage type relates to \'Create Account Profile\', the provisioning template for the account to be created. For example, this would be used for a joiner on a source. UPDATE - This usage type relates to \'Update Account Profile\', the provisioning template for the \'Update\' connector operations. For example, this would be used for an attribute sync on a source. ENABLE - This usage type relates to \'Enable Account Profile\', the provisioning template for the account to be enabled. For example, this could be used for a joiner on a source once the joiner\'s account is created. DISABLE - This usage type relates to \'Disable Account Profile\', the provisioning template for the account to be disabled. For example, this could be used when a leaver is removed temporarily from a source. You can use these four usage types for all your provisioning policy needs. * @param {Array} jsonPatchOperation The JSONPatch payload used to update the schema. * @param {*} [axiosOptions] Override http request option. * @throws {RequiredError} */ updateProvisioningPolicyV1(sourceId: string, usageType: UsageType, jsonPatchOperation: Array, axiosOptions?: RawAxiosRequestConfig): Promise<(axios?: AxiosInstance, basePath?: string) => AxiosPromise>; /** * This API selectively updates an existing Provisioning Policy using a JSONPatch payload. Transforms can be used in the provisioning policy to create a new attribute that you only need during provisioning. Refer to [Transforms in Provisioning Policies](https://developer.sailpoint.com/docs/extensibility/transforms/guides/transforms-in-provisioning-policies) for more information. * @summary Partial update of provisioning policy * @param {string} sourceId The Source id. * @param {string} id The provisioning policy ID. * @param {Array} jsonPatchOperation The JSONPatch payload used to update the schema. * @param {string} [xSailPointExperimental] Use this header to enable this experimental API. * @param {*} [axiosOptions] Override http request option. * @throws {RequiredError} */ updateProvisioningPolicyV2(sourceId: string, id: string, jsonPatchOperation: Array, xSailPointExperimental?: string, axiosOptions?: RawAxiosRequestConfig): Promise<(axios?: AxiosInstance, basePath?: string) => AxiosPromise>; /** * This API replaces the current entitlement request configuration for a source. This source-level configuration should apply for all the entitlements in the source. Access request to any entitlements in the source should follow this configuration unless a separate entitlement-level configuration is defined. - During access request, this source-level entitlement request configuration overrides the global organization-level configuration. - However, the entitlement-level configuration (if defined) overrides this source-level configuration. * @summary Update source entitlement request configuration * @param {string} id The Source id * @param {SourceEntitlementRequestConfig} sourceEntitlementRequestConfig * @param {*} [axiosOptions] Override http request option. * @throws {RequiredError} */ updateSourceEntitlementRequestConfigV1(id: string, sourceEntitlementRequestConfig: SourceEntitlementRequestConfig, axiosOptions?: RawAxiosRequestConfig): Promise<(axios?: AxiosInstance, basePath?: string) => AxiosPromise>; /** * Use this API to selectively update an existing Schedule using a JSONPatch payload. The following schedule fields are immutable and cannot be updated: - type * @summary Update source schedule (partial) * @param {string} sourceId The Source id. * @param {UpdateSourceScheduleV1ScheduleTypeEnum} scheduleType The Schedule type. * @param {Array} jsonPatchOperation The JSONPatch payload used to update the schedule. * @param {*} [axiosOptions] Override http request option. * @throws {RequiredError} */ updateSourceScheduleV1(sourceId: string, scheduleType: UpdateSourceScheduleV1ScheduleTypeEnum, jsonPatchOperation: Array, axiosOptions?: RawAxiosRequestConfig): Promise<(axios?: AxiosInstance, basePath?: string) => AxiosPromise>; /** * Use this API to selectively update an existing Schema using a JSONPatch payload. The following schema fields are immutable and cannot be updated: - id - name - created - modified To switch an account attribute to a group entitlement, you need to have the following in place: - `isEntitlement: true` - Must define a schema for the group and [add it to the source](https://developer.sailpoint.com/docs/api/create-source-schema-v-1) before updating the `isGroup` flag. For example, here is the `group` account attribute referencing a schema that defines the group: ```json { \"name\": \"groups\", \"type\": \"STRING\", \"schema\": { \"type\": \"CONNECTOR_SCHEMA\", \"id\": \"2c9180887671ff8c01767b4671fc7d60\", \"name\": \"group\" }, \"description\": \"The groups, roles etc. that reference account group objects\", \"isMulti\": true, \"isEntitlement\": true, \"isGroup\": true } ``` * @summary Update source schema (partial) * @param {string} sourceId The Source id. * @param {string} schemaId The Schema id. * @param {Array} jsonPatchOperation The JSONPatch payload used to update the schema. * @param {*} [axiosOptions] Override http request option. * @throws {RequiredError} */ updateSourceSchemaV1(sourceId: string, schemaId: string, jsonPatchOperation: Array, axiosOptions?: RawAxiosRequestConfig): Promise<(axios?: AxiosInstance, basePath?: string) => AxiosPromise>; /** * Use this API to partially update a source in Identity Security Cloud (ISC), using a list of patch operations according to the [JSON Patch](https://tools.ietf.org/html/rfc6902) standard. These fields are immutable, so they cannot be changed: * id * type * authoritative * created * modified * connector * connectorClass * passwordPolicies Attempts to modify these fields will result in a 400 error. * @summary Update source (partial) * @param {string} id Source ID. * @param {Array} jsonPatchOperation A list of account update operations according to the [JSON Patch](https://tools.ietf.org/html/rfc6902) standard. Any password changes are submitted as plain-text and encrypted upon receipt in Identity Security Cloud (ISC). * @param {*} [axiosOptions] Override http request option. * @throws {RequiredError} */ updateSourceV1(id: string, jsonPatchOperation: Array, axiosOptions?: RawAxiosRequestConfig): Promise<(axios?: AxiosInstance, basePath?: string) => AxiosPromise>; }; /** * SourcesApi - factory interface * @export */ export declare const SourcesApiFactory: (configuration?: Configuration, basePath?: string, axios?: AxiosInstance) => { /** * This API generates a create policy/template based on field value transforms. This API is intended for use when setting up JDBC Provisioning type sources, but it will also work on other source types. Transforms can be used in the provisioning policy to create a new attribute that you only need during provisioning. Refer to [Transforms in Provisioning Policies](https://developer.sailpoint.com/docs/extensibility/transforms/guides/transforms-in-provisioning-policies) for more information. * @summary Create provisioning policy * @param {SourcesApiCreateProvisioningPolicyV1Request} requestParameters Request parameters. * @param {*} [axiosOptions] Override http request option. * @throws {RequiredError} */ createProvisioningPolicyV1(requestParameters: SourcesApiCreateProvisioningPolicyV1Request, axiosOptions?: RawAxiosRequestConfig): AxiosPromise; /** * This API generates a create policy/template based on field value transforms. This API is intended for use when setting up JDBC Provisioning type sources, but it will also work on other source types. Transforms can be used in the provisioning policy to create a new attribute that you only need during provisioning. The V2 API allows you to use a unique identifier (id) for each provisioning policy instead of usageType. This enables read, update, and delete operations on policies using their id. Note: The subtypeId field is required if usageType is CREATE_MACHINE_ACCOUNT. Refer to [Transforms in Provisioning Policies](https://developer.sailpoint.com/docs/extensibility/transforms/guides/transforms-in-provisioning-policies) for more information. * @summary Create provisioning policy * @param {SourcesApiCreateProvisioningPolicyV2Request} requestParameters Request parameters. * @param {*} [axiosOptions] Override http request option. * @throws {RequiredError} */ createProvisioningPolicyV2(requestParameters: SourcesApiCreateProvisioningPolicyV2Request, axiosOptions?: RawAxiosRequestConfig): AxiosPromise; /** * Use this API to create a new schedule for a type on the specified source in Identity Security Cloud (ISC). * @summary Create schedule on source * @param {SourcesApiCreateSourceScheduleV1Request} requestParameters Request parameters. * @param {*} [axiosOptions] Override http request option. * @throws {RequiredError} */ createSourceScheduleV1(requestParameters: SourcesApiCreateSourceScheduleV1Request, axiosOptions?: RawAxiosRequestConfig): AxiosPromise; /** * Use this API to create a new schema on the specified source in Identity Security Cloud (ISC). * @summary Create schema on source * @param {SourcesApiCreateSourceSchemaV1Request} requestParameters Request parameters. * @param {*} [axiosOptions] Override http request option. * @throws {RequiredError} */ createSourceSchemaV1(requestParameters: SourcesApiCreateSourceSchemaV1Request, axiosOptions?: RawAxiosRequestConfig): AxiosPromise; /** * This creates a specific source with a full source JSON representation. Any passwords are submitted as plain-text and encrypted upon receipt in IdentityNow. * @summary Creates a source in identitynow. * @param {SourcesApiCreateSourceV1Request} requestParameters Request parameters. * @param {*} [axiosOptions] Override http request option. * @throws {RequiredError} */ createSourceV1(requestParameters: SourcesApiCreateSourceV1Request, axiosOptions?: RawAxiosRequestConfig): AxiosPromise; /** * Use this endpoint to remove all accounts from the system without provisioning changes to the source. Accounts that are removed could be re-created during the next aggregation. This endpoint is good for: * Removing accounts that no longer exist on the source. * Removing accounts that won\'t be aggregated following updates to the source configuration. * Forcing accounts to be re-created following the next aggregation to re-run account processing, support testing, etc. * @summary Remove all accounts in source * @param {SourcesApiDeleteAccountsAsyncV1Request} requestParameters Request parameters. * @param {*} [axiosOptions] Override http request option. * @throws {RequiredError} */ deleteAccountsAsyncV1(requestParameters: SourcesApiDeleteAccountsAsyncV1Request, axiosOptions?: RawAxiosRequestConfig): AxiosPromise; /** * Deletes the native change detection configuration for the source specified by the given ID. * @summary Delete native change detection configuration * @param {SourcesApiDeleteNativeChangeDetectionConfigV1Request} requestParameters Request parameters. * @param {*} [axiosOptions] Override http request option. * @throws {RequiredError} */ deleteNativeChangeDetectionConfigV1(requestParameters: SourcesApiDeleteNativeChangeDetectionConfigV1Request, axiosOptions?: RawAxiosRequestConfig): AxiosPromise; /** * Deletes the provisioning policy with the specified usage on an application. * @summary Delete provisioning policy by usagetype * @param {SourcesApiDeleteProvisioningPolicyV1Request} requestParameters Request parameters. * @param {*} [axiosOptions] Override http request option. * @throws {RequiredError} */ deleteProvisioningPolicyV1(requestParameters: SourcesApiDeleteProvisioningPolicyV1Request, axiosOptions?: RawAxiosRequestConfig): AxiosPromise; /** * Deletes the provisioning policy with the specified ID on an application. * @summary Delete provisioning policy by ID * @param {SourcesApiDeleteProvisioningPolicyV2Request} requestParameters Request parameters. * @param {*} [axiosOptions] Override http request option. * @throws {RequiredError} */ deleteProvisioningPolicyV2(requestParameters: SourcesApiDeleteProvisioningPolicyV2Request, axiosOptions?: RawAxiosRequestConfig): AxiosPromise; /** * * @summary Delete source schedule by type. * @param {SourcesApiDeleteSourceScheduleV1Request} requestParameters Request parameters. * @param {*} [axiosOptions] Override http request option. * @throws {RequiredError} */ deleteSourceScheduleV1(requestParameters: SourcesApiDeleteSourceScheduleV1Request, axiosOptions?: RawAxiosRequestConfig): AxiosPromise; /** * * @summary Delete source schema by id * @param {SourcesApiDeleteSourceSchemaV1Request} requestParameters Request parameters. * @param {*} [axiosOptions] Override http request option. * @throws {RequiredError} */ deleteSourceSchemaV1(requestParameters: SourcesApiDeleteSourceSchemaV1Request, axiosOptions?: RawAxiosRequestConfig): AxiosPromise; /** * Use this API to delete a specific source in Identity Security Cloud (ISC). The API removes all the accounts on the source first, and then it deletes the source. You can retrieve the actual task execution status with this method: GET `/task-status/{id}` * @summary Delete source by id * @param {SourcesApiDeleteSourceV1Request} requestParameters Request parameters. * @param {*} [axiosOptions] Override http request option. * @throws {RequiredError} */ deleteSourceV1(requestParameters: SourcesApiDeleteSourceV1Request, axiosOptions?: RawAxiosRequestConfig): AxiosPromise; /** * The endpoint retrieves the approval configuration for deleting human accounts from a specified source. It returns details such as whether approval is required, who the approvers are, and any additional approval settings. This helps administrators understand and manage the approval workflow for human account deletions in their organization. The response is provided as an AccountDeleteConfigDto object. * @summary Human Account Deletion Approval Config * @param {SourcesApiGetAccountDeleteApprovalConfigV1Request} requestParameters Request parameters. * @param {*} [axiosOptions] Override http request option. * @throws {RequiredError} */ getAccountDeleteApprovalConfigV1(requestParameters: SourcesApiGetAccountDeleteApprovalConfigV1Request, axiosOptions?: RawAxiosRequestConfig): AxiosPromise; /** * This API downloads the CSV schema that defines the account attributes on a source. >**NOTE: This API is designated only for Delimited File sources.** * @summary Downloads source accounts schema template * @param {SourcesApiGetAccountsSchemaV1Request} requestParameters Request parameters. * @param {*} [axiosOptions] Override http request option. * @throws {RequiredError} */ getAccountsSchemaV1(requestParameters: SourcesApiGetAccountsSchemaV1Request, axiosOptions?: RawAxiosRequestConfig): AxiosPromise; /** * This API returns the existing correlation configuration for a source specified by the given ID. * @summary Get source correlation configuration * @param {SourcesApiGetCorrelationConfigV1Request} requestParameters Request parameters. * @param {*} [axiosOptions] Override http request option. * @throws {RequiredError} */ getCorrelationConfigV1(requestParameters: SourcesApiGetCorrelationConfigV1Request, axiosOptions?: RawAxiosRequestConfig): AxiosPromise; /** * This API downloads the CSV schema that defines the entitlement attributes on a source. >**NOTE: This API is designated only for Delimited File sources.** * @summary Downloads source entitlements schema template * @param {SourcesApiGetEntitlementsSchemaV1Request} requestParameters Request parameters. * @param {*} [axiosOptions] Override http request option. * @throws {RequiredError} */ getEntitlementsSchemaV1(requestParameters: SourcesApiGetEntitlementsSchemaV1Request, axiosOptions?: RawAxiosRequestConfig): AxiosPromise; /** * Retrieves the machine account deletion approval configuration for a specific source. This endpoint returns details about the approval requirements, approvers, and comment settings that govern the deletion of machine accounts associated with the given source ID. * @summary Machine Account Deletion Approval Config * @param {SourcesApiGetMachineAccountDeletionApprovalConfigBySourceV1Request} requestParameters Request parameters. * @param {*} [axiosOptions] Override http request option. * @throws {RequiredError} */ getMachineAccountDeletionApprovalConfigBySourceV1(requestParameters: SourcesApiGetMachineAccountDeletionApprovalConfigBySourceV1Request, axiosOptions?: RawAxiosRequestConfig): AxiosPromise; /** * This API returns the existing native change detection configuration for a source specified by the given ID. * @summary Native change detection configuration * @param {SourcesApiGetNativeChangeDetectionConfigV1Request} requestParameters Request parameters. * @param {*} [axiosOptions] Override http request option. * @throws {RequiredError} */ getNativeChangeDetectionConfigV1(requestParameters: SourcesApiGetNativeChangeDetectionConfigV1Request, axiosOptions?: RawAxiosRequestConfig): AxiosPromise; /** * This end-point retrieves the ProvisioningPolicy with the specified usage on the specified Source in IdentityNow. * @summary Get provisioning policy by usagetype * @param {SourcesApiGetProvisioningPolicyV1Request} requestParameters Request parameters. * @param {*} [axiosOptions] Override http request option. * @throws {RequiredError} */ getProvisioningPolicyV1(requestParameters: SourcesApiGetProvisioningPolicyV1Request, axiosOptions?: RawAxiosRequestConfig): AxiosPromise; /** * This end-point retrieves the ProvisioningPolicy with the specified ID on the specified Source in Identity Security Cloud. * @summary Get provisioning policy by ID * @param {SourcesApiGetProvisioningPolicyV2Request} requestParameters Request parameters. * @param {*} [axiosOptions] Override http request option. * @throws {RequiredError} */ getProvisioningPolicyV2(requestParameters: SourcesApiGetProvisioningPolicyV2Request, axiosOptions?: RawAxiosRequestConfig): AxiosPromise; /** * This API returns the existing attribute synchronization configuration for a source specified by the given ID. The response contains all attributes, regardless of whether they enabled or not. * @summary Attribute sync config * @param {SourcesApiGetSourceAttrSyncConfigV1Request} requestParameters Request parameters. * @param {*} [axiosOptions] Override http request option. * @throws {RequiredError} */ getSourceAttrSyncConfigV1(requestParameters: SourcesApiGetSourceAttrSyncConfigV1Request, axiosOptions?: RawAxiosRequestConfig): AxiosPromise; /** * Looks up and returns the source config for the requested source id after populating the source config values and applying language translations. * @summary Gets source config with language-translations * @param {SourcesApiGetSourceConfigV1Request} requestParameters Request parameters. * @param {*} [axiosOptions] Override http request option. * @throws {RequiredError} */ getSourceConfigV1(requestParameters: SourcesApiGetSourceConfigV1Request, axiosOptions?: RawAxiosRequestConfig): AxiosPromise; /** * Use this API to get all dependent Profiles, Attributes, Applications and Custom Transforms for a source by a specified ID in Identity Security Cloud (ISC). * @summary Get source connections by id * @param {SourcesApiGetSourceConnectionsV1Request} requestParameters Request parameters. * @param {*} [axiosOptions] Override http request option. * @throws {RequiredError} */ getSourceConnectionsV1(requestParameters: SourcesApiGetSourceConnectionsV1Request, axiosOptions?: RawAxiosRequestConfig): AxiosPromise; /** * This API gets the current entitlement request configuration for a source. This source-level configuration should apply for all the entitlements in the source. Access request to any entitlements in the source should follow this configuration unless a separate entitlement-level configuration is defined. - During access request, this source-level entitlement request configuration overrides the global organization-level configuration. - However, the entitlement-level configuration (if defined) overrides this source-level configuration. * @summary Get source entitlement request configuration * @param {SourcesApiGetSourceEntitlementRequestConfigV1Request} requestParameters Request parameters. * @param {*} [axiosOptions] Override http request option. * @throws {RequiredError} */ getSourceEntitlementRequestConfigV1(requestParameters: SourcesApiGetSourceEntitlementRequestConfigV1Request, axiosOptions?: RawAxiosRequestConfig): AxiosPromise; /** * This endpoint fetches source health by source\'s id * @summary Fetches source health by id * @param {SourcesApiGetSourceHealthV1Request} requestParameters Request parameters. * @param {*} [axiosOptions] Override http request option. * @throws {RequiredError} */ getSourceHealthV1(requestParameters: SourcesApiGetSourceHealthV1Request, axiosOptions?: RawAxiosRequestConfig): AxiosPromise; /** * Get the source schedule by type in Identity Security Cloud (ISC). * @summary Get source schedule by type * @param {SourcesApiGetSourceScheduleV1Request} requestParameters Request parameters. * @param {*} [axiosOptions] Override http request option. * @throws {RequiredError} */ getSourceScheduleV1(requestParameters: SourcesApiGetSourceScheduleV1Request, axiosOptions?: RawAxiosRequestConfig): AxiosPromise; /** * Use this API to list the schedules that exist on the specified source in Identity Security Cloud (ISC). :::info This endpoint uses a **cron expression** to schedule a task, following standard **cron job syntax**. For example, `0 0 12 1/1 * ? *` runs the task **daily at 12:00 PM**. **Days of the week are represented as 1-7 (Sunday-Saturday).** ::: * @summary List schedules on source * @param {SourcesApiGetSourceSchedulesV1Request} requestParameters Request parameters. * @param {*} [axiosOptions] Override http request option. * @throws {RequiredError} */ getSourceSchedulesV1(requestParameters: SourcesApiGetSourceSchedulesV1Request, axiosOptions?: RawAxiosRequestConfig): AxiosPromise>; /** * Get the Source Schema by ID in IdentityNow. * @summary Get source schema by id * @param {SourcesApiGetSourceSchemaV1Request} requestParameters Request parameters. * @param {*} [axiosOptions] Override http request option. * @throws {RequiredError} */ getSourceSchemaV1(requestParameters: SourcesApiGetSourceSchemaV1Request, axiosOptions?: RawAxiosRequestConfig): AxiosPromise; /** * Use this API to list the schemas that exist on the specified source in Identity Security Cloud (ISC). * @summary List schemas on source * @param {SourcesApiGetSourceSchemasV1Request} requestParameters Request parameters. * @param {*} [axiosOptions] Override http request option. * @throws {RequiredError} */ getSourceSchemasV1(requestParameters: SourcesApiGetSourceSchemasV1Request, axiosOptions?: RawAxiosRequestConfig): AxiosPromise>; /** * Use this API to get a source by a specified ID in Identity Security Cloud (ISC). * @summary Get source by id * @param {SourcesApiGetSourceV1Request} requestParameters Request parameters. * @param {*} [axiosOptions] Override http request option. * @throws {RequiredError} */ getSourceV1(requestParameters: SourcesApiGetSourceV1Request, axiosOptions?: RawAxiosRequestConfig): AxiosPromise; /** * This API uploads a source schema template file to configure a source\'s account attributes. To retrieve the file to modify and upload, log into Identity Now. Click **Admin** -> **Connections** -> **Sources** -> **`{SourceName}`** -> **Import Data** -> **Account Schema** -> **Options** -> **Download Schema** >**NOTE: This API is designated only for Delimited File sources.** * @summary Uploads source accounts schema template * @param {SourcesApiImportAccountsSchemaV1Request} requestParameters Request parameters. * @param {*} [axiosOptions] Override http request option. * @throws {RequiredError} */ importAccountsSchemaV1(requestParameters: SourcesApiImportAccountsSchemaV1Request, axiosOptions?: RawAxiosRequestConfig): AxiosPromise; /** * Starts an account aggregation on the specified source. If the target source is a delimited file source, then the CSV file needs to be included in the request body. You will also need to set the Content-Type header to `multipart/form-data`. * @summary Account aggregation * @param {SourcesApiImportAccountsV1Request} requestParameters Request parameters. * @param {*} [axiosOptions] Override http request option. * @throws {RequiredError} */ importAccountsV1(requestParameters: SourcesApiImportAccountsV1Request, axiosOptions?: RawAxiosRequestConfig): AxiosPromise; /** * This uploads a supplemental source connector file (like jdbc driver jars) to a source\'s S3 bucket. This also sends ETS and Audit events. * @summary Upload connector file to source * @param {SourcesApiImportConnectorFileV1Request} requestParameters Request parameters. * @param {*} [axiosOptions] Override http request option. * @throws {RequiredError} */ importConnectorFileV1(requestParameters: SourcesApiImportConnectorFileV1Request, axiosOptions?: RawAxiosRequestConfig): AxiosPromise; /** * This API uploads a source schema template file to configure a source\'s entitlement attributes. To retrieve the file to modify and upload, log into Identity Now. Click **Admin** -> **Connections** -> **Sources** -> **`{SourceName}`** -> **Import Data** -> **Import Entitlements** -> **Download** >**NOTE: This API is designated only for Delimited File sources.** * @summary Uploads source entitlements schema template * @param {SourcesApiImportEntitlementsSchemaV1Request} requestParameters Request parameters. * @param {*} [axiosOptions] Override http request option. * @throws {RequiredError} */ importEntitlementsSchemaV1(requestParameters: SourcesApiImportEntitlementsSchemaV1Request, axiosOptions?: RawAxiosRequestConfig): AxiosPromise; /** * Starts an entitlement aggregation on the specified source. If the target source is a delimited file source, then the CSV file needs to be included in the request body. You will also need to set the Content-Type header to `multipart/form-data`. A token with ORG_ADMIN, SOURCE_ADMIN, or SOURCE_SUBADMIN authority is required to call this API. * @summary Entitlement aggregation * @param {SourcesApiImportEntitlementsV1Request} requestParameters Request parameters. * @param {*} [axiosOptions] Override http request option. * @throws {RequiredError} */ importEntitlementsV1(requestParameters: SourcesApiImportEntitlementsV1Request, axiosOptions?: RawAxiosRequestConfig): AxiosPromise; /** * File is required for upload. You will also need to set the Content-Type header to `multipart/form-data` * @summary Process uncorrelated accounts * @param {SourcesApiImportUncorrelatedAccountsV1Request} requestParameters Request parameters. * @param {*} [axiosOptions] Override http request option. * @throws {RequiredError} */ importUncorrelatedAccountsV1(requestParameters: SourcesApiImportUncorrelatedAccountsV1Request, axiosOptions?: RawAxiosRequestConfig): AxiosPromise; /** * This API can be used to get Password Policy in IdentityNow for the specified Source. Source must support PASSWORD feature. * @summary Get Password Policy for source * @param {SourcesApiListPasswordPolicyHoldersOnSourceV1Request} requestParameters Request parameters. * @param {*} [axiosOptions] Override http request option. * @throws {RequiredError} */ listPasswordPolicyHoldersOnSourceV1(requestParameters: SourcesApiListPasswordPolicyHoldersOnSourceV1Request, axiosOptions?: RawAxiosRequestConfig): AxiosPromise>; /** * This end-point lists all the ProvisioningPolicies in IdentityNow. * @summary Lists provisioningpolicies * @param {SourcesApiListProvisioningPoliciesV1Request} requestParameters Request parameters. * @param {*} [axiosOptions] Override http request option. * @throws {RequiredError} */ listProvisioningPoliciesV1(requestParameters: SourcesApiListProvisioningPoliciesV1Request, axiosOptions?: RawAxiosRequestConfig): AxiosPromise>; /** * This end-point lists all the ProvisioningPolicies in IdentityNow. * @summary Lists Provisioning Policies * @param {SourcesApiListProvisioningPoliciesV2Request} requestParameters Request parameters. * @param {*} [axiosOptions] Override http request option. * @throws {RequiredError} */ listProvisioningPoliciesV2(requestParameters: SourcesApiListProvisioningPoliciesV2Request, axiosOptions?: RawAxiosRequestConfig): AxiosPromise>; /** * This end-point lists all the sources in IdentityNow. * @summary Lists all sources in identitynow. * @param {SourcesApiListSourcesV1Request} requestParameters Request parameters. * @param {*} [axiosOptions] Override http request option. * @throws {RequiredError} */ listSourcesV1(requestParameters?: SourcesApiListSourcesV1Request, axiosOptions?: RawAxiosRequestConfig): AxiosPromise>; /** * This endpoint validates that the cluster being used by the source is reachable from IdentityNow. * @summary Ping cluster for source connector * @param {SourcesApiPingClusterV1Request} requestParameters Request parameters. * @param {*} [axiosOptions] Override http request option. * @throws {RequiredError} */ pingClusterV1(requestParameters: SourcesApiPingClusterV1Request, axiosOptions?: RawAxiosRequestConfig): AxiosPromise; /** * Replaces the correlation configuration for the source specified by the given ID with the configuration provided in the request body. * @summary Update source correlation configuration * @param {SourcesApiPutCorrelationConfigV1Request} requestParameters Request parameters. * @param {*} [axiosOptions] Override http request option. * @throws {RequiredError} */ putCorrelationConfigV1(requestParameters: SourcesApiPutCorrelationConfigV1Request, axiosOptions?: RawAxiosRequestConfig): AxiosPromise; /** * Replaces the native change detection configuration for the source specified by the given ID with the configuration provided in the request body. * @summary Update native change detection configuration * @param {SourcesApiPutNativeChangeDetectionConfigV1Request} requestParameters Request parameters. * @param {*} [axiosOptions] Override http request option. * @throws {RequiredError} */ putNativeChangeDetectionConfigV1(requestParameters: SourcesApiPutNativeChangeDetectionConfigV1Request, axiosOptions?: RawAxiosRequestConfig): AxiosPromise; /** * This end-point updates the provisioning policy with the specified usage on the specified source in IdentityNow. Transforms can be used in the provisioning policy to create a new attribute that you only need during provisioning. Refer to [Transforms in Provisioning Policies](https://developer.sailpoint.com/docs/extensibility/transforms/guides/transforms-in-provisioning-policies) for more information. * @summary Update provisioning policy by usagetype * @param {SourcesApiPutProvisioningPolicyV1Request} requestParameters Request parameters. * @param {*} [axiosOptions] Override http request option. * @throws {RequiredError} */ putProvisioningPolicyV1(requestParameters: SourcesApiPutProvisioningPolicyV1Request, axiosOptions?: RawAxiosRequestConfig): AxiosPromise; /** * This end-point updates the provisioning policy with the specified ID on the specified source in Identity Security Cloud. Transforms can be used in the provisioning policy to create a new attribute that you only need during provisioning. Refer to [Transforms in Provisioning Policies](https://developer.sailpoint.com/docs/extensibility/transforms/guides/transforms-in-provisioning-policies) for more information. * @summary Update provisioning policy by ID * @param {SourcesApiPutProvisioningPolicyV2Request} requestParameters Request parameters. * @param {*} [axiosOptions] Override http request option. * @throws {RequiredError} */ putProvisioningPolicyV2(requestParameters: SourcesApiPutProvisioningPolicyV2Request, axiosOptions?: RawAxiosRequestConfig): AxiosPromise; /** * Replaces the attribute synchronization configuration for the source specified by the given ID with the configuration provided in the request body. Only the \"enabled\" field of the values in the \"attributes\" array is mutable. Attempting to change other attributes or add new values to the \"attributes\" array will result in an error. * @summary Update attribute sync config * @param {SourcesApiPutSourceAttrSyncConfigV1Request} requestParameters Request parameters. * @param {*} [axiosOptions] Override http request option. * @throws {RequiredError} */ putSourceAttrSyncConfigV1(requestParameters: SourcesApiPutSourceAttrSyncConfigV1Request, axiosOptions?: RawAxiosRequestConfig): AxiosPromise; /** * This API will completely replace an existing Schema with the submitted payload. Some fields of the Schema cannot be updated. These fields are listed below. * id * name * created * modified Any attempt to modify these fields will result in an error response with a status code of 400. > `id` must remain in the request body, but it cannot be changed. If `id` is omitted from the request body, the result will be a 400 error. * @summary Update source schema (full) * @param {SourcesApiPutSourceSchemaV1Request} requestParameters Request parameters. * @param {*} [axiosOptions] Override http request option. * @throws {RequiredError} */ putSourceSchemaV1(requestParameters: SourcesApiPutSourceSchemaV1Request, axiosOptions?: RawAxiosRequestConfig): AxiosPromise; /** * Use this API to update a source in Identity Security Cloud (ISC), using a full object representation. This means that when you use this API, it completely replaces the existing source configuration. These fields are immutable, so they cannot be changed: * id * type * authoritative * connector * connectorClass * passwordPolicies Attempts to modify these fields will result in a 400 error. * @summary Update source (full) * @param {SourcesApiPutSourceV1Request} requestParameters Request parameters. * @param {*} [axiosOptions] Override http request option. * @throws {RequiredError} */ putSourceV1(requestParameters: SourcesApiPutSourceV1Request, axiosOptions?: RawAxiosRequestConfig): AxiosPromise; /** * Retrieves a sample of data returned from account and group aggregation requests. * @summary Peek source connector\'s resource objects * @param {SourcesApiSearchResourceObjectsV1Request} requestParameters Request parameters. * @param {*} [axiosOptions] Override http request option. * @throws {RequiredError} */ searchResourceObjectsV1(requestParameters: SourcesApiSearchResourceObjectsV1Request, axiosOptions?: RawAxiosRequestConfig): AxiosPromise; /** * This end-point performs attribute synchronization for a selected source. * @summary Synchronize single source attributes. * @param {SourcesApiSyncAttributesForSourceV1Request} requestParameters Request parameters. * @param {*} [axiosOptions] Override http request option. * @throws {RequiredError} */ syncAttributesForSourceV1(requestParameters: SourcesApiSyncAttributesForSourceV1Request, axiosOptions?: RawAxiosRequestConfig): AxiosPromise; /** * This endpoint performs a more detailed validation of the source\'\'s configuration that can take longer than the lighter weight credential validation performed by the checkConnection API. * @summary Test configuration for source connector * @param {SourcesApiTestSourceConfigurationV1Request} requestParameters Request parameters. * @param {*} [axiosOptions] Override http request option. * @throws {RequiredError} */ testSourceConfigurationV1(requestParameters: SourcesApiTestSourceConfigurationV1Request, axiosOptions?: RawAxiosRequestConfig): AxiosPromise; /** * This endpoint validates that the configured credentials are valid and will properly authenticate with the source identified by the sourceId path parameter. * @summary Check connection for source connector. * @param {SourcesApiTestSourceConnectionV1Request} requestParameters Request parameters. * @param {*} [axiosOptions] Override http request option. * @throws {RequiredError} */ testSourceConnectionV1(requestParameters: SourcesApiTestSourceConnectionV1Request, axiosOptions?: RawAxiosRequestConfig): AxiosPromise; /** * Updates the approval configuration for deleting human accounts for a specific source, identified by source ID. This endpoint allows administrators to modify settings such as whether approval is required, who the approvers are, and other approval-related options. The update is performed using a JSON Patch payload, and the response returns the updated AccountDeleteConfigDto object reflecting the new approval workflow configuration. * @summary Human Account Deletion Approval Config * @param {SourcesApiUpdateAccountDeletionApprovalConfigV1Request} requestParameters Request parameters. * @param {*} [axiosOptions] Override http request option. * @throws {RequiredError} */ updateAccountDeletionApprovalConfigV1(requestParameters: SourcesApiUpdateAccountDeletionApprovalConfigV1Request, axiosOptions?: RawAxiosRequestConfig): AxiosPromise; /** * Use this endpoint to update the machine account deletion approval configuration for a specific source. The update is performed using a JSON Patch payload, which allows partial modifications to the approval config. This operation is typically used to change approval requirements, approvers, or comments settings for machine account deletion. The endpoint expects the source ID as a path parameter and a valid JSON Patch array in the request body. * @summary Machine Account Deletion Approval Config * @param {SourcesApiUpdateMachineAccountDeletionApprovalConfigV1Request} requestParameters Request parameters. * @param {*} [axiosOptions] Override http request option. * @throws {RequiredError} */ updateMachineAccountDeletionApprovalConfigV1(requestParameters: SourcesApiUpdateMachineAccountDeletionApprovalConfigV1Request, axiosOptions?: RawAxiosRequestConfig): AxiosPromise; /** * This API can be used to set up or update Password Policy in IdentityNow for the specified Source. Source must support PASSWORD feature. * @summary Update password policy * @param {SourcesApiUpdatePasswordPolicyHoldersV1Request} requestParameters Request parameters. * @param {*} [axiosOptions] Override http request option. * @throws {RequiredError} */ updatePasswordPolicyHoldersV1(requestParameters: SourcesApiUpdatePasswordPolicyHoldersV1Request, axiosOptions?: RawAxiosRequestConfig): AxiosPromise>; /** * This end-point updates a list of provisioning policies on the specified source in IdentityNow. * @summary Bulk update provisioning policies * @param {SourcesApiUpdateProvisioningPoliciesInBulkV1Request} requestParameters Request parameters. * @param {*} [axiosOptions] Override http request option. * @throws {RequiredError} */ updateProvisioningPoliciesInBulkV1(requestParameters: SourcesApiUpdateProvisioningPoliciesInBulkV1Request, axiosOptions?: RawAxiosRequestConfig): AxiosPromise>; /** * This API selectively updates an existing Provisioning Policy using a JSONPatch payload. Transforms can be used in the provisioning policy to create a new attribute that you only need during provisioning. Refer to [Transforms in Provisioning Policies](https://developer.sailpoint.com/docs/extensibility/transforms/guides/transforms-in-provisioning-policies) for more information. * @summary Partial update of provisioning policy * @param {SourcesApiUpdateProvisioningPolicyV1Request} requestParameters Request parameters. * @param {*} [axiosOptions] Override http request option. * @throws {RequiredError} */ updateProvisioningPolicyV1(requestParameters: SourcesApiUpdateProvisioningPolicyV1Request, axiosOptions?: RawAxiosRequestConfig): AxiosPromise; /** * This API selectively updates an existing Provisioning Policy using a JSONPatch payload. Transforms can be used in the provisioning policy to create a new attribute that you only need during provisioning. Refer to [Transforms in Provisioning Policies](https://developer.sailpoint.com/docs/extensibility/transforms/guides/transforms-in-provisioning-policies) for more information. * @summary Partial update of provisioning policy * @param {SourcesApiUpdateProvisioningPolicyV2Request} requestParameters Request parameters. * @param {*} [axiosOptions] Override http request option. * @throws {RequiredError} */ updateProvisioningPolicyV2(requestParameters: SourcesApiUpdateProvisioningPolicyV2Request, axiosOptions?: RawAxiosRequestConfig): AxiosPromise; /** * This API replaces the current entitlement request configuration for a source. This source-level configuration should apply for all the entitlements in the source. Access request to any entitlements in the source should follow this configuration unless a separate entitlement-level configuration is defined. - During access request, this source-level entitlement request configuration overrides the global organization-level configuration. - However, the entitlement-level configuration (if defined) overrides this source-level configuration. * @summary Update source entitlement request configuration * @param {SourcesApiUpdateSourceEntitlementRequestConfigV1Request} requestParameters Request parameters. * @param {*} [axiosOptions] Override http request option. * @throws {RequiredError} */ updateSourceEntitlementRequestConfigV1(requestParameters: SourcesApiUpdateSourceEntitlementRequestConfigV1Request, axiosOptions?: RawAxiosRequestConfig): AxiosPromise; /** * Use this API to selectively update an existing Schedule using a JSONPatch payload. The following schedule fields are immutable and cannot be updated: - type * @summary Update source schedule (partial) * @param {SourcesApiUpdateSourceScheduleV1Request} requestParameters Request parameters. * @param {*} [axiosOptions] Override http request option. * @throws {RequiredError} */ updateSourceScheduleV1(requestParameters: SourcesApiUpdateSourceScheduleV1Request, axiosOptions?: RawAxiosRequestConfig): AxiosPromise; /** * Use this API to selectively update an existing Schema using a JSONPatch payload. The following schema fields are immutable and cannot be updated: - id - name - created - modified To switch an account attribute to a group entitlement, you need to have the following in place: - `isEntitlement: true` - Must define a schema for the group and [add it to the source](https://developer.sailpoint.com/docs/api/create-source-schema-v-1) before updating the `isGroup` flag. For example, here is the `group` account attribute referencing a schema that defines the group: ```json { \"name\": \"groups\", \"type\": \"STRING\", \"schema\": { \"type\": \"CONNECTOR_SCHEMA\", \"id\": \"2c9180887671ff8c01767b4671fc7d60\", \"name\": \"group\" }, \"description\": \"The groups, roles etc. that reference account group objects\", \"isMulti\": true, \"isEntitlement\": true, \"isGroup\": true } ``` * @summary Update source schema (partial) * @param {SourcesApiUpdateSourceSchemaV1Request} requestParameters Request parameters. * @param {*} [axiosOptions] Override http request option. * @throws {RequiredError} */ updateSourceSchemaV1(requestParameters: SourcesApiUpdateSourceSchemaV1Request, axiosOptions?: RawAxiosRequestConfig): AxiosPromise; /** * Use this API to partially update a source in Identity Security Cloud (ISC), using a list of patch operations according to the [JSON Patch](https://tools.ietf.org/html/rfc6902) standard. These fields are immutable, so they cannot be changed: * id * type * authoritative * created * modified * connector * connectorClass * passwordPolicies Attempts to modify these fields will result in a 400 error. * @summary Update source (partial) * @param {SourcesApiUpdateSourceV1Request} requestParameters Request parameters. * @param {*} [axiosOptions] Override http request option. * @throws {RequiredError} */ updateSourceV1(requestParameters: SourcesApiUpdateSourceV1Request, axiosOptions?: RawAxiosRequestConfig): AxiosPromise; }; /** * Request parameters for createProvisioningPolicyV1 operation in SourcesApi. * @export * @interface SourcesApiCreateProvisioningPolicyV1Request */ export interface SourcesApiCreateProvisioningPolicyV1Request { /** * The Source id * @type {string} * @memberof SourcesApiCreateProvisioningPolicyV1 */ readonly sourceId: string; /** * * @type {ProvisioningPolicyDto} * @memberof SourcesApiCreateProvisioningPolicyV1 */ readonly provisioningPolicyDto: ProvisioningPolicyDto; } /** * Request parameters for createProvisioningPolicyV2 operation in SourcesApi. * @export * @interface SourcesApiCreateProvisioningPolicyV2Request */ export interface SourcesApiCreateProvisioningPolicyV2Request { /** * The Source id * @type {string} * @memberof SourcesApiCreateProvisioningPolicyV2 */ readonly sourceId: string; /** * * @type {ProvisioningPolicyDtoV2} * @memberof SourcesApiCreateProvisioningPolicyV2 */ readonly provisioningPolicyDtoV2: ProvisioningPolicyDtoV2; /** * If passed as true, then it uses default fields from the connector template. * @type {boolean} * @memberof SourcesApiCreateProvisioningPolicyV2 */ readonly useDefaultFields?: boolean; /** * Use this header to enable this experimental API. * @type {string} * @memberof SourcesApiCreateProvisioningPolicyV2 */ readonly xSailPointExperimental?: string; } /** * Request parameters for createSourceScheduleV1 operation in SourcesApi. * @export * @interface SourcesApiCreateSourceScheduleV1Request */ export interface SourcesApiCreateSourceScheduleV1Request { /** * Source ID. * @type {string} * @memberof SourcesApiCreateSourceScheduleV1 */ readonly sourceId: string; /** * * @type {Schedule3} * @memberof SourcesApiCreateSourceScheduleV1 */ readonly schedule3: Schedule3; } /** * Request parameters for createSourceSchemaV1 operation in SourcesApi. * @export * @interface SourcesApiCreateSourceSchemaV1Request */ export interface SourcesApiCreateSourceSchemaV1Request { /** * Source ID. * @type {string} * @memberof SourcesApiCreateSourceSchemaV1 */ readonly sourceId: string; /** * * @type {Schema} * @memberof SourcesApiCreateSourceSchemaV1 */ readonly schema: Schema; } /** * Request parameters for createSourceV1 operation in SourcesApi. * @export * @interface SourcesApiCreateSourceV1Request */ export interface SourcesApiCreateSourceV1Request { /** * * @type {Source} * @memberof SourcesApiCreateSourceV1 */ readonly source: Source; /** * If this parameter is `true`, it configures the source as a Delimited File (CSV) source. Setting this to `true` will automatically set the `type` of the source to `DelimitedFile`. You must use this query parameter to create a Delimited File source as you would in the UI. If you don\'t set this query parameter and you attempt to set the `type` attribute directly, the request won\'t correctly generate the source. * @type {boolean} * @memberof SourcesApiCreateSourceV1 */ readonly provisionAsCsv?: boolean; } /** * Request parameters for deleteAccountsAsyncV1 operation in SourcesApi. * @export * @interface SourcesApiDeleteAccountsAsyncV1Request */ export interface SourcesApiDeleteAccountsAsyncV1Request { /** * The source id * @type {string} * @memberof SourcesApiDeleteAccountsAsyncV1 */ readonly id: string; } /** * Request parameters for deleteNativeChangeDetectionConfigV1 operation in SourcesApi. * @export * @interface SourcesApiDeleteNativeChangeDetectionConfigV1Request */ export interface SourcesApiDeleteNativeChangeDetectionConfigV1Request { /** * The source id * @type {string} * @memberof SourcesApiDeleteNativeChangeDetectionConfigV1 */ readonly sourceId: string; } /** * Request parameters for deleteProvisioningPolicyV1 operation in SourcesApi. * @export * @interface SourcesApiDeleteProvisioningPolicyV1Request */ export interface SourcesApiDeleteProvisioningPolicyV1Request { /** * The Source ID. * @type {string} * @memberof SourcesApiDeleteProvisioningPolicyV1 */ readonly sourceId: string; /** * The type of provisioning policy usage. In IdentityNow, a source can support various provisioning operations. For example, when a joiner is added to a source, this may trigger both CREATE and UPDATE provisioning operations. Each usage type is considered a provisioning policy. A source can have any number of these provisioning policies defined. These are the common usage types: CREATE - This usage type relates to \'Create Account Profile\', the provisioning template for the account to be created. For example, this would be used for a joiner on a source. UPDATE - This usage type relates to \'Update Account Profile\', the provisioning template for the \'Update\' connector operations. For example, this would be used for an attribute sync on a source. ENABLE - This usage type relates to \'Enable Account Profile\', the provisioning template for the account to be enabled. For example, this could be used for a joiner on a source once the joiner\'s account is created. DISABLE - This usage type relates to \'Disable Account Profile\', the provisioning template for the account to be disabled. For example, this could be used when a leaver is removed temporarily from a source. You can use these four usage types for all your provisioning policy needs. * @type {UsageType} * @memberof SourcesApiDeleteProvisioningPolicyV1 */ readonly usageType: UsageType; } /** * Request parameters for deleteProvisioningPolicyV2 operation in SourcesApi. * @export * @interface SourcesApiDeleteProvisioningPolicyV2Request */ export interface SourcesApiDeleteProvisioningPolicyV2Request { /** * The Source ID. * @type {string} * @memberof SourcesApiDeleteProvisioningPolicyV2 */ readonly sourceId: string; /** * The provisioning policy ID. * @type {string} * @memberof SourcesApiDeleteProvisioningPolicyV2 */ readonly id: string; /** * Use this header to enable this experimental API. * @type {string} * @memberof SourcesApiDeleteProvisioningPolicyV2 */ readonly xSailPointExperimental?: string; } /** * Request parameters for deleteSourceScheduleV1 operation in SourcesApi. * @export * @interface SourcesApiDeleteSourceScheduleV1Request */ export interface SourcesApiDeleteSourceScheduleV1Request { /** * The Source id. * @type {string} * @memberof SourcesApiDeleteSourceScheduleV1 */ readonly sourceId: string; /** * The Schedule type. * @type {'ACCOUNT_AGGREGATION' | 'GROUP_AGGREGATION'} * @memberof SourcesApiDeleteSourceScheduleV1 */ readonly scheduleType: DeleteSourceScheduleV1ScheduleTypeEnum; } /** * Request parameters for deleteSourceSchemaV1 operation in SourcesApi. * @export * @interface SourcesApiDeleteSourceSchemaV1Request */ export interface SourcesApiDeleteSourceSchemaV1Request { /** * The Source id. * @type {string} * @memberof SourcesApiDeleteSourceSchemaV1 */ readonly sourceId: string; /** * The Schema id. * @type {string} * @memberof SourcesApiDeleteSourceSchemaV1 */ readonly schemaId: string; } /** * Request parameters for deleteSourceV1 operation in SourcesApi. * @export * @interface SourcesApiDeleteSourceV1Request */ export interface SourcesApiDeleteSourceV1Request { /** * Source ID. * @type {string} * @memberof SourcesApiDeleteSourceV1 */ readonly id: string; } /** * Request parameters for getAccountDeleteApprovalConfigV1 operation in SourcesApi. * @export * @interface SourcesApiGetAccountDeleteApprovalConfigV1Request */ export interface SourcesApiGetAccountDeleteApprovalConfigV1Request { /** * The Source id * @type {string} * @memberof SourcesApiGetAccountDeleteApprovalConfigV1 */ readonly sourceId: string; } /** * Request parameters for getAccountsSchemaV1 operation in SourcesApi. * @export * @interface SourcesApiGetAccountsSchemaV1Request */ export interface SourcesApiGetAccountsSchemaV1Request { /** * The Source id * @type {string} * @memberof SourcesApiGetAccountsSchemaV1 */ readonly id: string; } /** * Request parameters for getCorrelationConfigV1 operation in SourcesApi. * @export * @interface SourcesApiGetCorrelationConfigV1Request */ export interface SourcesApiGetCorrelationConfigV1Request { /** * The source id * @type {string} * @memberof SourcesApiGetCorrelationConfigV1 */ readonly id: string; } /** * Request parameters for getEntitlementsSchemaV1 operation in SourcesApi. * @export * @interface SourcesApiGetEntitlementsSchemaV1Request */ export interface SourcesApiGetEntitlementsSchemaV1Request { /** * The Source id * @type {string} * @memberof SourcesApiGetEntitlementsSchemaV1 */ readonly id: string; /** * Name of entitlement schema * @type {string} * @memberof SourcesApiGetEntitlementsSchemaV1 */ readonly schemaName?: string; } /** * Request parameters for getMachineAccountDeletionApprovalConfigBySourceV1 operation in SourcesApi. * @export * @interface SourcesApiGetMachineAccountDeletionApprovalConfigBySourceV1Request */ export interface SourcesApiGetMachineAccountDeletionApprovalConfigBySourceV1Request { /** * source id. * @type {string} * @memberof SourcesApiGetMachineAccountDeletionApprovalConfigBySourceV1 */ readonly sourceId: string; } /** * Request parameters for getNativeChangeDetectionConfigV1 operation in SourcesApi. * @export * @interface SourcesApiGetNativeChangeDetectionConfigV1Request */ export interface SourcesApiGetNativeChangeDetectionConfigV1Request { /** * The source id * @type {string} * @memberof SourcesApiGetNativeChangeDetectionConfigV1 */ readonly sourceId: string; } /** * Request parameters for getProvisioningPolicyV1 operation in SourcesApi. * @export * @interface SourcesApiGetProvisioningPolicyV1Request */ export interface SourcesApiGetProvisioningPolicyV1Request { /** * The Source ID. * @type {string} * @memberof SourcesApiGetProvisioningPolicyV1 */ readonly sourceId: string; /** * The type of provisioning policy usage. In IdentityNow, a source can support various provisioning operations. For example, when a joiner is added to a source, this may trigger both CREATE and UPDATE provisioning operations. Each usage type is considered a provisioning policy. A source can have any number of these provisioning policies defined. These are the common usage types: CREATE - This usage type relates to \'Create Account Profile\', the provisioning template for the account to be created. For example, this would be used for a joiner on a source. UPDATE - This usage type relates to \'Update Account Profile\', the provisioning template for the \'Update\' connector operations. For example, this would be used for an attribute sync on a source. ENABLE - This usage type relates to \'Enable Account Profile\', the provisioning template for the account to be enabled. For example, this could be used for a joiner on a source once the joiner\'s account is created. DISABLE - This usage type relates to \'Disable Account Profile\', the provisioning template for the account to be disabled. For example, this could be used when a leaver is removed temporarily from a source. You can use these four usage types for all your provisioning policy needs. * @type {UsageType} * @memberof SourcesApiGetProvisioningPolicyV1 */ readonly usageType: UsageType; } /** * Request parameters for getProvisioningPolicyV2 operation in SourcesApi. * @export * @interface SourcesApiGetProvisioningPolicyV2Request */ export interface SourcesApiGetProvisioningPolicyV2Request { /** * The Source ID. * @type {string} * @memberof SourcesApiGetProvisioningPolicyV2 */ readonly sourceId: string; /** * The provisioning policy ID. * @type {string} * @memberof SourcesApiGetProvisioningPolicyV2 */ readonly id: string; /** * Use this header to enable this experimental API. * @type {string} * @memberof SourcesApiGetProvisioningPolicyV2 */ readonly xSailPointExperimental?: string; } /** * Request parameters for getSourceAttrSyncConfigV1 operation in SourcesApi. * @export * @interface SourcesApiGetSourceAttrSyncConfigV1Request */ export interface SourcesApiGetSourceAttrSyncConfigV1Request { /** * The source id * @type {string} * @memberof SourcesApiGetSourceAttrSyncConfigV1 */ readonly id: string; /** * Use this header to enable this experimental API. * @type {string} * @memberof SourcesApiGetSourceAttrSyncConfigV1 */ readonly xSailPointExperimental?: string; } /** * Request parameters for getSourceConfigV1 operation in SourcesApi. * @export * @interface SourcesApiGetSourceConfigV1Request */ export interface SourcesApiGetSourceConfigV1Request { /** * The Source id * @type {string} * @memberof SourcesApiGetSourceConfigV1 */ readonly id: string; /** * The locale to apply to the config. If no viable locale is given, it will default to \"en\" * @type {'de' | 'false' | 'fi' | 'sv' | 'ru' | 'pt' | 'ko' | 'zh-TW' | 'en' | 'it' | 'fr' | 'zh-CN' | 'hu' | 'es' | 'cs' | 'ja' | 'pl' | 'da' | 'nl'} * @memberof SourcesApiGetSourceConfigV1 */ readonly locale?: GetSourceConfigV1LocaleEnum; } /** * Request parameters for getSourceConnectionsV1 operation in SourcesApi. * @export * @interface SourcesApiGetSourceConnectionsV1Request */ export interface SourcesApiGetSourceConnectionsV1Request { /** * Source ID. * @type {string} * @memberof SourcesApiGetSourceConnectionsV1 */ readonly sourceId: string; } /** * Request parameters for getSourceEntitlementRequestConfigV1 operation in SourcesApi. * @export * @interface SourcesApiGetSourceEntitlementRequestConfigV1Request */ export interface SourcesApiGetSourceEntitlementRequestConfigV1Request { /** * The Source id * @type {string} * @memberof SourcesApiGetSourceEntitlementRequestConfigV1 */ readonly id: string; } /** * Request parameters for getSourceHealthV1 operation in SourcesApi. * @export * @interface SourcesApiGetSourceHealthV1Request */ export interface SourcesApiGetSourceHealthV1Request { /** * The Source id. * @type {string} * @memberof SourcesApiGetSourceHealthV1 */ readonly sourceId: string; } /** * Request parameters for getSourceScheduleV1 operation in SourcesApi. * @export * @interface SourcesApiGetSourceScheduleV1Request */ export interface SourcesApiGetSourceScheduleV1Request { /** * The Source id. * @type {string} * @memberof SourcesApiGetSourceScheduleV1 */ readonly sourceId: string; /** * The Schedule type. * @type {'ACCOUNT_AGGREGATION' | 'GROUP_AGGREGATION'} * @memberof SourcesApiGetSourceScheduleV1 */ readonly scheduleType: GetSourceScheduleV1ScheduleTypeEnum; } /** * Request parameters for getSourceSchedulesV1 operation in SourcesApi. * @export * @interface SourcesApiGetSourceSchedulesV1Request */ export interface SourcesApiGetSourceSchedulesV1Request { /** * Source ID. * @type {string} * @memberof SourcesApiGetSourceSchedulesV1 */ readonly sourceId: string; } /** * Request parameters for getSourceSchemaV1 operation in SourcesApi. * @export * @interface SourcesApiGetSourceSchemaV1Request */ export interface SourcesApiGetSourceSchemaV1Request { /** * The Source id. * @type {string} * @memberof SourcesApiGetSourceSchemaV1 */ readonly sourceId: string; /** * The Schema id. * @type {string} * @memberof SourcesApiGetSourceSchemaV1 */ readonly schemaId: string; } /** * Request parameters for getSourceSchemasV1 operation in SourcesApi. * @export * @interface SourcesApiGetSourceSchemasV1Request */ export interface SourcesApiGetSourceSchemasV1Request { /** * Source ID. * @type {string} * @memberof SourcesApiGetSourceSchemasV1 */ readonly sourceId: string; /** * If set to \'group\', then the account schema is filtered and only group schemas are returned. Only a value of \'group\' is recognized presently. Note: The API will check whether include-types is group or not, if not, it will list schemas based on include-names, if include-names is not provided, it will list all schemas. * @type {'group' | 'user'} * @memberof SourcesApiGetSourceSchemasV1 */ readonly includeTypes?: GetSourceSchemasV1IncludeTypesEnum; /** * A comma-separated list of schema names to filter result. * @type {string} * @memberof SourcesApiGetSourceSchemasV1 */ readonly includeNames?: string; } /** * Request parameters for getSourceV1 operation in SourcesApi. * @export * @interface SourcesApiGetSourceV1Request */ export interface SourcesApiGetSourceV1Request { /** * Source ID. * @type {string} * @memberof SourcesApiGetSourceV1 */ readonly id: string; } /** * Request parameters for importAccountsSchemaV1 operation in SourcesApi. * @export * @interface SourcesApiImportAccountsSchemaV1Request */ export interface SourcesApiImportAccountsSchemaV1Request { /** * The Source id * @type {string} * @memberof SourcesApiImportAccountsSchemaV1 */ readonly id: string; /** * * @type {File} * @memberof SourcesApiImportAccountsSchemaV1 */ readonly file?: File; } /** * Request parameters for importAccountsV1 operation in SourcesApi. * @export * @interface SourcesApiImportAccountsV1Request */ export interface SourcesApiImportAccountsV1Request { /** * Source Id * @type {string} * @memberof SourcesApiImportAccountsV1 */ readonly id: string; /** * The CSV file containing the source accounts to aggregate. * @type {File} * @memberof SourcesApiImportAccountsV1 */ readonly file?: File; /** * Use this flag to reprocess every account whether or not the data has changed. * @type {string} * @memberof SourcesApiImportAccountsV1 */ readonly disableOptimization?: string; } /** * Request parameters for importConnectorFileV1 operation in SourcesApi. * @export * @interface SourcesApiImportConnectorFileV1Request */ export interface SourcesApiImportConnectorFileV1Request { /** * The Source id. * @type {string} * @memberof SourcesApiImportConnectorFileV1 */ readonly sourceId: string; /** * * @type {File} * @memberof SourcesApiImportConnectorFileV1 */ readonly file?: File; } /** * Request parameters for importEntitlementsSchemaV1 operation in SourcesApi. * @export * @interface SourcesApiImportEntitlementsSchemaV1Request */ export interface SourcesApiImportEntitlementsSchemaV1Request { /** * The Source id * @type {string} * @memberof SourcesApiImportEntitlementsSchemaV1 */ readonly id: string; /** * Name of entitlement schema * @type {string} * @memberof SourcesApiImportEntitlementsSchemaV1 */ readonly schemaName?: string; /** * * @type {File} * @memberof SourcesApiImportEntitlementsSchemaV1 */ readonly file?: File; } /** * Request parameters for importEntitlementsV1 operation in SourcesApi. * @export * @interface SourcesApiImportEntitlementsV1Request */ export interface SourcesApiImportEntitlementsV1Request { /** * Source Id * @type {string} * @memberof SourcesApiImportEntitlementsV1 */ readonly sourceId: string; /** * The CSV file containing the source entitlements to aggregate. * @type {File} * @memberof SourcesApiImportEntitlementsV1 */ readonly file?: File; } /** * Request parameters for importUncorrelatedAccountsV1 operation in SourcesApi. * @export * @interface SourcesApiImportUncorrelatedAccountsV1Request */ export interface SourcesApiImportUncorrelatedAccountsV1Request { /** * Source Id * @type {string} * @memberof SourcesApiImportUncorrelatedAccountsV1 */ readonly id: string; /** * * @type {File} * @memberof SourcesApiImportUncorrelatedAccountsV1 */ readonly file?: File; } /** * Request parameters for listPasswordPolicyHoldersOnSourceV1 operation in SourcesApi. * @export * @interface SourcesApiListPasswordPolicyHoldersOnSourceV1Request */ export interface SourcesApiListPasswordPolicyHoldersOnSourceV1Request { /** * The Source id * @type {string} * @memberof SourcesApiListPasswordPolicyHoldersOnSourceV1 */ readonly sourceId: string; /** * 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 SourcesApiListPasswordPolicyHoldersOnSourceV1 */ readonly offset?: number; /** * 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 SourcesApiListPasswordPolicyHoldersOnSourceV1 */ readonly limit?: 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 SourcesApiListPasswordPolicyHoldersOnSourceV1 */ readonly count?: boolean; } /** * Request parameters for listProvisioningPoliciesV1 operation in SourcesApi. * @export * @interface SourcesApiListProvisioningPoliciesV1Request */ export interface SourcesApiListProvisioningPoliciesV1Request { /** * The Source id * @type {string} * @memberof SourcesApiListProvisioningPoliciesV1 */ readonly sourceId: string; /** * Offset Integer specifying the offset of the first result from the beginning of the collection. The standard syntax described in [V3 API Standard Collection Parameters](https://developer.sailpoint.com/idn/api/standard-collection-parameters#paginating-results). The offset value is record-based, not page-based, and the index starts at 0. * @type {number} * @memberof SourcesApiListProvisioningPoliciesV1 */ readonly offset?: number; /** * Limit Integer specifying the maximum number of records to return in a single API call. The standard syntax described in [V3 API Standard Collection Parameters](https://developer.sailpoint.com/idn/api/standard-collection-parameters#paginating-results). If it is not specified, a default limit is used. * @type {number} * @memberof SourcesApiListProvisioningPoliciesV1 */ readonly limit?: number; } /** * Request parameters for listProvisioningPoliciesV2 operation in SourcesApi. * @export * @interface SourcesApiListProvisioningPoliciesV2Request */ export interface SourcesApiListProvisioningPoliciesV2Request { /** * The Source id * @type {string} * @memberof SourcesApiListProvisioningPoliciesV2 */ readonly sourceId: string; /** * 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: **subtypeId**: *eq* **usageType**: *eq* * @type {string} * @memberof SourcesApiListProvisioningPoliciesV2 */ readonly filters?: string; /** * Offset Integer specifying the offset of the first result from the beginning of the collection. The standard syntax described in [V3 API Standard Collection Parameters](https://developer.sailpoint.com/idn/api/standard-collection-parameters#paginating-results). The offset value is record-based, not page-based, and the index starts at 0. * @type {number} * @memberof SourcesApiListProvisioningPoliciesV2 */ readonly offset?: number; /** * Limit Integer specifying the maximum number of records to return in a single API call. The standard syntax described in [V3 API Standard Collection Parameters](https://developer.sailpoint.com/idn/api/standard-collection-parameters#paginating-results). If it is not specified, a default limit is used. * @type {number} * @memberof SourcesApiListProvisioningPoliciesV2 */ readonly limit?: number; /** * Use this header to enable this experimental API. * @type {string} * @memberof SourcesApiListProvisioningPoliciesV2 */ readonly xSailPointExperimental?: string; } /** * Request parameters for listSourcesV1 operation in SourcesApi. * @export * @interface SourcesApiListSourcesV1Request */ export interface SourcesApiListSourcesV1Request { /** * 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 SourcesApiListSourcesV1 */ 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 SourcesApiListSourcesV1 */ 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 SourcesApiListSourcesV1 */ readonly count?: boolean; /** * Filter results using the standard syntax described in [V3 API Standard Collection Parameters](https://developer.sailpoint.com/idn/api/standard-collection-parameters#filtering-results) Filtering is supported for the following fields and operators: **id**: *eq, in, ge, gt, le, lt, ne, isnull, sw* **name**: *co, eq, in, sw, ge, gt, ne, isnull* **type**: *eq, in, ge, gt, ne, isnull, sw* **owner.id**: *eq, in, ge, gt, le, lt, ne, isnull, sw* **features**: *ca, co* **created**: *eq, ge, gt, in, le, lt, ne, isnull, sw* **modified**: *eq, ge, gt, in, le, lt, ne, isnull, sw* **managementWorkgroup.id**: *eq, ge, gt, in, le, lt, ne, isnull, sw* **description**: *eq, sw* **authoritative**: *eq, ne, isnull* **healthy**: *isnull* **status**: *eq, in, ge, gt, le, lt, ne, isnull, sw* **connectionType**: *eq, ge, gt, in, le, lt, ne, isnull, sw* **connectorName**: *eq, ge, gt, in, ne, isnull, sw* **category**: *co, eq, ge, gt, in, le, lt, ne, sw* * @type {string} * @memberof SourcesApiListSourcesV1 */ readonly filters?: string; /** * Sort results using the standard syntax described in [V3 API Standard Collection Parameters](https://developer.sailpoint.com/idn/api/standard-collection-parameters#sorting-results) Sorting is supported for the following fields: **type, created, modified, name, owner.name, healthy, status, id, description, owner.id, accountCorrelationConfig.id, accountCorrelationConfig.name, managerCorrelationRule.type, managerCorrelationRule.id, managerCorrelationRule.name, authoritative, managementWorkgroup.id, connectorName, connectionType** * @type {string} * @memberof SourcesApiListSourcesV1 */ readonly sorters?: string; /** * Filter the returned list of sources for the identity specified by the parameter, which is the id of an identity with the role SOURCE_SUBADMIN. By convention, the value **me** indicates the identity id of the current user. Subadmins may only view Sources which they are able to administer; all other Sources will be filtered out when this parameter is set. If the current user is a SOURCE_SUBADMIN but fails to pass a valid value for this parameter, a 403 Forbidden is returned. * @type {string} * @memberof SourcesApiListSourcesV1 */ readonly forSubadmin?: string; /** * Include the IdentityNow source in the response. * @type {boolean} * @memberof SourcesApiListSourcesV1 */ readonly includeIDNSource?: boolean; } /** * Request parameters for pingClusterV1 operation in SourcesApi. * @export * @interface SourcesApiPingClusterV1Request */ export interface SourcesApiPingClusterV1Request { /** * The ID of the Source * @type {string} * @memberof SourcesApiPingClusterV1 */ readonly sourceId: string; } /** * Request parameters for putCorrelationConfigV1 operation in SourcesApi. * @export * @interface SourcesApiPutCorrelationConfigV1Request */ export interface SourcesApiPutCorrelationConfigV1Request { /** * The source id * @type {string} * @memberof SourcesApiPutCorrelationConfigV1 */ readonly id: string; /** * * @type {CorrelationConfig} * @memberof SourcesApiPutCorrelationConfigV1 */ readonly correlationConfig: CorrelationConfig; } /** * Request parameters for putNativeChangeDetectionConfigV1 operation in SourcesApi. * @export * @interface SourcesApiPutNativeChangeDetectionConfigV1Request */ export interface SourcesApiPutNativeChangeDetectionConfigV1Request { /** * The source id * @type {string} * @memberof SourcesApiPutNativeChangeDetectionConfigV1 */ readonly sourceId: string; /** * * @type {NativeChangeDetectionConfig} * @memberof SourcesApiPutNativeChangeDetectionConfigV1 */ readonly nativeChangeDetectionConfig: NativeChangeDetectionConfig; } /** * Request parameters for putProvisioningPolicyV1 operation in SourcesApi. * @export * @interface SourcesApiPutProvisioningPolicyV1Request */ export interface SourcesApiPutProvisioningPolicyV1Request { /** * The Source ID. * @type {string} * @memberof SourcesApiPutProvisioningPolicyV1 */ readonly sourceId: string; /** * The type of provisioning policy usage. In IdentityNow, a source can support various provisioning operations. For example, when a joiner is added to a source, this may trigger both CREATE and UPDATE provisioning operations. Each usage type is considered a provisioning policy. A source can have any number of these provisioning policies defined. These are the common usage types: CREATE - This usage type relates to \'Create Account Profile\', the provisioning template for the account to be created. For example, this would be used for a joiner on a source. UPDATE - This usage type relates to \'Update Account Profile\', the provisioning template for the \'Update\' connector operations. For example, this would be used for an attribute sync on a source. ENABLE - This usage type relates to \'Enable Account Profile\', the provisioning template for the account to be enabled. For example, this could be used for a joiner on a source once the joiner\'s account is created. DISABLE - This usage type relates to \'Disable Account Profile\', the provisioning template for the account to be disabled. For example, this could be used when a leaver is removed temporarily from a source. You can use these four usage types for all your provisioning policy needs. * @type {UsageType} * @memberof SourcesApiPutProvisioningPolicyV1 */ readonly usageType: UsageType; /** * * @type {ProvisioningPolicyDto} * @memberof SourcesApiPutProvisioningPolicyV1 */ readonly provisioningPolicyDto: ProvisioningPolicyDto; } /** * Request parameters for putProvisioningPolicyV2 operation in SourcesApi. * @export * @interface SourcesApiPutProvisioningPolicyV2Request */ export interface SourcesApiPutProvisioningPolicyV2Request { /** * The Source ID. * @type {string} * @memberof SourcesApiPutProvisioningPolicyV2 */ readonly sourceId: string; /** * The provisioning policy ID. * @type {string} * @memberof SourcesApiPutProvisioningPolicyV2 */ readonly id: string; /** * * @type {ProvisioningPolicyDtoV2} * @memberof SourcesApiPutProvisioningPolicyV2 */ readonly provisioningPolicyDtoV2: ProvisioningPolicyDtoV2; /** * Use this header to enable this experimental API. * @type {string} * @memberof SourcesApiPutProvisioningPolicyV2 */ readonly xSailPointExperimental?: string; } /** * Request parameters for putSourceAttrSyncConfigV1 operation in SourcesApi. * @export * @interface SourcesApiPutSourceAttrSyncConfigV1Request */ export interface SourcesApiPutSourceAttrSyncConfigV1Request { /** * The source id * @type {string} * @memberof SourcesApiPutSourceAttrSyncConfigV1 */ readonly id: string; /** * * @type {AttrSyncSourceConfig} * @memberof SourcesApiPutSourceAttrSyncConfigV1 */ readonly attrSyncSourceConfig: AttrSyncSourceConfig; /** * Use this header to enable this experimental API. * @type {string} * @memberof SourcesApiPutSourceAttrSyncConfigV1 */ readonly xSailPointExperimental?: string; } /** * Request parameters for putSourceSchemaV1 operation in SourcesApi. * @export * @interface SourcesApiPutSourceSchemaV1Request */ export interface SourcesApiPutSourceSchemaV1Request { /** * The Source id. * @type {string} * @memberof SourcesApiPutSourceSchemaV1 */ readonly sourceId: string; /** * The Schema id. * @type {string} * @memberof SourcesApiPutSourceSchemaV1 */ readonly schemaId: string; /** * * @type {Schema} * @memberof SourcesApiPutSourceSchemaV1 */ readonly schema: Schema; } /** * Request parameters for putSourceV1 operation in SourcesApi. * @export * @interface SourcesApiPutSourceV1Request */ export interface SourcesApiPutSourceV1Request { /** * Source ID. * @type {string} * @memberof SourcesApiPutSourceV1 */ readonly id: string; /** * * @type {Source} * @memberof SourcesApiPutSourceV1 */ readonly source: Source; } /** * Request parameters for searchResourceObjectsV1 operation in SourcesApi. * @export * @interface SourcesApiSearchResourceObjectsV1Request */ export interface SourcesApiSearchResourceObjectsV1Request { /** * The ID of the Source * @type {string} * @memberof SourcesApiSearchResourceObjectsV1 */ readonly sourceId: string; /** * * @type {ResourceObjectsRequest} * @memberof SourcesApiSearchResourceObjectsV1 */ readonly resourceObjectsRequest: ResourceObjectsRequest; } /** * Request parameters for syncAttributesForSourceV1 operation in SourcesApi. * @export * @interface SourcesApiSyncAttributesForSourceV1Request */ export interface SourcesApiSyncAttributesForSourceV1Request { /** * The Source id * @type {string} * @memberof SourcesApiSyncAttributesForSourceV1 */ readonly id: string; /** * Use this header to enable this experimental API. * @type {string} * @memberof SourcesApiSyncAttributesForSourceV1 */ readonly xSailPointExperimental?: string; } /** * Request parameters for testSourceConfigurationV1 operation in SourcesApi. * @export * @interface SourcesApiTestSourceConfigurationV1Request */ export interface SourcesApiTestSourceConfigurationV1Request { /** * The ID of the Source * @type {string} * @memberof SourcesApiTestSourceConfigurationV1 */ readonly sourceId: string; } /** * Request parameters for testSourceConnectionV1 operation in SourcesApi. * @export * @interface SourcesApiTestSourceConnectionV1Request */ export interface SourcesApiTestSourceConnectionV1Request { /** * The ID of the Source. * @type {string} * @memberof SourcesApiTestSourceConnectionV1 */ readonly sourceId: string; } /** * Request parameters for updateAccountDeletionApprovalConfigV1 operation in SourcesApi. * @export * @interface SourcesApiUpdateAccountDeletionApprovalConfigV1Request */ export interface SourcesApiUpdateAccountDeletionApprovalConfigV1Request { /** * Human account source ID. * @type {string} * @memberof SourcesApiUpdateAccountDeletionApprovalConfigV1 */ readonly sourceId: string; /** * The JSONPatch payload used to update the object. * @type {Array} * @memberof SourcesApiUpdateAccountDeletionApprovalConfigV1 */ readonly jsonPatchOperation: Array; } /** * Request parameters for updateMachineAccountDeletionApprovalConfigV1 operation in SourcesApi. * @export * @interface SourcesApiUpdateMachineAccountDeletionApprovalConfigV1Request */ export interface SourcesApiUpdateMachineAccountDeletionApprovalConfigV1Request { /** * machine account source ID. * @type {string} * @memberof SourcesApiUpdateMachineAccountDeletionApprovalConfigV1 */ readonly sourceId: string; /** * The JSONPatch payload used to update the object. * @type {Array} * @memberof SourcesApiUpdateMachineAccountDeletionApprovalConfigV1 */ readonly jsonPatchOperation: Array; } /** * Request parameters for updatePasswordPolicyHoldersV1 operation in SourcesApi. * @export * @interface SourcesApiUpdatePasswordPolicyHoldersV1Request */ export interface SourcesApiUpdatePasswordPolicyHoldersV1Request { /** * The Source id * @type {string} * @memberof SourcesApiUpdatePasswordPolicyHoldersV1 */ readonly sourceId: string; /** * * @type {Array} * @memberof SourcesApiUpdatePasswordPolicyHoldersV1 */ readonly passwordPolicyHoldersDtoInner: Array; } /** * Request parameters for updateProvisioningPoliciesInBulkV1 operation in SourcesApi. * @export * @interface SourcesApiUpdateProvisioningPoliciesInBulkV1Request */ export interface SourcesApiUpdateProvisioningPoliciesInBulkV1Request { /** * The Source id. * @type {string} * @memberof SourcesApiUpdateProvisioningPoliciesInBulkV1 */ readonly sourceId: string; /** * * @type {Array} * @memberof SourcesApiUpdateProvisioningPoliciesInBulkV1 */ readonly provisioningPolicyDto: Array; } /** * Request parameters for updateProvisioningPolicyV1 operation in SourcesApi. * @export * @interface SourcesApiUpdateProvisioningPolicyV1Request */ export interface SourcesApiUpdateProvisioningPolicyV1Request { /** * The Source id. * @type {string} * @memberof SourcesApiUpdateProvisioningPolicyV1 */ readonly sourceId: string; /** * The type of provisioning policy usage. In IdentityNow, a source can support various provisioning operations. For example, when a joiner is added to a source, this may trigger both CREATE and UPDATE provisioning operations. Each usage type is considered a provisioning policy. A source can have any number of these provisioning policies defined. These are the common usage types: CREATE - This usage type relates to \'Create Account Profile\', the provisioning template for the account to be created. For example, this would be used for a joiner on a source. UPDATE - This usage type relates to \'Update Account Profile\', the provisioning template for the \'Update\' connector operations. For example, this would be used for an attribute sync on a source. ENABLE - This usage type relates to \'Enable Account Profile\', the provisioning template for the account to be enabled. For example, this could be used for a joiner on a source once the joiner\'s account is created. DISABLE - This usage type relates to \'Disable Account Profile\', the provisioning template for the account to be disabled. For example, this could be used when a leaver is removed temporarily from a source. You can use these four usage types for all your provisioning policy needs. * @type {UsageType} * @memberof SourcesApiUpdateProvisioningPolicyV1 */ readonly usageType: UsageType; /** * The JSONPatch payload used to update the schema. * @type {Array} * @memberof SourcesApiUpdateProvisioningPolicyV1 */ readonly jsonPatchOperation: Array; } /** * Request parameters for updateProvisioningPolicyV2 operation in SourcesApi. * @export * @interface SourcesApiUpdateProvisioningPolicyV2Request */ export interface SourcesApiUpdateProvisioningPolicyV2Request { /** * The Source id. * @type {string} * @memberof SourcesApiUpdateProvisioningPolicyV2 */ readonly sourceId: string; /** * The provisioning policy ID. * @type {string} * @memberof SourcesApiUpdateProvisioningPolicyV2 */ readonly id: string; /** * The JSONPatch payload used to update the schema. * @type {Array} * @memberof SourcesApiUpdateProvisioningPolicyV2 */ readonly jsonPatchOperation: Array; /** * Use this header to enable this experimental API. * @type {string} * @memberof SourcesApiUpdateProvisioningPolicyV2 */ readonly xSailPointExperimental?: string; } /** * Request parameters for updateSourceEntitlementRequestConfigV1 operation in SourcesApi. * @export * @interface SourcesApiUpdateSourceEntitlementRequestConfigV1Request */ export interface SourcesApiUpdateSourceEntitlementRequestConfigV1Request { /** * The Source id * @type {string} * @memberof SourcesApiUpdateSourceEntitlementRequestConfigV1 */ readonly id: string; /** * * @type {SourceEntitlementRequestConfig} * @memberof SourcesApiUpdateSourceEntitlementRequestConfigV1 */ readonly sourceEntitlementRequestConfig: SourceEntitlementRequestConfig; } /** * Request parameters for updateSourceScheduleV1 operation in SourcesApi. * @export * @interface SourcesApiUpdateSourceScheduleV1Request */ export interface SourcesApiUpdateSourceScheduleV1Request { /** * The Source id. * @type {string} * @memberof SourcesApiUpdateSourceScheduleV1 */ readonly sourceId: string; /** * The Schedule type. * @type {'ACCOUNT_AGGREGATION' | 'GROUP_AGGREGATION'} * @memberof SourcesApiUpdateSourceScheduleV1 */ readonly scheduleType: UpdateSourceScheduleV1ScheduleTypeEnum; /** * The JSONPatch payload used to update the schedule. * @type {Array} * @memberof SourcesApiUpdateSourceScheduleV1 */ readonly jsonPatchOperation: Array; } /** * Request parameters for updateSourceSchemaV1 operation in SourcesApi. * @export * @interface SourcesApiUpdateSourceSchemaV1Request */ export interface SourcesApiUpdateSourceSchemaV1Request { /** * The Source id. * @type {string} * @memberof SourcesApiUpdateSourceSchemaV1 */ readonly sourceId: string; /** * The Schema id. * @type {string} * @memberof SourcesApiUpdateSourceSchemaV1 */ readonly schemaId: string; /** * The JSONPatch payload used to update the schema. * @type {Array} * @memberof SourcesApiUpdateSourceSchemaV1 */ readonly jsonPatchOperation: Array; } /** * Request parameters for updateSourceV1 operation in SourcesApi. * @export * @interface SourcesApiUpdateSourceV1Request */ export interface SourcesApiUpdateSourceV1Request { /** * Source ID. * @type {string} * @memberof SourcesApiUpdateSourceV1 */ readonly id: string; /** * A list of account update operations according to the [JSON Patch](https://tools.ietf.org/html/rfc6902) standard. Any password changes are submitted as plain-text and encrypted upon receipt in Identity Security Cloud (ISC). * @type {Array} * @memberof SourcesApiUpdateSourceV1 */ readonly jsonPatchOperation: Array; } /** * SourcesApi - object-oriented interface * @export * @class SourcesApi * @extends {BaseAPI} */ export declare class SourcesApi extends BaseAPI { /** * This API generates a create policy/template based on field value transforms. This API is intended for use when setting up JDBC Provisioning type sources, but it will also work on other source types. Transforms can be used in the provisioning policy to create a new attribute that you only need during provisioning. Refer to [Transforms in Provisioning Policies](https://developer.sailpoint.com/docs/extensibility/transforms/guides/transforms-in-provisioning-policies) for more information. * @summary Create provisioning policy * @param {SourcesApiCreateProvisioningPolicyV1Request} requestParameters Request parameters. * @param {*} [axiosOptions] Override http request option. * @throws {RequiredError} * @memberof SourcesApi */ createProvisioningPolicyV1(requestParameters: SourcesApiCreateProvisioningPolicyV1Request, axiosOptions?: RawAxiosRequestConfig): Promise>; /** * This API generates a create policy/template based on field value transforms. This API is intended for use when setting up JDBC Provisioning type sources, but it will also work on other source types. Transforms can be used in the provisioning policy to create a new attribute that you only need during provisioning. The V2 API allows you to use a unique identifier (id) for each provisioning policy instead of usageType. This enables read, update, and delete operations on policies using their id. Note: The subtypeId field is required if usageType is CREATE_MACHINE_ACCOUNT. Refer to [Transforms in Provisioning Policies](https://developer.sailpoint.com/docs/extensibility/transforms/guides/transforms-in-provisioning-policies) for more information. * @summary Create provisioning policy * @param {SourcesApiCreateProvisioningPolicyV2Request} requestParameters Request parameters. * @param {*} [axiosOptions] Override http request option. * @throws {RequiredError} * @memberof SourcesApi */ createProvisioningPolicyV2(requestParameters: SourcesApiCreateProvisioningPolicyV2Request, axiosOptions?: RawAxiosRequestConfig): Promise>; /** * Use this API to create a new schedule for a type on the specified source in Identity Security Cloud (ISC). * @summary Create schedule on source * @param {SourcesApiCreateSourceScheduleV1Request} requestParameters Request parameters. * @param {*} [axiosOptions] Override http request option. * @throws {RequiredError} * @memberof SourcesApi */ createSourceScheduleV1(requestParameters: SourcesApiCreateSourceScheduleV1Request, axiosOptions?: RawAxiosRequestConfig): Promise>; /** * Use this API to create a new schema on the specified source in Identity Security Cloud (ISC). * @summary Create schema on source * @param {SourcesApiCreateSourceSchemaV1Request} requestParameters Request parameters. * @param {*} [axiosOptions] Override http request option. * @throws {RequiredError} * @memberof SourcesApi */ createSourceSchemaV1(requestParameters: SourcesApiCreateSourceSchemaV1Request, axiosOptions?: RawAxiosRequestConfig): Promise>; /** * This creates a specific source with a full source JSON representation. Any passwords are submitted as plain-text and encrypted upon receipt in IdentityNow. * @summary Creates a source in identitynow. * @param {SourcesApiCreateSourceV1Request} requestParameters Request parameters. * @param {*} [axiosOptions] Override http request option. * @throws {RequiredError} * @memberof SourcesApi */ createSourceV1(requestParameters: SourcesApiCreateSourceV1Request, axiosOptions?: RawAxiosRequestConfig): Promise>; /** * Use this endpoint to remove all accounts from the system without provisioning changes to the source. Accounts that are removed could be re-created during the next aggregation. This endpoint is good for: * Removing accounts that no longer exist on the source. * Removing accounts that won\'t be aggregated following updates to the source configuration. * Forcing accounts to be re-created following the next aggregation to re-run account processing, support testing, etc. * @summary Remove all accounts in source * @param {SourcesApiDeleteAccountsAsyncV1Request} requestParameters Request parameters. * @param {*} [axiosOptions] Override http request option. * @throws {RequiredError} * @memberof SourcesApi */ deleteAccountsAsyncV1(requestParameters: SourcesApiDeleteAccountsAsyncV1Request, axiosOptions?: RawAxiosRequestConfig): Promise>; /** * Deletes the native change detection configuration for the source specified by the given ID. * @summary Delete native change detection configuration * @param {SourcesApiDeleteNativeChangeDetectionConfigV1Request} requestParameters Request parameters. * @param {*} [axiosOptions] Override http request option. * @throws {RequiredError} * @memberof SourcesApi */ deleteNativeChangeDetectionConfigV1(requestParameters: SourcesApiDeleteNativeChangeDetectionConfigV1Request, axiosOptions?: RawAxiosRequestConfig): Promise>; /** * Deletes the provisioning policy with the specified usage on an application. * @summary Delete provisioning policy by usagetype * @param {SourcesApiDeleteProvisioningPolicyV1Request} requestParameters Request parameters. * @param {*} [axiosOptions] Override http request option. * @throws {RequiredError} * @memberof SourcesApi */ deleteProvisioningPolicyV1(requestParameters: SourcesApiDeleteProvisioningPolicyV1Request, axiosOptions?: RawAxiosRequestConfig): Promise>; /** * Deletes the provisioning policy with the specified ID on an application. * @summary Delete provisioning policy by ID * @param {SourcesApiDeleteProvisioningPolicyV2Request} requestParameters Request parameters. * @param {*} [axiosOptions] Override http request option. * @throws {RequiredError} * @memberof SourcesApi */ deleteProvisioningPolicyV2(requestParameters: SourcesApiDeleteProvisioningPolicyV2Request, axiosOptions?: RawAxiosRequestConfig): Promise>; /** * * @summary Delete source schedule by type. * @param {SourcesApiDeleteSourceScheduleV1Request} requestParameters Request parameters. * @param {*} [axiosOptions] Override http request option. * @throws {RequiredError} * @memberof SourcesApi */ deleteSourceScheduleV1(requestParameters: SourcesApiDeleteSourceScheduleV1Request, axiosOptions?: RawAxiosRequestConfig): Promise>; /** * * @summary Delete source schema by id * @param {SourcesApiDeleteSourceSchemaV1Request} requestParameters Request parameters. * @param {*} [axiosOptions] Override http request option. * @throws {RequiredError} * @memberof SourcesApi */ deleteSourceSchemaV1(requestParameters: SourcesApiDeleteSourceSchemaV1Request, axiosOptions?: RawAxiosRequestConfig): Promise>; /** * Use this API to delete a specific source in Identity Security Cloud (ISC). The API removes all the accounts on the source first, and then it deletes the source. You can retrieve the actual task execution status with this method: GET `/task-status/{id}` * @summary Delete source by id * @param {SourcesApiDeleteSourceV1Request} requestParameters Request parameters. * @param {*} [axiosOptions] Override http request option. * @throws {RequiredError} * @memberof SourcesApi */ deleteSourceV1(requestParameters: SourcesApiDeleteSourceV1Request, axiosOptions?: RawAxiosRequestConfig): Promise>; /** * The endpoint retrieves the approval configuration for deleting human accounts from a specified source. It returns details such as whether approval is required, who the approvers are, and any additional approval settings. This helps administrators understand and manage the approval workflow for human account deletions in their organization. The response is provided as an AccountDeleteConfigDto object. * @summary Human Account Deletion Approval Config * @param {SourcesApiGetAccountDeleteApprovalConfigV1Request} requestParameters Request parameters. * @param {*} [axiosOptions] Override http request option. * @throws {RequiredError} * @memberof SourcesApi */ getAccountDeleteApprovalConfigV1(requestParameters: SourcesApiGetAccountDeleteApprovalConfigV1Request, axiosOptions?: RawAxiosRequestConfig): Promise>; /** * This API downloads the CSV schema that defines the account attributes on a source. >**NOTE: This API is designated only for Delimited File sources.** * @summary Downloads source accounts schema template * @param {SourcesApiGetAccountsSchemaV1Request} requestParameters Request parameters. * @param {*} [axiosOptions] Override http request option. * @throws {RequiredError} * @memberof SourcesApi */ getAccountsSchemaV1(requestParameters: SourcesApiGetAccountsSchemaV1Request, axiosOptions?: RawAxiosRequestConfig): Promise>; /** * This API returns the existing correlation configuration for a source specified by the given ID. * @summary Get source correlation configuration * @param {SourcesApiGetCorrelationConfigV1Request} requestParameters Request parameters. * @param {*} [axiosOptions] Override http request option. * @throws {RequiredError} * @memberof SourcesApi */ getCorrelationConfigV1(requestParameters: SourcesApiGetCorrelationConfigV1Request, axiosOptions?: RawAxiosRequestConfig): Promise>; /** * This API downloads the CSV schema that defines the entitlement attributes on a source. >**NOTE: This API is designated only for Delimited File sources.** * @summary Downloads source entitlements schema template * @param {SourcesApiGetEntitlementsSchemaV1Request} requestParameters Request parameters. * @param {*} [axiosOptions] Override http request option. * @throws {RequiredError} * @memberof SourcesApi */ getEntitlementsSchemaV1(requestParameters: SourcesApiGetEntitlementsSchemaV1Request, axiosOptions?: RawAxiosRequestConfig): Promise>; /** * Retrieves the machine account deletion approval configuration for a specific source. This endpoint returns details about the approval requirements, approvers, and comment settings that govern the deletion of machine accounts associated with the given source ID. * @summary Machine Account Deletion Approval Config * @param {SourcesApiGetMachineAccountDeletionApprovalConfigBySourceV1Request} requestParameters Request parameters. * @param {*} [axiosOptions] Override http request option. * @throws {RequiredError} * @memberof SourcesApi */ getMachineAccountDeletionApprovalConfigBySourceV1(requestParameters: SourcesApiGetMachineAccountDeletionApprovalConfigBySourceV1Request, axiosOptions?: RawAxiosRequestConfig): Promise>; /** * This API returns the existing native change detection configuration for a source specified by the given ID. * @summary Native change detection configuration * @param {SourcesApiGetNativeChangeDetectionConfigV1Request} requestParameters Request parameters. * @param {*} [axiosOptions] Override http request option. * @throws {RequiredError} * @memberof SourcesApi */ getNativeChangeDetectionConfigV1(requestParameters: SourcesApiGetNativeChangeDetectionConfigV1Request, axiosOptions?: RawAxiosRequestConfig): Promise>; /** * This end-point retrieves the ProvisioningPolicy with the specified usage on the specified Source in IdentityNow. * @summary Get provisioning policy by usagetype * @param {SourcesApiGetProvisioningPolicyV1Request} requestParameters Request parameters. * @param {*} [axiosOptions] Override http request option. * @throws {RequiredError} * @memberof SourcesApi */ getProvisioningPolicyV1(requestParameters: SourcesApiGetProvisioningPolicyV1Request, axiosOptions?: RawAxiosRequestConfig): Promise>; /** * This end-point retrieves the ProvisioningPolicy with the specified ID on the specified Source in Identity Security Cloud. * @summary Get provisioning policy by ID * @param {SourcesApiGetProvisioningPolicyV2Request} requestParameters Request parameters. * @param {*} [axiosOptions] Override http request option. * @throws {RequiredError} * @memberof SourcesApi */ getProvisioningPolicyV2(requestParameters: SourcesApiGetProvisioningPolicyV2Request, axiosOptions?: RawAxiosRequestConfig): Promise>; /** * This API returns the existing attribute synchronization configuration for a source specified by the given ID. The response contains all attributes, regardless of whether they enabled or not. * @summary Attribute sync config * @param {SourcesApiGetSourceAttrSyncConfigV1Request} requestParameters Request parameters. * @param {*} [axiosOptions] Override http request option. * @throws {RequiredError} * @memberof SourcesApi */ getSourceAttrSyncConfigV1(requestParameters: SourcesApiGetSourceAttrSyncConfigV1Request, axiosOptions?: RawAxiosRequestConfig): Promise>; /** * Looks up and returns the source config for the requested source id after populating the source config values and applying language translations. * @summary Gets source config with language-translations * @param {SourcesApiGetSourceConfigV1Request} requestParameters Request parameters. * @param {*} [axiosOptions] Override http request option. * @throws {RequiredError} * @memberof SourcesApi */ getSourceConfigV1(requestParameters: SourcesApiGetSourceConfigV1Request, axiosOptions?: RawAxiosRequestConfig): Promise>; /** * Use this API to get all dependent Profiles, Attributes, Applications and Custom Transforms for a source by a specified ID in Identity Security Cloud (ISC). * @summary Get source connections by id * @param {SourcesApiGetSourceConnectionsV1Request} requestParameters Request parameters. * @param {*} [axiosOptions] Override http request option. * @throws {RequiredError} * @memberof SourcesApi */ getSourceConnectionsV1(requestParameters: SourcesApiGetSourceConnectionsV1Request, axiosOptions?: RawAxiosRequestConfig): Promise>; /** * This API gets the current entitlement request configuration for a source. This source-level configuration should apply for all the entitlements in the source. Access request to any entitlements in the source should follow this configuration unless a separate entitlement-level configuration is defined. - During access request, this source-level entitlement request configuration overrides the global organization-level configuration. - However, the entitlement-level configuration (if defined) overrides this source-level configuration. * @summary Get source entitlement request configuration * @param {SourcesApiGetSourceEntitlementRequestConfigV1Request} requestParameters Request parameters. * @param {*} [axiosOptions] Override http request option. * @throws {RequiredError} * @memberof SourcesApi */ getSourceEntitlementRequestConfigV1(requestParameters: SourcesApiGetSourceEntitlementRequestConfigV1Request, axiosOptions?: RawAxiosRequestConfig): Promise>; /** * This endpoint fetches source health by source\'s id * @summary Fetches source health by id * @param {SourcesApiGetSourceHealthV1Request} requestParameters Request parameters. * @param {*} [axiosOptions] Override http request option. * @throws {RequiredError} * @memberof SourcesApi */ getSourceHealthV1(requestParameters: SourcesApiGetSourceHealthV1Request, axiosOptions?: RawAxiosRequestConfig): Promise>; /** * Get the source schedule by type in Identity Security Cloud (ISC). * @summary Get source schedule by type * @param {SourcesApiGetSourceScheduleV1Request} requestParameters Request parameters. * @param {*} [axiosOptions] Override http request option. * @throws {RequiredError} * @memberof SourcesApi */ getSourceScheduleV1(requestParameters: SourcesApiGetSourceScheduleV1Request, axiosOptions?: RawAxiosRequestConfig): Promise>; /** * Use this API to list the schedules that exist on the specified source in Identity Security Cloud (ISC). :::info This endpoint uses a **cron expression** to schedule a task, following standard **cron job syntax**. For example, `0 0 12 1/1 * ? *` runs the task **daily at 12:00 PM**. **Days of the week are represented as 1-7 (Sunday-Saturday).** ::: * @summary List schedules on source * @param {SourcesApiGetSourceSchedulesV1Request} requestParameters Request parameters. * @param {*} [axiosOptions] Override http request option. * @throws {RequiredError} * @memberof SourcesApi */ getSourceSchedulesV1(requestParameters: SourcesApiGetSourceSchedulesV1Request, axiosOptions?: RawAxiosRequestConfig): Promise>; /** * Get the Source Schema by ID in IdentityNow. * @summary Get source schema by id * @param {SourcesApiGetSourceSchemaV1Request} requestParameters Request parameters. * @param {*} [axiosOptions] Override http request option. * @throws {RequiredError} * @memberof SourcesApi */ getSourceSchemaV1(requestParameters: SourcesApiGetSourceSchemaV1Request, axiosOptions?: RawAxiosRequestConfig): Promise>; /** * Use this API to list the schemas that exist on the specified source in Identity Security Cloud (ISC). * @summary List schemas on source * @param {SourcesApiGetSourceSchemasV1Request} requestParameters Request parameters. * @param {*} [axiosOptions] Override http request option. * @throws {RequiredError} * @memberof SourcesApi */ getSourceSchemasV1(requestParameters: SourcesApiGetSourceSchemasV1Request, axiosOptions?: RawAxiosRequestConfig): Promise>; /** * Use this API to get a source by a specified ID in Identity Security Cloud (ISC). * @summary Get source by id * @param {SourcesApiGetSourceV1Request} requestParameters Request parameters. * @param {*} [axiosOptions] Override http request option. * @throws {RequiredError} * @memberof SourcesApi */ getSourceV1(requestParameters: SourcesApiGetSourceV1Request, axiosOptions?: RawAxiosRequestConfig): Promise>; /** * This API uploads a source schema template file to configure a source\'s account attributes. To retrieve the file to modify and upload, log into Identity Now. Click **Admin** -> **Connections** -> **Sources** -> **`{SourceName}`** -> **Import Data** -> **Account Schema** -> **Options** -> **Download Schema** >**NOTE: This API is designated only for Delimited File sources.** * @summary Uploads source accounts schema template * @param {SourcesApiImportAccountsSchemaV1Request} requestParameters Request parameters. * @param {*} [axiosOptions] Override http request option. * @throws {RequiredError} * @memberof SourcesApi */ importAccountsSchemaV1(requestParameters: SourcesApiImportAccountsSchemaV1Request, axiosOptions?: RawAxiosRequestConfig): Promise>; /** * Starts an account aggregation on the specified source. If the target source is a delimited file source, then the CSV file needs to be included in the request body. You will also need to set the Content-Type header to `multipart/form-data`. * @summary Account aggregation * @param {SourcesApiImportAccountsV1Request} requestParameters Request parameters. * @param {*} [axiosOptions] Override http request option. * @throws {RequiredError} * @memberof SourcesApi */ importAccountsV1(requestParameters: SourcesApiImportAccountsV1Request, axiosOptions?: RawAxiosRequestConfig): Promise>; /** * This uploads a supplemental source connector file (like jdbc driver jars) to a source\'s S3 bucket. This also sends ETS and Audit events. * @summary Upload connector file to source * @param {SourcesApiImportConnectorFileV1Request} requestParameters Request parameters. * @param {*} [axiosOptions] Override http request option. * @throws {RequiredError} * @memberof SourcesApi */ importConnectorFileV1(requestParameters: SourcesApiImportConnectorFileV1Request, axiosOptions?: RawAxiosRequestConfig): Promise>; /** * This API uploads a source schema template file to configure a source\'s entitlement attributes. To retrieve the file to modify and upload, log into Identity Now. Click **Admin** -> **Connections** -> **Sources** -> **`{SourceName}`** -> **Import Data** -> **Import Entitlements** -> **Download** >**NOTE: This API is designated only for Delimited File sources.** * @summary Uploads source entitlements schema template * @param {SourcesApiImportEntitlementsSchemaV1Request} requestParameters Request parameters. * @param {*} [axiosOptions] Override http request option. * @throws {RequiredError} * @memberof SourcesApi */ importEntitlementsSchemaV1(requestParameters: SourcesApiImportEntitlementsSchemaV1Request, axiosOptions?: RawAxiosRequestConfig): Promise>; /** * Starts an entitlement aggregation on the specified source. If the target source is a delimited file source, then the CSV file needs to be included in the request body. You will also need to set the Content-Type header to `multipart/form-data`. A token with ORG_ADMIN, SOURCE_ADMIN, or SOURCE_SUBADMIN authority is required to call this API. * @summary Entitlement aggregation * @param {SourcesApiImportEntitlementsV1Request} requestParameters Request parameters. * @param {*} [axiosOptions] Override http request option. * @throws {RequiredError} * @memberof SourcesApi */ importEntitlementsV1(requestParameters: SourcesApiImportEntitlementsV1Request, axiosOptions?: RawAxiosRequestConfig): Promise>; /** * File is required for upload. You will also need to set the Content-Type header to `multipart/form-data` * @summary Process uncorrelated accounts * @param {SourcesApiImportUncorrelatedAccountsV1Request} requestParameters Request parameters. * @param {*} [axiosOptions] Override http request option. * @throws {RequiredError} * @memberof SourcesApi */ importUncorrelatedAccountsV1(requestParameters: SourcesApiImportUncorrelatedAccountsV1Request, axiosOptions?: RawAxiosRequestConfig): Promise>; /** * This API can be used to get Password Policy in IdentityNow for the specified Source. Source must support PASSWORD feature. * @summary Get Password Policy for source * @param {SourcesApiListPasswordPolicyHoldersOnSourceV1Request} requestParameters Request parameters. * @param {*} [axiosOptions] Override http request option. * @throws {RequiredError} * @memberof SourcesApi */ listPasswordPolicyHoldersOnSourceV1(requestParameters: SourcesApiListPasswordPolicyHoldersOnSourceV1Request, axiosOptions?: RawAxiosRequestConfig): Promise>; /** * This end-point lists all the ProvisioningPolicies in IdentityNow. * @summary Lists provisioningpolicies * @param {SourcesApiListProvisioningPoliciesV1Request} requestParameters Request parameters. * @param {*} [axiosOptions] Override http request option. * @throws {RequiredError} * @memberof SourcesApi */ listProvisioningPoliciesV1(requestParameters: SourcesApiListProvisioningPoliciesV1Request, axiosOptions?: RawAxiosRequestConfig): Promise>; /** * This end-point lists all the ProvisioningPolicies in IdentityNow. * @summary Lists Provisioning Policies * @param {SourcesApiListProvisioningPoliciesV2Request} requestParameters Request parameters. * @param {*} [axiosOptions] Override http request option. * @throws {RequiredError} * @memberof SourcesApi */ listProvisioningPoliciesV2(requestParameters: SourcesApiListProvisioningPoliciesV2Request, axiosOptions?: RawAxiosRequestConfig): Promise>; /** * This end-point lists all the sources in IdentityNow. * @summary Lists all sources in identitynow. * @param {SourcesApiListSourcesV1Request} requestParameters Request parameters. * @param {*} [axiosOptions] Override http request option. * @throws {RequiredError} * @memberof SourcesApi */ listSourcesV1(requestParameters?: SourcesApiListSourcesV1Request, axiosOptions?: RawAxiosRequestConfig): Promise>; /** * This endpoint validates that the cluster being used by the source is reachable from IdentityNow. * @summary Ping cluster for source connector * @param {SourcesApiPingClusterV1Request} requestParameters Request parameters. * @param {*} [axiosOptions] Override http request option. * @throws {RequiredError} * @memberof SourcesApi */ pingClusterV1(requestParameters: SourcesApiPingClusterV1Request, axiosOptions?: RawAxiosRequestConfig): Promise>; /** * Replaces the correlation configuration for the source specified by the given ID with the configuration provided in the request body. * @summary Update source correlation configuration * @param {SourcesApiPutCorrelationConfigV1Request} requestParameters Request parameters. * @param {*} [axiosOptions] Override http request option. * @throws {RequiredError} * @memberof SourcesApi */ putCorrelationConfigV1(requestParameters: SourcesApiPutCorrelationConfigV1Request, axiosOptions?: RawAxiosRequestConfig): Promise>; /** * Replaces the native change detection configuration for the source specified by the given ID with the configuration provided in the request body. * @summary Update native change detection configuration * @param {SourcesApiPutNativeChangeDetectionConfigV1Request} requestParameters Request parameters. * @param {*} [axiosOptions] Override http request option. * @throws {RequiredError} * @memberof SourcesApi */ putNativeChangeDetectionConfigV1(requestParameters: SourcesApiPutNativeChangeDetectionConfigV1Request, axiosOptions?: RawAxiosRequestConfig): Promise>; /** * This end-point updates the provisioning policy with the specified usage on the specified source in IdentityNow. Transforms can be used in the provisioning policy to create a new attribute that you only need during provisioning. Refer to [Transforms in Provisioning Policies](https://developer.sailpoint.com/docs/extensibility/transforms/guides/transforms-in-provisioning-policies) for more information. * @summary Update provisioning policy by usagetype * @param {SourcesApiPutProvisioningPolicyV1Request} requestParameters Request parameters. * @param {*} [axiosOptions] Override http request option. * @throws {RequiredError} * @memberof SourcesApi */ putProvisioningPolicyV1(requestParameters: SourcesApiPutProvisioningPolicyV1Request, axiosOptions?: RawAxiosRequestConfig): Promise>; /** * This end-point updates the provisioning policy with the specified ID on the specified source in Identity Security Cloud. Transforms can be used in the provisioning policy to create a new attribute that you only need during provisioning. Refer to [Transforms in Provisioning Policies](https://developer.sailpoint.com/docs/extensibility/transforms/guides/transforms-in-provisioning-policies) for more information. * @summary Update provisioning policy by ID * @param {SourcesApiPutProvisioningPolicyV2Request} requestParameters Request parameters. * @param {*} [axiosOptions] Override http request option. * @throws {RequiredError} * @memberof SourcesApi */ putProvisioningPolicyV2(requestParameters: SourcesApiPutProvisioningPolicyV2Request, axiosOptions?: RawAxiosRequestConfig): Promise>; /** * Replaces the attribute synchronization configuration for the source specified by the given ID with the configuration provided in the request body. Only the \"enabled\" field of the values in the \"attributes\" array is mutable. Attempting to change other attributes or add new values to the \"attributes\" array will result in an error. * @summary Update attribute sync config * @param {SourcesApiPutSourceAttrSyncConfigV1Request} requestParameters Request parameters. * @param {*} [axiosOptions] Override http request option. * @throws {RequiredError} * @memberof SourcesApi */ putSourceAttrSyncConfigV1(requestParameters: SourcesApiPutSourceAttrSyncConfigV1Request, axiosOptions?: RawAxiosRequestConfig): Promise>; /** * This API will completely replace an existing Schema with the submitted payload. Some fields of the Schema cannot be updated. These fields are listed below. * id * name * created * modified Any attempt to modify these fields will result in an error response with a status code of 400. > `id` must remain in the request body, but it cannot be changed. If `id` is omitted from the request body, the result will be a 400 error. * @summary Update source schema (full) * @param {SourcesApiPutSourceSchemaV1Request} requestParameters Request parameters. * @param {*} [axiosOptions] Override http request option. * @throws {RequiredError} * @memberof SourcesApi */ putSourceSchemaV1(requestParameters: SourcesApiPutSourceSchemaV1Request, axiosOptions?: RawAxiosRequestConfig): Promise>; /** * Use this API to update a source in Identity Security Cloud (ISC), using a full object representation. This means that when you use this API, it completely replaces the existing source configuration. These fields are immutable, so they cannot be changed: * id * type * authoritative * connector * connectorClass * passwordPolicies Attempts to modify these fields will result in a 400 error. * @summary Update source (full) * @param {SourcesApiPutSourceV1Request} requestParameters Request parameters. * @param {*} [axiosOptions] Override http request option. * @throws {RequiredError} * @memberof SourcesApi */ putSourceV1(requestParameters: SourcesApiPutSourceV1Request, axiosOptions?: RawAxiosRequestConfig): Promise>; /** * Retrieves a sample of data returned from account and group aggregation requests. * @summary Peek source connector\'s resource objects * @param {SourcesApiSearchResourceObjectsV1Request} requestParameters Request parameters. * @param {*} [axiosOptions] Override http request option. * @throws {RequiredError} * @memberof SourcesApi */ searchResourceObjectsV1(requestParameters: SourcesApiSearchResourceObjectsV1Request, axiosOptions?: RawAxiosRequestConfig): Promise>; /** * This end-point performs attribute synchronization for a selected source. * @summary Synchronize single source attributes. * @param {SourcesApiSyncAttributesForSourceV1Request} requestParameters Request parameters. * @param {*} [axiosOptions] Override http request option. * @throws {RequiredError} * @memberof SourcesApi */ syncAttributesForSourceV1(requestParameters: SourcesApiSyncAttributesForSourceV1Request, axiosOptions?: RawAxiosRequestConfig): Promise>; /** * This endpoint performs a more detailed validation of the source\'\'s configuration that can take longer than the lighter weight credential validation performed by the checkConnection API. * @summary Test configuration for source connector * @param {SourcesApiTestSourceConfigurationV1Request} requestParameters Request parameters. * @param {*} [axiosOptions] Override http request option. * @throws {RequiredError} * @memberof SourcesApi */ testSourceConfigurationV1(requestParameters: SourcesApiTestSourceConfigurationV1Request, axiosOptions?: RawAxiosRequestConfig): Promise>; /** * This endpoint validates that the configured credentials are valid and will properly authenticate with the source identified by the sourceId path parameter. * @summary Check connection for source connector. * @param {SourcesApiTestSourceConnectionV1Request} requestParameters Request parameters. * @param {*} [axiosOptions] Override http request option. * @throws {RequiredError} * @memberof SourcesApi */ testSourceConnectionV1(requestParameters: SourcesApiTestSourceConnectionV1Request, axiosOptions?: RawAxiosRequestConfig): Promise>; /** * Updates the approval configuration for deleting human accounts for a specific source, identified by source ID. This endpoint allows administrators to modify settings such as whether approval is required, who the approvers are, and other approval-related options. The update is performed using a JSON Patch payload, and the response returns the updated AccountDeleteConfigDto object reflecting the new approval workflow configuration. * @summary Human Account Deletion Approval Config * @param {SourcesApiUpdateAccountDeletionApprovalConfigV1Request} requestParameters Request parameters. * @param {*} [axiosOptions] Override http request option. * @throws {RequiredError} * @memberof SourcesApi */ updateAccountDeletionApprovalConfigV1(requestParameters: SourcesApiUpdateAccountDeletionApprovalConfigV1Request, axiosOptions?: RawAxiosRequestConfig): Promise>; /** * Use this endpoint to update the machine account deletion approval configuration for a specific source. The update is performed using a JSON Patch payload, which allows partial modifications to the approval config. This operation is typically used to change approval requirements, approvers, or comments settings for machine account deletion. The endpoint expects the source ID as a path parameter and a valid JSON Patch array in the request body. * @summary Machine Account Deletion Approval Config * @param {SourcesApiUpdateMachineAccountDeletionApprovalConfigV1Request} requestParameters Request parameters. * @param {*} [axiosOptions] Override http request option. * @throws {RequiredError} * @memberof SourcesApi */ updateMachineAccountDeletionApprovalConfigV1(requestParameters: SourcesApiUpdateMachineAccountDeletionApprovalConfigV1Request, axiosOptions?: RawAxiosRequestConfig): Promise>; /** * This API can be used to set up or update Password Policy in IdentityNow for the specified Source. Source must support PASSWORD feature. * @summary Update password policy * @param {SourcesApiUpdatePasswordPolicyHoldersV1Request} requestParameters Request parameters. * @param {*} [axiosOptions] Override http request option. * @throws {RequiredError} * @memberof SourcesApi */ updatePasswordPolicyHoldersV1(requestParameters: SourcesApiUpdatePasswordPolicyHoldersV1Request, axiosOptions?: RawAxiosRequestConfig): Promise>; /** * This end-point updates a list of provisioning policies on the specified source in IdentityNow. * @summary Bulk update provisioning policies * @param {SourcesApiUpdateProvisioningPoliciesInBulkV1Request} requestParameters Request parameters. * @param {*} [axiosOptions] Override http request option. * @throws {RequiredError} * @memberof SourcesApi */ updateProvisioningPoliciesInBulkV1(requestParameters: SourcesApiUpdateProvisioningPoliciesInBulkV1Request, axiosOptions?: RawAxiosRequestConfig): Promise>; /** * This API selectively updates an existing Provisioning Policy using a JSONPatch payload. Transforms can be used in the provisioning policy to create a new attribute that you only need during provisioning. Refer to [Transforms in Provisioning Policies](https://developer.sailpoint.com/docs/extensibility/transforms/guides/transforms-in-provisioning-policies) for more information. * @summary Partial update of provisioning policy * @param {SourcesApiUpdateProvisioningPolicyV1Request} requestParameters Request parameters. * @param {*} [axiosOptions] Override http request option. * @throws {RequiredError} * @memberof SourcesApi */ updateProvisioningPolicyV1(requestParameters: SourcesApiUpdateProvisioningPolicyV1Request, axiosOptions?: RawAxiosRequestConfig): Promise>; /** * This API selectively updates an existing Provisioning Policy using a JSONPatch payload. Transforms can be used in the provisioning policy to create a new attribute that you only need during provisioning. Refer to [Transforms in Provisioning Policies](https://developer.sailpoint.com/docs/extensibility/transforms/guides/transforms-in-provisioning-policies) for more information. * @summary Partial update of provisioning policy * @param {SourcesApiUpdateProvisioningPolicyV2Request} requestParameters Request parameters. * @param {*} [axiosOptions] Override http request option. * @throws {RequiredError} * @memberof SourcesApi */ updateProvisioningPolicyV2(requestParameters: SourcesApiUpdateProvisioningPolicyV2Request, axiosOptions?: RawAxiosRequestConfig): Promise>; /** * This API replaces the current entitlement request configuration for a source. This source-level configuration should apply for all the entitlements in the source. Access request to any entitlements in the source should follow this configuration unless a separate entitlement-level configuration is defined. - During access request, this source-level entitlement request configuration overrides the global organization-level configuration. - However, the entitlement-level configuration (if defined) overrides this source-level configuration. * @summary Update source entitlement request configuration * @param {SourcesApiUpdateSourceEntitlementRequestConfigV1Request} requestParameters Request parameters. * @param {*} [axiosOptions] Override http request option. * @throws {RequiredError} * @memberof SourcesApi */ updateSourceEntitlementRequestConfigV1(requestParameters: SourcesApiUpdateSourceEntitlementRequestConfigV1Request, axiosOptions?: RawAxiosRequestConfig): Promise>; /** * Use this API to selectively update an existing Schedule using a JSONPatch payload. The following schedule fields are immutable and cannot be updated: - type * @summary Update source schedule (partial) * @param {SourcesApiUpdateSourceScheduleV1Request} requestParameters Request parameters. * @param {*} [axiosOptions] Override http request option. * @throws {RequiredError} * @memberof SourcesApi */ updateSourceScheduleV1(requestParameters: SourcesApiUpdateSourceScheduleV1Request, axiosOptions?: RawAxiosRequestConfig): Promise>; /** * Use this API to selectively update an existing Schema using a JSONPatch payload. The following schema fields are immutable and cannot be updated: - id - name - created - modified To switch an account attribute to a group entitlement, you need to have the following in place: - `isEntitlement: true` - Must define a schema for the group and [add it to the source](https://developer.sailpoint.com/docs/api/create-source-schema-v-1) before updating the `isGroup` flag. For example, here is the `group` account attribute referencing a schema that defines the group: ```json { \"name\": \"groups\", \"type\": \"STRING\", \"schema\": { \"type\": \"CONNECTOR_SCHEMA\", \"id\": \"2c9180887671ff8c01767b4671fc7d60\", \"name\": \"group\" }, \"description\": \"The groups, roles etc. that reference account group objects\", \"isMulti\": true, \"isEntitlement\": true, \"isGroup\": true } ``` * @summary Update source schema (partial) * @param {SourcesApiUpdateSourceSchemaV1Request} requestParameters Request parameters. * @param {*} [axiosOptions] Override http request option. * @throws {RequiredError} * @memberof SourcesApi */ updateSourceSchemaV1(requestParameters: SourcesApiUpdateSourceSchemaV1Request, axiosOptions?: RawAxiosRequestConfig): Promise>; /** * Use this API to partially update a source in Identity Security Cloud (ISC), using a list of patch operations according to the [JSON Patch](https://tools.ietf.org/html/rfc6902) standard. These fields are immutable, so they cannot be changed: * id * type * authoritative * created * modified * connector * connectorClass * passwordPolicies Attempts to modify these fields will result in a 400 error. * @summary Update source (partial) * @param {SourcesApiUpdateSourceV1Request} requestParameters Request parameters. * @param {*} [axiosOptions] Override http request option. * @throws {RequiredError} * @memberof SourcesApi */ updateSourceV1(requestParameters: SourcesApiUpdateSourceV1Request, axiosOptions?: RawAxiosRequestConfig): Promise>; } /** * @export */ export declare const DeleteSourceScheduleV1ScheduleTypeEnum: { readonly AccountAggregation: "ACCOUNT_AGGREGATION"; readonly GroupAggregation: "GROUP_AGGREGATION"; }; export type DeleteSourceScheduleV1ScheduleTypeEnum = typeof DeleteSourceScheduleV1ScheduleTypeEnum[keyof typeof DeleteSourceScheduleV1ScheduleTypeEnum]; /** * @export */ export declare const GetSourceConfigV1LocaleEnum: { readonly De: "de"; readonly False: "false"; readonly Fi: "fi"; readonly Sv: "sv"; readonly Ru: "ru"; readonly Pt: "pt"; readonly Ko: "ko"; readonly ZhTw: "zh-TW"; readonly En: "en"; readonly It: "it"; readonly Fr: "fr"; readonly ZhCn: "zh-CN"; readonly Hu: "hu"; readonly Es: "es"; readonly Cs: "cs"; readonly Ja: "ja"; readonly Pl: "pl"; readonly Da: "da"; readonly Nl: "nl"; }; export type GetSourceConfigV1LocaleEnum = typeof GetSourceConfigV1LocaleEnum[keyof typeof GetSourceConfigV1LocaleEnum]; /** * @export */ export declare const GetSourceScheduleV1ScheduleTypeEnum: { readonly AccountAggregation: "ACCOUNT_AGGREGATION"; readonly GroupAggregation: "GROUP_AGGREGATION"; }; export type GetSourceScheduleV1ScheduleTypeEnum = typeof GetSourceScheduleV1ScheduleTypeEnum[keyof typeof GetSourceScheduleV1ScheduleTypeEnum]; /** * @export */ export declare const GetSourceSchemasV1IncludeTypesEnum: { readonly Group: "group"; readonly User: "user"; }; export type GetSourceSchemasV1IncludeTypesEnum = typeof GetSourceSchemasV1IncludeTypesEnum[keyof typeof GetSourceSchemasV1IncludeTypesEnum]; /** * @export */ export declare const UpdateSourceScheduleV1ScheduleTypeEnum: { readonly AccountAggregation: "ACCOUNT_AGGREGATION"; readonly GroupAggregation: "GROUP_AGGREGATION"; }; export type UpdateSourceScheduleV1ScheduleTypeEnum = typeof UpdateSourceScheduleV1ScheduleTypeEnum[keyof typeof UpdateSourceScheduleV1ScheduleTypeEnum];