MachineAccountCreationRequestService

Use this API to submit and retrieve machine account creation requests.

Every method returns an Observable. All request paths are relative to the baseUrl you pass to provideSailPoint().

Method	HTTP request	Description
create-machine-account-request-v1	POST /account-requests/v1/machine-account-create	Submit Machine Account Creation Request
create-machine-account-request-v2	POST /account-requests/v2/machine-account-create	Submit Machine Account Creation Request
create-machine-account-v2	POST /machine-accounts/v2/machine-account-create	Create Machine Account V2
get-create-machine-account-request-v1	GET /account-requests/v1/machine-account-create/{accountRequestId}	Get Machine Account Creation Request
get-machine-account-create-access-info-v1	GET /source-subtypes/v1/machine-account-create-access	Machine Account Create Access

create-machine-account-request-v1

experimental

This API is currently in an experimental state. The API is subject to change based on feedback and further testing. You must include the X-SailPoint-Experimental header and set it to true to use this endpoint.

Submit Machine Account Creation Request 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.

API Spec

Parameters

The service takes one object that holds every parameter. Its type is CreateMachineAccountRequestV1RequestParams.

Name	Type	Description	Notes
machineAccountCreateRequestInput	MachineAccountCreateRequestInput
xSailPointExperimental	string	Use this header to enable this experimental API.	[optional] [default to 'true']

Return type

Observable<AccountRequestAsyncResult>

HTTP request headers

• Content-Type: application/json
• Accept: application/json

Example

import { Component, inject } from '@angular/core';
import { MachineAccountCreationRequestService } from '@sailpoint/angular-sdk/machine_account_creation_request';
import { MachineAccountCreateRequestInput } from '@sailpoint/angular-sdk/machine_account_creation_request';

@Component({ selector: 'app-example', template: '' })
export class ExampleComponent {
  private readonly api = inject(MachineAccountCreationRequestService);

  createMachineAccountRequestV1(): void {
    const machineAccountCreateRequestInput: MachineAccountCreateRequestInput = ; // 
    const xSailPointExperimental: string = ; // Use this header to enable this experimental API. (optional)
    this.api.createMachineAccountRequestV1({ machineAccountCreateRequestInput: machineAccountCreateRequestInput }).subscribe({
      next: (result) => console.log(result),
      error: (error) => console.error(error),
    });
  }
}

[Back to top]

create-machine-account-request-v2

experimental

This API is currently in an experimental state. The API is subject to change based on feedback and further testing. You must include the X-SailPoint-Experimental header and set it to true to use this endpoint.

Submit Machine Account Creation Request Submits a machine account creation request on the account-requests API. This operation accepts the same request and runs the same creation process as Create Machine Account. Use this operation when the integration already calls the account-requests APIs. New integrations should call Create Machine Account.

This method validates the input data, processes the machine account creation request, and returns an asynchronous result containing a tracking ID.

Compared with v1, this version:

• Accepts a sourceId so you can choose the source to create the account on. When subtypes can be configured per source for the tenant, sourceId is required and the subtype must be available on that source.
• Accepts entitlements, which lets you add a comment, start date, and remove date to each requested entitlement.
• Supports subtypes that are not tied to a single source. Version 1 rejects those subtypes.

There is no v2 status endpoint. Use the returned accountRequestId with Get Machine Account Creation Request to track the request.

This API returns 403 when machine identity creation is not included in the tenant's plan. When machine account creation is not enabled for the tenant, this API returns 404.

NOTE: You can only request a machine account on a subtype for which you have a create machine account entitlement provisioned. Otherwise, this API returns 403.

API Spec

Parameters

The service takes one object that holds every parameter. Its type is CreateMachineAccountRequestV2RequestParams.

Name	Type	Description	Notes
machineAccountCreateRequestInputV2	MachineAccountCreateRequestInputV2
xSailPointExperimental	string	Use this header to enable this experimental API.	[optional] [default to 'true']

Return type

Observable<AccountRequestAsyncResult>

HTTP request headers

• Content-Type: application/json
• Accept: application/json

Example

import { Component, inject } from '@angular/core';
import { MachineAccountCreationRequestService } from '@sailpoint/angular-sdk/machine_account_creation_request';
import { MachineAccountCreateRequestInputV2 } from '@sailpoint/angular-sdk/machine_account_creation_request';

@Component({ selector: 'app-example', template: '' })
export class ExampleComponent {
  private readonly api = inject(MachineAccountCreationRequestService);

  createMachineAccountRequestV2(): void {
    const machineAccountCreateRequestInputV2: MachineAccountCreateRequestInputV2 = ; // 
    const xSailPointExperimental: string = ; // Use this header to enable this experimental API. (optional)
    this.api.createMachineAccountRequestV2({ machineAccountCreateRequestInputV2: machineAccountCreateRequestInputV2 }).subscribe({
      next: (result) => console.log(result),
      error: (error) => console.error(error),
    });
  }
}

[Back to top]

create-machine-account-v2

experimental

This API is currently in an experimental state. The API is subject to change based on feedback and further testing. You must include the X-SailPoint-Experimental header and set it to true to use this endpoint.

Create Machine Account V2 Submits a machine account creation request. New integrations should use this operation. This operation accepts the same request and runs the same creation process as Submit Machine Account Creation Request. That operation stays on the account-requests API for integrations that already call it. When version 1 cannot create the account because the subtype is not tied to a single source, the error directs the caller here. This method validates the input data, processes the machine account creation request, and returns an asynchronous result containing a tracking ID.

Compared with v1, this version:

