MachineAccountMappingsService

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

Method	HTTP request	Description
create-machine-account-mappings-v1	POST /sources/v1/{sourceId}/machine-account-mappings	Create machine account mappings
delete-machine-account-mappings-v1	DELETE /sources/v1/{sourceId}/machine-account-mappings	Delete source's machine account mappings
list-machine-account-mappings-v1	GET /sources/v1/{sourceId}/machine-account-mappings	Machine account mapping for source
set-machine-account-mappings-v1	PUT /sources/v1/{sourceId}/machine-mappings	Update source's machine account mappings

create-machine-account-mappings-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.

Create machine account mappings 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.

API Spec

Parameters

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

Name	Type	Description	Notes
sourceId	string	Source ID.	[default to undefined]
attributeMappings	AttributeMappings
xSailPointExperimental	string	Use this header to enable this experimental API.	[optional] [default to 'true']

Return type

Observable<Array<AttributeMappings>>

HTTP request headers

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

Example

import { Component, inject } from '@angular/core';
import { MachineAccountMappingsService } from '@sailpoint/angular-sdk/machine_account_mappings';
import { AttributeMappings } from '@sailpoint/angular-sdk/machine_account_mappings';

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

  createMachineAccountMappingsV1(): void {
    const sourceId: string = ; // Source ID.
    const attributeMappings: AttributeMappings = ; // 
    const xSailPointExperimental: string = ; // Use this header to enable this experimental API. (optional)
    this.api.createMachineAccountMappingsV1({ sourceId: sourceId, attributeMappings: attributeMappings }).subscribe({
      next: (result) => console.log(result),
      error: (error) => console.error(error),
    });
  }
}

[Back to top]

delete-machine-account-mappings-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.

Delete source's machine account mappings 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.

API Spec

Parameters

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

Name	Type	Description	Notes
sourceId	string	source ID.	[default to undefined]
xSailPointExperimental	string	Use this header to enable this experimental API.	[optional] [default to 'true']

Return type

Observable<void> (empty response body)

HTTP request headers

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

Example

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

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

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

[Back to top]

list-machine-account-mappings-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 mapping for source Retrieves Machine account mappings for a specified source using Source ID.

API Spec

Parameters

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

Name	Type	Description	Notes
sourceId	string	Source ID	[default to undefined]
limit	number	Max number of results to return. See V3 API Standard Collection Parameters for more information.	[optional] [default to 250]
offset	number	Offset into the full result set. Usually specified with limit to paginate through the results. See V3 API Standard Collection Parameters for more information.	[optional] [default to 0]
xSailPointExperimental	string	Use this header to enable this experimental API.	[optional] [default to 'true']

Return type

Observable<Array<AttributeMappings>>

HTTP request headers

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

Example

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

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

  listMachineAccountMappingsV1(): void {
    const sourceId: string = ; // Source ID
    const limit: number = ; // Max number of results to return. See [V3 API Standard Collection Parameters](https://developer.sailpoint.com/idn/api/standard-collection-parameters) for more information. (optional)
    const offset: 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. (optional)
    const xSailPointExperimental: string = ; // Use this header to enable this experimental API. (optional)
    this.api.listMachineAccountMappingsV1({ sourceId: sourceId }).subscribe({
      next: (result) => console.log(result),
      error: (error) => console.error(error),
    });
  }
}

[Back to top]

set-machine-account-mappings-v1

Update source's machine account mappings 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.

API Spec

Parameters

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

Name	Type	Description	Notes
sourceId	string	Source ID.	[default to undefined]
attributeMappings	AttributeMappings

Return type

Observable<Array<AttributeMappings>>

HTTP request headers

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

Example

import { Component, inject } from '@angular/core';
import { MachineAccountMappingsService } from '@sailpoint/angular-sdk/machine_account_mappings';
import { AttributeMappings } from '@sailpoint/angular-sdk/machine_account_mappings';

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

  setMachineAccountMappingsV1(): void {
    const sourceId: string = ; // Source ID.
    const attributeMappings: AttributeMappings = ; // 
    this.api.setMachineAccountMappingsV1({ sourceId: sourceId, attributeMappings: attributeMappings }).subscribe({
      next: (result) => console.log(result),
      error: (error) => console.error(error),
    });
  }
}

[Back to top]