/** * Identity Security Cloud API - Machine Account Creation Request * 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'; /** * Asynchronous response containing a unique tracking ID for the account request * @export * @interface AccountRequestAsyncResult */ export interface AccountRequestAsyncResult { /** * Id of the account request * @type {string} * @memberof AccountRequestAsyncResult */ 'accountRequestId': string; } /** * Represents a request to create a machine account. * @export * @interface AccountRequestDetailsDto */ export interface AccountRequestDetailsDto { /** * Account request ID. * @type {string} * @memberof AccountRequestDetailsDto */ 'accountRequestId'?: string; /** * Type of the account request. * @type {string} * @memberof AccountRequestDetailsDto */ 'requestType'?: string; /** * Machine account creation request creation date and time. * @type {string} * @memberof AccountRequestDetailsDto */ 'createdAt'?: string; /** * Machine account creation request completion date and time. * @type {string} * @memberof AccountRequestDetailsDto */ 'completedAt'?: string | null; /** * Overall status of the creation request. * @type {string} * @memberof AccountRequestDetailsDto */ 'overallStatus'?: string; /** * * @type {AccountRequestDetailsDtoRequester} * @memberof AccountRequestDetailsDto */ 'requester'?: AccountRequestDetailsDtoRequester; /** * List of account request phases. * @type {Array} * @memberof AccountRequestDetailsDto */ 'accountRequestPhases'?: Array; /** * Detailed error information. * @type {string} * @memberof AccountRequestDetailsDto */ 'errorDetails'?: string | null; } /** * * @export * @interface AccountRequestDetailsDtoRequester */ export interface AccountRequestDetailsDtoRequester { /** * * @type {DtoType} * @memberof AccountRequestDetailsDtoRequester */ 'type'?: DtoType; /** * ID of the object to which this reference applies * @type {string} * @memberof AccountRequestDetailsDtoRequester */ 'id'?: string; /** * Human-readable display name of the object to which this reference applies * @type {string} * @memberof AccountRequestDetailsDtoRequester */ 'name'?: string; } /** * Contains detailed information about each phase in the account request process, including its type, current state, and relevant timestamps. * @export * @interface AccountRequestPhase */ export interface AccountRequestPhase { /** * Enum of account request phase type * @type {string} * @memberof AccountRequestPhase */ 'name'?: AccountRequestPhaseNameEnum; /** * * @type {AccountRequestPhaseState} * @memberof AccountRequestPhase */ 'state'?: AccountRequestPhaseState; /** * Start date of account request phase. * @type {string} * @memberof AccountRequestPhase */ 'started'?: string; /** * Finish date of account request phase. * @type {string} * @memberof AccountRequestPhase */ 'finished'?: string; } export declare const AccountRequestPhaseNameEnum: { readonly ApprovalPhase: "APPROVAL_PHASE"; readonly ProvisioningPhase: "PROVISIONING_PHASE"; }; export type AccountRequestPhaseNameEnum = typeof AccountRequestPhaseNameEnum[keyof typeof AccountRequestPhaseNameEnum]; /** * The current phase state of the account request, indicating its progress or outcome in the approval workflow. * @export * @enum {string} */ export declare const AccountRequestPhaseState: { readonly Pending: "PENDING"; readonly Cancelled: "CANCELLED"; readonly Approved: "APPROVED"; readonly Rejected: "REJECTED"; readonly Passed: "PASSED"; readonly Failed: "FAILED"; readonly NotStarted: "NOT_STARTED"; }; export type AccountRequestPhaseState = typeof AccountRequestPhaseState[keyof typeof AccountRequestPhaseState]; /** * * @export * @interface BaseReferenceDto */ export interface BaseReferenceDto { /** * * @type {DtoType} * @memberof BaseReferenceDto */ 'type'?: DtoType; /** * ID of the object to which this reference applies * @type {string} * @memberof BaseReferenceDto */ 'id'?: string; /** * Human-readable display name of the object to which this reference applies * @type {string} * @memberof BaseReferenceDto */ 'name'?: string; } /** * * @export * @interface CreateMachineAccountRequestV1401Response */ export interface CreateMachineAccountRequestV1401Response { /** * A message describing the error * @type {any} * @memberof CreateMachineAccountRequestV1401Response */ 'error'?: any; } /** * * @export * @interface CreateMachineAccountRequestV1429Response */ export interface CreateMachineAccountRequestV1429Response { /** * A message describing the error * @type {any} * @memberof CreateMachineAccountRequestV1429Response */ 'message'?: any; } /** * An enumeration of the types of DTOs supported within the IdentityNow infrastructure. * @export * @enum {string} */ export declare const DtoType: { readonly AccountCorrelationConfig: "ACCOUNT_CORRELATION_CONFIG"; readonly AccessProfile: "ACCESS_PROFILE"; readonly AccessRequestApproval: "ACCESS_REQUEST_APPROVAL"; readonly Account: "ACCOUNT"; readonly Application: "APPLICATION"; readonly Campaign: "CAMPAIGN"; readonly CampaignFilter: "CAMPAIGN_FILTER"; readonly Certification: "CERTIFICATION"; readonly Cluster: "CLUSTER"; readonly ConnectorSchema: "CONNECTOR_SCHEMA"; readonly Entitlement: "ENTITLEMENT"; readonly GovernanceGroup: "GOVERNANCE_GROUP"; readonly Identity: "IDENTITY"; readonly IdentityProfile: "IDENTITY_PROFILE"; readonly IdentityRequest: "IDENTITY_REQUEST"; readonly MachineIdentity: "MACHINE_IDENTITY"; readonly LifecycleState: "LIFECYCLE_STATE"; readonly PasswordPolicy: "PASSWORD_POLICY"; readonly Role: "ROLE"; readonly Rule: "RULE"; readonly SodPolicy: "SOD_POLICY"; readonly Source: "SOURCE"; readonly Tag: "TAG"; readonly TagCategory: "TAG_CATEGORY"; readonly TaskResult: "TASK_RESULT"; readonly ReportResult: "REPORT_RESULT"; readonly SodViolation: "SOD_VIOLATION"; readonly AccountActivity: "ACCOUNT_ACTIVITY"; readonly Workgroup: "WORKGROUP"; }; export type DtoType = typeof DtoType[keyof typeof DtoType]; /** * * @export * @interface 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; } /** * 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]; /** * A summary endpoint which returns list of sources and subtypes for which user has an entitlement to request machine accounts. * @export * @interface MachineAccountCreateAccessDto */ export interface MachineAccountCreateAccessDto { /** * Source ID. * @type {string} * @memberof MachineAccountCreateAccessDto */ 'sourceId'?: string; /** * Source name. * @type {string} * @memberof MachineAccountCreateAccessDto */ 'sourceName'?: string; /** * List of subtypes for which the user has an entitlement to request machine accounts. * @type {Array} * @memberof MachineAccountCreateAccessDto */ 'subtypes'?: Array; } /** * * @export * @interface MachineAccountCreateAccessDtoSubtypesInner */ export interface MachineAccountCreateAccessDtoSubtypesInner { /** * Subtype ID. * @type {string} * @memberof MachineAccountCreateAccessDtoSubtypesInner */ 'subtypeId'?: string; /** * Entitlement ID. * @type {string} * @memberof MachineAccountCreateAccessDtoSubtypesInner */ 'entitlementId'?: string; /** * Subtype display name. * @type {string} * @memberof MachineAccountCreateAccessDtoSubtypesInner */ 'subtypeDisplayName'?: string; /** * Subtype technical name. * @type {string} * @memberof MachineAccountCreateAccessDtoSubtypesInner */ 'subtypeTechnicalName'?: string; } /** * Contains the required information for processing a user-initiated machine account creation request. * @export * @interface MachineAccountCreateRequestInput */ export interface MachineAccountCreateRequestInput { /** * Subtype ID for which machine account create is enabled and user have the entitlement to create the machine account. * @type {string} * @memberof MachineAccountCreateRequestInput */ 'subtypeId': string; /** * Form ID selected by user for the machine account create request. * @type {string} * @memberof MachineAccountCreateRequestInput */ 'formId'?: string; /** * Owner Identity ID. This identity will be assigned as an owner of the created machine account. * @type {string} * @memberof MachineAccountCreateRequestInput */ 'ownerIdentityId': string; /** * Machine identity to correlate with the created machine account. If not provided, a new machine identity will be created. * @type {string} * @memberof MachineAccountCreateRequestInput */ 'machineIdentityId'?: string | null; /** * Environment type to use for the machine account. * @type {string} * @memberof MachineAccountCreateRequestInput */ 'environment'?: string; /** * Description for the machine account. * @type {string} * @memberof MachineAccountCreateRequestInput */ 'description'?: string; /** * Fields of the form linked to the subtype in approval settings. * @type {object} * @memberof MachineAccountCreateRequestInput */ 'userInput'?: object; /** * List of entitlement IDs to provision for created machine account. * @type {Array} * @memberof MachineAccountCreateRequestInput */ 'entitlementIds'?: Array; } /** * MachineAccountCreationRequestApi - axios parameter creator * @export */ export declare const MachineAccountCreationRequestApiAxiosParamCreator: (configuration?: Configuration) => { /** * Initiates machine account creation request for the specified subtype. This method validates the input data, processes the machine account creation request, and generates an asynchronous result containing a tracking ID. >**NOTE: You can only request a machine accounts on subtype for which you have a create machine account entitlement provisioned.** * @summary Submit Machine Account Creation Request * @param {MachineAccountCreateRequestInput} machineAccountCreateRequestInput * @param {string} [xSailPointExperimental] Use this header to enable this experimental API. * @param {*} [axiosOptions] Override http request option. * @throws {RequiredError} */ createMachineAccountRequestV1: (machineAccountCreateRequestInput: MachineAccountCreateRequestInput, xSailPointExperimental?: string, axiosOptions?: RawAxiosRequestConfig) => Promise; /** * Retrieves a account request details for machine account creation. This allows the user to view all details for given account request. * @summary Get Machine Account Creation Request * @param {string} xSailPointExperimental Use this header to enable this experimental API. * @param {string} accountRequestId Account Request ID * @param {*} [axiosOptions] Override http request option. * @throws {RequiredError} */ getCreateMachineAccountRequestV1: (xSailPointExperimental: string, accountRequestId: string, axiosOptions?: RawAxiosRequestConfig) => Promise; /** * This endpoint retrieves the list of sources and subtypes for which logged in user has the entitlement to create a machine account. The response includes a list of object detailing the source, subtype and entitlement details which enables the clients to understand if they can submit the request to create a machine account for the given subtype. * @summary Machine Account Create Access * @param {string} xSailPointExperimental Use this header to enable this experimental API. * @param {number} [offset] Offset Integer specifying the offset of the first result from the beginning of the collection. The standard syntax described in [V3 API Standard Collection Parameters](https://developer.sailpoint.com/idn/api/standard-collection-parameters#paginating-results). The offset value is record-based, not page-based, and the index starts at 0. * @param {number} [limit] Limit Integer specifying the maximum number of records to return in a single API call. The standard syntax described in [V3 API Standard Collection Parameters](https://developer.sailpoint.com/idn/api/standard-collection-parameters#paginating-results). If it is not specified, a default limit is used. * @param {*} [axiosOptions] Override http request option. * @throws {RequiredError} */ getMachineAccountCreateAccessInfoV1: (xSailPointExperimental: string, offset?: number, limit?: number, axiosOptions?: RawAxiosRequestConfig) => Promise; }; /** * MachineAccountCreationRequestApi - functional programming interface * @export */ export declare const MachineAccountCreationRequestApiFp: (configuration?: Configuration) => { /** * Initiates machine account creation request for the specified subtype. This method validates the input data, processes the machine account creation request, and generates an asynchronous result containing a tracking ID. >**NOTE: You can only request a machine accounts on subtype for which you have a create machine account entitlement provisioned.** * @summary Submit Machine Account Creation Request * @param {MachineAccountCreateRequestInput} machineAccountCreateRequestInput * @param {string} [xSailPointExperimental] Use this header to enable this experimental API. * @param {*} [axiosOptions] Override http request option. * @throws {RequiredError} */ createMachineAccountRequestV1(machineAccountCreateRequestInput: MachineAccountCreateRequestInput, xSailPointExperimental?: string, axiosOptions?: RawAxiosRequestConfig): Promise<(axios?: AxiosInstance, basePath?: string) => AxiosPromise>; /** * Retrieves a account request details for machine account creation. This allows the user to view all details for given account request. * @summary Get Machine Account Creation Request * @param {string} xSailPointExperimental Use this header to enable this experimental API. * @param {string} accountRequestId Account Request ID * @param {*} [axiosOptions] Override http request option. * @throws {RequiredError} */ getCreateMachineAccountRequestV1(xSailPointExperimental: string, accountRequestId: string, axiosOptions?: RawAxiosRequestConfig): Promise<(axios?: AxiosInstance, basePath?: string) => AxiosPromise>; /** * This endpoint retrieves the list of sources and subtypes for which logged in user has the entitlement to create a machine account. The response includes a list of object detailing the source, subtype and entitlement details which enables the clients to understand if they can submit the request to create a machine account for the given subtype. * @summary Machine Account Create Access * @param {string} xSailPointExperimental Use this header to enable this experimental API. * @param {number} [offset] Offset Integer specifying the offset of the first result from the beginning of the collection. The standard syntax described in [V3 API Standard Collection Parameters](https://developer.sailpoint.com/idn/api/standard-collection-parameters#paginating-results). The offset value is record-based, not page-based, and the index starts at 0. * @param {number} [limit] Limit Integer specifying the maximum number of records to return in a single API call. The standard syntax described in [V3 API Standard Collection Parameters](https://developer.sailpoint.com/idn/api/standard-collection-parameters#paginating-results). If it is not specified, a default limit is used. * @param {*} [axiosOptions] Override http request option. * @throws {RequiredError} */ getMachineAccountCreateAccessInfoV1(xSailPointExperimental: string, offset?: number, limit?: number, axiosOptions?: RawAxiosRequestConfig): Promise<(axios?: AxiosInstance, basePath?: string) => AxiosPromise>>; }; /** * MachineAccountCreationRequestApi - factory interface * @export */ export declare const MachineAccountCreationRequestApiFactory: (configuration?: Configuration, basePath?: string, axios?: AxiosInstance) => { /** * Initiates machine account creation request for the specified subtype. This method validates the input data, processes the machine account creation request, and generates an asynchronous result containing a tracking ID. >**NOTE: You can only request a machine accounts on subtype for which you have a create machine account entitlement provisioned.** * @summary Submit Machine Account Creation Request * @param {MachineAccountCreationRequestApiCreateMachineAccountRequestV1Request} requestParameters Request parameters. * @param {*} [axiosOptions] Override http request option. * @throws {RequiredError} */ createMachineAccountRequestV1(requestParameters: MachineAccountCreationRequestApiCreateMachineAccountRequestV1Request, axiosOptions?: RawAxiosRequestConfig): AxiosPromise; /** * Retrieves a account request details for machine account creation. This allows the user to view all details for given account request. * @summary Get Machine Account Creation Request * @param {MachineAccountCreationRequestApiGetCreateMachineAccountRequestV1Request} requestParameters Request parameters. * @param {*} [axiosOptions] Override http request option. * @throws {RequiredError} */ getCreateMachineAccountRequestV1(requestParameters: MachineAccountCreationRequestApiGetCreateMachineAccountRequestV1Request, axiosOptions?: RawAxiosRequestConfig): AxiosPromise; /** * This endpoint retrieves the list of sources and subtypes for which logged in user has the entitlement to create a machine account. The response includes a list of object detailing the source, subtype and entitlement details which enables the clients to understand if they can submit the request to create a machine account for the given subtype. * @summary Machine Account Create Access * @param {MachineAccountCreationRequestApiGetMachineAccountCreateAccessInfoV1Request} requestParameters Request parameters. * @param {*} [axiosOptions] Override http request option. * @throws {RequiredError} */ getMachineAccountCreateAccessInfoV1(requestParameters: MachineAccountCreationRequestApiGetMachineAccountCreateAccessInfoV1Request, axiosOptions?: RawAxiosRequestConfig): AxiosPromise>; }; /** * Request parameters for createMachineAccountRequestV1 operation in MachineAccountCreationRequestApi. * @export * @interface MachineAccountCreationRequestApiCreateMachineAccountRequestV1Request */ export interface MachineAccountCreationRequestApiCreateMachineAccountRequestV1Request { /** * * @type {MachineAccountCreateRequestInput} * @memberof MachineAccountCreationRequestApiCreateMachineAccountRequestV1 */ readonly machineAccountCreateRequestInput: MachineAccountCreateRequestInput; /** * Use this header to enable this experimental API. * @type {string} * @memberof MachineAccountCreationRequestApiCreateMachineAccountRequestV1 */ readonly xSailPointExperimental?: string; } /** * Request parameters for getCreateMachineAccountRequestV1 operation in MachineAccountCreationRequestApi. * @export * @interface MachineAccountCreationRequestApiGetCreateMachineAccountRequestV1Request */ export interface MachineAccountCreationRequestApiGetCreateMachineAccountRequestV1Request { /** * Use this header to enable this experimental API. * @type {string} * @memberof MachineAccountCreationRequestApiGetCreateMachineAccountRequestV1 */ readonly xSailPointExperimental: string; /** * Account Request ID * @type {string} * @memberof MachineAccountCreationRequestApiGetCreateMachineAccountRequestV1 */ readonly accountRequestId: string; } /** * Request parameters for getMachineAccountCreateAccessInfoV1 operation in MachineAccountCreationRequestApi. * @export * @interface MachineAccountCreationRequestApiGetMachineAccountCreateAccessInfoV1Request */ export interface MachineAccountCreationRequestApiGetMachineAccountCreateAccessInfoV1Request { /** * Use this header to enable this experimental API. * @type {string} * @memberof MachineAccountCreationRequestApiGetMachineAccountCreateAccessInfoV1 */ readonly xSailPointExperimental: string; /** * Offset Integer specifying the offset of the first result from the beginning of the collection. The standard syntax described in [V3 API Standard Collection Parameters](https://developer.sailpoint.com/idn/api/standard-collection-parameters#paginating-results). The offset value is record-based, not page-based, and the index starts at 0. * @type {number} * @memberof MachineAccountCreationRequestApiGetMachineAccountCreateAccessInfoV1 */ readonly offset?: number; /** * Limit Integer specifying the maximum number of records to return in a single API call. The standard syntax described in [V3 API Standard Collection Parameters](https://developer.sailpoint.com/idn/api/standard-collection-parameters#paginating-results). If it is not specified, a default limit is used. * @type {number} * @memberof MachineAccountCreationRequestApiGetMachineAccountCreateAccessInfoV1 */ readonly limit?: number; } /** * MachineAccountCreationRequestApi - object-oriented interface * @export * @class MachineAccountCreationRequestApi * @extends {BaseAPI} */ export declare class MachineAccountCreationRequestApi extends BaseAPI { /** * Initiates machine account creation request for the specified subtype. This method validates the input data, processes the machine account creation request, and generates an asynchronous result containing a tracking ID. >**NOTE: You can only request a machine accounts on subtype for which you have a create machine account entitlement provisioned.** * @summary Submit Machine Account Creation Request * @param {MachineAccountCreationRequestApiCreateMachineAccountRequestV1Request} requestParameters Request parameters. * @param {*} [axiosOptions] Override http request option. * @throws {RequiredError} * @memberof MachineAccountCreationRequestApi */ createMachineAccountRequestV1(requestParameters: MachineAccountCreationRequestApiCreateMachineAccountRequestV1Request, axiosOptions?: RawAxiosRequestConfig): Promise>; /** * Retrieves a account request details for machine account creation. This allows the user to view all details for given account request. * @summary Get Machine Account Creation Request * @param {MachineAccountCreationRequestApiGetCreateMachineAccountRequestV1Request} requestParameters Request parameters. * @param {*} [axiosOptions] Override http request option. * @throws {RequiredError} * @memberof MachineAccountCreationRequestApi */ getCreateMachineAccountRequestV1(requestParameters: MachineAccountCreationRequestApiGetCreateMachineAccountRequestV1Request, axiosOptions?: RawAxiosRequestConfig): Promise>; /** * This endpoint retrieves the list of sources and subtypes for which logged in user has the entitlement to create a machine account. The response includes a list of object detailing the source, subtype and entitlement details which enables the clients to understand if they can submit the request to create a machine account for the given subtype. * @summary Machine Account Create Access * @param {MachineAccountCreationRequestApiGetMachineAccountCreateAccessInfoV1Request} requestParameters Request parameters. * @param {*} [axiosOptions] Override http request option. * @throws {RequiredError} * @memberof MachineAccountCreationRequestApi */ getMachineAccountCreateAccessInfoV1(requestParameters: MachineAccountCreationRequestApiGetMachineAccountCreateAccessInfoV1Request, axiosOptions?: RawAxiosRequestConfig): Promise>; }