• Accepts a sourceId so you can choose the source to create the account on. When subtypes can be configured per source for the tenant, sourceId is required and the subtype must be available on that source.
• Accepts entitlements, which lets you add a comment, start date, and remove date to each requested entitlement.
• Supports subtypes that are not tied to a single source. Version 1 rejects those subtypes.

There is no v2 status endpoint. Use the returned accountRequestId with Get Machine Account Creation Request to track the request.

This API returns 403 when machine identity creation is not included in the tenant's plan. When machine account creation is not enabled for the tenant, this API returns 404.

NOTE: You can only request a machine account on a subtype for which you have a create machine account entitlement provisioned. Otherwise, this API returns 403.

API Spec

Parameters

The service takes one object that holds every parameter. Its type is CreateMachineAccountV2RequestParams.

Name	Type	Description	Notes
machineAccountCreateRequestInputV2	MachineAccountCreateRequestInputV2
xSailPointExperimental	string	Use this header to enable this experimental API.	[optional] [default to 'true']

Return type

Observable<AccountRequestAsyncResult>

HTTP request headers

• Content-Type: application/json
• Accept: application/json

Example

import { Component, inject } from '@angular/core';
import { MachineAccountCreationRequestService } from '@sailpoint/angular-sdk/machine_account_creation_request';
import { MachineAccountCreateRequestInputV2 } from '@sailpoint/angular-sdk/machine_account_creation_request';

@Component({ selector: 'app-example', template: '' })
export class ExampleComponent {
  private readonly api = inject(MachineAccountCreationRequestService);

  createMachineAccountV2(): void {
    const machineAccountCreateRequestInputV2: MachineAccountCreateRequestInputV2 = ; // 
    const xSailPointExperimental: string = ; // Use this header to enable this experimental API. (optional)
    this.api.createMachineAccountV2({ machineAccountCreateRequestInputV2: machineAccountCreateRequestInputV2 }).subscribe({
      next: (result) => console.log(result),
      error: (error) => console.error(error),
    });
  }
}

[Back to top]

get-create-machine-account-request-v1

experimental

This API is currently in an experimental state. The API is subject to change based on feedback and further testing. You must include the X-SailPoint-Experimental header and set it to true to use this endpoint.

Get Machine Account Creation Request Retrieves a account request details for machine account creation. This allows the user to view all details for given account request.

API Spec

Parameters

The service takes one object that holds every parameter. Its type is GetCreateMachineAccountRequestV1RequestParams.

Name	Type	Description	Notes
xSailPointExperimental	string	Use this header to enable this experimental API.	[default to 'true']
accountRequestId	string	Account Request ID	[default to undefined]

Return type

Observable<AccountRequestDetailsDto>

HTTP request headers

• Content-Type: Not defined
• Accept: application/json

Example

import { Component, inject } from '@angular/core';
import { MachineAccountCreationRequestService } from '@sailpoint/angular-sdk/machine_account_creation_request';

@Component({ selector: 'app-example', template: '' })
export class ExampleComponent {
  private readonly api = inject(MachineAccountCreationRequestService);

  getCreateMachineAccountRequestV1(): void {
    const xSailPointExperimental: string = ; // Use this header to enable this experimental API.
    const accountRequestId: string = ; // Account Request ID
    this.api.getCreateMachineAccountRequestV1({ xSailPointExperimental: xSailPointExperimental, accountRequestId: accountRequestId }).subscribe({
      next: (result) => console.log(result),
      error: (error) => console.error(error),
    });
  }
}

[Back to top]

get-machine-account-create-access-info-v1

experimental

This API is currently in an experimental state. The API is subject to change based on feedback and further testing. You must include the X-SailPoint-Experimental header and set it to true to use this endpoint.

Machine Account Create Access 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.

API Spec

Parameters

The service takes one object that holds every parameter. Its type is GetMachineAccountCreateAccessInfoV1RequestParams.

Name	Type	Description	Notes
xSailPointExperimental	string	Use this header to enable this experimental API.	[default to 'true']
offset	number	Offset Integer specifying the offset of the first result from the beginning of the collection. The standard syntax described in API Standard Collection Parameters. The offset value is record-based, not page-based, and the index starts at 0.	[optional] [default to 0]
limit	number	Limit Integer specifying the maximum number of records to return in a single API call. The standard syntax described in API Standard Collection Parameters. If it is not specified, a default limit is used.	[optional] [default to 250]

Return type

Observable<Array<MachineAccountCreateAccessDto>>

HTTP request headers

• Content-Type: Not defined
• Accept: application/json

Example

import { Component, inject } from '@angular/core';
import { MachineAccountCreationRequestService } from '@sailpoint/angular-sdk/machine_account_creation_request';

@Component({ selector: 'app-example', template: '' })
export class ExampleComponent {
  private readonly api = inject(MachineAccountCreationRequestService);

  getMachineAccountCreateAccessInfoV1(): void {
    const xSailPointExperimental: string = ; // Use this header to enable this experimental API.
    const offset: number = ; // Offset  Integer specifying the offset of the first result from the beginning of the collection. The standard syntax described in [API Standard Collection Parameters](https://developer.sailpoint.com/docs/api/standard-collection-parameters#paginating-results). The offset value is record-based, not page-based, and the index starts at 0. (optional)
    const limit: number = ; // Limit  Integer specifying the maximum number of records to return in a single API call. The standard syntax described in [API Standard Collection Parameters](https://developer.sailpoint.com/docs/api/standard-collection-parameters#paginating-results). If it is not specified, a default limit is used. (optional)
    this.api.getMachineAccountCreateAccessInfoV1({ xSailPointExperimental: xSailPointExperimental }).subscribe({
      next: (result) => console.log(result),
      error: (error) => console.error(error),
    });
  }
}

[Back to top]