/** * Identity Security Cloud API - Machine Account Mappings * 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 AttributeMappings */ export interface AttributeMappings { /** * * @type {AttributeMappingsAllOfTarget} * @memberof AttributeMappings */ 'target'?: AttributeMappingsAllOfTarget; /** * * @type {AttributeMappingsAllOfTransformDefinition} * @memberof AttributeMappings */ 'transformDefinition'?: AttributeMappingsAllOfTransformDefinition; } /** * Targeted Entity * @export * @interface AttributeMappingsAllOfTarget */ export interface AttributeMappingsAllOfTarget { /** * The type of target entity * @type {string} * @memberof AttributeMappingsAllOfTarget */ 'type'?: AttributeMappingsAllOfTargetTypeEnum; /** * Name of the targeted attribute * @type {string} * @memberof AttributeMappingsAllOfTarget */ 'attributeName'?: string; /** * The ID of Source * @type {string} * @memberof AttributeMappingsAllOfTarget */ 'sourceId'?: string; } export declare const AttributeMappingsAllOfTargetTypeEnum: { readonly Account: "ACCOUNT"; readonly Identity: "IDENTITY"; readonly OwnerAccount: "OWNER_ACCOUNT"; readonly OwnerIdentity: "OWNER_IDENTITY"; }; export type AttributeMappingsAllOfTargetTypeEnum = typeof AttributeMappingsAllOfTargetTypeEnum[keyof typeof AttributeMappingsAllOfTargetTypeEnum]; /** * * @export * @interface AttributeMappingsAllOfTransformDefinition */ export interface AttributeMappingsAllOfTransformDefinition { /** * The type of transform * @type {string} * @memberof AttributeMappingsAllOfTransformDefinition */ 'type'?: string; /** * * @type {AttributeMappingsAllOfTransformDefinitionAttributes} * @memberof AttributeMappingsAllOfTransformDefinition */ 'attributes'?: AttributeMappingsAllOfTransformDefinitionAttributes; /** * Transform Operation * @type {string} * @memberof AttributeMappingsAllOfTransformDefinition */ 'id'?: string; } /** * attributes object * @export * @interface AttributeMappingsAllOfTransformDefinitionAttributes */ export interface AttributeMappingsAllOfTransformDefinitionAttributes { /** * * @type {AttributeMappingsAllOfTransformDefinitionAttributesInput} * @memberof AttributeMappingsAllOfTransformDefinitionAttributes */ 'input'?: AttributeMappingsAllOfTransformDefinitionAttributesInput; } /** * Input Object * @export * @interface AttributeMappingsAllOfTransformDefinitionAttributesInput */ export interface AttributeMappingsAllOfTransformDefinitionAttributesInput { /** * The Type of Attribute * @type {string} * @memberof AttributeMappingsAllOfTransformDefinitionAttributesInput */ 'type'?: string; /** * * @type {AttributeMappingsAllOfTransformDefinitionAttributesInputAttributes} * @memberof AttributeMappingsAllOfTransformDefinitionAttributesInput */ 'attributes'?: AttributeMappingsAllOfTransformDefinitionAttributesInputAttributes; } /** * Attibute Mapping Object * @export * @interface AttributeMappingsAllOfTransformDefinitionAttributesInputAttributes */ export interface AttributeMappingsAllOfTransformDefinitionAttributesInputAttributes { /** * The name of attribute * @type {string} * @memberof AttributeMappingsAllOfTransformDefinitionAttributesInputAttributes */ 'attributeName'?: string; /** * Name of the Source * @type {string} * @memberof AttributeMappingsAllOfTransformDefinitionAttributesInputAttributes */ 'sourceName'?: string; /** * ID of the Source * @type {string} * @memberof AttributeMappingsAllOfTransformDefinitionAttributesInputAttributes */ 'name'?: 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 ListMachineAccountMappingsV1401Response */ export interface ListMachineAccountMappingsV1401Response { /** * A message describing the error * @type {any} * @memberof ListMachineAccountMappingsV1401Response */ 'error'?: any; } /** * * @export * @interface ListMachineAccountMappingsV1429Response */ export interface ListMachineAccountMappingsV1429Response { /** * A message describing the error * @type {any} * @memberof ListMachineAccountMappingsV1429Response */ '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]; /** * MachineAccountMappingsApi - axios parameter creator * @export */ export declare const MachineAccountMappingsApiAxiosParamCreator: (configuration?: Configuration) => { /** * Creates Machine Account Mappings for both identities and accounts for a source. A token with API, ORG_ADMIN, ROLE_ADMIN, ROLE_SUBADMIN, SOURCE_ADMIN, or SOURCE_SUBADMIN authority is required to call this API. * @summary Create machine account mappings * @param {string} sourceId Source ID. * @param {AttributeMappings} attributeMappings * @param {string} [xSailPointExperimental] Use this header to enable this experimental API. * @param {*} [axiosOptions] Override http request option. * @throws {RequiredError} */ createMachineAccountMappingsV1: (sourceId: string, attributeMappings: AttributeMappings, xSailPointExperimental?: string, axiosOptions?: RawAxiosRequestConfig) => Promise; /** * Use this API to remove machine account attribute mappings for a Source. A token with ORG_ADMIN, SOURCE_ADMIN, or SOURCE_SUBADMIN authority is required to call this API. * @summary Delete source\'s machine account mappings * @param {string} sourceId source ID. * @param {string} [xSailPointExperimental] Use this header to enable this experimental API. * @param {*} [axiosOptions] Override http request option. * @throws {RequiredError} */ deleteMachineAccountMappingsV1: (sourceId: string, xSailPointExperimental?: string, axiosOptions?: RawAxiosRequestConfig) => Promise; /** * Retrieves Machine account mappings for a specified source using Source ID. * @summary Machine account mapping for source * @param {string} sourceId Source ID * @param {number} [limit] Max number of results to return. See [V3 API Standard Collection Parameters](https://developer.sailpoint.com/idn/api/standard-collection-parameters) for more information. * @param {number} [offset] Offset into the full result set. Usually specified with *limit* to paginate through the results. See [V3 API Standard Collection Parameters](https://developer.sailpoint.com/idn/api/standard-collection-parameters) for more information. * @param {string} [xSailPointExperimental] Use this header to enable this experimental API. * @param {*} [axiosOptions] Override http request option. * @throws {RequiredError} */ listMachineAccountMappingsV1: (sourceId: string, limit?: number, offset?: number, xSailPointExperimental?: string, axiosOptions?: RawAxiosRequestConfig) => Promise; /** * Use this API to update Machine Account Attribute Mapping for a Source. A token with ORG_ADMIN, SOURCE_ADMIN, or SOURCE_SUBADMIN authority is required to call this API. * @summary Update source\'s machine account mappings * @param {string} sourceId Source ID. * @param {AttributeMappings} attributeMappings * @param {*} [axiosOptions] Override http request option. * @throws {RequiredError} */ setMachineAccountMappingsV1: (sourceId: string, attributeMappings: AttributeMappings, axiosOptions?: RawAxiosRequestConfig) => Promise; }; /** * MachineAccountMappingsApi - functional programming interface * @export */ export declare const MachineAccountMappingsApiFp: (configuration?: Configuration) => { /** * Creates Machine Account Mappings for both identities and accounts for a source. A token with API, ORG_ADMIN, ROLE_ADMIN, ROLE_SUBADMIN, SOURCE_ADMIN, or SOURCE_SUBADMIN authority is required to call this API. * @summary Create machine account mappings * @param {string} sourceId Source ID. * @param {AttributeMappings} attributeMappings * @param {string} [xSailPointExperimental] Use this header to enable this experimental API. * @param {*} [axiosOptions] Override http request option. * @throws {RequiredError} */ createMachineAccountMappingsV1(sourceId: string, attributeMappings: AttributeMappings, xSailPointExperimental?: string, axiosOptions?: RawAxiosRequestConfig): Promise<(axios?: AxiosInstance, basePath?: string) => AxiosPromise>>; /** * Use this API to remove machine account attribute mappings for a Source. A token with ORG_ADMIN, SOURCE_ADMIN, or SOURCE_SUBADMIN authority is required to call this API. * @summary Delete source\'s machine account mappings * @param {string} sourceId source ID. * @param {string} [xSailPointExperimental] Use this header to enable this experimental API. * @param {*} [axiosOptions] Override http request option. * @throws {RequiredError} */ deleteMachineAccountMappingsV1(sourceId: string, xSailPointExperimental?: string, axiosOptions?: RawAxiosRequestConfig): Promise<(axios?: AxiosInstance, basePath?: string) => AxiosPromise>; /** * Retrieves Machine account mappings for a specified source using Source ID. * @summary Machine account mapping for source * @param {string} sourceId Source ID * @param {number} [limit] Max number of results to return. See [V3 API Standard Collection Parameters](https://developer.sailpoint.com/idn/api/standard-collection-parameters) for more information. * @param {number} [offset] Offset into the full result set. Usually specified with *limit* to paginate through the results. See [V3 API Standard Collection Parameters](https://developer.sailpoint.com/idn/api/standard-collection-parameters) for more information. * @param {string} [xSailPointExperimental] Use this header to enable this experimental API. * @param {*} [axiosOptions] Override http request option. * @throws {RequiredError} */ listMachineAccountMappingsV1(sourceId: string, limit?: number, offset?: number, xSailPointExperimental?: string, axiosOptions?: RawAxiosRequestConfig): Promise<(axios?: AxiosInstance, basePath?: string) => AxiosPromise>>; /** * Use this API to update Machine Account Attribute Mapping for a Source. A token with ORG_ADMIN, SOURCE_ADMIN, or SOURCE_SUBADMIN authority is required to call this API. * @summary Update source\'s machine account mappings * @param {string} sourceId Source ID. * @param {AttributeMappings} attributeMappings * @param {*} [axiosOptions] Override http request option. * @throws {RequiredError} */ setMachineAccountMappingsV1(sourceId: string, attributeMappings: AttributeMappings, axiosOptions?: RawAxiosRequestConfig): Promise<(axios?: AxiosInstance, basePath?: string) => AxiosPromise>>; }; /** * MachineAccountMappingsApi - factory interface * @export */ export declare const MachineAccountMappingsApiFactory: (configuration?: Configuration, basePath?: string, axios?: AxiosInstance) => { /** * Creates Machine Account Mappings for both identities and accounts for a source. A token with API, ORG_ADMIN, ROLE_ADMIN, ROLE_SUBADMIN, SOURCE_ADMIN, or SOURCE_SUBADMIN authority is required to call this API. * @summary Create machine account mappings * @param {MachineAccountMappingsApiCreateMachineAccountMappingsV1Request} requestParameters Request parameters. * @param {*} [axiosOptions] Override http request option. * @throws {RequiredError} */ createMachineAccountMappingsV1(requestParameters: MachineAccountMappingsApiCreateMachineAccountMappingsV1Request, axiosOptions?: RawAxiosRequestConfig): AxiosPromise>; /** * Use this API to remove machine account attribute mappings for a Source. A token with ORG_ADMIN, SOURCE_ADMIN, or SOURCE_SUBADMIN authority is required to call this API. * @summary Delete source\'s machine account mappings * @param {MachineAccountMappingsApiDeleteMachineAccountMappingsV1Request} requestParameters Request parameters. * @param {*} [axiosOptions] Override http request option. * @throws {RequiredError} */ deleteMachineAccountMappingsV1(requestParameters: MachineAccountMappingsApiDeleteMachineAccountMappingsV1Request, axiosOptions?: RawAxiosRequestConfig): AxiosPromise; /** * Retrieves Machine account mappings for a specified source using Source ID. * @summary Machine account mapping for source * @param {MachineAccountMappingsApiListMachineAccountMappingsV1Request} requestParameters Request parameters. * @param {*} [axiosOptions] Override http request option. * @throws {RequiredError} */ listMachineAccountMappingsV1(requestParameters: MachineAccountMappingsApiListMachineAccountMappingsV1Request, axiosOptions?: RawAxiosRequestConfig): AxiosPromise>; /** * Use this API to update Machine Account Attribute Mapping for a Source. A token with ORG_ADMIN, SOURCE_ADMIN, or SOURCE_SUBADMIN authority is required to call this API. * @summary Update source\'s machine account mappings * @param {MachineAccountMappingsApiSetMachineAccountMappingsV1Request} requestParameters Request parameters. * @param {*} [axiosOptions] Override http request option. * @throws {RequiredError} */ setMachineAccountMappingsV1(requestParameters: MachineAccountMappingsApiSetMachineAccountMappingsV1Request, axiosOptions?: RawAxiosRequestConfig): AxiosPromise>; }; /** * Request parameters for createMachineAccountMappingsV1 operation in MachineAccountMappingsApi. * @export * @interface MachineAccountMappingsApiCreateMachineAccountMappingsV1Request */ export interface MachineAccountMappingsApiCreateMachineAccountMappingsV1Request { /** * Source ID. * @type {string} * @memberof MachineAccountMappingsApiCreateMachineAccountMappingsV1 */ readonly sourceId: string; /** * * @type {AttributeMappings} * @memberof MachineAccountMappingsApiCreateMachineAccountMappingsV1 */ readonly attributeMappings: AttributeMappings; /** * Use this header to enable this experimental API. * @type {string} * @memberof MachineAccountMappingsApiCreateMachineAccountMappingsV1 */ readonly xSailPointExperimental?: string; } /** * Request parameters for deleteMachineAccountMappingsV1 operation in MachineAccountMappingsApi. * @export * @interface MachineAccountMappingsApiDeleteMachineAccountMappingsV1Request */ export interface MachineAccountMappingsApiDeleteMachineAccountMappingsV1Request { /** * source ID. * @type {string} * @memberof MachineAccountMappingsApiDeleteMachineAccountMappingsV1 */ readonly sourceId: string; /** * Use this header to enable this experimental API. * @type {string} * @memberof MachineAccountMappingsApiDeleteMachineAccountMappingsV1 */ readonly xSailPointExperimental?: string; } /** * Request parameters for listMachineAccountMappingsV1 operation in MachineAccountMappingsApi. * @export * @interface MachineAccountMappingsApiListMachineAccountMappingsV1Request */ export interface MachineAccountMappingsApiListMachineAccountMappingsV1Request { /** * Source ID * @type {string} * @memberof MachineAccountMappingsApiListMachineAccountMappingsV1 */ readonly sourceId: string; /** * Max number of results to return. See [V3 API Standard Collection Parameters](https://developer.sailpoint.com/idn/api/standard-collection-parameters) for more information. * @type {number} * @memberof MachineAccountMappingsApiListMachineAccountMappingsV1 */ 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 MachineAccountMappingsApiListMachineAccountMappingsV1 */ readonly offset?: number; /** * Use this header to enable this experimental API. * @type {string} * @memberof MachineAccountMappingsApiListMachineAccountMappingsV1 */ readonly xSailPointExperimental?: string; } /** * Request parameters for setMachineAccountMappingsV1 operation in MachineAccountMappingsApi. * @export * @interface MachineAccountMappingsApiSetMachineAccountMappingsV1Request */ export interface MachineAccountMappingsApiSetMachineAccountMappingsV1Request { /** * Source ID. * @type {string} * @memberof MachineAccountMappingsApiSetMachineAccountMappingsV1 */ readonly sourceId: string; /** * * @type {AttributeMappings} * @memberof MachineAccountMappingsApiSetMachineAccountMappingsV1 */ readonly attributeMappings: AttributeMappings; } /** * MachineAccountMappingsApi - object-oriented interface * @export * @class MachineAccountMappingsApi * @extends {BaseAPI} */ export declare class MachineAccountMappingsApi extends BaseAPI { /** * Creates Machine Account Mappings for both identities and accounts for a source. A token with API, ORG_ADMIN, ROLE_ADMIN, ROLE_SUBADMIN, SOURCE_ADMIN, or SOURCE_SUBADMIN authority is required to call this API. * @summary Create machine account mappings * @param {MachineAccountMappingsApiCreateMachineAccountMappingsV1Request} requestParameters Request parameters. * @param {*} [axiosOptions] Override http request option. * @throws {RequiredError} * @memberof MachineAccountMappingsApi */ createMachineAccountMappingsV1(requestParameters: MachineAccountMappingsApiCreateMachineAccountMappingsV1Request, axiosOptions?: RawAxiosRequestConfig): Promise>; /** * Use this API to remove machine account attribute mappings for a Source. A token with ORG_ADMIN, SOURCE_ADMIN, or SOURCE_SUBADMIN authority is required to call this API. * @summary Delete source\'s machine account mappings * @param {MachineAccountMappingsApiDeleteMachineAccountMappingsV1Request} requestParameters Request parameters. * @param {*} [axiosOptions] Override http request option. * @throws {RequiredError} * @memberof MachineAccountMappingsApi */ deleteMachineAccountMappingsV1(requestParameters: MachineAccountMappingsApiDeleteMachineAccountMappingsV1Request, axiosOptions?: RawAxiosRequestConfig): Promise>; /** * Retrieves Machine account mappings for a specified source using Source ID. * @summary Machine account mapping for source * @param {MachineAccountMappingsApiListMachineAccountMappingsV1Request} requestParameters Request parameters. * @param {*} [axiosOptions] Override http request option. * @throws {RequiredError} * @memberof MachineAccountMappingsApi */ listMachineAccountMappingsV1(requestParameters: MachineAccountMappingsApiListMachineAccountMappingsV1Request, axiosOptions?: RawAxiosRequestConfig): Promise>; /** * Use this API to update Machine Account Attribute Mapping for a Source. A token with ORG_ADMIN, SOURCE_ADMIN, or SOURCE_SUBADMIN authority is required to call this API. * @summary Update source\'s machine account mappings * @param {MachineAccountMappingsApiSetMachineAccountMappingsV1Request} requestParameters Request parameters. * @param {*} [axiosOptions] Override http request option. * @throws {RequiredError} * @memberof MachineAccountMappingsApi */ setMachineAccountMappingsV1(requestParameters: MachineAccountMappingsApiSetMachineAccountMappingsV1Request, axiosOptions?: RawAxiosRequestConfig): Promise>; }