/* tslint:disable */ /* eslint-disable */ /** * Identity Security Cloud API - Machine Identities * Use these APIs to interact with the Identity Security Cloud platform to achieve repeatable, automated processes with greater scalability. We encourage you to join the SailPoint Developer Community forum at https://developer.sailpoint.com/discuss to connect with other developers using our APIs. * * The version of the OpenAPI document: v1 * * * NOTE: This class is auto generated by OpenAPI Generator (https://openapi-generator.tech). * https://openapi-generator.tech * Do not edit the class manually. */ import type { Configuration } from '../configuration'; import type { AxiosPromise, AxiosInstance, RawAxiosRequestConfig } from 'axios'; import globalAxios from 'axios'; // Some imports not used depending on template conditions // @ts-ignore import { DUMMY_BASE_URL, assertParamExists, setApiKeyToObject, setBasicAuthToObject, setBearerAuthToObject, setOAuthToObject, setSearchParams, serializeDataIfNeeded, toPathString, createRequestFunction } from './common'; import type { RequestArgs } from './base'; // @ts-ignore import { BASE_PATH, COLLECTION_FORMATS, BaseAPI, RequiredError, operationServerMap } from './base'; /** * * @export * @interface ArrayInner */ export interface ArrayInner { } /** * * @export * @interface BaseCommonDto */ export interface BaseCommonDto { /** * System-generated unique ID of the Object * @type {string} * @memberof BaseCommonDto */ 'id'?: string; /** * Name of the Object * @type {string} * @memberof BaseCommonDto */ 'name': string | null; /** * Creation date of the Object * @type {string} * @memberof BaseCommonDto */ 'created'?: string; /** * Last modification date of the Object * @type {string} * @memberof BaseCommonDto */ 'modified'?: string; } /** * * @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; } /** * Reference to a Business Application associated with a machine identity. * @export * @interface BusinessApplicationRef */ export interface BusinessApplicationRef { /** * Reference type. * @type {string} * @memberof BusinessApplicationRef */ 'type'?: string; /** * Business Application ID. * @type {string} * @memberof BusinessApplicationRef */ 'id'?: string; /** * Business Application display name. * @type {string} * @memberof BusinessApplicationRef */ 'name'?: string | null; /** * * @type {SanctionedStatus} * @memberof BusinessApplicationRef */ 'sanctionedStatus'?: SanctionedStatus; /** * Whether the Business Application reference was manually assigned or automatically correlated. * @type {string} * @memberof BusinessApplicationRef */ 'correlationType'?: BusinessApplicationRefCorrelationTypeEnum; } export const BusinessApplicationRefCorrelationTypeEnum = { Manual: 'MANUAL', Automatic: 'AUTOMATIC' } as const; export type BusinessApplicationRefCorrelationTypeEnum = typeof BusinessApplicationRefCorrelationTypeEnum[keyof typeof BusinessApplicationRefCorrelationTypeEnum]; /** * A single condition expression within a correlation rule. * @export * @interface CorrelationCondition */ export interface CorrelationCondition { /** * System-generated unique ID of the condition. * @type {string} * @memberof CorrelationCondition */ 'id'?: string; /** * The left-hand attribute name of the condition. * @type {string} * @memberof CorrelationCondition */ 'leftAttributeName': string; /** * The comparison operator applied between the left and right attributes. * @type {string} * @memberof CorrelationCondition */ 'operatorType': string; /** * The right-hand attribute name. Use an empty string when there is no RHS attribute. * @type {string} * @memberof CorrelationCondition */ 'rightAttributeName': string; /** * Optional transform applied before comparison. * @type {string} * @memberof CorrelationCondition */ 'transform'?: string | null; /** * The position of this condition within the rule. * @type {number} * @memberof CorrelationCondition */ 'ordinal': number; } /** * An ownership correlation config scoped to a source resource. Configs are of type OWNER_PRIMARY or OWNER_SECONDARY and drive how machine identity owners are correlated. * @export * @interface CorrelationConfig */ export interface CorrelationConfig { /** * System-generated unique ID of the correlation config. * @type {string} * @memberof CorrelationConfig */ 'id': string; /** * The source ID this config belongs to. * @type {string} * @memberof CorrelationConfig */ 'sourceId': string; /** * The source resource identifier for this config scope. * @type {string} * @memberof CorrelationConfig */ 'resourceId': string; /** * The correlation config type. * @type {string} * @memberof CorrelationConfig */ 'type': CorrelationConfigTypeEnum; /** * JSON object of config attributes. May include syncPrimaryToMachineAccounts (boolean) on OWNER_PRIMARY only. * @type {{ [key: string]: any; }} * @memberof CorrelationConfig */ 'attributes': { [key: string]: any; }; /** * The ordered set of correlation rules for this config. * @type {Array} * @memberof CorrelationConfig */ 'rules': Array; /** * Creation date of the config. * @type {string} * @memberof CorrelationConfig */ 'created'?: string; /** * Last modification date of the config. * @type {string} * @memberof CorrelationConfig */ 'modified'?: string; } export const CorrelationConfigTypeEnum = { OwnerPrimary: 'OWNER_PRIMARY', OwnerSecondary: 'OWNER_SECONDARY' } as const; export type CorrelationConfigTypeEnum = typeof CorrelationConfigTypeEnum[keyof typeof CorrelationConfigTypeEnum]; /** * A single correlation rule within an ownership correlation config. * @export * @interface CorrelationRule */ export interface CorrelationRule { /** * Omit for new rules (server mints a UUID). Send only when updating a rule that already exists on this config (merge on PATCH). Unknown ids are rejected. * @type {string} * @memberof CorrelationRule */ 'id'?: string; /** * The evaluation priority of the rule. Lower values are evaluated first. * @type {number} * @memberof CorrelationRule */ 'priority': number; /** * Whether this rule is the default rule for the config. * @type {boolean} * @memberof CorrelationRule */ 'defaultRule': boolean; /** * The rule subject type. When either ruleType or ruleAction.type is GOVERNANCE_GROUP, both must be; ruleType GOVERNANCE_GROUP is allowed only when the parent config type is OWNER_SECONDARY. * @type {string} * @memberof CorrelationRule */ 'ruleType': CorrelationRuleRuleTypeEnum; /** * * @type {CorrelationRuleAction} * @memberof CorrelationRule */ 'ruleAction': CorrelationRuleAction; /** * The conditions that must match for this rule to apply. * @type {Array} * @memberof CorrelationRule */ 'conditionExpressions': Array; } export const CorrelationRuleRuleTypeEnum = { Identity: 'IDENTITY', Account: 'ACCOUNT', GovernanceGroup: 'GOVERNANCE_GROUP' } as const; export type CorrelationRuleRuleTypeEnum = typeof CorrelationRuleRuleTypeEnum[keyof typeof CorrelationRuleRuleTypeEnum]; /** * The action applied when a correlation rule matches. * @export * @interface CorrelationRuleAction */ export interface CorrelationRuleAction { /** * The target owner type resolved by this action. * @type {string} * @memberof CorrelationRuleAction */ 'type': CorrelationRuleActionTypeEnum; /** * Action-specific payload. * @type {{ [key: string]: any; }} * @memberof CorrelationRuleAction */ 'payload'?: { [key: string]: any; }; } export const CorrelationRuleActionTypeEnum = { Identity: 'IDENTITY', Account: 'ACCOUNT', GovernanceGroup: 'GOVERNANCE_GROUP' } as const; export type CorrelationRuleActionTypeEnum = typeof CorrelationRuleActionTypeEnum[keyof typeof CorrelationRuleActionTypeEnum]; /** * An enumeration of the types of DTOs supported within the IdentityNow infrastructure. * @export * @enum {string} */ export const DtoType = { AccountCorrelationConfig: 'ACCOUNT_CORRELATION_CONFIG', AccessProfile: 'ACCESS_PROFILE', AccessRequestApproval: 'ACCESS_REQUEST_APPROVAL', Account: 'ACCOUNT', Application: 'APPLICATION', Campaign: 'CAMPAIGN', CampaignFilter: 'CAMPAIGN_FILTER', Certification: 'CERTIFICATION', Cluster: 'CLUSTER', ConnectorSchema: 'CONNECTOR_SCHEMA', Entitlement: 'ENTITLEMENT', GovernanceGroup: 'GOVERNANCE_GROUP', Identity: 'IDENTITY', IdentityProfile: 'IDENTITY_PROFILE', IdentityRequest: 'IDENTITY_REQUEST', MachineIdentity: 'MACHINE_IDENTITY', LifecycleState: 'LIFECYCLE_STATE', PasswordPolicy: 'PASSWORD_POLICY', Role: 'ROLE', Rule: 'RULE', SodPolicy: 'SOD_POLICY', Source: 'SOURCE', Tag: 'TAG', TagCategory: 'TAG_CATEGORY', TaskResult: 'TASK_RESULT', ReportResult: 'REPORT_RESULT', SodViolation: 'SOD_VIOLATION', AccountActivity: 'ACCOUNT_ACTIVITY', Workgroup: 'WORKGROUP' } as const; export type DtoType = typeof DtoType[keyof typeof DtoType]; /** * * @export * @interface ErrorMessageDto */ export interface ErrorMessageDto { /** * The locale for the message text, a BCP 47 language tag. * @type {string} * @memberof ErrorMessageDto */ 'locale'?: string | null; /** * * @type {LocaleOrigin} * @memberof ErrorMessageDto */ 'localeOrigin'?: LocaleOrigin | null; /** * Actual text of the error message in the indicated locale. * @type {string} * @memberof ErrorMessageDto */ 'text'?: string; } /** * * @export * @interface ErrorResponseDto */ export interface ErrorResponseDto { /** * Fine-grained error code providing more detail of the error. * @type {string} * @memberof ErrorResponseDto */ 'detailCode'?: string; /** * Unique tracking id for the error. * @type {string} * @memberof ErrorResponseDto */ 'trackingId'?: string; /** * Generic localized reason for error * @type {Array} * @memberof ErrorResponseDto */ 'messages'?: Array; /** * Plain-text descriptive reasons to provide additional detail to the text provided in the messages field * @type {Array} * @memberof ErrorResponseDto */ 'causes'?: Array; } /** * 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 const JsonPatchOperationOpEnum = { Add: 'add', Remove: 'remove', Replace: 'replace', Move: 'move', Copy: 'copy', Test: 'test' } as const; 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 ListMachineIdentitiesV1401Response */ export interface ListMachineIdentitiesV1401Response { /** * A message describing the error * @type {any} * @memberof ListMachineIdentitiesV1401Response */ 'error'?: any; } /** * * @export * @interface ListMachineIdentitiesV1429Response */ export interface ListMachineIdentitiesV1429Response { /** * A message describing the error * @type {any} * @memberof ListMachineIdentitiesV1429Response */ 'message'?: any; } /** * An indicator of how the locale was selected. *DEFAULT* means the locale is the system default. *REQUEST* means the locale was selected from the request context (i.e., best match based on the *Accept-Language* header). Additional values may be added in the future without notice. * @export * @enum {string} */ export const LocaleOrigin = { Default: 'DEFAULT', Request: 'REQUEST' } as const; export type LocaleOrigin = typeof LocaleOrigin[keyof typeof LocaleOrigin]; /** * Localized error message to indicate a failed invocation or error if any. * @export * @interface LocalizedMessage */ export interface LocalizedMessage { /** * Message locale * @type {string} * @memberof LocalizedMessage */ 'locale': string; /** * Message text * @type {string} * @memberof LocalizedMessage */ 'message': string; } /** * * @export * @interface MachineIdentity */ export interface MachineIdentity { /** * System-generated unique ID of the Object * @type {string} * @memberof MachineIdentity */ 'id'?: string; /** * Name of the Object * @type {string} * @memberof MachineIdentity */ 'name': string | null; /** * Creation date of the Object * @type {string} * @memberof MachineIdentity */ 'created'?: string; /** * Last modification date of the Object * @type {string} * @memberof MachineIdentity */ 'modified'?: string; /** * The native identity associated to the machine identity directly aggregated from a source * @type {string} * @memberof MachineIdentity */ 'nativeIdentity': string; /** * Description of machine identity * @type {string} * @memberof MachineIdentity */ 'description'?: string; /** * A map of custom machine identity attributes * @type {object} * @memberof MachineIdentity */ 'attributes'?: object; /** * The subtype value associated to the machine identity * @type {string} * @memberof MachineIdentity */ 'subtype': string; /** * * @type {MachineIdentityDtoOwners} * @memberof MachineIdentity */ 'owners'?: MachineIdentityDtoOwners; /** * The source id associated to the machine identity * @type {string} * @memberof MachineIdentity */ 'sourceId'?: string; /** * The UUID associated to the machine identity directly aggregated from a source * @type {string} * @memberof MachineIdentity */ 'uuid'?: string; } /** * * @export * @interface MachineIdentityAggregationRequest */ export interface MachineIdentityAggregationRequest { /** * List of dataset Ids to aggregate machine identities * @type {Array} * @memberof MachineIdentityAggregationRequest */ 'datasetIds': Array; /** * Flag to disable optimization for the aggregation. Defaults to false when not provided. When set to true, it disables aggregation optimizations and may increase processing time. * @type {boolean} * @memberof MachineIdentityAggregationRequest */ 'disableOptimization'?: boolean; } /** * * @export * @interface MachineIdentityAggregationResponse */ export interface MachineIdentityAggregationResponse { /** * System-generated unique ID of the Object * @type {string} * @memberof MachineIdentityAggregationResponse */ 'id'?: string; /** * Type of task for aggregation * @type {string} * @memberof MachineIdentityAggregationResponse */ 'type'?: MachineIdentityAggregationResponseTypeEnum; /** * Name of the task for aggregation * @type {string} * @memberof MachineIdentityAggregationResponse */ 'uniqueName'?: string; /** * Description of the aggregation * @type {string} * @memberof MachineIdentityAggregationResponse */ 'description'?: string; /** * Name of the parent of the task for aggregation * @type {string} * @memberof MachineIdentityAggregationResponse */ 'parentName'?: string | null; /** * Service to execute the aggregation * @type {string} * @memberof MachineIdentityAggregationResponse */ 'launcher'?: string; /** * * @type {MachineIdentityAggregationResponseTarget} * @memberof MachineIdentityAggregationResponse */ 'target'?: MachineIdentityAggregationResponseTarget; /** * Creation date of the aggregation * @type {string} * @memberof MachineIdentityAggregationResponse */ 'created'?: string; /** * Last modification date of the aggregation * @type {string} * @memberof MachineIdentityAggregationResponse */ 'modified'?: string; /** * Launch date of the aggregation * @type {string} * @memberof MachineIdentityAggregationResponse */ 'launched'?: string | null; /** * Completion date of the aggregation * @type {string} * @memberof MachineIdentityAggregationResponse */ 'completed'?: string | null; /** * * @type {TaskDefinitionSummary} * @memberof MachineIdentityAggregationResponse */ 'taskDefinitionSummary'?: TaskDefinitionSummary; /** * Completion status of the aggregation * @type {string} * @memberof MachineIdentityAggregationResponse */ 'completionStatus'?: MachineIdentityAggregationResponseCompletionStatusEnum | null; /** * Messages associated with the aggregation * @type {Array} * @memberof MachineIdentityAggregationResponse */ 'messages'?: Array; /** * Return values associated with the aggregation * @type {Array} * @memberof MachineIdentityAggregationResponse */ 'returns'?: Array; /** * Attributes of the aggregation * @type {{ [key: string]: any; }} * @memberof MachineIdentityAggregationResponse */ 'attributes'?: { [key: string]: any; }; /** * Current progress of aggregation * @type {string} * @memberof MachineIdentityAggregationResponse */ 'progress'?: string | null; /** * Current percentage completion of aggregation * @type {number} * @memberof MachineIdentityAggregationResponse */ 'percentComplete'?: number; } export const MachineIdentityAggregationResponseTypeEnum = { Quartz: 'QUARTZ', Qpoc: 'QPOC', QueuedTask: 'QUEUED_TASK' } as const; export type MachineIdentityAggregationResponseTypeEnum = typeof MachineIdentityAggregationResponseTypeEnum[keyof typeof MachineIdentityAggregationResponseTypeEnum]; export const MachineIdentityAggregationResponseCompletionStatusEnum = { Success: 'SUCCESS', Warning: 'WARNING', Error: 'ERROR', Terminated: 'TERMINATED', Temperror: 'TEMPERROR' } as const; export type MachineIdentityAggregationResponseCompletionStatusEnum = typeof MachineIdentityAggregationResponseCompletionStatusEnum[keyof typeof MachineIdentityAggregationResponseCompletionStatusEnum]; /** * The target(source) of the aggregation * @export * @interface MachineIdentityAggregationResponseTarget */ export interface MachineIdentityAggregationResponseTarget { /** * * @type {DtoType} * @memberof MachineIdentityAggregationResponseTarget */ 'type'?: DtoType; /** * ID of the object to which this reference applies * @type {string} * @memberof MachineIdentityAggregationResponseTarget */ 'id'?: string; /** * Human-readable display name of the object to which this reference applies * @type {string} * @memberof MachineIdentityAggregationResponseTarget */ 'name'?: string; } /** * The owner configuration associated to the machine identity * @export * @interface MachineIdentityDtoOwners */ export interface MachineIdentityDtoOwners { /** * Defines the identity which is selected as the primary owner * @type {object} * @memberof MachineIdentityDtoOwners */ 'primaryIdentity': object; /** * Defines the identities which are selected as secondary owners * @type {Array} * @memberof MachineIdentityDtoOwners */ 'secondaryIdentities': Array; } /** * Owner configuration for a machine identity. A single primary (human IDENTITY) owner plus additional owners that are either up to ten human (IDENTITY) references or exactly one GOVERNANCE_GROUP reference - not both. * @export * @interface MachineIdentityOwnersV2 */ export interface MachineIdentityOwnersV2 { /** * * @type {MachineIdentityOwnersV2Primary} * @memberof MachineIdentityOwnersV2 */ 'primary'?: MachineIdentityOwnersV2Primary; /** * Additional owners. Entries are either up to ten human (IDENTITY) references or exactly one GOVERNANCE_GROUP reference - not both. Governance-group owners appear here with type GOVERNANCE_GROUP. * @type {Array} * @memberof MachineIdentityOwnersV2 */ 'secondary'?: Array; } /** * The identity selected as the primary owner. * @export * @interface MachineIdentityOwnersV2Primary */ export interface MachineIdentityOwnersV2Primary { /** * * @type {DtoType} * @memberof MachineIdentityOwnersV2Primary */ 'type'?: DtoType; /** * ID of the object to which this reference applies * @type {string} * @memberof MachineIdentityOwnersV2Primary */ 'id'?: string; /** * Human-readable display name of the object to which this reference applies * @type {string} * @memberof MachineIdentityOwnersV2Primary */ 'name'?: string; } /** * * @export * @interface MachineIdentityRequest */ export interface MachineIdentityRequest { /** * System-generated unique ID of the Object * @type {string} * @memberof MachineIdentityRequest */ 'id'?: string; /** * Name of the Object * @type {string} * @memberof MachineIdentityRequest */ 'name': string | null; /** * Creation date of the Object * @type {string} * @memberof MachineIdentityRequest */ 'created'?: string; /** * Last modification date of the Object * @type {string} * @memberof MachineIdentityRequest */ 'modified'?: string; /** * The native identity associated to the machine identity directly aggregated from a source * @type {string} * @memberof MachineIdentityRequest */ 'nativeIdentity': string; /** * Description of machine identity * @type {string} * @memberof MachineIdentityRequest */ 'description'?: string; /** * A map of custom machine identity attributes * @type {object} * @memberof MachineIdentityRequest */ 'attributes'?: object; /** * The subtype value associated to the machine identity * @type {string} * @memberof MachineIdentityRequest */ 'subtype': string; /** * * @type {MachineIdentityDtoOwners} * @memberof MachineIdentityRequest */ 'owners'?: MachineIdentityDtoOwners; /** * The source id associated to the machine identity * @type {string} * @memberof MachineIdentityRequest */ 'sourceId'?: string; /** * The UUID associated to the machine identity directly aggregated from a source * @type {string} * @memberof MachineIdentityRequest */ 'uuid'?: string; /** * The user entitlements associated to the machine identity * @type {Array} * @memberof MachineIdentityRequest */ 'userEntitlements'?: Array; } /** * * @export * @interface MachineIdentityRequestUserEntitlements */ export interface MachineIdentityRequestUserEntitlements { /** * The ID of the entitlement * @type {string} * @memberof MachineIdentityRequestUserEntitlements */ 'entitlementId': string; /** * The source ID of the entitlement * @type {string} * @memberof MachineIdentityRequestUserEntitlements */ 'sourceId': string; } /** * * @export * @interface MachineIdentityResponse */ export interface MachineIdentityResponse { /** * System-generated unique ID of the Object * @type {string} * @memberof MachineIdentityResponse */ 'id'?: string; /** * Name of the Object * @type {string} * @memberof MachineIdentityResponse */ 'name': string | null; /** * Creation date of the Object * @type {string} * @memberof MachineIdentityResponse */ 'created'?: string; /** * Last modification date of the Object * @type {string} * @memberof MachineIdentityResponse */ 'modified'?: string; /** * The native identity associated to the machine identity directly aggregated from a source * @type {string} * @memberof MachineIdentityResponse */ 'nativeIdentity': string; /** * Description of machine identity * @type {string} * @memberof MachineIdentityResponse */ 'description'?: string; /** * A map of custom machine identity attributes * @type {object} * @memberof MachineIdentityResponse */ 'attributes'?: object; /** * The subtype value associated to the machine identity * @type {string} * @memberof MachineIdentityResponse */ 'subtype': string; /** * * @type {MachineIdentityDtoOwners} * @memberof MachineIdentityResponse */ 'owners'?: MachineIdentityDtoOwners; /** * The source id associated to the machine identity * @type {string} * @memberof MachineIdentityResponse */ 'sourceId'?: string; /** * The UUID associated to the machine identity directly aggregated from a source * @type {string} * @memberof MachineIdentityResponse */ 'uuid'?: string; /** * Indicates if the machine identity has been manually edited * @type {boolean} * @memberof MachineIdentityResponse */ 'manuallyEdited'?: boolean; /** * Indicates if the machine identity has been manually created * @type {boolean} * @memberof MachineIdentityResponse */ 'manuallyCreated'?: boolean; /** * The source of the machine identity * @type {object} * @memberof MachineIdentityResponse */ 'source'?: object; /** * The dataset id associated to the source in which the identity was retrieved from * @type {string} * @memberof MachineIdentityResponse */ 'datasetId'?: string; /** * The user entitlements associated to the machine identity * @type {Array} * @memberof MachineIdentityResponse */ 'userEntitlements'?: Array; } /** * * @export * @interface MachineIdentityResponseUserEntitlements */ export interface MachineIdentityResponseUserEntitlements { /** * The source ID of the entitlement * @type {string} * @memberof MachineIdentityResponseUserEntitlements */ 'sourceId'?: string; /** * The ID of the entitlement * @type {string} * @memberof MachineIdentityResponseUserEntitlements */ 'entitlementId'?: string; /** * The display name of the entitlement * @type {string} * @memberof MachineIdentityResponseUserEntitlements */ 'displayName'?: string; /** * The source of the entitlement * @type {object} * @memberof MachineIdentityResponseUserEntitlements */ 'source'?: object; } /** * * @export * @interface MachineIdentityUserEntitlementResponse */ export interface MachineIdentityUserEntitlementResponse { /** * System-generated unique ID of the Object * @type {string} * @memberof MachineIdentityUserEntitlementResponse */ 'id'?: string; /** * System-generated unique ID of the Machine Identity * @type {string} * @memberof MachineIdentityUserEntitlementResponse */ 'machineIdentityId'?: string; /** * * @type {MachineIdentityUserEntitlementResponseSource} * @memberof MachineIdentityUserEntitlementResponse */ 'source'?: MachineIdentityUserEntitlementResponseSource; /** * * @type {MachineIdentityUserEntitlementResponseEntitlement} * @memberof MachineIdentityUserEntitlementResponse */ 'entitlement'?: MachineIdentityUserEntitlementResponseEntitlement; /** * Creation date of the Object * @type {string} * @memberof MachineIdentityUserEntitlementResponse */ 'created'?: string; } /** * The user entitlement * @export * @interface MachineIdentityUserEntitlementResponseEntitlement */ export interface MachineIdentityUserEntitlementResponseEntitlement { /** * * @type {DtoType} * @memberof MachineIdentityUserEntitlementResponseEntitlement */ 'type'?: DtoType; /** * ID of the object to which this reference applies * @type {string} * @memberof MachineIdentityUserEntitlementResponseEntitlement */ 'id'?: string; /** * Human-readable display name of the object to which this reference applies * @type {string} * @memberof MachineIdentityUserEntitlementResponseEntitlement */ 'name'?: string; } /** * The source of the user entitlement * @export * @interface MachineIdentityUserEntitlementResponseSource */ export interface MachineIdentityUserEntitlementResponseSource { /** * * @type {DtoType} * @memberof MachineIdentityUserEntitlementResponseSource */ 'type'?: DtoType; /** * ID of the object to which this reference applies * @type {string} * @memberof MachineIdentityUserEntitlementResponseSource */ 'id'?: string; /** * Human-readable display name of the object to which this reference applies * @type {string} * @memberof MachineIdentityUserEntitlementResponseSource */ 'name'?: string; } /** * Risk data for the machine identity; null when no risk data has landed yet. * @export * @interface MachineIdentityV2Risk */ export interface MachineIdentityV2Risk { /** * Normalised risk score 0.0-100.0. * @type {number} * @memberof MachineIdentityV2Risk */ 'score'?: number; /** * Risk severity bucket. * @type {string} * @memberof MachineIdentityV2Risk */ 'severity'?: MachineIdentityV2RiskSeverityEnum; } export const MachineIdentityV2RiskSeverityEnum = { Critical: 'CRITICAL', High: 'HIGH', Medium: 'MEDIUM', Low: 'LOW' } as const; export type MachineIdentityV2RiskSeverityEnum = typeof MachineIdentityV2RiskSeverityEnum[keyof typeof MachineIdentityV2RiskSeverityEnum]; /** * The source of the machine identity. * @export * @interface MachineIdentityV2Source */ export interface MachineIdentityV2Source { /** * * @type {DtoType} * @memberof MachineIdentityV2Source */ 'type'?: DtoType; /** * ID of the object to which this reference applies * @type {string} * @memberof MachineIdentityV2Source */ 'id'?: string; /** * Human-readable display name of the object to which this reference applies * @type {string} * @memberof MachineIdentityV2Source */ 'name'?: string; } /** * * @export * @interface Machineidentityv2 */ export interface Machineidentityv2 { /** * System-generated unique ID of the Object * @type {string} * @memberof Machineidentityv2 */ 'id'?: string; /** * Name of the Object * @type {string} * @memberof Machineidentityv2 */ 'name': string | null; /** * Creation date of the Object * @type {string} * @memberof Machineidentityv2 */ 'created'?: string; /** * Last modification date of the Object * @type {string} * @memberof Machineidentityv2 */ 'modified'?: string; /** * Description of the machine identity. * @type {string} * @memberof Machineidentityv2 */ 'description'?: string; /** * A map of custom machine identity attributes. * @type {{ [key: string]: any; }} * @memberof Machineidentityv2 */ 'attributes'?: { [key: string]: any; }; /** * A map of attributes sourced from the connector during aggregation. * @type {{ [key: string]: any; }} * @memberof Machineidentityv2 */ 'connectorAttributes'?: { [key: string]: any; }; /** * Indicates if the machine identity has been manually edited. * @type {boolean} * @memberof Machineidentityv2 */ 'manuallyEdited'?: boolean; /** * Indicates if the machine identity has been manually created. * @type {boolean} * @memberof Machineidentityv2 */ 'manuallyCreated'?: boolean; /** * * @type {MachineIdentityOwnersV2} * @memberof Machineidentityv2 */ 'owners'?: MachineIdentityOwnersV2; /** * The subtype value associated to the machine identity. * @type {string} * @memberof Machineidentityv2 */ 'subtype'?: string; /** * The source id associated to the machine identity. * @type {string} * @memberof Machineidentityv2 */ 'sourceId'?: string; /** * The UUID associated to the machine identity directly aggregated from a source. * @type {string} * @memberof Machineidentityv2 */ 'uuid'?: string; /** * The native identity associated to the machine identity directly aggregated from a source. * @type {string} * @memberof Machineidentityv2 */ 'nativeIdentity'?: string; /** * The dataset id associated to the source from which the identity was retrieved. * @type {string} * @memberof Machineidentityv2 */ 'datasetId'?: string; /** * The environment the machine identity belongs to. * @type {string} * @memberof Machineidentityv2 */ 'environment'?: string; /** * Indicates whether the machine identity still exists on the source. * @type {string} * @memberof Machineidentityv2 */ 'existsOnSource'?: string; /** * Operational status read from stored attributes.status; null when absent. * @type {string} * @memberof Machineidentityv2 */ 'status'?: string | null; /** * * @type {ResourceV2} * @memberof Machineidentityv2 */ 'resource'?: ResourceV2; /** * * @type {MachineIdentityV2Source} * @memberof Machineidentityv2 */ 'source'?: MachineIdentityV2Source; /** * The user entitlements associated to the machine identity. * @type {Array} * @memberof Machineidentityv2 */ 'userEntitlements'?: Array; /** * Optional Business Application references associated with this machine identity. * @type {Array} * @memberof Machineidentityv2 */ 'businessApplicationRefs'?: Array | null; /** * * @type {SanctionedStatus} * @memberof Machineidentityv2 */ 'effectiveSanctionedStatus'?: SanctionedStatus; /** * * @type {MachineIdentityV2Risk} * @memberof Machineidentityv2 */ 'risk'?: MachineIdentityV2Risk; } /** * The source resource a machine identity is derived from. * @export * @interface ResourceV2 */ export interface ResourceV2 { /** * The source resource identifier. * @type {string} * @memberof ResourceV2 */ 'id'?: string; /** * The type of the source resource. * @type {string} * @memberof ResourceV2 */ 'type'?: string; /** * The display name of the source resource. * @type {string} * @memberof ResourceV2 */ 'name'?: string; /** * The set of features supported by the source resource. * @type {Array} * @memberof ResourceV2 */ 'features'?: Array; } /** * Sanctioned status for a Business Application or derived machine identity effective status. * @export * @enum {string} */ export const SanctionedStatus = { Sanctioned: 'SANCTIONED', Unsanctioned: 'UNSANCTIONED', Unknown: 'UNKNOWN' } as const; export type SanctionedStatus = typeof SanctionedStatus[keyof typeof SanctionedStatus]; /** * Definition of a type of task, used to invoke tasks * @export * @interface TaskDefinitionSummary */ export interface TaskDefinitionSummary { /** * System-generated unique ID of the TaskDefinition * @type {string} * @memberof TaskDefinitionSummary */ 'id': string; /** * Name of the TaskDefinition * @type {string} * @memberof TaskDefinitionSummary */ 'uniqueName': string; /** * Description of the TaskDefinition * @type {string} * @memberof TaskDefinitionSummary */ 'description': string | null; /** * Name of the parent of the TaskDefinition * @type {string} * @memberof TaskDefinitionSummary */ 'parentName': string; /** * Executor of the TaskDefinition * @type {string} * @memberof TaskDefinitionSummary */ 'executor': string | null; /** * Formal parameters of the TaskDefinition, without values * @type {{ [key: string]: any; }} * @memberof TaskDefinitionSummary */ 'arguments': { [key: string]: any; }; } /** * Task return details * @export * @interface TaskReturnDetails */ export interface TaskReturnDetails { /** * Display name of the TaskReturnDetails * @type {string} * @memberof TaskReturnDetails */ 'name': string; /** * Attribute the TaskReturnDetails is for * @type {string} * @memberof TaskReturnDetails */ 'attributeName': string; } /** * TaskStatus Message * @export * @interface TaskStatusMessage */ export interface TaskStatusMessage { /** * Type of the message * @type {string} * @memberof TaskStatusMessage */ 'type': TaskStatusMessageTypeEnum; /** * * @type {LocalizedMessage} * @memberof TaskStatusMessage */ 'localizedText': LocalizedMessage | null; /** * Key of the message * @type {string} * @memberof TaskStatusMessage */ 'key': string; /** * Message parameters for internationalization * @type {Array} * @memberof TaskStatusMessage */ 'parameters': Array | null; } export const TaskStatusMessageTypeEnum = { Info: 'INFO', Warn: 'WARN', Error: 'ERROR' } as const; export type TaskStatusMessageTypeEnum = typeof TaskStatusMessageTypeEnum[keyof typeof TaskStatusMessageTypeEnum]; /** * * @export * @interface TaskStatusMessageParametersInner */ export interface TaskStatusMessageParametersInner { } /** * A user entitlement associated to a machine identity. * @export * @interface UserEntitlementV2 */ export interface UserEntitlementV2 { /** * The source ID of the entitlement. * @type {string} * @memberof UserEntitlementV2 */ 'sourceId'?: string; /** * The ID of the entitlement. * @type {string} * @memberof UserEntitlementV2 */ 'entitlementId'?: string; /** * The display name of the entitlement. * @type {string} * @memberof UserEntitlementV2 */ 'displayName'?: string; /** * * @type {UserEntitlementV2Source} * @memberof UserEntitlementV2 */ 'source'?: UserEntitlementV2Source; } /** * The source of the entitlement. * @export * @interface UserEntitlementV2Source */ export interface UserEntitlementV2Source { /** * * @type {DtoType} * @memberof UserEntitlementV2Source */ 'type'?: DtoType; /** * ID of the object to which this reference applies * @type {string} * @memberof UserEntitlementV2Source */ 'id'?: string; /** * Human-readable display name of the object to which this reference applies * @type {string} * @memberof UserEntitlementV2Source */ 'name'?: string; } /** * MachineIdentitiesApi - axios parameter creator * @export */ export const MachineIdentitiesApiAxiosParamCreator = function (configuration?: Configuration) { return { /** * Use this API to create a machine identity. The maximum supported length for the description field is 2000 characters. * @summary Create machine identity * @param {MachineIdentityRequest} machineIdentityRequest * @param {string} [xSailPointExperimental] Use this header to enable this experimental API. * @param {*} [axiosOptions] Override http request option. * @throws {RequiredError} */ createMachineIdentityV1: async (machineIdentityRequest: MachineIdentityRequest, xSailPointExperimental?: string, axiosOptions: RawAxiosRequestConfig = {}): Promise => { // verify required parameter 'machineIdentityRequest' is not null or undefined assertParamExists('createMachineIdentityV1', 'machineIdentityRequest', machineIdentityRequest) if (xSailPointExperimental === undefined) { xSailPointExperimental = 'true'; } const localVarPath = `/machine-identities/v1`; // use dummy base URL string because the URL constructor only accepts absolute URLs. const localVarUrlObj = new URL(localVarPath, DUMMY_BASE_URL); let baseOptions; if (configuration) { baseOptions = configuration.baseOptions; } const localVarRequestOptions = { method: 'POST', ...baseOptions, ...axiosOptions}; const localVarHeaderParameter = {} as any; const localVarQueryParameter = {} as any; localVarHeaderParameter['Content-Type'] = 'application/json'; if (xSailPointExperimental != null) { localVarHeaderParameter['X-SailPoint-Experimental'] = String(xSailPointExperimental); } setSearchParams(localVarUrlObj, localVarQueryParameter); let headersFromBaseOptions = baseOptions && baseOptions.headers ? baseOptions.headers : {}; localVarRequestOptions.headers = {...localVarHeaderParameter, ...headersFromBaseOptions, ...axiosOptions.headers}; localVarRequestOptions.data = serializeDataIfNeeded(machineIdentityRequest, localVarRequestOptions, configuration) return { url: toPathString(localVarUrlObj), axiosOptions: localVarRequestOptions, }; }, /** * Use this API to create a machine identity. Additional owners may be either up to ten human (IDENTITY) references or exactly one GOVERNANCE_GROUP reference - not both. The maximum supported length for the description field is 2000 characters. * @summary Create machine identity * @param {Machineidentityv2} machineidentityv2 * @param {*} [axiosOptions] Override http request option. * @throws {RequiredError} */ createMachineIdentityV2: async (machineidentityv2: Machineidentityv2, axiosOptions: RawAxiosRequestConfig = {}): Promise => { // verify required parameter 'machineidentityv2' is not null or undefined assertParamExists('createMachineIdentityV2', 'machineidentityv2', machineidentityv2) const localVarPath = `/machine-identities/v2`; // use dummy base URL string because the URL constructor only accepts absolute URLs. const localVarUrlObj = new URL(localVarPath, DUMMY_BASE_URL); let baseOptions; if (configuration) { baseOptions = configuration.baseOptions; } const localVarRequestOptions = { method: 'POST', ...baseOptions, ...axiosOptions}; const localVarHeaderParameter = {} as any; const localVarQueryParameter = {} as any; localVarHeaderParameter['Content-Type'] = 'application/json'; setSearchParams(localVarUrlObj, localVarQueryParameter); let headersFromBaseOptions = baseOptions && baseOptions.headers ? baseOptions.headers : {}; localVarRequestOptions.headers = {...localVarHeaderParameter, ...headersFromBaseOptions, ...axiosOptions.headers}; localVarRequestOptions.data = serializeDataIfNeeded(machineidentityv2, localVarRequestOptions, configuration) return { url: toPathString(localVarUrlObj), axiosOptions: localVarRequestOptions, }; }, /** * The API returns successful response if the requested machine identity was deleted. * @summary Delete machine identity * @param {string} id Machine Identity ID * @param {string} [xSailPointExperimental] Use this header to enable this experimental API. * @param {*} [axiosOptions] Override http request option. * @throws {RequiredError} */ deleteMachineIdentityV1: async (id: string, xSailPointExperimental?: string, axiosOptions: RawAxiosRequestConfig = {}): Promise => { // verify required parameter 'id' is not null or undefined assertParamExists('deleteMachineIdentityV1', 'id', id) if (xSailPointExperimental === undefined) { xSailPointExperimental = 'true'; } const localVarPath = `/machine-identities/v1/{id}` .replace(`{${"id"}}`, encodeURIComponent(String(id))); // use dummy base URL string because the URL constructor only accepts absolute URLs. const localVarUrlObj = new URL(localVarPath, DUMMY_BASE_URL); let baseOptions; if (configuration) { baseOptions = configuration.baseOptions; } const localVarRequestOptions = { method: 'DELETE', ...baseOptions, ...axiosOptions}; const localVarHeaderParameter = {} as any; const localVarQueryParameter = {} as any; if (xSailPointExperimental != null) { localVarHeaderParameter['X-SailPoint-Experimental'] = String(xSailPointExperimental); } setSearchParams(localVarUrlObj, localVarQueryParameter); let headersFromBaseOptions = baseOptions && baseOptions.headers ? baseOptions.headers : {}; localVarRequestOptions.headers = {...localVarHeaderParameter, ...headersFromBaseOptions, ...axiosOptions.headers}; return { url: toPathString(localVarUrlObj), axiosOptions: localVarRequestOptions, }; }, /** * The API returns a successful response if the requested machine identity was deleted. * @summary Delete machine identity * @param {string} id Machine Identity ID. * @param {*} [axiosOptions] Override http request option. * @throws {RequiredError} */ deleteMachineIdentityV2: async (id: string, axiosOptions: RawAxiosRequestConfig = {}): Promise => { // verify required parameter 'id' is not null or undefined assertParamExists('deleteMachineIdentityV2', 'id', id) const localVarPath = `/machine-identities/v2/{id}` .replace(`{${"id"}}`, encodeURIComponent(String(id))); // use dummy base URL string because the URL constructor only accepts absolute URLs. const localVarUrlObj = new URL(localVarPath, DUMMY_BASE_URL); let baseOptions; if (configuration) { baseOptions = configuration.baseOptions; } const localVarRequestOptions = { method: 'DELETE', ...baseOptions, ...axiosOptions}; const localVarHeaderParameter = {} as any; const localVarQueryParameter = {} as any; setSearchParams(localVarUrlObj, localVarQueryParameter); let headersFromBaseOptions = baseOptions && baseOptions.headers ? baseOptions.headers : {}; localVarRequestOptions.headers = {...localVarHeaderParameter, ...headersFromBaseOptions, ...axiosOptions.headers}; return { url: toPathString(localVarUrlObj), axiosOptions: localVarRequestOptions, }; }, /** * Deletes the ownership correlation config with the specified ID for the given source resource. * @summary Delete ownership correlation config * @param {string} sourceId The Source ID. * @param {string} resourceId The source resource ID (for example, account or aws:iam-role). * @param {string} configId The correlation config ID. * @param {*} [axiosOptions] Override http request option. * @throws {RequiredError} */ deleteOwnershipCorrelationConfigV1: async (sourceId: string, resourceId: string, configId: string, axiosOptions: RawAxiosRequestConfig = {}): Promise => { // verify required parameter 'sourceId' is not null or undefined assertParamExists('deleteOwnershipCorrelationConfigV1', 'sourceId', sourceId) // verify required parameter 'resourceId' is not null or undefined assertParamExists('deleteOwnershipCorrelationConfigV1', 'resourceId', resourceId) // verify required parameter 'configId' is not null or undefined assertParamExists('deleteOwnershipCorrelationConfigV1', 'configId', configId) const localVarPath = `/sources/v1/{sourceId}/resources/{resourceId}/correlation-configs/{configId}` .replace(`{${"sourceId"}}`, encodeURIComponent(String(sourceId))) .replace(`{${"resourceId"}}`, encodeURIComponent(String(resourceId))) .replace(`{${"configId"}}`, encodeURIComponent(String(configId))); // use dummy base URL string because the URL constructor only accepts absolute URLs. const localVarUrlObj = new URL(localVarPath, DUMMY_BASE_URL); let baseOptions; if (configuration) { baseOptions = configuration.baseOptions; } const localVarRequestOptions = { method: 'DELETE', ...baseOptions, ...axiosOptions}; const localVarHeaderParameter = {} as any; const localVarQueryParameter = {} as any; setSearchParams(localVarUrlObj, localVarQueryParameter); let headersFromBaseOptions = baseOptions && baseOptions.headers ? baseOptions.headers : {}; localVarRequestOptions.headers = {...localVarHeaderParameter, ...headersFromBaseOptions, ...axiosOptions.headers}; return { url: toPathString(localVarUrlObj), axiosOptions: localVarRequestOptions, }; }, /** * This API returns a single machine identity using the Machine Identity ID. * @summary Get machine identity details * @param {string} id Machine Identity ID * @param {string} [xSailPointExperimental] Use this header to enable this experimental API. * @param {*} [axiosOptions] Override http request option. * @throws {RequiredError} */ getMachineIdentityV1: async (id: string, xSailPointExperimental?: string, axiosOptions: RawAxiosRequestConfig = {}): Promise => { // verify required parameter 'id' is not null or undefined assertParamExists('getMachineIdentityV1', 'id', id) if (xSailPointExperimental === undefined) { xSailPointExperimental = 'true'; } const localVarPath = `/machine-identities/v1/{id}` .replace(`{${"id"}}`, encodeURIComponent(String(id))); // use dummy base URL string because the URL constructor only accepts absolute URLs. const localVarUrlObj = new URL(localVarPath, DUMMY_BASE_URL); let baseOptions; if (configuration) { baseOptions = configuration.baseOptions; } const localVarRequestOptions = { method: 'GET', ...baseOptions, ...axiosOptions}; const localVarHeaderParameter = {} as any; const localVarQueryParameter = {} as any; if (xSailPointExperimental != null) { localVarHeaderParameter['X-SailPoint-Experimental'] = String(xSailPointExperimental); } setSearchParams(localVarUrlObj, localVarQueryParameter); let headersFromBaseOptions = baseOptions && baseOptions.headers ? baseOptions.headers : {}; localVarRequestOptions.headers = {...localVarHeaderParameter, ...headersFromBaseOptions, ...axiosOptions.headers}; return { url: toPathString(localVarUrlObj), axiosOptions: localVarRequestOptions, }; }, /** * This API returns a single machine identity using the Machine Identity ID. * @summary Get machine identity details * @param {string} id Machine Identity ID. * @param {*} [axiosOptions] Override http request option. * @throws {RequiredError} */ getMachineIdentityV2: async (id: string, axiosOptions: RawAxiosRequestConfig = {}): Promise => { // verify required parameter 'id' is not null or undefined assertParamExists('getMachineIdentityV2', 'id', id) const localVarPath = `/machine-identities/v2/{id}` .replace(`{${"id"}}`, encodeURIComponent(String(id))); // use dummy base URL string because the URL constructor only accepts absolute URLs. const localVarUrlObj = new URL(localVarPath, DUMMY_BASE_URL); let baseOptions; if (configuration) { baseOptions = configuration.baseOptions; } const localVarRequestOptions = { method: 'GET', ...baseOptions, ...axiosOptions}; const localVarHeaderParameter = {} as any; const localVarQueryParameter = {} as any; setSearchParams(localVarUrlObj, localVarQueryParameter); let headersFromBaseOptions = baseOptions && baseOptions.headers ? baseOptions.headers : {}; localVarRequestOptions.headers = {...localVarHeaderParameter, ...headersFromBaseOptions, ...axiosOptions.headers}; return { url: toPathString(localVarUrlObj), axiosOptions: localVarRequestOptions, }; }, /** * This end-point retrieves a single ownership correlation config by ID for the specified source resource. * @summary Get ownership correlation config * @param {string} sourceId The Source ID. * @param {string} resourceId The source resource ID (for example, account or aws:iam-role). * @param {string} configId The correlation config ID. * @param {*} [axiosOptions] Override http request option. * @throws {RequiredError} */ getOwnershipCorrelationConfigV1: async (sourceId: string, resourceId: string, configId: string, axiosOptions: RawAxiosRequestConfig = {}): Promise => { // verify required parameter 'sourceId' is not null or undefined assertParamExists('getOwnershipCorrelationConfigV1', 'sourceId', sourceId) // verify required parameter 'resourceId' is not null or undefined assertParamExists('getOwnershipCorrelationConfigV1', 'resourceId', resourceId) // verify required parameter 'configId' is not null or undefined assertParamExists('getOwnershipCorrelationConfigV1', 'configId', configId) const localVarPath = `/sources/v1/{sourceId}/resources/{resourceId}/correlation-configs/{configId}` .replace(`{${"sourceId"}}`, encodeURIComponent(String(sourceId))) .replace(`{${"resourceId"}}`, encodeURIComponent(String(resourceId))) .replace(`{${"configId"}}`, encodeURIComponent(String(configId))); // use dummy base URL string because the URL constructor only accepts absolute URLs. const localVarUrlObj = new URL(localVarPath, DUMMY_BASE_URL); let baseOptions; if (configuration) { baseOptions = configuration.baseOptions; } const localVarRequestOptions = { method: 'GET', ...baseOptions, ...axiosOptions}; const localVarHeaderParameter = {} as any; const localVarQueryParameter = {} as any; setSearchParams(localVarUrlObj, localVarQueryParameter); let headersFromBaseOptions = baseOptions && baseOptions.headers ? baseOptions.headers : {}; localVarRequestOptions.headers = {...localVarHeaderParameter, ...headersFromBaseOptions, ...axiosOptions.headers}; return { url: toPathString(localVarUrlObj), axiosOptions: localVarRequestOptions, }; }, /** * This API returns a list of machine identities. * @summary List machine identities * @param {string} [filters] Filter results using the standard syntax described in [V3 API Standard Collection Parameters](https://developer.sailpoint.com/idn/api/standard-collection-parameters#filtering-results) Filtering is supported for the following fields and operators: **id**: *eq, in, sw* **displayName**: *eq, in, sw* **cisIdentityId**: *eq, in, sw* **nativeIdentity**: *eq, in, sw* **attributes**: *eq* **manuallyEdited**: *eq* **subtype**: *eq, in* **owners.primaryIdentity.id**: *eq, in, sw* **owners.primaryIdentity.name**: *eq, in, isnull, pr* **owners.secondaryIdentity.id**: *eq, in, sw* **owners.secondaryIdentity.name**: *eq, in, isnull, pr* **source.name**: *eq, in, sw* **source.id**: *eq, in* **entitlement.id**: *eq, in* **entitlement.name**: *eq, in, 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: **nativeIdentity, name, owners.primaryIdentity.name, source.name, created, modified** * @param {string} [xSailPointExperimental] Use this header to enable this experimental API. * @param {boolean} [count] If *true* it will populate the *X-Total-Count* response header with the number of results that would be returned if *limit* and *offset* were ignored. Since requesting a total count can have a performance impact, it is recommended not to send **count=true** if that value will not be used. See [V3 API Standard Collection Parameters](https://developer.sailpoint.com/idn/api/standard-collection-parameters) for more information. * @param {number} [limit] Max number of results to return. See [V3 API Standard Collection Parameters](https://developer.sailpoint.com/idn/api/standard-collection-parameters) for more information. * @param {number} [offset] Offset into the full result set. Usually specified with *limit* to paginate through the results. See [V3 API Standard Collection Parameters](https://developer.sailpoint.com/idn/api/standard-collection-parameters) for more information. * @param {*} [axiosOptions] Override http request option. * @throws {RequiredError} */ listMachineIdentitiesV1: async (filters?: string, sorters?: string, xSailPointExperimental?: string, count?: boolean, limit?: number, offset?: number, axiosOptions: RawAxiosRequestConfig = {}): Promise => { if (xSailPointExperimental === undefined) { xSailPointExperimental = 'true'; } const localVarPath = `/machine-identities/v1`; // use dummy base URL string because the URL constructor only accepts absolute URLs. const localVarUrlObj = new URL(localVarPath, DUMMY_BASE_URL); let baseOptions; if (configuration) { baseOptions = configuration.baseOptions; } const localVarRequestOptions = { method: 'GET', ...baseOptions, ...axiosOptions}; const localVarHeaderParameter = {} as any; const localVarQueryParameter = {} as any; if (filters !== undefined) { localVarQueryParameter['filters'] = filters; } if (sorters !== undefined) { localVarQueryParameter['sorters'] = sorters; } if (count !== undefined) { localVarQueryParameter['count'] = count; } if (limit !== undefined) { localVarQueryParameter['limit'] = limit; } if (offset !== undefined) { localVarQueryParameter['offset'] = offset; } if (xSailPointExperimental != null) { localVarHeaderParameter['X-SailPoint-Experimental'] = String(xSailPointExperimental); } setSearchParams(localVarUrlObj, localVarQueryParameter); let headersFromBaseOptions = baseOptions && baseOptions.headers ? baseOptions.headers : {}; localVarRequestOptions.headers = {...localVarHeaderParameter, ...headersFromBaseOptions, ...axiosOptions.headers}; return { url: toPathString(localVarUrlObj), axiosOptions: localVarRequestOptions, }; }, /** * This API returns a list of machine identities. * @summary List machine identities * @param {string} [filters] Filter results using the standard syntax described in [V3 API Standard Collection Parameters](https://developer.sailpoint.com/idn/api/standard-collection-parameters#filtering-results) Filtering is supported for the following fields and operators: **id**: *eq, in, sw* **displayName**: *eq, in, sw* **nativeIdentity**: *eq, in, sw* **attributes**: *eq* **manuallyEdited**: *eq* **subtype**: *eq, in* **owners.primaryIdentity.id**: *eq, in, sw* **owners.primaryIdentity.name**: *eq, in, isnull, pr* **owners.secondaryIdentity.id**: *eq, in, sw* **owners.secondaryIdentity.name**: *eq, in, isnull, pr* **owners.secondaryGovernanceGroup.id**: *eq, in* **owners.secondaryGovernanceGroup.name**: *eq, in, isnull, pr* **source.id**: *eq, in* **source.name**: *eq, in, sw* **entitlement.id**: *eq, in* **entitlement.name**: *eq, in, sw* **risk.severity**: *eq, in* * @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: **nativeIdentity, name, owners.primaryIdentity.name, source.name, created, modified** * @param {boolean} [count] If *true* it will populate the *X-Total-Count* response header with the number of results that would be returned if *limit* and *offset* were ignored. Since requesting a total count can have a performance impact, it is recommended not to send **count=true** if that value will not be used. See [V3 API Standard Collection Parameters](https://developer.sailpoint.com/idn/api/standard-collection-parameters) for more information. * @param {number} [limit] Max number of results to return. See [V3 API Standard Collection Parameters](https://developer.sailpoint.com/idn/api/standard-collection-parameters) for more information. * @param {number} [offset] Offset into the full result set. Usually specified with *limit* to paginate through the results. See [V3 API Standard Collection Parameters](https://developer.sailpoint.com/idn/api/standard-collection-parameters) for more information. * @param {*} [axiosOptions] Override http request option. * @throws {RequiredError} */ listMachineIdentitiesV2: async (filters?: string, sorters?: string, count?: boolean, limit?: number, offset?: number, axiosOptions: RawAxiosRequestConfig = {}): Promise => { const localVarPath = `/machine-identities/v2`; // use dummy base URL string because the URL constructor only accepts absolute URLs. const localVarUrlObj = new URL(localVarPath, DUMMY_BASE_URL); let baseOptions; if (configuration) { baseOptions = configuration.baseOptions; } const localVarRequestOptions = { method: 'GET', ...baseOptions, ...axiosOptions}; const localVarHeaderParameter = {} as any; const localVarQueryParameter = {} as any; if (filters !== undefined) { localVarQueryParameter['filters'] = filters; } if (sorters !== undefined) { localVarQueryParameter['sorters'] = sorters; } if (count !== undefined) { localVarQueryParameter['count'] = count; } if (limit !== undefined) { localVarQueryParameter['limit'] = limit; } if (offset !== undefined) { localVarQueryParameter['offset'] = offset; } setSearchParams(localVarUrlObj, localVarQueryParameter); let headersFromBaseOptions = baseOptions && baseOptions.headers ? baseOptions.headers : {}; localVarRequestOptions.headers = {...localVarHeaderParameter, ...headersFromBaseOptions, ...axiosOptions.headers}; return { url: toPathString(localVarUrlObj), axiosOptions: localVarRequestOptions, }; }, /** * This API returns a list of user entitlements associated with machine identities. * @summary List machine identity\'s user entitlements * @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: **machineIdentityId**: *eq, in* **machineIdentityName**: *eq, in, sw* **entitlement.id**: *eq, in* **entitlement.name**: *eq, in, sw* **source.id**: *eq, in* **source.name**: *eq, in, 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: **machineIdentityName, entitlement.name, source.name** * @param {string} [xSailPointExperimental] Use this header to enable this experimental API. * @param {boolean} [count] If *true* it will populate the *X-Total-Count* response header with the number of results that would be returned if *limit* and *offset* were ignored. Since requesting a total count can have a performance impact, it is recommended not to send **count=true** if that value will not be used. See [V3 API Standard Collection Parameters](https://developer.sailpoint.com/idn/api/standard-collection-parameters) for more information. * @param {number} [limit] Max number of results to return. See [V3 API Standard Collection Parameters](https://developer.sailpoint.com/idn/api/standard-collection-parameters) for more information. * @param {number} [offset] Offset into the full result set. Usually specified with *limit* to paginate through the results. See [V3 API Standard Collection Parameters](https://developer.sailpoint.com/idn/api/standard-collection-parameters) for more information. * @param {*} [axiosOptions] Override http request option. * @throws {RequiredError} */ listMachineIdentityUserEntitlementsV1: async (filters?: string, sorters?: string, xSailPointExperimental?: string, count?: boolean, limit?: number, offset?: number, axiosOptions: RawAxiosRequestConfig = {}): Promise => { if (xSailPointExperimental === undefined) { xSailPointExperimental = 'true'; } const localVarPath = `/machine-identity-user-entitlements/v1`; // use dummy base URL string because the URL constructor only accepts absolute URLs. const localVarUrlObj = new URL(localVarPath, DUMMY_BASE_URL); let baseOptions; if (configuration) { baseOptions = configuration.baseOptions; } const localVarRequestOptions = { method: 'GET', ...baseOptions, ...axiosOptions}; const localVarHeaderParameter = {} as any; const localVarQueryParameter = {} as any; if (filters !== undefined) { localVarQueryParameter['filters'] = filters; } if (sorters !== undefined) { localVarQueryParameter['sorters'] = sorters; } if (count !== undefined) { localVarQueryParameter['count'] = count; } if (limit !== undefined) { localVarQueryParameter['limit'] = limit; } if (offset !== undefined) { localVarQueryParameter['offset'] = offset; } if (xSailPointExperimental != null) { localVarHeaderParameter['X-SailPoint-Experimental'] = String(xSailPointExperimental); } setSearchParams(localVarUrlObj, localVarQueryParameter); let headersFromBaseOptions = baseOptions && baseOptions.headers ? baseOptions.headers : {}; localVarRequestOptions.headers = {...localVarHeaderParameter, ...headersFromBaseOptions, ...axiosOptions.headers}; return { url: toPathString(localVarUrlObj), axiosOptions: localVarRequestOptions, }; }, /** * Returns the OWNER_PRIMARY and OWNER_SECONDARY correlation configs for the specified source resource, creating default rows if they are missing. Use the optional type query parameter to return a single matching config. * @summary List ownership correlation configs * @param {string} sourceId The Source ID. * @param {string} resourceId The source resource ID (for example, account or aws:iam-role). * @param {ListOwnershipCorrelationConfigsV1TypeEnum} [type] When set, filters to the given config type. * @param {boolean} [count] If *true* it will populate the *X-Total-Count* response header with the number of results that would be returned if *limit* and *offset* were ignored. Since requesting a total count can have a performance impact, it is recommended not to send **count=true** if that value will not be used. See [V3 API Standard Collection Parameters](https://developer.sailpoint.com/idn/api/standard-collection-parameters) for more information. * @param {number} [limit] Max number of results to return. See [V3 API Standard Collection Parameters](https://developer.sailpoint.com/idn/api/standard-collection-parameters) for more information. * @param {number} [offset] Offset into the full result set. Usually specified with *limit* to paginate through the results. See [V3 API Standard Collection Parameters](https://developer.sailpoint.com/idn/api/standard-collection-parameters) for more information. * @param {*} [axiosOptions] Override http request option. * @throws {RequiredError} */ listOwnershipCorrelationConfigsV1: async (sourceId: string, resourceId: string, type?: ListOwnershipCorrelationConfigsV1TypeEnum, count?: boolean, limit?: number, offset?: number, axiosOptions: RawAxiosRequestConfig = {}): Promise => { // verify required parameter 'sourceId' is not null or undefined assertParamExists('listOwnershipCorrelationConfigsV1', 'sourceId', sourceId) // verify required parameter 'resourceId' is not null or undefined assertParamExists('listOwnershipCorrelationConfigsV1', 'resourceId', resourceId) const localVarPath = `/sources/v1/{sourceId}/resources/{resourceId}/correlation-configs` .replace(`{${"sourceId"}}`, encodeURIComponent(String(sourceId))) .replace(`{${"resourceId"}}`, encodeURIComponent(String(resourceId))); // use dummy base URL string because the URL constructor only accepts absolute URLs. const localVarUrlObj = new URL(localVarPath, DUMMY_BASE_URL); let baseOptions; if (configuration) { baseOptions = configuration.baseOptions; } const localVarRequestOptions = { method: 'GET', ...baseOptions, ...axiosOptions}; const localVarHeaderParameter = {} as any; const localVarQueryParameter = {} as any; if (type !== undefined) { localVarQueryParameter['type'] = type; } if (count !== undefined) { localVarQueryParameter['count'] = count; } if (limit !== undefined) { localVarQueryParameter['limit'] = limit; } if (offset !== undefined) { localVarQueryParameter['offset'] = offset; } setSearchParams(localVarUrlObj, localVarQueryParameter); let headersFromBaseOptions = baseOptions && baseOptions.headers ? baseOptions.headers : {}; localVarRequestOptions.headers = {...localVarHeaderParameter, ...headersFromBaseOptions, ...axiosOptions.headers}; return { url: toPathString(localVarUrlObj), axiosOptions: localVarRequestOptions, }; }, /** * Selectively updates an ownership correlation config using an RFC 6902 JSONPatch payload. Only replace on /attributes (full object) and replace on /rules (full array; merge by stable rule id, remove rules omitted from the array) are allowed. * @summary Patch ownership correlation config * @param {string} sourceId The Source ID. * @param {string} resourceId The source resource ID (for example, account or aws:iam-role). * @param {string} configId The correlation config ID. * @param {Array} jsonPatchOperation The JSONPatch payload used to update the correlation config. * @param {*} [axiosOptions] Override http request option. * @throws {RequiredError} */ patchOwnershipCorrelationConfigV1: async (sourceId: string, resourceId: string, configId: string, jsonPatchOperation: Array, axiosOptions: RawAxiosRequestConfig = {}): Promise => { // verify required parameter 'sourceId' is not null or undefined assertParamExists('patchOwnershipCorrelationConfigV1', 'sourceId', sourceId) // verify required parameter 'resourceId' is not null or undefined assertParamExists('patchOwnershipCorrelationConfigV1', 'resourceId', resourceId) // verify required parameter 'configId' is not null or undefined assertParamExists('patchOwnershipCorrelationConfigV1', 'configId', configId) // verify required parameter 'jsonPatchOperation' is not null or undefined assertParamExists('patchOwnershipCorrelationConfigV1', 'jsonPatchOperation', jsonPatchOperation) const localVarPath = `/sources/v1/{sourceId}/resources/{resourceId}/correlation-configs/{configId}` .replace(`{${"sourceId"}}`, encodeURIComponent(String(sourceId))) .replace(`{${"resourceId"}}`, encodeURIComponent(String(resourceId))) .replace(`{${"configId"}}`, encodeURIComponent(String(configId))); // use dummy base URL string because the URL constructor only accepts absolute URLs. const localVarUrlObj = new URL(localVarPath, DUMMY_BASE_URL); let baseOptions; if (configuration) { baseOptions = configuration.baseOptions; } const localVarRequestOptions = { method: 'PATCH', ...baseOptions, ...axiosOptions}; const localVarHeaderParameter = {} as any; const localVarQueryParameter = {} as any; localVarHeaderParameter['Content-Type'] = 'application/json-patch+json'; setSearchParams(localVarUrlObj, localVarQueryParameter); let headersFromBaseOptions = baseOptions && baseOptions.headers ? baseOptions.headers : {}; localVarRequestOptions.headers = {...localVarHeaderParameter, ...headersFromBaseOptions, ...axiosOptions.headers}; localVarRequestOptions.data = serializeDataIfNeeded(jsonPatchOperation, localVarRequestOptions, configuration) return { url: toPathString(localVarUrlObj), axiosOptions: localVarRequestOptions, }; }, /** * Starts a machine identity (AI Agents) aggregation on the specified source. * @summary Start machine identity aggregation * @param {string} sourceId Source ID. * @param {MachineIdentityAggregationRequest} machineIdentityAggregationRequest * @param {string} [xSailPointExperimental] Use this header to enable this experimental API. * @param {*} [axiosOptions] Override http request option. * @throws {RequiredError} */ startMachineIdentityAggregationV1: async (sourceId: string, machineIdentityAggregationRequest: MachineIdentityAggregationRequest, xSailPointExperimental?: string, axiosOptions: RawAxiosRequestConfig = {}): Promise => { // verify required parameter 'sourceId' is not null or undefined assertParamExists('startMachineIdentityAggregationV1', 'sourceId', sourceId) // verify required parameter 'machineIdentityAggregationRequest' is not null or undefined assertParamExists('startMachineIdentityAggregationV1', 'machineIdentityAggregationRequest', machineIdentityAggregationRequest) if (xSailPointExperimental === undefined) { xSailPointExperimental = 'true'; } const localVarPath = `/sources/v1/{sourceId}/aggregate-agents` .replace(`{${"sourceId"}}`, encodeURIComponent(String(sourceId))); // use dummy base URL string because the URL constructor only accepts absolute URLs. const localVarUrlObj = new URL(localVarPath, DUMMY_BASE_URL); let baseOptions; if (configuration) { baseOptions = configuration.baseOptions; } const localVarRequestOptions = { method: 'POST', ...baseOptions, ...axiosOptions}; const localVarHeaderParameter = {} as any; const localVarQueryParameter = {} as any; localVarHeaderParameter['Content-Type'] = 'application/json'; if (xSailPointExperimental != null) { localVarHeaderParameter['X-SailPoint-Experimental'] = String(xSailPointExperimental); } setSearchParams(localVarUrlObj, localVarQueryParameter); let headersFromBaseOptions = baseOptions && baseOptions.headers ? baseOptions.headers : {}; localVarRequestOptions.headers = {...localVarHeaderParameter, ...headersFromBaseOptions, ...axiosOptions.headers}; localVarRequestOptions.data = serializeDataIfNeeded(machineIdentityAggregationRequest, localVarRequestOptions, configuration) return { url: toPathString(localVarUrlObj), axiosOptions: localVarRequestOptions, }; }, /** * Use this API to update machine identity details. * @summary Update machine identity details * @param {string} id Machine Identity ID. * @param {Array} requestBody A JSON of updated values [JSON Patch](https://tools.ietf.org/html/rfc6902) standard. * @param {string} [xSailPointExperimental] Use this header to enable this experimental API. * @param {*} [axiosOptions] Override http request option. * @throws {RequiredError} */ updateMachineIdentityV1: async (id: string, requestBody: Array, xSailPointExperimental?: string, axiosOptions: RawAxiosRequestConfig = {}): Promise => { // verify required parameter 'id' is not null or undefined assertParamExists('updateMachineIdentityV1', 'id', id) // verify required parameter 'requestBody' is not null or undefined assertParamExists('updateMachineIdentityV1', 'requestBody', requestBody) if (xSailPointExperimental === undefined) { xSailPointExperimental = 'true'; } const localVarPath = `/machine-identities/v1/{id}` .replace(`{${"id"}}`, encodeURIComponent(String(id))); // use dummy base URL string because the URL constructor only accepts absolute URLs. const localVarUrlObj = new URL(localVarPath, DUMMY_BASE_URL); let baseOptions; if (configuration) { baseOptions = configuration.baseOptions; } const localVarRequestOptions = { method: 'PATCH', ...baseOptions, ...axiosOptions}; const localVarHeaderParameter = {} as any; const localVarQueryParameter = {} as any; localVarHeaderParameter['Content-Type'] = 'application/json-patch+json'; if (xSailPointExperimental != null) { localVarHeaderParameter['X-SailPoint-Experimental'] = String(xSailPointExperimental); } setSearchParams(localVarUrlObj, localVarQueryParameter); let headersFromBaseOptions = baseOptions && baseOptions.headers ? baseOptions.headers : {}; localVarRequestOptions.headers = {...localVarHeaderParameter, ...headersFromBaseOptions, ...axiosOptions.headers}; localVarRequestOptions.data = serializeDataIfNeeded(requestBody, localVarRequestOptions, configuration) return { url: toPathString(localVarUrlObj), axiosOptions: localVarRequestOptions, }; }, /** * Use this API to selectively update machine identity details using a JSONPatch payload. Patchable fields include **name**, **description**, **nativeIdentity**, **subtype**, **environment**, **attributes**, **owners**, **userEntitlements**, and **manuallyEdited** only. * @summary Partial update of machine identity * @param {string} id Machine Identity ID. * @param {Array} jsonPatchOperation A JSON of updated values [JSON Patch](https://tools.ietf.org/html/rfc6902) standard. * @param {*} [axiosOptions] Override http request option. * @throws {RequiredError} */ updateMachineIdentityV2: async (id: string, jsonPatchOperation: Array, axiosOptions: RawAxiosRequestConfig = {}): Promise => { // verify required parameter 'id' is not null or undefined assertParamExists('updateMachineIdentityV2', 'id', id) // verify required parameter 'jsonPatchOperation' is not null or undefined assertParamExists('updateMachineIdentityV2', 'jsonPatchOperation', jsonPatchOperation) const localVarPath = `/machine-identities/v2/{id}` .replace(`{${"id"}}`, encodeURIComponent(String(id))); // use dummy base URL string because the URL constructor only accepts absolute URLs. const localVarUrlObj = new URL(localVarPath, DUMMY_BASE_URL); let baseOptions; if (configuration) { baseOptions = configuration.baseOptions; } const localVarRequestOptions = { method: 'PATCH', ...baseOptions, ...axiosOptions}; const localVarHeaderParameter = {} as any; const localVarQueryParameter = {} as any; localVarHeaderParameter['Content-Type'] = 'application/json-patch+json'; setSearchParams(localVarUrlObj, localVarQueryParameter); let headersFromBaseOptions = baseOptions && baseOptions.headers ? baseOptions.headers : {}; localVarRequestOptions.headers = {...localVarHeaderParameter, ...headersFromBaseOptions, ...axiosOptions.headers}; localVarRequestOptions.data = serializeDataIfNeeded(jsonPatchOperation, localVarRequestOptions, configuration) return { url: toPathString(localVarUrlObj), axiosOptions: localVarRequestOptions, }; }, } }; /** * MachineIdentitiesApi - functional programming interface * @export */ export const MachineIdentitiesApiFp = function(configuration?: Configuration) { const localVarAxiosParamCreator = MachineIdentitiesApiAxiosParamCreator(configuration) return { /** * Use this API to create a machine identity. The maximum supported length for the description field is 2000 characters. * @summary Create machine identity * @param {MachineIdentityRequest} machineIdentityRequest * @param {string} [xSailPointExperimental] Use this header to enable this experimental API. * @param {*} [axiosOptions] Override http request option. * @throws {RequiredError} */ async createMachineIdentityV1(machineIdentityRequest: MachineIdentityRequest, xSailPointExperimental?: string, axiosOptions?: RawAxiosRequestConfig): Promise<(axios?: AxiosInstance, basePath?: string) => AxiosPromise> { const localVarAxiosArgs = await localVarAxiosParamCreator.createMachineIdentityV1(machineIdentityRequest, xSailPointExperimental, axiosOptions); const localVarOperationServerIndex = configuration?.serverIndex ?? 0; const localVarOperationServerBasePath = operationServerMap['MachineIdentitiesApi.createMachineIdentityV1']?.[localVarOperationServerIndex]?.url; return (axios, basePath) => createRequestFunction(localVarAxiosArgs, globalAxios, BASE_PATH, configuration)(axios, localVarOperationServerBasePath || basePath); }, /** * Use this API to create a machine identity. Additional owners may be either up to ten human (IDENTITY) references or exactly one GOVERNANCE_GROUP reference - not both. The maximum supported length for the description field is 2000 characters. * @summary Create machine identity * @param {Machineidentityv2} machineidentityv2 * @param {*} [axiosOptions] Override http request option. * @throws {RequiredError} */ async createMachineIdentityV2(machineidentityv2: Machineidentityv2, axiosOptions?: RawAxiosRequestConfig): Promise<(axios?: AxiosInstance, basePath?: string) => AxiosPromise> { const localVarAxiosArgs = await localVarAxiosParamCreator.createMachineIdentityV2(machineidentityv2, axiosOptions); const localVarOperationServerIndex = configuration?.serverIndex ?? 0; const localVarOperationServerBasePath = operationServerMap['MachineIdentitiesApi.createMachineIdentityV2']?.[localVarOperationServerIndex]?.url; return (axios, basePath) => createRequestFunction(localVarAxiosArgs, globalAxios, BASE_PATH, configuration)(axios, localVarOperationServerBasePath || basePath); }, /** * The API returns successful response if the requested machine identity was deleted. * @summary Delete machine identity * @param {string} id Machine Identity ID * @param {string} [xSailPointExperimental] Use this header to enable this experimental API. * @param {*} [axiosOptions] Override http request option. * @throws {RequiredError} */ async deleteMachineIdentityV1(id: string, xSailPointExperimental?: string, axiosOptions?: RawAxiosRequestConfig): Promise<(axios?: AxiosInstance, basePath?: string) => AxiosPromise> { const localVarAxiosArgs = await localVarAxiosParamCreator.deleteMachineIdentityV1(id, xSailPointExperimental, axiosOptions); const localVarOperationServerIndex = configuration?.serverIndex ?? 0; const localVarOperationServerBasePath = operationServerMap['MachineIdentitiesApi.deleteMachineIdentityV1']?.[localVarOperationServerIndex]?.url; return (axios, basePath) => createRequestFunction(localVarAxiosArgs, globalAxios, BASE_PATH, configuration)(axios, localVarOperationServerBasePath || basePath); }, /** * The API returns a successful response if the requested machine identity was deleted. * @summary Delete machine identity * @param {string} id Machine Identity ID. * @param {*} [axiosOptions] Override http request option. * @throws {RequiredError} */ async deleteMachineIdentityV2(id: string, axiosOptions?: RawAxiosRequestConfig): Promise<(axios?: AxiosInstance, basePath?: string) => AxiosPromise> { const localVarAxiosArgs = await localVarAxiosParamCreator.deleteMachineIdentityV2(id, axiosOptions); const localVarOperationServerIndex = configuration?.serverIndex ?? 0; const localVarOperationServerBasePath = operationServerMap['MachineIdentitiesApi.deleteMachineIdentityV2']?.[localVarOperationServerIndex]?.url; return (axios, basePath) => createRequestFunction(localVarAxiosArgs, globalAxios, BASE_PATH, configuration)(axios, localVarOperationServerBasePath || basePath); }, /** * Deletes the ownership correlation config with the specified ID for the given source resource. * @summary Delete ownership correlation config * @param {string} sourceId The Source ID. * @param {string} resourceId The source resource ID (for example, account or aws:iam-role). * @param {string} configId The correlation config ID. * @param {*} [axiosOptions] Override http request option. * @throws {RequiredError} */ async deleteOwnershipCorrelationConfigV1(sourceId: string, resourceId: string, configId: string, axiosOptions?: RawAxiosRequestConfig): Promise<(axios?: AxiosInstance, basePath?: string) => AxiosPromise> { const localVarAxiosArgs = await localVarAxiosParamCreator.deleteOwnershipCorrelationConfigV1(sourceId, resourceId, configId, axiosOptions); const localVarOperationServerIndex = configuration?.serverIndex ?? 0; const localVarOperationServerBasePath = operationServerMap['MachineIdentitiesApi.deleteOwnershipCorrelationConfigV1']?.[localVarOperationServerIndex]?.url; return (axios, basePath) => createRequestFunction(localVarAxiosArgs, globalAxios, BASE_PATH, configuration)(axios, localVarOperationServerBasePath || basePath); }, /** * This API returns a single machine identity using the Machine Identity ID. * @summary Get machine identity details * @param {string} id Machine Identity ID * @param {string} [xSailPointExperimental] Use this header to enable this experimental API. * @param {*} [axiosOptions] Override http request option. * @throws {RequiredError} */ async getMachineIdentityV1(id: string, xSailPointExperimental?: string, axiosOptions?: RawAxiosRequestConfig): Promise<(axios?: AxiosInstance, basePath?: string) => AxiosPromise> { const localVarAxiosArgs = await localVarAxiosParamCreator.getMachineIdentityV1(id, xSailPointExperimental, axiosOptions); const localVarOperationServerIndex = configuration?.serverIndex ?? 0; const localVarOperationServerBasePath = operationServerMap['MachineIdentitiesApi.getMachineIdentityV1']?.[localVarOperationServerIndex]?.url; return (axios, basePath) => createRequestFunction(localVarAxiosArgs, globalAxios, BASE_PATH, configuration)(axios, localVarOperationServerBasePath || basePath); }, /** * This API returns a single machine identity using the Machine Identity ID. * @summary Get machine identity details * @param {string} id Machine Identity ID. * @param {*} [axiosOptions] Override http request option. * @throws {RequiredError} */ async getMachineIdentityV2(id: string, axiosOptions?: RawAxiosRequestConfig): Promise<(axios?: AxiosInstance, basePath?: string) => AxiosPromise> { const localVarAxiosArgs = await localVarAxiosParamCreator.getMachineIdentityV2(id, axiosOptions); const localVarOperationServerIndex = configuration?.serverIndex ?? 0; const localVarOperationServerBasePath = operationServerMap['MachineIdentitiesApi.getMachineIdentityV2']?.[localVarOperationServerIndex]?.url; return (axios, basePath) => createRequestFunction(localVarAxiosArgs, globalAxios, BASE_PATH, configuration)(axios, localVarOperationServerBasePath || basePath); }, /** * This end-point retrieves a single ownership correlation config by ID for the specified source resource. * @summary Get ownership correlation config * @param {string} sourceId The Source ID. * @param {string} resourceId The source resource ID (for example, account or aws:iam-role). * @param {string} configId The correlation config ID. * @param {*} [axiosOptions] Override http request option. * @throws {RequiredError} */ async getOwnershipCorrelationConfigV1(sourceId: string, resourceId: string, configId: string, axiosOptions?: RawAxiosRequestConfig): Promise<(axios?: AxiosInstance, basePath?: string) => AxiosPromise> { const localVarAxiosArgs = await localVarAxiosParamCreator.getOwnershipCorrelationConfigV1(sourceId, resourceId, configId, axiosOptions); const localVarOperationServerIndex = configuration?.serverIndex ?? 0; const localVarOperationServerBasePath = operationServerMap['MachineIdentitiesApi.getOwnershipCorrelationConfigV1']?.[localVarOperationServerIndex]?.url; return (axios, basePath) => createRequestFunction(localVarAxiosArgs, globalAxios, BASE_PATH, configuration)(axios, localVarOperationServerBasePath || basePath); }, /** * This API returns a list of machine identities. * @summary List machine identities * @param {string} [filters] Filter results using the standard syntax described in [V3 API Standard Collection Parameters](https://developer.sailpoint.com/idn/api/standard-collection-parameters#filtering-results) Filtering is supported for the following fields and operators: **id**: *eq, in, sw* **displayName**: *eq, in, sw* **cisIdentityId**: *eq, in, sw* **nativeIdentity**: *eq, in, sw* **attributes**: *eq* **manuallyEdited**: *eq* **subtype**: *eq, in* **owners.primaryIdentity.id**: *eq, in, sw* **owners.primaryIdentity.name**: *eq, in, isnull, pr* **owners.secondaryIdentity.id**: *eq, in, sw* **owners.secondaryIdentity.name**: *eq, in, isnull, pr* **source.name**: *eq, in, sw* **source.id**: *eq, in* **entitlement.id**: *eq, in* **entitlement.name**: *eq, in, 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: **nativeIdentity, name, owners.primaryIdentity.name, source.name, created, modified** * @param {string} [xSailPointExperimental] Use this header to enable this experimental API. * @param {boolean} [count] If *true* it will populate the *X-Total-Count* response header with the number of results that would be returned if *limit* and *offset* were ignored. Since requesting a total count can have a performance impact, it is recommended not to send **count=true** if that value will not be used. See [V3 API Standard Collection Parameters](https://developer.sailpoint.com/idn/api/standard-collection-parameters) for more information. * @param {number} [limit] Max number of results to return. See [V3 API Standard Collection Parameters](https://developer.sailpoint.com/idn/api/standard-collection-parameters) for more information. * @param {number} [offset] Offset into the full result set. Usually specified with *limit* to paginate through the results. See [V3 API Standard Collection Parameters](https://developer.sailpoint.com/idn/api/standard-collection-parameters) for more information. * @param {*} [axiosOptions] Override http request option. * @throws {RequiredError} */ async listMachineIdentitiesV1(filters?: string, sorters?: string, xSailPointExperimental?: string, count?: boolean, limit?: number, offset?: number, axiosOptions?: RawAxiosRequestConfig): Promise<(axios?: AxiosInstance, basePath?: string) => AxiosPromise>> { const localVarAxiosArgs = await localVarAxiosParamCreator.listMachineIdentitiesV1(filters, sorters, xSailPointExperimental, count, limit, offset, axiosOptions); const localVarOperationServerIndex = configuration?.serverIndex ?? 0; const localVarOperationServerBasePath = operationServerMap['MachineIdentitiesApi.listMachineIdentitiesV1']?.[localVarOperationServerIndex]?.url; return (axios, basePath) => createRequestFunction(localVarAxiosArgs, globalAxios, BASE_PATH, configuration)(axios, localVarOperationServerBasePath || basePath); }, /** * This API returns a list of machine identities. * @summary List machine identities * @param {string} [filters] Filter results using the standard syntax described in [V3 API Standard Collection Parameters](https://developer.sailpoint.com/idn/api/standard-collection-parameters#filtering-results) Filtering is supported for the following fields and operators: **id**: *eq, in, sw* **displayName**: *eq, in, sw* **nativeIdentity**: *eq, in, sw* **attributes**: *eq* **manuallyEdited**: *eq* **subtype**: *eq, in* **owners.primaryIdentity.id**: *eq, in, sw* **owners.primaryIdentity.name**: *eq, in, isnull, pr* **owners.secondaryIdentity.id**: *eq, in, sw* **owners.secondaryIdentity.name**: *eq, in, isnull, pr* **owners.secondaryGovernanceGroup.id**: *eq, in* **owners.secondaryGovernanceGroup.name**: *eq, in, isnull, pr* **source.id**: *eq, in* **source.name**: *eq, in, sw* **entitlement.id**: *eq, in* **entitlement.name**: *eq, in, sw* **risk.severity**: *eq, in* * @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: **nativeIdentity, name, owners.primaryIdentity.name, source.name, created, modified** * @param {boolean} [count] If *true* it will populate the *X-Total-Count* response header with the number of results that would be returned if *limit* and *offset* were ignored. Since requesting a total count can have a performance impact, it is recommended not to send **count=true** if that value will not be used. See [V3 API Standard Collection Parameters](https://developer.sailpoint.com/idn/api/standard-collection-parameters) for more information. * @param {number} [limit] Max number of results to return. See [V3 API Standard Collection Parameters](https://developer.sailpoint.com/idn/api/standard-collection-parameters) for more information. * @param {number} [offset] Offset into the full result set. Usually specified with *limit* to paginate through the results. See [V3 API Standard Collection Parameters](https://developer.sailpoint.com/idn/api/standard-collection-parameters) for more information. * @param {*} [axiosOptions] Override http request option. * @throws {RequiredError} */ async listMachineIdentitiesV2(filters?: string, sorters?: string, count?: boolean, limit?: number, offset?: number, axiosOptions?: RawAxiosRequestConfig): Promise<(axios?: AxiosInstance, basePath?: string) => AxiosPromise>> { const localVarAxiosArgs = await localVarAxiosParamCreator.listMachineIdentitiesV2(filters, sorters, count, limit, offset, axiosOptions); const localVarOperationServerIndex = configuration?.serverIndex ?? 0; const localVarOperationServerBasePath = operationServerMap['MachineIdentitiesApi.listMachineIdentitiesV2']?.[localVarOperationServerIndex]?.url; return (axios, basePath) => createRequestFunction(localVarAxiosArgs, globalAxios, BASE_PATH, configuration)(axios, localVarOperationServerBasePath || basePath); }, /** * This API returns a list of user entitlements associated with machine identities. * @summary List machine identity\'s user entitlements * @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: **machineIdentityId**: *eq, in* **machineIdentityName**: *eq, in, sw* **entitlement.id**: *eq, in* **entitlement.name**: *eq, in, sw* **source.id**: *eq, in* **source.name**: *eq, in, 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: **machineIdentityName, entitlement.name, source.name** * @param {string} [xSailPointExperimental] Use this header to enable this experimental API. * @param {boolean} [count] If *true* it will populate the *X-Total-Count* response header with the number of results that would be returned if *limit* and *offset* were ignored. Since requesting a total count can have a performance impact, it is recommended not to send **count=true** if that value will not be used. See [V3 API Standard Collection Parameters](https://developer.sailpoint.com/idn/api/standard-collection-parameters) for more information. * @param {number} [limit] Max number of results to return. See [V3 API Standard Collection Parameters](https://developer.sailpoint.com/idn/api/standard-collection-parameters) for more information. * @param {number} [offset] Offset into the full result set. Usually specified with *limit* to paginate through the results. See [V3 API Standard Collection Parameters](https://developer.sailpoint.com/idn/api/standard-collection-parameters) for more information. * @param {*} [axiosOptions] Override http request option. * @throws {RequiredError} */ async listMachineIdentityUserEntitlementsV1(filters?: string, sorters?: string, xSailPointExperimental?: string, count?: boolean, limit?: number, offset?: number, axiosOptions?: RawAxiosRequestConfig): Promise<(axios?: AxiosInstance, basePath?: string) => AxiosPromise>> { const localVarAxiosArgs = await localVarAxiosParamCreator.listMachineIdentityUserEntitlementsV1(filters, sorters, xSailPointExperimental, count, limit, offset, axiosOptions); const localVarOperationServerIndex = configuration?.serverIndex ?? 0; const localVarOperationServerBasePath = operationServerMap['MachineIdentitiesApi.listMachineIdentityUserEntitlementsV1']?.[localVarOperationServerIndex]?.url; return (axios, basePath) => createRequestFunction(localVarAxiosArgs, globalAxios, BASE_PATH, configuration)(axios, localVarOperationServerBasePath || basePath); }, /** * Returns the OWNER_PRIMARY and OWNER_SECONDARY correlation configs for the specified source resource, creating default rows if they are missing. Use the optional type query parameter to return a single matching config. * @summary List ownership correlation configs * @param {string} sourceId The Source ID. * @param {string} resourceId The source resource ID (for example, account or aws:iam-role). * @param {ListOwnershipCorrelationConfigsV1TypeEnum} [type] When set, filters to the given config type. * @param {boolean} [count] If *true* it will populate the *X-Total-Count* response header with the number of results that would be returned if *limit* and *offset* were ignored. Since requesting a total count can have a performance impact, it is recommended not to send **count=true** if that value will not be used. See [V3 API Standard Collection Parameters](https://developer.sailpoint.com/idn/api/standard-collection-parameters) for more information. * @param {number} [limit] Max number of results to return. See [V3 API Standard Collection Parameters](https://developer.sailpoint.com/idn/api/standard-collection-parameters) for more information. * @param {number} [offset] Offset into the full result set. Usually specified with *limit* to paginate through the results. See [V3 API Standard Collection Parameters](https://developer.sailpoint.com/idn/api/standard-collection-parameters) for more information. * @param {*} [axiosOptions] Override http request option. * @throws {RequiredError} */ async listOwnershipCorrelationConfigsV1(sourceId: string, resourceId: string, type?: ListOwnershipCorrelationConfigsV1TypeEnum, count?: boolean, limit?: number, offset?: number, axiosOptions?: RawAxiosRequestConfig): Promise<(axios?: AxiosInstance, basePath?: string) => AxiosPromise>> { const localVarAxiosArgs = await localVarAxiosParamCreator.listOwnershipCorrelationConfigsV1(sourceId, resourceId, type, count, limit, offset, axiosOptions); const localVarOperationServerIndex = configuration?.serverIndex ?? 0; const localVarOperationServerBasePath = operationServerMap['MachineIdentitiesApi.listOwnershipCorrelationConfigsV1']?.[localVarOperationServerIndex]?.url; return (axios, basePath) => createRequestFunction(localVarAxiosArgs, globalAxios, BASE_PATH, configuration)(axios, localVarOperationServerBasePath || basePath); }, /** * Selectively updates an ownership correlation config using an RFC 6902 JSONPatch payload. Only replace on /attributes (full object) and replace on /rules (full array; merge by stable rule id, remove rules omitted from the array) are allowed. * @summary Patch ownership correlation config * @param {string} sourceId The Source ID. * @param {string} resourceId The source resource ID (for example, account or aws:iam-role). * @param {string} configId The correlation config ID. * @param {Array} jsonPatchOperation The JSONPatch payload used to update the correlation config. * @param {*} [axiosOptions] Override http request option. * @throws {RequiredError} */ async patchOwnershipCorrelationConfigV1(sourceId: string, resourceId: string, configId: string, jsonPatchOperation: Array, axiosOptions?: RawAxiosRequestConfig): Promise<(axios?: AxiosInstance, basePath?: string) => AxiosPromise> { const localVarAxiosArgs = await localVarAxiosParamCreator.patchOwnershipCorrelationConfigV1(sourceId, resourceId, configId, jsonPatchOperation, axiosOptions); const localVarOperationServerIndex = configuration?.serverIndex ?? 0; const localVarOperationServerBasePath = operationServerMap['MachineIdentitiesApi.patchOwnershipCorrelationConfigV1']?.[localVarOperationServerIndex]?.url; return (axios, basePath) => createRequestFunction(localVarAxiosArgs, globalAxios, BASE_PATH, configuration)(axios, localVarOperationServerBasePath || basePath); }, /** * Starts a machine identity (AI Agents) aggregation on the specified source. * @summary Start machine identity aggregation * @param {string} sourceId Source ID. * @param {MachineIdentityAggregationRequest} machineIdentityAggregationRequest * @param {string} [xSailPointExperimental] Use this header to enable this experimental API. * @param {*} [axiosOptions] Override http request option. * @throws {RequiredError} */ async startMachineIdentityAggregationV1(sourceId: string, machineIdentityAggregationRequest: MachineIdentityAggregationRequest, xSailPointExperimental?: string, axiosOptions?: RawAxiosRequestConfig): Promise<(axios?: AxiosInstance, basePath?: string) => AxiosPromise> { const localVarAxiosArgs = await localVarAxiosParamCreator.startMachineIdentityAggregationV1(sourceId, machineIdentityAggregationRequest, xSailPointExperimental, axiosOptions); const localVarOperationServerIndex = configuration?.serverIndex ?? 0; const localVarOperationServerBasePath = operationServerMap['MachineIdentitiesApi.startMachineIdentityAggregationV1']?.[localVarOperationServerIndex]?.url; return (axios, basePath) => createRequestFunction(localVarAxiosArgs, globalAxios, BASE_PATH, configuration)(axios, localVarOperationServerBasePath || basePath); }, /** * Use this API to update machine identity details. * @summary Update machine identity details * @param {string} id Machine Identity ID. * @param {Array} requestBody A JSON of updated values [JSON Patch](https://tools.ietf.org/html/rfc6902) standard. * @param {string} [xSailPointExperimental] Use this header to enable this experimental API. * @param {*} [axiosOptions] Override http request option. * @throws {RequiredError} */ async updateMachineIdentityV1(id: string, requestBody: Array, xSailPointExperimental?: string, axiosOptions?: RawAxiosRequestConfig): Promise<(axios?: AxiosInstance, basePath?: string) => AxiosPromise> { const localVarAxiosArgs = await localVarAxiosParamCreator.updateMachineIdentityV1(id, requestBody, xSailPointExperimental, axiosOptions); const localVarOperationServerIndex = configuration?.serverIndex ?? 0; const localVarOperationServerBasePath = operationServerMap['MachineIdentitiesApi.updateMachineIdentityV1']?.[localVarOperationServerIndex]?.url; return (axios, basePath) => createRequestFunction(localVarAxiosArgs, globalAxios, BASE_PATH, configuration)(axios, localVarOperationServerBasePath || basePath); }, /** * Use this API to selectively update machine identity details using a JSONPatch payload. Patchable fields include **name**, **description**, **nativeIdentity**, **subtype**, **environment**, **attributes**, **owners**, **userEntitlements**, and **manuallyEdited** only. * @summary Partial update of machine identity * @param {string} id Machine Identity ID. * @param {Array} jsonPatchOperation A JSON of updated values [JSON Patch](https://tools.ietf.org/html/rfc6902) standard. * @param {*} [axiosOptions] Override http request option. * @throws {RequiredError} */ async updateMachineIdentityV2(id: string, jsonPatchOperation: Array, axiosOptions?: RawAxiosRequestConfig): Promise<(axios?: AxiosInstance, basePath?: string) => AxiosPromise> { const localVarAxiosArgs = await localVarAxiosParamCreator.updateMachineIdentityV2(id, jsonPatchOperation, axiosOptions); const localVarOperationServerIndex = configuration?.serverIndex ?? 0; const localVarOperationServerBasePath = operationServerMap['MachineIdentitiesApi.updateMachineIdentityV2']?.[localVarOperationServerIndex]?.url; return (axios, basePath) => createRequestFunction(localVarAxiosArgs, globalAxios, BASE_PATH, configuration)(axios, localVarOperationServerBasePath || basePath); }, } }; /** * MachineIdentitiesApi - factory interface * @export */ export const MachineIdentitiesApiFactory = function (configuration?: Configuration, basePath?: string, axios?: AxiosInstance) { const localVarFp = MachineIdentitiesApiFp(configuration) return { /** * Use this API to create a machine identity. The maximum supported length for the description field is 2000 characters. * @summary Create machine identity * @param {MachineIdentitiesApiCreateMachineIdentityV1Request} requestParameters Request parameters. * @param {*} [axiosOptions] Override http request option. * @throws {RequiredError} */ createMachineIdentityV1(requestParameters: MachineIdentitiesApiCreateMachineIdentityV1Request, axiosOptions?: RawAxiosRequestConfig): AxiosPromise { return localVarFp.createMachineIdentityV1(requestParameters.machineIdentityRequest, requestParameters.xSailPointExperimental, axiosOptions).then((request) => request(axios, basePath)); }, /** * Use this API to create a machine identity. Additional owners may be either up to ten human (IDENTITY) references or exactly one GOVERNANCE_GROUP reference - not both. The maximum supported length for the description field is 2000 characters. * @summary Create machine identity * @param {MachineIdentitiesApiCreateMachineIdentityV2Request} requestParameters Request parameters. * @param {*} [axiosOptions] Override http request option. * @throws {RequiredError} */ createMachineIdentityV2(requestParameters: MachineIdentitiesApiCreateMachineIdentityV2Request, axiosOptions?: RawAxiosRequestConfig): AxiosPromise { return localVarFp.createMachineIdentityV2(requestParameters.machineidentityv2, axiosOptions).then((request) => request(axios, basePath)); }, /** * The API returns successful response if the requested machine identity was deleted. * @summary Delete machine identity * @param {MachineIdentitiesApiDeleteMachineIdentityV1Request} requestParameters Request parameters. * @param {*} [axiosOptions] Override http request option. * @throws {RequiredError} */ deleteMachineIdentityV1(requestParameters: MachineIdentitiesApiDeleteMachineIdentityV1Request, axiosOptions?: RawAxiosRequestConfig): AxiosPromise { return localVarFp.deleteMachineIdentityV1(requestParameters.id, requestParameters.xSailPointExperimental, axiosOptions).then((request) => request(axios, basePath)); }, /** * The API returns a successful response if the requested machine identity was deleted. * @summary Delete machine identity * @param {MachineIdentitiesApiDeleteMachineIdentityV2Request} requestParameters Request parameters. * @param {*} [axiosOptions] Override http request option. * @throws {RequiredError} */ deleteMachineIdentityV2(requestParameters: MachineIdentitiesApiDeleteMachineIdentityV2Request, axiosOptions?: RawAxiosRequestConfig): AxiosPromise { return localVarFp.deleteMachineIdentityV2(requestParameters.id, axiosOptions).then((request) => request(axios, basePath)); }, /** * Deletes the ownership correlation config with the specified ID for the given source resource. * @summary Delete ownership correlation config * @param {MachineIdentitiesApiDeleteOwnershipCorrelationConfigV1Request} requestParameters Request parameters. * @param {*} [axiosOptions] Override http request option. * @throws {RequiredError} */ deleteOwnershipCorrelationConfigV1(requestParameters: MachineIdentitiesApiDeleteOwnershipCorrelationConfigV1Request, axiosOptions?: RawAxiosRequestConfig): AxiosPromise { return localVarFp.deleteOwnershipCorrelationConfigV1(requestParameters.sourceId, requestParameters.resourceId, requestParameters.configId, axiosOptions).then((request) => request(axios, basePath)); }, /** * This API returns a single machine identity using the Machine Identity ID. * @summary Get machine identity details * @param {MachineIdentitiesApiGetMachineIdentityV1Request} requestParameters Request parameters. * @param {*} [axiosOptions] Override http request option. * @throws {RequiredError} */ getMachineIdentityV1(requestParameters: MachineIdentitiesApiGetMachineIdentityV1Request, axiosOptions?: RawAxiosRequestConfig): AxiosPromise { return localVarFp.getMachineIdentityV1(requestParameters.id, requestParameters.xSailPointExperimental, axiosOptions).then((request) => request(axios, basePath)); }, /** * This API returns a single machine identity using the Machine Identity ID. * @summary Get machine identity details * @param {MachineIdentitiesApiGetMachineIdentityV2Request} requestParameters Request parameters. * @param {*} [axiosOptions] Override http request option. * @throws {RequiredError} */ getMachineIdentityV2(requestParameters: MachineIdentitiesApiGetMachineIdentityV2Request, axiosOptions?: RawAxiosRequestConfig): AxiosPromise { return localVarFp.getMachineIdentityV2(requestParameters.id, axiosOptions).then((request) => request(axios, basePath)); }, /** * This end-point retrieves a single ownership correlation config by ID for the specified source resource. * @summary Get ownership correlation config * @param {MachineIdentitiesApiGetOwnershipCorrelationConfigV1Request} requestParameters Request parameters. * @param {*} [axiosOptions] Override http request option. * @throws {RequiredError} */ getOwnershipCorrelationConfigV1(requestParameters: MachineIdentitiesApiGetOwnershipCorrelationConfigV1Request, axiosOptions?: RawAxiosRequestConfig): AxiosPromise { return localVarFp.getOwnershipCorrelationConfigV1(requestParameters.sourceId, requestParameters.resourceId, requestParameters.configId, axiosOptions).then((request) => request(axios, basePath)); }, /** * This API returns a list of machine identities. * @summary List machine identities * @param {MachineIdentitiesApiListMachineIdentitiesV1Request} requestParameters Request parameters. * @param {*} [axiosOptions] Override http request option. * @throws {RequiredError} */ listMachineIdentitiesV1(requestParameters: MachineIdentitiesApiListMachineIdentitiesV1Request = {}, axiosOptions?: RawAxiosRequestConfig): AxiosPromise> { return localVarFp.listMachineIdentitiesV1(requestParameters.filters, requestParameters.sorters, requestParameters.xSailPointExperimental, requestParameters.count, requestParameters.limit, requestParameters.offset, axiosOptions).then((request) => request(axios, basePath)); }, /** * This API returns a list of machine identities. * @summary List machine identities * @param {MachineIdentitiesApiListMachineIdentitiesV2Request} requestParameters Request parameters. * @param {*} [axiosOptions] Override http request option. * @throws {RequiredError} */ listMachineIdentitiesV2(requestParameters: MachineIdentitiesApiListMachineIdentitiesV2Request = {}, axiosOptions?: RawAxiosRequestConfig): AxiosPromise> { return localVarFp.listMachineIdentitiesV2(requestParameters.filters, requestParameters.sorters, requestParameters.count, requestParameters.limit, requestParameters.offset, axiosOptions).then((request) => request(axios, basePath)); }, /** * This API returns a list of user entitlements associated with machine identities. * @summary List machine identity\'s user entitlements * @param {MachineIdentitiesApiListMachineIdentityUserEntitlementsV1Request} requestParameters Request parameters. * @param {*} [axiosOptions] Override http request option. * @throws {RequiredError} */ listMachineIdentityUserEntitlementsV1(requestParameters: MachineIdentitiesApiListMachineIdentityUserEntitlementsV1Request = {}, axiosOptions?: RawAxiosRequestConfig): AxiosPromise> { return localVarFp.listMachineIdentityUserEntitlementsV1(requestParameters.filters, requestParameters.sorters, requestParameters.xSailPointExperimental, requestParameters.count, requestParameters.limit, requestParameters.offset, axiosOptions).then((request) => request(axios, basePath)); }, /** * Returns the OWNER_PRIMARY and OWNER_SECONDARY correlation configs for the specified source resource, creating default rows if they are missing. Use the optional type query parameter to return a single matching config. * @summary List ownership correlation configs * @param {MachineIdentitiesApiListOwnershipCorrelationConfigsV1Request} requestParameters Request parameters. * @param {*} [axiosOptions] Override http request option. * @throws {RequiredError} */ listOwnershipCorrelationConfigsV1(requestParameters: MachineIdentitiesApiListOwnershipCorrelationConfigsV1Request, axiosOptions?: RawAxiosRequestConfig): AxiosPromise> { return localVarFp.listOwnershipCorrelationConfigsV1(requestParameters.sourceId, requestParameters.resourceId, requestParameters.type, requestParameters.count, requestParameters.limit, requestParameters.offset, axiosOptions).then((request) => request(axios, basePath)); }, /** * Selectively updates an ownership correlation config using an RFC 6902 JSONPatch payload. Only replace on /attributes (full object) and replace on /rules (full array; merge by stable rule id, remove rules omitted from the array) are allowed. * @summary Patch ownership correlation config * @param {MachineIdentitiesApiPatchOwnershipCorrelationConfigV1Request} requestParameters Request parameters. * @param {*} [axiosOptions] Override http request option. * @throws {RequiredError} */ patchOwnershipCorrelationConfigV1(requestParameters: MachineIdentitiesApiPatchOwnershipCorrelationConfigV1Request, axiosOptions?: RawAxiosRequestConfig): AxiosPromise { return localVarFp.patchOwnershipCorrelationConfigV1(requestParameters.sourceId, requestParameters.resourceId, requestParameters.configId, requestParameters.jsonPatchOperation, axiosOptions).then((request) => request(axios, basePath)); }, /** * Starts a machine identity (AI Agents) aggregation on the specified source. * @summary Start machine identity aggregation * @param {MachineIdentitiesApiStartMachineIdentityAggregationV1Request} requestParameters Request parameters. * @param {*} [axiosOptions] Override http request option. * @throws {RequiredError} */ startMachineIdentityAggregationV1(requestParameters: MachineIdentitiesApiStartMachineIdentityAggregationV1Request, axiosOptions?: RawAxiosRequestConfig): AxiosPromise { return localVarFp.startMachineIdentityAggregationV1(requestParameters.sourceId, requestParameters.machineIdentityAggregationRequest, requestParameters.xSailPointExperimental, axiosOptions).then((request) => request(axios, basePath)); }, /** * Use this API to update machine identity details. * @summary Update machine identity details * @param {MachineIdentitiesApiUpdateMachineIdentityV1Request} requestParameters Request parameters. * @param {*} [axiosOptions] Override http request option. * @throws {RequiredError} */ updateMachineIdentityV1(requestParameters: MachineIdentitiesApiUpdateMachineIdentityV1Request, axiosOptions?: RawAxiosRequestConfig): AxiosPromise { return localVarFp.updateMachineIdentityV1(requestParameters.id, requestParameters.requestBody, requestParameters.xSailPointExperimental, axiosOptions).then((request) => request(axios, basePath)); }, /** * Use this API to selectively update machine identity details using a JSONPatch payload. Patchable fields include **name**, **description**, **nativeIdentity**, **subtype**, **environment**, **attributes**, **owners**, **userEntitlements**, and **manuallyEdited** only. * @summary Partial update of machine identity * @param {MachineIdentitiesApiUpdateMachineIdentityV2Request} requestParameters Request parameters. * @param {*} [axiosOptions] Override http request option. * @throws {RequiredError} */ updateMachineIdentityV2(requestParameters: MachineIdentitiesApiUpdateMachineIdentityV2Request, axiosOptions?: RawAxiosRequestConfig): AxiosPromise { return localVarFp.updateMachineIdentityV2(requestParameters.id, requestParameters.jsonPatchOperation, axiosOptions).then((request) => request(axios, basePath)); }, }; }; /** * Request parameters for createMachineIdentityV1 operation in MachineIdentitiesApi. * @export * @interface MachineIdentitiesApiCreateMachineIdentityV1Request */ export interface MachineIdentitiesApiCreateMachineIdentityV1Request { /** * * @type {MachineIdentityRequest} * @memberof MachineIdentitiesApiCreateMachineIdentityV1 */ readonly machineIdentityRequest: MachineIdentityRequest /** * Use this header to enable this experimental API. * @type {string} * @memberof MachineIdentitiesApiCreateMachineIdentityV1 */ readonly xSailPointExperimental?: string } /** * Request parameters for createMachineIdentityV2 operation in MachineIdentitiesApi. * @export * @interface MachineIdentitiesApiCreateMachineIdentityV2Request */ export interface MachineIdentitiesApiCreateMachineIdentityV2Request { /** * * @type {Machineidentityv2} * @memberof MachineIdentitiesApiCreateMachineIdentityV2 */ readonly machineidentityv2: Machineidentityv2 } /** * Request parameters for deleteMachineIdentityV1 operation in MachineIdentitiesApi. * @export * @interface MachineIdentitiesApiDeleteMachineIdentityV1Request */ export interface MachineIdentitiesApiDeleteMachineIdentityV1Request { /** * Machine Identity ID * @type {string} * @memberof MachineIdentitiesApiDeleteMachineIdentityV1 */ readonly id: string /** * Use this header to enable this experimental API. * @type {string} * @memberof MachineIdentitiesApiDeleteMachineIdentityV1 */ readonly xSailPointExperimental?: string } /** * Request parameters for deleteMachineIdentityV2 operation in MachineIdentitiesApi. * @export * @interface MachineIdentitiesApiDeleteMachineIdentityV2Request */ export interface MachineIdentitiesApiDeleteMachineIdentityV2Request { /** * Machine Identity ID. * @type {string} * @memberof MachineIdentitiesApiDeleteMachineIdentityV2 */ readonly id: string } /** * Request parameters for deleteOwnershipCorrelationConfigV1 operation in MachineIdentitiesApi. * @export * @interface MachineIdentitiesApiDeleteOwnershipCorrelationConfigV1Request */ export interface MachineIdentitiesApiDeleteOwnershipCorrelationConfigV1Request { /** * The Source ID. * @type {string} * @memberof MachineIdentitiesApiDeleteOwnershipCorrelationConfigV1 */ readonly sourceId: string /** * The source resource ID (for example, account or aws:iam-role). * @type {string} * @memberof MachineIdentitiesApiDeleteOwnershipCorrelationConfigV1 */ readonly resourceId: string /** * The correlation config ID. * @type {string} * @memberof MachineIdentitiesApiDeleteOwnershipCorrelationConfigV1 */ readonly configId: string } /** * Request parameters for getMachineIdentityV1 operation in MachineIdentitiesApi. * @export * @interface MachineIdentitiesApiGetMachineIdentityV1Request */ export interface MachineIdentitiesApiGetMachineIdentityV1Request { /** * Machine Identity ID * @type {string} * @memberof MachineIdentitiesApiGetMachineIdentityV1 */ readonly id: string /** * Use this header to enable this experimental API. * @type {string} * @memberof MachineIdentitiesApiGetMachineIdentityV1 */ readonly xSailPointExperimental?: string } /** * Request parameters for getMachineIdentityV2 operation in MachineIdentitiesApi. * @export * @interface MachineIdentitiesApiGetMachineIdentityV2Request */ export interface MachineIdentitiesApiGetMachineIdentityV2Request { /** * Machine Identity ID. * @type {string} * @memberof MachineIdentitiesApiGetMachineIdentityV2 */ readonly id: string } /** * Request parameters for getOwnershipCorrelationConfigV1 operation in MachineIdentitiesApi. * @export * @interface MachineIdentitiesApiGetOwnershipCorrelationConfigV1Request */ export interface MachineIdentitiesApiGetOwnershipCorrelationConfigV1Request { /** * The Source ID. * @type {string} * @memberof MachineIdentitiesApiGetOwnershipCorrelationConfigV1 */ readonly sourceId: string /** * The source resource ID (for example, account or aws:iam-role). * @type {string} * @memberof MachineIdentitiesApiGetOwnershipCorrelationConfigV1 */ readonly resourceId: string /** * The correlation config ID. * @type {string} * @memberof MachineIdentitiesApiGetOwnershipCorrelationConfigV1 */ readonly configId: string } /** * Request parameters for listMachineIdentitiesV1 operation in MachineIdentitiesApi. * @export * @interface MachineIdentitiesApiListMachineIdentitiesV1Request */ export interface MachineIdentitiesApiListMachineIdentitiesV1Request { /** * 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, sw* **displayName**: *eq, in, sw* **cisIdentityId**: *eq, in, sw* **nativeIdentity**: *eq, in, sw* **attributes**: *eq* **manuallyEdited**: *eq* **subtype**: *eq, in* **owners.primaryIdentity.id**: *eq, in, sw* **owners.primaryIdentity.name**: *eq, in, isnull, pr* **owners.secondaryIdentity.id**: *eq, in, sw* **owners.secondaryIdentity.name**: *eq, in, isnull, pr* **source.name**: *eq, in, sw* **source.id**: *eq, in* **entitlement.id**: *eq, in* **entitlement.name**: *eq, in, sw* * @type {string} * @memberof MachineIdentitiesApiListMachineIdentitiesV1 */ 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: **nativeIdentity, name, owners.primaryIdentity.name, source.name, created, modified** * @type {string} * @memberof MachineIdentitiesApiListMachineIdentitiesV1 */ readonly sorters?: string /** * Use this header to enable this experimental API. * @type {string} * @memberof MachineIdentitiesApiListMachineIdentitiesV1 */ readonly xSailPointExperimental?: string /** * 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 MachineIdentitiesApiListMachineIdentitiesV1 */ readonly count?: boolean /** * Max number of results to return. See [V3 API Standard Collection Parameters](https://developer.sailpoint.com/idn/api/standard-collection-parameters) for more information. * @type {number} * @memberof MachineIdentitiesApiListMachineIdentitiesV1 */ 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 MachineIdentitiesApiListMachineIdentitiesV1 */ readonly offset?: number } /** * Request parameters for listMachineIdentitiesV2 operation in MachineIdentitiesApi. * @export * @interface MachineIdentitiesApiListMachineIdentitiesV2Request */ export interface MachineIdentitiesApiListMachineIdentitiesV2Request { /** * 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, sw* **displayName**: *eq, in, sw* **nativeIdentity**: *eq, in, sw* **attributes**: *eq* **manuallyEdited**: *eq* **subtype**: *eq, in* **owners.primaryIdentity.id**: *eq, in, sw* **owners.primaryIdentity.name**: *eq, in, isnull, pr* **owners.secondaryIdentity.id**: *eq, in, sw* **owners.secondaryIdentity.name**: *eq, in, isnull, pr* **owners.secondaryGovernanceGroup.id**: *eq, in* **owners.secondaryGovernanceGroup.name**: *eq, in, isnull, pr* **source.id**: *eq, in* **source.name**: *eq, in, sw* **entitlement.id**: *eq, in* **entitlement.name**: *eq, in, sw* **risk.severity**: *eq, in* * @type {string} * @memberof MachineIdentitiesApiListMachineIdentitiesV2 */ 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: **nativeIdentity, name, owners.primaryIdentity.name, source.name, created, modified** * @type {string} * @memberof MachineIdentitiesApiListMachineIdentitiesV2 */ readonly sorters?: string /** * 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 MachineIdentitiesApiListMachineIdentitiesV2 */ readonly count?: boolean /** * Max number of results to return. See [V3 API Standard Collection Parameters](https://developer.sailpoint.com/idn/api/standard-collection-parameters) for more information. * @type {number} * @memberof MachineIdentitiesApiListMachineIdentitiesV2 */ 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 MachineIdentitiesApiListMachineIdentitiesV2 */ readonly offset?: number } /** * Request parameters for listMachineIdentityUserEntitlementsV1 operation in MachineIdentitiesApi. * @export * @interface MachineIdentitiesApiListMachineIdentityUserEntitlementsV1Request */ export interface MachineIdentitiesApiListMachineIdentityUserEntitlementsV1Request { /** * 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: **machineIdentityId**: *eq, in* **machineIdentityName**: *eq, in, sw* **entitlement.id**: *eq, in* **entitlement.name**: *eq, in, sw* **source.id**: *eq, in* **source.name**: *eq, in, sw* * @type {string} * @memberof MachineIdentitiesApiListMachineIdentityUserEntitlementsV1 */ 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: **machineIdentityName, entitlement.name, source.name** * @type {string} * @memberof MachineIdentitiesApiListMachineIdentityUserEntitlementsV1 */ readonly sorters?: string /** * Use this header to enable this experimental API. * @type {string} * @memberof MachineIdentitiesApiListMachineIdentityUserEntitlementsV1 */ readonly xSailPointExperimental?: string /** * 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 MachineIdentitiesApiListMachineIdentityUserEntitlementsV1 */ readonly count?: boolean /** * Max number of results to return. See [V3 API Standard Collection Parameters](https://developer.sailpoint.com/idn/api/standard-collection-parameters) for more information. * @type {number} * @memberof MachineIdentitiesApiListMachineIdentityUserEntitlementsV1 */ 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 MachineIdentitiesApiListMachineIdentityUserEntitlementsV1 */ readonly offset?: number } /** * Request parameters for listOwnershipCorrelationConfigsV1 operation in MachineIdentitiesApi. * @export * @interface MachineIdentitiesApiListOwnershipCorrelationConfigsV1Request */ export interface MachineIdentitiesApiListOwnershipCorrelationConfigsV1Request { /** * The Source ID. * @type {string} * @memberof MachineIdentitiesApiListOwnershipCorrelationConfigsV1 */ readonly sourceId: string /** * The source resource ID (for example, account or aws:iam-role). * @type {string} * @memberof MachineIdentitiesApiListOwnershipCorrelationConfigsV1 */ readonly resourceId: string /** * When set, filters to the given config type. * @type {'OWNER_PRIMARY' | 'OWNER_SECONDARY'} * @memberof MachineIdentitiesApiListOwnershipCorrelationConfigsV1 */ readonly type?: ListOwnershipCorrelationConfigsV1TypeEnum /** * 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 MachineIdentitiesApiListOwnershipCorrelationConfigsV1 */ readonly count?: boolean /** * Max number of results to return. See [V3 API Standard Collection Parameters](https://developer.sailpoint.com/idn/api/standard-collection-parameters) for more information. * @type {number} * @memberof MachineIdentitiesApiListOwnershipCorrelationConfigsV1 */ 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 MachineIdentitiesApiListOwnershipCorrelationConfigsV1 */ readonly offset?: number } /** * Request parameters for patchOwnershipCorrelationConfigV1 operation in MachineIdentitiesApi. * @export * @interface MachineIdentitiesApiPatchOwnershipCorrelationConfigV1Request */ export interface MachineIdentitiesApiPatchOwnershipCorrelationConfigV1Request { /** * The Source ID. * @type {string} * @memberof MachineIdentitiesApiPatchOwnershipCorrelationConfigV1 */ readonly sourceId: string /** * The source resource ID (for example, account or aws:iam-role). * @type {string} * @memberof MachineIdentitiesApiPatchOwnershipCorrelationConfigV1 */ readonly resourceId: string /** * The correlation config ID. * @type {string} * @memberof MachineIdentitiesApiPatchOwnershipCorrelationConfigV1 */ readonly configId: string /** * The JSONPatch payload used to update the correlation config. * @type {Array} * @memberof MachineIdentitiesApiPatchOwnershipCorrelationConfigV1 */ readonly jsonPatchOperation: Array } /** * Request parameters for startMachineIdentityAggregationV1 operation in MachineIdentitiesApi. * @export * @interface MachineIdentitiesApiStartMachineIdentityAggregationV1Request */ export interface MachineIdentitiesApiStartMachineIdentityAggregationV1Request { /** * Source ID. * @type {string} * @memberof MachineIdentitiesApiStartMachineIdentityAggregationV1 */ readonly sourceId: string /** * * @type {MachineIdentityAggregationRequest} * @memberof MachineIdentitiesApiStartMachineIdentityAggregationV1 */ readonly machineIdentityAggregationRequest: MachineIdentityAggregationRequest /** * Use this header to enable this experimental API. * @type {string} * @memberof MachineIdentitiesApiStartMachineIdentityAggregationV1 */ readonly xSailPointExperimental?: string } /** * Request parameters for updateMachineIdentityV1 operation in MachineIdentitiesApi. * @export * @interface MachineIdentitiesApiUpdateMachineIdentityV1Request */ export interface MachineIdentitiesApiUpdateMachineIdentityV1Request { /** * Machine Identity ID. * @type {string} * @memberof MachineIdentitiesApiUpdateMachineIdentityV1 */ readonly id: string /** * A JSON of updated values [JSON Patch](https://tools.ietf.org/html/rfc6902) standard. * @type {Array} * @memberof MachineIdentitiesApiUpdateMachineIdentityV1 */ readonly requestBody: Array /** * Use this header to enable this experimental API. * @type {string} * @memberof MachineIdentitiesApiUpdateMachineIdentityV1 */ readonly xSailPointExperimental?: string } /** * Request parameters for updateMachineIdentityV2 operation in MachineIdentitiesApi. * @export * @interface MachineIdentitiesApiUpdateMachineIdentityV2Request */ export interface MachineIdentitiesApiUpdateMachineIdentityV2Request { /** * Machine Identity ID. * @type {string} * @memberof MachineIdentitiesApiUpdateMachineIdentityV2 */ readonly id: string /** * A JSON of updated values [JSON Patch](https://tools.ietf.org/html/rfc6902) standard. * @type {Array} * @memberof MachineIdentitiesApiUpdateMachineIdentityV2 */ readonly jsonPatchOperation: Array } /** * MachineIdentitiesApi - object-oriented interface * @export * @class MachineIdentitiesApi * @extends {BaseAPI} */ export class MachineIdentitiesApi extends BaseAPI { /** * Use this API to create a machine identity. The maximum supported length for the description field is 2000 characters. * @summary Create machine identity * @param {MachineIdentitiesApiCreateMachineIdentityV1Request} requestParameters Request parameters. * @param {*} [axiosOptions] Override http request option. * @throws {RequiredError} * @memberof MachineIdentitiesApi */ public createMachineIdentityV1(requestParameters: MachineIdentitiesApiCreateMachineIdentityV1Request, axiosOptions?: RawAxiosRequestConfig) { return MachineIdentitiesApiFp(this.configuration).createMachineIdentityV1(requestParameters.machineIdentityRequest, requestParameters.xSailPointExperimental, axiosOptions).then((request) => request(this.axios, this.basePath)); } /** * Use this API to create a machine identity. Additional owners may be either up to ten human (IDENTITY) references or exactly one GOVERNANCE_GROUP reference - not both. The maximum supported length for the description field is 2000 characters. * @summary Create machine identity * @param {MachineIdentitiesApiCreateMachineIdentityV2Request} requestParameters Request parameters. * @param {*} [axiosOptions] Override http request option. * @throws {RequiredError} * @memberof MachineIdentitiesApi */ public createMachineIdentityV2(requestParameters: MachineIdentitiesApiCreateMachineIdentityV2Request, axiosOptions?: RawAxiosRequestConfig) { return MachineIdentitiesApiFp(this.configuration).createMachineIdentityV2(requestParameters.machineidentityv2, axiosOptions).then((request) => request(this.axios, this.basePath)); } /** * The API returns successful response if the requested machine identity was deleted. * @summary Delete machine identity * @param {MachineIdentitiesApiDeleteMachineIdentityV1Request} requestParameters Request parameters. * @param {*} [axiosOptions] Override http request option. * @throws {RequiredError} * @memberof MachineIdentitiesApi */ public deleteMachineIdentityV1(requestParameters: MachineIdentitiesApiDeleteMachineIdentityV1Request, axiosOptions?: RawAxiosRequestConfig) { return MachineIdentitiesApiFp(this.configuration).deleteMachineIdentityV1(requestParameters.id, requestParameters.xSailPointExperimental, axiosOptions).then((request) => request(this.axios, this.basePath)); } /** * The API returns a successful response if the requested machine identity was deleted. * @summary Delete machine identity * @param {MachineIdentitiesApiDeleteMachineIdentityV2Request} requestParameters Request parameters. * @param {*} [axiosOptions] Override http request option. * @throws {RequiredError} * @memberof MachineIdentitiesApi */ public deleteMachineIdentityV2(requestParameters: MachineIdentitiesApiDeleteMachineIdentityV2Request, axiosOptions?: RawAxiosRequestConfig) { return MachineIdentitiesApiFp(this.configuration).deleteMachineIdentityV2(requestParameters.id, axiosOptions).then((request) => request(this.axios, this.basePath)); } /** * Deletes the ownership correlation config with the specified ID for the given source resource. * @summary Delete ownership correlation config * @param {MachineIdentitiesApiDeleteOwnershipCorrelationConfigV1Request} requestParameters Request parameters. * @param {*} [axiosOptions] Override http request option. * @throws {RequiredError} * @memberof MachineIdentitiesApi */ public deleteOwnershipCorrelationConfigV1(requestParameters: MachineIdentitiesApiDeleteOwnershipCorrelationConfigV1Request, axiosOptions?: RawAxiosRequestConfig) { return MachineIdentitiesApiFp(this.configuration).deleteOwnershipCorrelationConfigV1(requestParameters.sourceId, requestParameters.resourceId, requestParameters.configId, axiosOptions).then((request) => request(this.axios, this.basePath)); } /** * This API returns a single machine identity using the Machine Identity ID. * @summary Get machine identity details * @param {MachineIdentitiesApiGetMachineIdentityV1Request} requestParameters Request parameters. * @param {*} [axiosOptions] Override http request option. * @throws {RequiredError} * @memberof MachineIdentitiesApi */ public getMachineIdentityV1(requestParameters: MachineIdentitiesApiGetMachineIdentityV1Request, axiosOptions?: RawAxiosRequestConfig) { return MachineIdentitiesApiFp(this.configuration).getMachineIdentityV1(requestParameters.id, requestParameters.xSailPointExperimental, axiosOptions).then((request) => request(this.axios, this.basePath)); } /** * This API returns a single machine identity using the Machine Identity ID. * @summary Get machine identity details * @param {MachineIdentitiesApiGetMachineIdentityV2Request} requestParameters Request parameters. * @param {*} [axiosOptions] Override http request option. * @throws {RequiredError} * @memberof MachineIdentitiesApi */ public getMachineIdentityV2(requestParameters: MachineIdentitiesApiGetMachineIdentityV2Request, axiosOptions?: RawAxiosRequestConfig) { return MachineIdentitiesApiFp(this.configuration).getMachineIdentityV2(requestParameters.id, axiosOptions).then((request) => request(this.axios, this.basePath)); } /** * This end-point retrieves a single ownership correlation config by ID for the specified source resource. * @summary Get ownership correlation config * @param {MachineIdentitiesApiGetOwnershipCorrelationConfigV1Request} requestParameters Request parameters. * @param {*} [axiosOptions] Override http request option. * @throws {RequiredError} * @memberof MachineIdentitiesApi */ public getOwnershipCorrelationConfigV1(requestParameters: MachineIdentitiesApiGetOwnershipCorrelationConfigV1Request, axiosOptions?: RawAxiosRequestConfig) { return MachineIdentitiesApiFp(this.configuration).getOwnershipCorrelationConfigV1(requestParameters.sourceId, requestParameters.resourceId, requestParameters.configId, axiosOptions).then((request) => request(this.axios, this.basePath)); } /** * This API returns a list of machine identities. * @summary List machine identities * @param {MachineIdentitiesApiListMachineIdentitiesV1Request} requestParameters Request parameters. * @param {*} [axiosOptions] Override http request option. * @throws {RequiredError} * @memberof MachineIdentitiesApi */ public listMachineIdentitiesV1(requestParameters: MachineIdentitiesApiListMachineIdentitiesV1Request = {}, axiosOptions?: RawAxiosRequestConfig) { return MachineIdentitiesApiFp(this.configuration).listMachineIdentitiesV1(requestParameters.filters, requestParameters.sorters, requestParameters.xSailPointExperimental, requestParameters.count, requestParameters.limit, requestParameters.offset, axiosOptions).then((request) => request(this.axios, this.basePath)); } /** * This API returns a list of machine identities. * @summary List machine identities * @param {MachineIdentitiesApiListMachineIdentitiesV2Request} requestParameters Request parameters. * @param {*} [axiosOptions] Override http request option. * @throws {RequiredError} * @memberof MachineIdentitiesApi */ public listMachineIdentitiesV2(requestParameters: MachineIdentitiesApiListMachineIdentitiesV2Request = {}, axiosOptions?: RawAxiosRequestConfig) { return MachineIdentitiesApiFp(this.configuration).listMachineIdentitiesV2(requestParameters.filters, requestParameters.sorters, requestParameters.count, requestParameters.limit, requestParameters.offset, axiosOptions).then((request) => request(this.axios, this.basePath)); } /** * This API returns a list of user entitlements associated with machine identities. * @summary List machine identity\'s user entitlements * @param {MachineIdentitiesApiListMachineIdentityUserEntitlementsV1Request} requestParameters Request parameters. * @param {*} [axiosOptions] Override http request option. * @throws {RequiredError} * @memberof MachineIdentitiesApi */ public listMachineIdentityUserEntitlementsV1(requestParameters: MachineIdentitiesApiListMachineIdentityUserEntitlementsV1Request = {}, axiosOptions?: RawAxiosRequestConfig) { return MachineIdentitiesApiFp(this.configuration).listMachineIdentityUserEntitlementsV1(requestParameters.filters, requestParameters.sorters, requestParameters.xSailPointExperimental, requestParameters.count, requestParameters.limit, requestParameters.offset, axiosOptions).then((request) => request(this.axios, this.basePath)); } /** * Returns the OWNER_PRIMARY and OWNER_SECONDARY correlation configs for the specified source resource, creating default rows if they are missing. Use the optional type query parameter to return a single matching config. * @summary List ownership correlation configs * @param {MachineIdentitiesApiListOwnershipCorrelationConfigsV1Request} requestParameters Request parameters. * @param {*} [axiosOptions] Override http request option. * @throws {RequiredError} * @memberof MachineIdentitiesApi */ public listOwnershipCorrelationConfigsV1(requestParameters: MachineIdentitiesApiListOwnershipCorrelationConfigsV1Request, axiosOptions?: RawAxiosRequestConfig) { return MachineIdentitiesApiFp(this.configuration).listOwnershipCorrelationConfigsV1(requestParameters.sourceId, requestParameters.resourceId, requestParameters.type, requestParameters.count, requestParameters.limit, requestParameters.offset, axiosOptions).then((request) => request(this.axios, this.basePath)); } /** * Selectively updates an ownership correlation config using an RFC 6902 JSONPatch payload. Only replace on /attributes (full object) and replace on /rules (full array; merge by stable rule id, remove rules omitted from the array) are allowed. * @summary Patch ownership correlation config * @param {MachineIdentitiesApiPatchOwnershipCorrelationConfigV1Request} requestParameters Request parameters. * @param {*} [axiosOptions] Override http request option. * @throws {RequiredError} * @memberof MachineIdentitiesApi */ public patchOwnershipCorrelationConfigV1(requestParameters: MachineIdentitiesApiPatchOwnershipCorrelationConfigV1Request, axiosOptions?: RawAxiosRequestConfig) { return MachineIdentitiesApiFp(this.configuration).patchOwnershipCorrelationConfigV1(requestParameters.sourceId, requestParameters.resourceId, requestParameters.configId, requestParameters.jsonPatchOperation, axiosOptions).then((request) => request(this.axios, this.basePath)); } /** * Starts a machine identity (AI Agents) aggregation on the specified source. * @summary Start machine identity aggregation * @param {MachineIdentitiesApiStartMachineIdentityAggregationV1Request} requestParameters Request parameters. * @param {*} [axiosOptions] Override http request option. * @throws {RequiredError} * @memberof MachineIdentitiesApi */ public startMachineIdentityAggregationV1(requestParameters: MachineIdentitiesApiStartMachineIdentityAggregationV1Request, axiosOptions?: RawAxiosRequestConfig) { return MachineIdentitiesApiFp(this.configuration).startMachineIdentityAggregationV1(requestParameters.sourceId, requestParameters.machineIdentityAggregationRequest, requestParameters.xSailPointExperimental, axiosOptions).then((request) => request(this.axios, this.basePath)); } /** * Use this API to update machine identity details. * @summary Update machine identity details * @param {MachineIdentitiesApiUpdateMachineIdentityV1Request} requestParameters Request parameters. * @param {*} [axiosOptions] Override http request option. * @throws {RequiredError} * @memberof MachineIdentitiesApi */ public updateMachineIdentityV1(requestParameters: MachineIdentitiesApiUpdateMachineIdentityV1Request, axiosOptions?: RawAxiosRequestConfig) { return MachineIdentitiesApiFp(this.configuration).updateMachineIdentityV1(requestParameters.id, requestParameters.requestBody, requestParameters.xSailPointExperimental, axiosOptions).then((request) => request(this.axios, this.basePath)); } /** * Use this API to selectively update machine identity details using a JSONPatch payload. Patchable fields include **name**, **description**, **nativeIdentity**, **subtype**, **environment**, **attributes**, **owners**, **userEntitlements**, and **manuallyEdited** only. * @summary Partial update of machine identity * @param {MachineIdentitiesApiUpdateMachineIdentityV2Request} requestParameters Request parameters. * @param {*} [axiosOptions] Override http request option. * @throws {RequiredError} * @memberof MachineIdentitiesApi */ public updateMachineIdentityV2(requestParameters: MachineIdentitiesApiUpdateMachineIdentityV2Request, axiosOptions?: RawAxiosRequestConfig) { return MachineIdentitiesApiFp(this.configuration).updateMachineIdentityV2(requestParameters.id, requestParameters.jsonPatchOperation, axiosOptions).then((request) => request(this.axios, this.basePath)); } } /** * @export */ export const ListOwnershipCorrelationConfigsV1TypeEnum = { OwnerPrimary: 'OWNER_PRIMARY', OwnerSecondary: 'OWNER_SECONDARY' } as const; export type ListOwnershipCorrelationConfigsV1TypeEnum = typeof ListOwnershipCorrelationConfigsV1TypeEnum[keyof typeof ListOwnershipCorrelationConfigsV1TypeEnum];