/** * Identity Security Cloud API - Machine Accounts * Use these APIs to interact with the Identity Security Cloud platform to achieve repeatable, automated processes with greater scalability. We encourage you to join the SailPoint Developer Community forum at https://developer.sailpoint.com/discuss to connect with other developers using our APIs. * * The version of the OpenAPI document: v1 * * * NOTE: This class is auto generated by OpenAPI Generator (https://openapi-generator.tech). * https://openapi-generator.tech * Do not edit the class manually. */ import type { Configuration } from '../configuration'; import type { AxiosPromise, AxiosInstance, RawAxiosRequestConfig } from 'axios'; import type { RequestArgs } from './base'; import { BaseAPI } from './base'; /** * * @export * @interface 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 CreateMachineAccountSubtypeV1Request */ export interface CreateMachineAccountSubtypeV1Request { /** * Technical name of the subtype. * @type {string} * @memberof CreateMachineAccountSubtypeV1Request */ 'technicalName': string; /** * Display name of the subtype. * @type {string} * @memberof CreateMachineAccountSubtypeV1Request */ 'displayName': string; /** * Description of the subtype. * @type {string} * @memberof CreateMachineAccountSubtypeV1Request */ 'description': string; /** * Type of the subtype. * @type {string} * @memberof CreateMachineAccountSubtypeV1Request */ 'type'?: string; } /** * * @export * @interface ErrorMessageDto */ export interface ErrorMessageDto { /** * The locale for the message text, a BCP 47 language tag. * @type {string} * @memberof ErrorMessageDto */ 'locale'?: string | null; /** * * @type {LocaleOrigin} * @memberof ErrorMessageDto */ 'localeOrigin'?: LocaleOrigin | null; /** * Actual text of the error message in the indicated locale. * @type {string} * @memberof ErrorMessageDto */ 'text'?: string; } /** * * @export * @interface ErrorResponseDto */ export interface ErrorResponseDto { /** * Fine-grained error code providing more detail of the error. * @type {string} * @memberof ErrorResponseDto */ 'detailCode'?: string; /** * Unique tracking id for the error. * @type {string} * @memberof ErrorResponseDto */ 'trackingId'?: string; /** * Generic localized reason for error * @type {Array} * @memberof ErrorResponseDto */ 'messages'?: Array; /** * Plain-text descriptive reasons to provide additional detail to the text provided in the messages field * @type {Array} * @memberof ErrorResponseDto */ 'causes'?: Array; } /** * * @export * @interface ListMachineAccountsV1401Response */ export interface ListMachineAccountsV1401Response { /** * A message describing the error * @type {any} * @memberof ListMachineAccountsV1401Response */ 'error'?: any; } /** * * @export * @interface ListMachineAccountsV1429Response */ export interface ListMachineAccountsV1429Response { /** * A message describing the error * @type {any} * @memberof ListMachineAccountsV1429Response */ 'message'?: any; } /** * An indicator of how the locale was selected. *DEFAULT* means the locale is the system default. *REQUEST* means the locale was selected from the request context (i.e., best match based on the *Accept-Language* header). Additional values may be added in the future without notice. * @export * @enum {string} */ export declare const LocaleOrigin: { readonly Default: "DEFAULT"; readonly Request: "REQUEST"; }; export type LocaleOrigin = typeof LocaleOrigin[keyof typeof LocaleOrigin]; /** * * @export * @interface MachineAccount */ export interface MachineAccount { /** * System-generated unique ID of the Object * @type {string} * @memberof MachineAccount */ 'id'?: string; /** * Name of the Object * @type {string} * @memberof MachineAccount */ 'name': string | null; /** * Creation date of the Object * @type {string} * @memberof MachineAccount */ 'created'?: string; /** * Last modification date of the Object * @type {string} * @memberof MachineAccount */ 'modified'?: string; /** * A description of the machine account * @type {string} * @memberof MachineAccount */ 'description'?: string | null; /** * The unique ID of the machine account generated by the source system * @type {string} * @memberof MachineAccount */ 'nativeIdentity': string; /** * The unique ID of the account as determined by the account schema * @type {string} * @memberof MachineAccount */ 'uuid'?: string | null; /** * Classification Method * @type {string} * @memberof MachineAccount */ 'classificationMethod': MachineAccountClassificationMethodEnum; /** * The machine identity this account is associated with * @type {any} * @memberof MachineAccount */ 'machineIdentity'?: any; /** * The identity who owns this account. * @type {any} * @memberof MachineAccount */ 'ownerIdentity'?: any | null; /** * The connection type of the source this account is from * @type {string} * @memberof MachineAccount */ 'accessType'?: string; /** * The sub-type * @type {string} * @memberof MachineAccount */ 'subtype'?: string | null; /** * Environment * @type {string} * @memberof MachineAccount */ 'environment'?: string | null; /** * Custom attributes specific to the machine account * @type {{ [key: string]: any; }} * @memberof MachineAccount */ 'attributes'?: { [key: string]: any; } | null; /** * The connector attributes for the account * @type {{ [key: string]: any; }} * @memberof MachineAccount */ 'connectorAttributes': { [key: string]: any; } | null; /** * Indicates if the account has been manually correlated to an identity * @type {boolean} * @memberof MachineAccount */ 'manuallyCorrelated'?: boolean; /** * Indicates if the account has been manually edited * @type {boolean} * @memberof MachineAccount */ 'manuallyEdited': boolean; /** * Indicates if the account is currently locked * @type {boolean} * @memberof MachineAccount */ 'locked': boolean; /** * Indicates if the account is enabled * @type {boolean} * @memberof MachineAccount */ 'enabled': boolean; /** * Indicates if the account has entitlements * @type {boolean} * @memberof MachineAccount */ 'hasEntitlements': boolean; /** * The source this machine account belongs to. * @type {any} * @memberof MachineAccount */ 'source': any; } export declare const MachineAccountClassificationMethodEnum: { readonly Source: "SOURCE"; readonly Criteria: "CRITERIA"; readonly Discovery: "DISCOVERY"; readonly Manual: "MANUAL"; }; export type MachineAccountClassificationMethodEnum = typeof MachineAccountClassificationMethodEnum[keyof typeof MachineAccountClassificationMethodEnum]; /** * * @export * @interface SourceSubtype */ export interface SourceSubtype { /** * Unique identifier for the subtype. * @type {string} * @memberof SourceSubtype */ 'id'?: string; /** * The ID of the source. * @type {string} * @memberof SourceSubtype */ 'sourceId'?: string; /** * Technical name of the subtype. * @type {string} * @memberof SourceSubtype */ 'technicalName': string; /** * Display name of the subtype. * @type {string} * @memberof SourceSubtype */ 'displayName': string; /** * Description of the subtype. * @type {string} * @memberof SourceSubtype */ 'description': string; /** * Creation timestamp. * @type {string} * @memberof SourceSubtype */ 'created'?: string; /** * Last modified timestamp. * @type {string} * @memberof SourceSubtype */ 'modified'?: string; /** * Type of the subtype. Either MACHINE OR null. * @type {string} * @memberof SourceSubtype */ 'type'?: string; } /** * MachineAccountsApi - axios parameter creator * @export */ export declare const MachineAccountsApiAxiosParamCreator: (configuration?: Configuration) => { /** * Create a new machine account subtype for a source. * @summary Create subtype * @param {string} sourceId The ID of the source. * @param {CreateMachineAccountSubtypeV1Request} createMachineAccountSubtypeV1Request * @param {string} [xSailPointExperimental] Use this header to enable this experimental API. * @param {*} [axiosOptions] Override http request option. * @deprecated * @throws {RequiredError} */ createMachineAccountSubtypeV1: (sourceId: string, createMachineAccountSubtypeV1Request: CreateMachineAccountSubtypeV1Request, xSailPointExperimental?: string, axiosOptions?: RawAxiosRequestConfig) => Promise; /** * Delete a machine account subtype by source ID and technical name. * @summary Delete subtype * @param {string} sourceId The ID of the source. * @param {string} technicalName The technical name of the subtype. * @param {string} [xSailPointExperimental] Use this header to enable this experimental API. * @param {*} [axiosOptions] Override http request option. * @deprecated * @throws {RequiredError} */ deleteMachineAccountSubtypeByTechnicalNameV1: (sourceId: string, technicalName: string, xSailPointExperimental?: string, axiosOptions?: RawAxiosRequestConfig) => Promise; /** * Get a machine account subtype by its unique ID. * @summary Retrieve subtype by subtype id * @param {string} subtypeId The ID of the machine account subtype. * @param {string} [xSailPointExperimental] Use this header to enable this experimental API. * @param {*} [axiosOptions] Override http request option. * @deprecated * @throws {RequiredError} */ getMachineAccountSubtypeByIdV1: (subtypeId: string, xSailPointExperimental?: string, axiosOptions?: RawAxiosRequestConfig) => Promise; /** * Get a machine account subtype by source ID and technical name. * @summary Retrieve subtype by source and technicalName * @param {string} sourceId The ID of the source. * @param {string} technicalName The technical name of the subtype. * @param {string} [xSailPointExperimental] Use this header to enable this experimental API. * @param {*} [axiosOptions] Override http request option. * @deprecated * @throws {RequiredError} */ getMachineAccountSubtypeByTechnicalNameV1: (sourceId: string, technicalName: string, xSailPointExperimental?: string, axiosOptions?: RawAxiosRequestConfig) => Promise; /** * Use this API to return the details for a single machine account by its ID. * @summary Get machine account details * @param {string} id Machine Account ID. * @param {string} [xSailPointExperimental] Use this header to enable this experimental API. * @param {*} [axiosOptions] Override http request option. * @throws {RequiredError} */ getMachineAccountV1: (id: string, xSailPointExperimental?: string, axiosOptions?: RawAxiosRequestConfig) => Promise; /** * Get all machine account subtypes for a given source. * @summary Retrieve all subtypes by source * @param {string} sourceId The ID of the source. * @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: **displayName**: *eq, sw* **technicalName**: *eq, 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: **displayName, technicalName** * @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. * @deprecated * @throws {RequiredError} */ listMachineAccountSubtypesV1: (sourceId: string, filters?: string, sorters?: string, xSailPointExperimental?: string, count?: boolean, limit?: number, offset?: number, axiosOptions?: RawAxiosRequestConfig) => Promise; /** * This returns a list of machine accounts. * @summary List machine accounts * @param {number} [limit] Max number of results to return. See [V3 API Standard Collection Parameters](https://developer.sailpoint.com/idn/api/standard-collection-parameters) for more information. * @param {number} [offset] Offset into the full result set. Usually specified with *limit* to paginate through the results. See [V3 API Standard Collection Parameters](https://developer.sailpoint.com/idn/api/standard-collection-parameters) for more information. * @param {boolean} [count] If *true* it will populate the *X-Total-Count* response header with the number of results that would be returned if *limit* and *offset* were ignored. Since requesting a total count can have a performance impact, it is recommended not to send **count=true** if that value will not be used. See [V3 API Standard Collection Parameters](https://developer.sailpoint.com/idn/api/standard-collection-parameters) for more information. * @param {string} [filters] Filter results using the standard syntax described in [V3 API Standard Collection Parameters](https://developer.sailpoint.com/idn/api/standard-collection-parameters#filtering-results) Filtering is supported for the following fields and operators: **id**: *eq, in* **name**: *eq, in, sw* **nativeIdentity**: *eq, in, sw* **uuid**: *eq, in* **description**: *eq, in, sw* **machineIdentity.id**: *eq, in* **machineIdentity.name**: *eq, in, sw* **subtype.technicalName**: *eq, in, sw* **subtype.displayName**: *eq, in, sw* **accessType**: *eq, in, sw* **environment**: *eq, in, sw* **ownerIdentity**: *eq, in* **ownerIdentity.id**: *eq, in* **ownerIdentity.name**: *eq, in, sw* **manuallyCorrelated**: *eq* **enabled**: *eq* **locked**: *eq* **hasEntitlements**: *eq* **attributes**: *eq* **source.id**: *eq, in* **source.name**: *eq, in, sw* **created**: *eq, gt, lt, ge, le* **modified**: *eq, gt, lt, ge, le* * @param {string} [sorters] Sort results using the standard syntax described in [V3 API Standard Collection Parameters](https://developer.sailpoint.com/idn/api/standard-collection-parameters#sorting-results) Sorting is supported for the following fields: **id, name, nativeIdentity, ownerIdentity, uuid, description, machineIdentity.id, machineIdentity.name, subtype.technicalName, subtype.displayName, accessType, environment, manuallyCorrelated, enabled, locked, hasEntitlements, ownerIdentity.id, ownerIdentity.name, attributes, source.id, source.name, created, modified** * @param {string} [xSailPointExperimental] Use this header to enable this experimental API. * @param {*} [axiosOptions] Override http request option. * @throws {RequiredError} */ listMachineAccountsV1: (limit?: number, offset?: number, count?: boolean, filters?: string, sorters?: string, xSailPointExperimental?: string, axiosOptions?: RawAxiosRequestConfig) => Promise; /** * Update fields of a machine account subtype by source ID and technical name. Patchable fields include: `displayName`, `description`. * @summary Patch subtype * @param {string} sourceId The ID of the source. * @param {string} technicalName The technical name of the subtype. * @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. * @deprecated * @throws {RequiredError} */ patchMachineAccountSubtypeByTechnicalNameV1: (sourceId: string, technicalName: string, requestBody: Array, xSailPointExperimental?: string, axiosOptions?: RawAxiosRequestConfig) => Promise; /** * Use this API to update machine accounts details. * @summary Update machine account details * @param {string} id Machine Account ID. * @param {Array} requestBody A JSON of updated values [JSON Patch](https://tools.ietf.org/html/rfc6902) standard. The following fields are patchable: * description * ownerIdentity * subType * accessType * environment * attributes * classificationMethod * manuallyEdited * nativeIdentity * uuid * source * manuallyCorrelated * enabled * locked * hasEntitlements * connectorAttributes * @param {string} [xSailPointExperimental] Use this header to enable this experimental API. * @param {*} [axiosOptions] Override http request option. * @throws {RequiredError} */ updateMachineAccountV1: (id: string, requestBody: Array, xSailPointExperimental?: string, axiosOptions?: RawAxiosRequestConfig) => Promise; }; /** * MachineAccountsApi - functional programming interface * @export */ export declare const MachineAccountsApiFp: (configuration?: Configuration) => { /** * Create a new machine account subtype for a source. * @summary Create subtype * @param {string} sourceId The ID of the source. * @param {CreateMachineAccountSubtypeV1Request} createMachineAccountSubtypeV1Request * @param {string} [xSailPointExperimental] Use this header to enable this experimental API. * @param {*} [axiosOptions] Override http request option. * @deprecated * @throws {RequiredError} */ createMachineAccountSubtypeV1(sourceId: string, createMachineAccountSubtypeV1Request: CreateMachineAccountSubtypeV1Request, xSailPointExperimental?: string, axiosOptions?: RawAxiosRequestConfig): Promise<(axios?: AxiosInstance, basePath?: string) => AxiosPromise>; /** * Delete a machine account subtype by source ID and technical name. * @summary Delete subtype * @param {string} sourceId The ID of the source. * @param {string} technicalName The technical name of the subtype. * @param {string} [xSailPointExperimental] Use this header to enable this experimental API. * @param {*} [axiosOptions] Override http request option. * @deprecated * @throws {RequiredError} */ deleteMachineAccountSubtypeByTechnicalNameV1(sourceId: string, technicalName: string, xSailPointExperimental?: string, axiosOptions?: RawAxiosRequestConfig): Promise<(axios?: AxiosInstance, basePath?: string) => AxiosPromise>; /** * Get a machine account subtype by its unique ID. * @summary Retrieve subtype by subtype id * @param {string} subtypeId The ID of the machine account subtype. * @param {string} [xSailPointExperimental] Use this header to enable this experimental API. * @param {*} [axiosOptions] Override http request option. * @deprecated * @throws {RequiredError} */ getMachineAccountSubtypeByIdV1(subtypeId: string, xSailPointExperimental?: string, axiosOptions?: RawAxiosRequestConfig): Promise<(axios?: AxiosInstance, basePath?: string) => AxiosPromise>; /** * Get a machine account subtype by source ID and technical name. * @summary Retrieve subtype by source and technicalName * @param {string} sourceId The ID of the source. * @param {string} technicalName The technical name of the subtype. * @param {string} [xSailPointExperimental] Use this header to enable this experimental API. * @param {*} [axiosOptions] Override http request option. * @deprecated * @throws {RequiredError} */ getMachineAccountSubtypeByTechnicalNameV1(sourceId: string, technicalName: string, xSailPointExperimental?: string, axiosOptions?: RawAxiosRequestConfig): Promise<(axios?: AxiosInstance, basePath?: string) => AxiosPromise>; /** * Use this API to return the details for a single machine account by its ID. * @summary Get machine account details * @param {string} id Machine Account ID. * @param {string} [xSailPointExperimental] Use this header to enable this experimental API. * @param {*} [axiosOptions] Override http request option. * @throws {RequiredError} */ getMachineAccountV1(id: string, xSailPointExperimental?: string, axiosOptions?: RawAxiosRequestConfig): Promise<(axios?: AxiosInstance, basePath?: string) => AxiosPromise>; /** * Get all machine account subtypes for a given source. * @summary Retrieve all subtypes by source * @param {string} sourceId The ID of the source. * @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: **displayName**: *eq, sw* **technicalName**: *eq, 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: **displayName, technicalName** * @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. * @deprecated * @throws {RequiredError} */ listMachineAccountSubtypesV1(sourceId: string, filters?: string, sorters?: string, xSailPointExperimental?: string, count?: boolean, limit?: number, offset?: number, axiosOptions?: RawAxiosRequestConfig): Promise<(axios?: AxiosInstance, basePath?: string) => AxiosPromise>>; /** * This returns a list of machine accounts. * @summary List machine accounts * @param {number} [limit] Max number of results to return. See [V3 API Standard Collection Parameters](https://developer.sailpoint.com/idn/api/standard-collection-parameters) for more information. * @param {number} [offset] Offset into the full result set. Usually specified with *limit* to paginate through the results. See [V3 API Standard Collection Parameters](https://developer.sailpoint.com/idn/api/standard-collection-parameters) for more information. * @param {boolean} [count] If *true* it will populate the *X-Total-Count* response header with the number of results that would be returned if *limit* and *offset* were ignored. Since requesting a total count can have a performance impact, it is recommended not to send **count=true** if that value will not be used. See [V3 API Standard Collection Parameters](https://developer.sailpoint.com/idn/api/standard-collection-parameters) for more information. * @param {string} [filters] Filter results using the standard syntax described in [V3 API Standard Collection Parameters](https://developer.sailpoint.com/idn/api/standard-collection-parameters#filtering-results) Filtering is supported for the following fields and operators: **id**: *eq, in* **name**: *eq, in, sw* **nativeIdentity**: *eq, in, sw* **uuid**: *eq, in* **description**: *eq, in, sw* **machineIdentity.id**: *eq, in* **machineIdentity.name**: *eq, in, sw* **subtype.technicalName**: *eq, in, sw* **subtype.displayName**: *eq, in, sw* **accessType**: *eq, in, sw* **environment**: *eq, in, sw* **ownerIdentity**: *eq, in* **ownerIdentity.id**: *eq, in* **ownerIdentity.name**: *eq, in, sw* **manuallyCorrelated**: *eq* **enabled**: *eq* **locked**: *eq* **hasEntitlements**: *eq* **attributes**: *eq* **source.id**: *eq, in* **source.name**: *eq, in, sw* **created**: *eq, gt, lt, ge, le* **modified**: *eq, gt, lt, ge, le* * @param {string} [sorters] Sort results using the standard syntax described in [V3 API Standard Collection Parameters](https://developer.sailpoint.com/idn/api/standard-collection-parameters#sorting-results) Sorting is supported for the following fields: **id, name, nativeIdentity, ownerIdentity, uuid, description, machineIdentity.id, machineIdentity.name, subtype.technicalName, subtype.displayName, accessType, environment, manuallyCorrelated, enabled, locked, hasEntitlements, ownerIdentity.id, ownerIdentity.name, attributes, source.id, source.name, created, modified** * @param {string} [xSailPointExperimental] Use this header to enable this experimental API. * @param {*} [axiosOptions] Override http request option. * @throws {RequiredError} */ listMachineAccountsV1(limit?: number, offset?: number, count?: boolean, filters?: string, sorters?: string, xSailPointExperimental?: string, axiosOptions?: RawAxiosRequestConfig): Promise<(axios?: AxiosInstance, basePath?: string) => AxiosPromise>>; /** * Update fields of a machine account subtype by source ID and technical name. Patchable fields include: `displayName`, `description`. * @summary Patch subtype * @param {string} sourceId The ID of the source. * @param {string} technicalName The technical name of the subtype. * @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. * @deprecated * @throws {RequiredError} */ patchMachineAccountSubtypeByTechnicalNameV1(sourceId: string, technicalName: string, requestBody: Array, xSailPointExperimental?: string, axiosOptions?: RawAxiosRequestConfig): Promise<(axios?: AxiosInstance, basePath?: string) => AxiosPromise>; /** * Use this API to update machine accounts details. * @summary Update machine account details * @param {string} id Machine Account ID. * @param {Array} requestBody A JSON of updated values [JSON Patch](https://tools.ietf.org/html/rfc6902) standard. The following fields are patchable: * description * ownerIdentity * subType * accessType * environment * attributes * classificationMethod * manuallyEdited * nativeIdentity * uuid * source * manuallyCorrelated * enabled * locked * hasEntitlements * connectorAttributes * @param {string} [xSailPointExperimental] Use this header to enable this experimental API. * @param {*} [axiosOptions] Override http request option. * @throws {RequiredError} */ updateMachineAccountV1(id: string, requestBody: Array, xSailPointExperimental?: string, axiosOptions?: RawAxiosRequestConfig): Promise<(axios?: AxiosInstance, basePath?: string) => AxiosPromise>; }; /** * MachineAccountsApi - factory interface * @export */ export declare const MachineAccountsApiFactory: (configuration?: Configuration, basePath?: string, axios?: AxiosInstance) => { /** * Create a new machine account subtype for a source. * @summary Create subtype * @param {MachineAccountsApiCreateMachineAccountSubtypeV1Request} requestParameters Request parameters. * @param {*} [axiosOptions] Override http request option. * @deprecated * @throws {RequiredError} */ createMachineAccountSubtypeV1(requestParameters: MachineAccountsApiCreateMachineAccountSubtypeV1Request, axiosOptions?: RawAxiosRequestConfig): AxiosPromise; /** * Delete a machine account subtype by source ID and technical name. * @summary Delete subtype * @param {MachineAccountsApiDeleteMachineAccountSubtypeByTechnicalNameV1Request} requestParameters Request parameters. * @param {*} [axiosOptions] Override http request option. * @deprecated * @throws {RequiredError} */ deleteMachineAccountSubtypeByTechnicalNameV1(requestParameters: MachineAccountsApiDeleteMachineAccountSubtypeByTechnicalNameV1Request, axiosOptions?: RawAxiosRequestConfig): AxiosPromise; /** * Get a machine account subtype by its unique ID. * @summary Retrieve subtype by subtype id * @param {MachineAccountsApiGetMachineAccountSubtypeByIdV1Request} requestParameters Request parameters. * @param {*} [axiosOptions] Override http request option. * @deprecated * @throws {RequiredError} */ getMachineAccountSubtypeByIdV1(requestParameters: MachineAccountsApiGetMachineAccountSubtypeByIdV1Request, axiosOptions?: RawAxiosRequestConfig): AxiosPromise; /** * Get a machine account subtype by source ID and technical name. * @summary Retrieve subtype by source and technicalName * @param {MachineAccountsApiGetMachineAccountSubtypeByTechnicalNameV1Request} requestParameters Request parameters. * @param {*} [axiosOptions] Override http request option. * @deprecated * @throws {RequiredError} */ getMachineAccountSubtypeByTechnicalNameV1(requestParameters: MachineAccountsApiGetMachineAccountSubtypeByTechnicalNameV1Request, axiosOptions?: RawAxiosRequestConfig): AxiosPromise; /** * Use this API to return the details for a single machine account by its ID. * @summary Get machine account details * @param {MachineAccountsApiGetMachineAccountV1Request} requestParameters Request parameters. * @param {*} [axiosOptions] Override http request option. * @throws {RequiredError} */ getMachineAccountV1(requestParameters: MachineAccountsApiGetMachineAccountV1Request, axiosOptions?: RawAxiosRequestConfig): AxiosPromise; /** * Get all machine account subtypes for a given source. * @summary Retrieve all subtypes by source * @param {MachineAccountsApiListMachineAccountSubtypesV1Request} requestParameters Request parameters. * @param {*} [axiosOptions] Override http request option. * @deprecated * @throws {RequiredError} */ listMachineAccountSubtypesV1(requestParameters: MachineAccountsApiListMachineAccountSubtypesV1Request, axiosOptions?: RawAxiosRequestConfig): AxiosPromise>; /** * This returns a list of machine accounts. * @summary List machine accounts * @param {MachineAccountsApiListMachineAccountsV1Request} requestParameters Request parameters. * @param {*} [axiosOptions] Override http request option. * @throws {RequiredError} */ listMachineAccountsV1(requestParameters?: MachineAccountsApiListMachineAccountsV1Request, axiosOptions?: RawAxiosRequestConfig): AxiosPromise>; /** * Update fields of a machine account subtype by source ID and technical name. Patchable fields include: `displayName`, `description`. * @summary Patch subtype * @param {MachineAccountsApiPatchMachineAccountSubtypeByTechnicalNameV1Request} requestParameters Request parameters. * @param {*} [axiosOptions] Override http request option. * @deprecated * @throws {RequiredError} */ patchMachineAccountSubtypeByTechnicalNameV1(requestParameters: MachineAccountsApiPatchMachineAccountSubtypeByTechnicalNameV1Request, axiosOptions?: RawAxiosRequestConfig): AxiosPromise; /** * Use this API to update machine accounts details. * @summary Update machine account details * @param {MachineAccountsApiUpdateMachineAccountV1Request} requestParameters Request parameters. * @param {*} [axiosOptions] Override http request option. * @throws {RequiredError} */ updateMachineAccountV1(requestParameters: MachineAccountsApiUpdateMachineAccountV1Request, axiosOptions?: RawAxiosRequestConfig): AxiosPromise; }; /** * Request parameters for createMachineAccountSubtypeV1 operation in MachineAccountsApi. * @export * @interface MachineAccountsApiCreateMachineAccountSubtypeV1Request */ export interface MachineAccountsApiCreateMachineAccountSubtypeV1Request { /** * The ID of the source. * @type {string} * @memberof MachineAccountsApiCreateMachineAccountSubtypeV1 */ readonly sourceId: string; /** * * @type {CreateMachineAccountSubtypeV1Request} * @memberof MachineAccountsApiCreateMachineAccountSubtypeV1 */ readonly createMachineAccountSubtypeV1Request: CreateMachineAccountSubtypeV1Request; /** * Use this header to enable this experimental API. * @type {string} * @memberof MachineAccountsApiCreateMachineAccountSubtypeV1 */ readonly xSailPointExperimental?: string; } /** * Request parameters for deleteMachineAccountSubtypeByTechnicalNameV1 operation in MachineAccountsApi. * @export * @interface MachineAccountsApiDeleteMachineAccountSubtypeByTechnicalNameV1Request */ export interface MachineAccountsApiDeleteMachineAccountSubtypeByTechnicalNameV1Request { /** * The ID of the source. * @type {string} * @memberof MachineAccountsApiDeleteMachineAccountSubtypeByTechnicalNameV1 */ readonly sourceId: string; /** * The technical name of the subtype. * @type {string} * @memberof MachineAccountsApiDeleteMachineAccountSubtypeByTechnicalNameV1 */ readonly technicalName: string; /** * Use this header to enable this experimental API. * @type {string} * @memberof MachineAccountsApiDeleteMachineAccountSubtypeByTechnicalNameV1 */ readonly xSailPointExperimental?: string; } /** * Request parameters for getMachineAccountSubtypeByIdV1 operation in MachineAccountsApi. * @export * @interface MachineAccountsApiGetMachineAccountSubtypeByIdV1Request */ export interface MachineAccountsApiGetMachineAccountSubtypeByIdV1Request { /** * The ID of the machine account subtype. * @type {string} * @memberof MachineAccountsApiGetMachineAccountSubtypeByIdV1 */ readonly subtypeId: string; /** * Use this header to enable this experimental API. * @type {string} * @memberof MachineAccountsApiGetMachineAccountSubtypeByIdV1 */ readonly xSailPointExperimental?: string; } /** * Request parameters for getMachineAccountSubtypeByTechnicalNameV1 operation in MachineAccountsApi. * @export * @interface MachineAccountsApiGetMachineAccountSubtypeByTechnicalNameV1Request */ export interface MachineAccountsApiGetMachineAccountSubtypeByTechnicalNameV1Request { /** * The ID of the source. * @type {string} * @memberof MachineAccountsApiGetMachineAccountSubtypeByTechnicalNameV1 */ readonly sourceId: string; /** * The technical name of the subtype. * @type {string} * @memberof MachineAccountsApiGetMachineAccountSubtypeByTechnicalNameV1 */ readonly technicalName: string; /** * Use this header to enable this experimental API. * @type {string} * @memberof MachineAccountsApiGetMachineAccountSubtypeByTechnicalNameV1 */ readonly xSailPointExperimental?: string; } /** * Request parameters for getMachineAccountV1 operation in MachineAccountsApi. * @export * @interface MachineAccountsApiGetMachineAccountV1Request */ export interface MachineAccountsApiGetMachineAccountV1Request { /** * Machine Account ID. * @type {string} * @memberof MachineAccountsApiGetMachineAccountV1 */ readonly id: string; /** * Use this header to enable this experimental API. * @type {string} * @memberof MachineAccountsApiGetMachineAccountV1 */ readonly xSailPointExperimental?: string; } /** * Request parameters for listMachineAccountSubtypesV1 operation in MachineAccountsApi. * @export * @interface MachineAccountsApiListMachineAccountSubtypesV1Request */ export interface MachineAccountsApiListMachineAccountSubtypesV1Request { /** * The ID of the source. * @type {string} * @memberof MachineAccountsApiListMachineAccountSubtypesV1 */ readonly sourceId: string; /** * Filter results using the standard syntax described in [V3 API Standard Collection Parameters](https://developer.sailpoint.com/idn/api/standard-collection-parameters#filtering-results) Filtering is supported for the following fields and operators: **displayName**: *eq, sw* **technicalName**: *eq, sw* * @type {string} * @memberof MachineAccountsApiListMachineAccountSubtypesV1 */ 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: **displayName, technicalName** * @type {string} * @memberof MachineAccountsApiListMachineAccountSubtypesV1 */ readonly sorters?: string; /** * Use this header to enable this experimental API. * @type {string} * @memberof MachineAccountsApiListMachineAccountSubtypesV1 */ 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 MachineAccountsApiListMachineAccountSubtypesV1 */ 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 MachineAccountsApiListMachineAccountSubtypesV1 */ 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 MachineAccountsApiListMachineAccountSubtypesV1 */ readonly offset?: number; } /** * Request parameters for listMachineAccountsV1 operation in MachineAccountsApi. * @export * @interface MachineAccountsApiListMachineAccountsV1Request */ export interface MachineAccountsApiListMachineAccountsV1Request { /** * 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 MachineAccountsApiListMachineAccountsV1 */ 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 MachineAccountsApiListMachineAccountsV1 */ readonly offset?: number; /** * If *true* it will populate the *X-Total-Count* response header with the number of results that would be returned if *limit* and *offset* were ignored. Since requesting a total count can have a performance impact, it is recommended not to send **count=true** if that value will not be used. See [V3 API Standard Collection Parameters](https://developer.sailpoint.com/idn/api/standard-collection-parameters) for more information. * @type {boolean} * @memberof MachineAccountsApiListMachineAccountsV1 */ readonly count?: boolean; /** * Filter results using the standard syntax described in [V3 API Standard Collection Parameters](https://developer.sailpoint.com/idn/api/standard-collection-parameters#filtering-results) Filtering is supported for the following fields and operators: **id**: *eq, in* **name**: *eq, in, sw* **nativeIdentity**: *eq, in, sw* **uuid**: *eq, in* **description**: *eq, in, sw* **machineIdentity.id**: *eq, in* **machineIdentity.name**: *eq, in, sw* **subtype.technicalName**: *eq, in, sw* **subtype.displayName**: *eq, in, sw* **accessType**: *eq, in, sw* **environment**: *eq, in, sw* **ownerIdentity**: *eq, in* **ownerIdentity.id**: *eq, in* **ownerIdentity.name**: *eq, in, sw* **manuallyCorrelated**: *eq* **enabled**: *eq* **locked**: *eq* **hasEntitlements**: *eq* **attributes**: *eq* **source.id**: *eq, in* **source.name**: *eq, in, sw* **created**: *eq, gt, lt, ge, le* **modified**: *eq, gt, lt, ge, le* * @type {string} * @memberof MachineAccountsApiListMachineAccountsV1 */ readonly filters?: string; /** * Sort results using the standard syntax described in [V3 API Standard Collection Parameters](https://developer.sailpoint.com/idn/api/standard-collection-parameters#sorting-results) Sorting is supported for the following fields: **id, name, nativeIdentity, ownerIdentity, uuid, description, machineIdentity.id, machineIdentity.name, subtype.technicalName, subtype.displayName, accessType, environment, manuallyCorrelated, enabled, locked, hasEntitlements, ownerIdentity.id, ownerIdentity.name, attributes, source.id, source.name, created, modified** * @type {string} * @memberof MachineAccountsApiListMachineAccountsV1 */ readonly sorters?: string; /** * Use this header to enable this experimental API. * @type {string} * @memberof MachineAccountsApiListMachineAccountsV1 */ readonly xSailPointExperimental?: string; } /** * Request parameters for patchMachineAccountSubtypeByTechnicalNameV1 operation in MachineAccountsApi. * @export * @interface MachineAccountsApiPatchMachineAccountSubtypeByTechnicalNameV1Request */ export interface MachineAccountsApiPatchMachineAccountSubtypeByTechnicalNameV1Request { /** * The ID of the source. * @type {string} * @memberof MachineAccountsApiPatchMachineAccountSubtypeByTechnicalNameV1 */ readonly sourceId: string; /** * The technical name of the subtype. * @type {string} * @memberof MachineAccountsApiPatchMachineAccountSubtypeByTechnicalNameV1 */ readonly technicalName: string; /** * A JSON of updated values [JSON Patch](https://tools.ietf.org/html/rfc6902) standard. * @type {Array} * @memberof MachineAccountsApiPatchMachineAccountSubtypeByTechnicalNameV1 */ readonly requestBody: Array; /** * Use this header to enable this experimental API. * @type {string} * @memberof MachineAccountsApiPatchMachineAccountSubtypeByTechnicalNameV1 */ readonly xSailPointExperimental?: string; } /** * Request parameters for updateMachineAccountV1 operation in MachineAccountsApi. * @export * @interface MachineAccountsApiUpdateMachineAccountV1Request */ export interface MachineAccountsApiUpdateMachineAccountV1Request { /** * Machine Account ID. * @type {string} * @memberof MachineAccountsApiUpdateMachineAccountV1 */ readonly id: string; /** * A JSON of updated values [JSON Patch](https://tools.ietf.org/html/rfc6902) standard. The following fields are patchable: * description * ownerIdentity * subType * accessType * environment * attributes * classificationMethod * manuallyEdited * nativeIdentity * uuid * source * manuallyCorrelated * enabled * locked * hasEntitlements * connectorAttributes * @type {Array} * @memberof MachineAccountsApiUpdateMachineAccountV1 */ readonly requestBody: Array; /** * Use this header to enable this experimental API. * @type {string} * @memberof MachineAccountsApiUpdateMachineAccountV1 */ readonly xSailPointExperimental?: string; } /** * MachineAccountsApi - object-oriented interface * @export * @class MachineAccountsApi * @extends {BaseAPI} */ export declare class MachineAccountsApi extends BaseAPI { /** * Create a new machine account subtype for a source. * @summary Create subtype * @param {MachineAccountsApiCreateMachineAccountSubtypeV1Request} requestParameters Request parameters. * @param {*} [axiosOptions] Override http request option. * @deprecated * @throws {RequiredError} * @memberof MachineAccountsApi */ createMachineAccountSubtypeV1(requestParameters: MachineAccountsApiCreateMachineAccountSubtypeV1Request, axiosOptions?: RawAxiosRequestConfig): Promise>; /** * Delete a machine account subtype by source ID and technical name. * @summary Delete subtype * @param {MachineAccountsApiDeleteMachineAccountSubtypeByTechnicalNameV1Request} requestParameters Request parameters. * @param {*} [axiosOptions] Override http request option. * @deprecated * @throws {RequiredError} * @memberof MachineAccountsApi */ deleteMachineAccountSubtypeByTechnicalNameV1(requestParameters: MachineAccountsApiDeleteMachineAccountSubtypeByTechnicalNameV1Request, axiosOptions?: RawAxiosRequestConfig): Promise>; /** * Get a machine account subtype by its unique ID. * @summary Retrieve subtype by subtype id * @param {MachineAccountsApiGetMachineAccountSubtypeByIdV1Request} requestParameters Request parameters. * @param {*} [axiosOptions] Override http request option. * @deprecated * @throws {RequiredError} * @memberof MachineAccountsApi */ getMachineAccountSubtypeByIdV1(requestParameters: MachineAccountsApiGetMachineAccountSubtypeByIdV1Request, axiosOptions?: RawAxiosRequestConfig): Promise>; /** * Get a machine account subtype by source ID and technical name. * @summary Retrieve subtype by source and technicalName * @param {MachineAccountsApiGetMachineAccountSubtypeByTechnicalNameV1Request} requestParameters Request parameters. * @param {*} [axiosOptions] Override http request option. * @deprecated * @throws {RequiredError} * @memberof MachineAccountsApi */ getMachineAccountSubtypeByTechnicalNameV1(requestParameters: MachineAccountsApiGetMachineAccountSubtypeByTechnicalNameV1Request, axiosOptions?: RawAxiosRequestConfig): Promise>; /** * Use this API to return the details for a single machine account by its ID. * @summary Get machine account details * @param {MachineAccountsApiGetMachineAccountV1Request} requestParameters Request parameters. * @param {*} [axiosOptions] Override http request option. * @throws {RequiredError} * @memberof MachineAccountsApi */ getMachineAccountV1(requestParameters: MachineAccountsApiGetMachineAccountV1Request, axiosOptions?: RawAxiosRequestConfig): Promise>; /** * Get all machine account subtypes for a given source. * @summary Retrieve all subtypes by source * @param {MachineAccountsApiListMachineAccountSubtypesV1Request} requestParameters Request parameters. * @param {*} [axiosOptions] Override http request option. * @deprecated * @throws {RequiredError} * @memberof MachineAccountsApi */ listMachineAccountSubtypesV1(requestParameters: MachineAccountsApiListMachineAccountSubtypesV1Request, axiosOptions?: RawAxiosRequestConfig): Promise>; /** * This returns a list of machine accounts. * @summary List machine accounts * @param {MachineAccountsApiListMachineAccountsV1Request} requestParameters Request parameters. * @param {*} [axiosOptions] Override http request option. * @throws {RequiredError} * @memberof MachineAccountsApi */ listMachineAccountsV1(requestParameters?: MachineAccountsApiListMachineAccountsV1Request, axiosOptions?: RawAxiosRequestConfig): Promise>; /** * Update fields of a machine account subtype by source ID and technical name. Patchable fields include: `displayName`, `description`. * @summary Patch subtype * @param {MachineAccountsApiPatchMachineAccountSubtypeByTechnicalNameV1Request} requestParameters Request parameters. * @param {*} [axiosOptions] Override http request option. * @deprecated * @throws {RequiredError} * @memberof MachineAccountsApi */ patchMachineAccountSubtypeByTechnicalNameV1(requestParameters: MachineAccountsApiPatchMachineAccountSubtypeByTechnicalNameV1Request, axiosOptions?: RawAxiosRequestConfig): Promise>; /** * Use this API to update machine accounts details. * @summary Update machine account details * @param {MachineAccountsApiUpdateMachineAccountV1Request} requestParameters Request parameters. * @param {*} [axiosOptions] Override http request option. * @throws {RequiredError} * @memberof MachineAccountsApi */ updateMachineAccountV1(requestParameters: MachineAccountsApiUpdateMachineAccountV1Request, axiosOptions?: RawAxiosRequestConfig): Promise>; }