MachineAccountsApi

All URIs are relative to https://sailpoint.api.identitynow.com

Method	HTTP request	Description
create-machine-account-subtype-v1	POST `/sources/v1/{sourceId}/subtypes`	Create subtype
delete-machine-account-subtype-by-technical-name-v1	DELETE `/sources/v1/{sourceId}/subtypes/{technicalName}`	Delete subtype
get-machine-account-subtype-by-id-v1	GET `/sources/v1/subtypes/{subtypeId}`	Retrieve subtype by subtype id
get-machine-account-subtype-by-technical-name-v1	GET `/sources/v1/{sourceId}/subtypes/{technicalName}`	Retrieve subtype by source and technicalName
get-machine-account-v1	GET `/machine-accounts/v1/{id}`	Get machine account details
list-machine-account-subtypes-v1	GET `/sources/v1/{sourceId}/subtypes`	Retrieve all subtypes by source
list-machine-accounts-v1	GET `/machine-accounts/v1`	List machine accounts
patch-machine-account-subtype-by-technical-name-v1	PATCH `/sources/v1/{sourceId}/subtypes/{technicalName}`	Patch subtype
update-machine-account-v1	PATCH `/machine-accounts/v1/{id}`	Update machine account details

create-machine-account-subtype-v1

deprecated

This endpoint has been deprecated and may be replaced or removed in future versions of the API.

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 subtype Create a new machine account subtype for a source.

API Spec

Parameters

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

Return type

Sourcesubtype

HTTP request headers

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

Example

import { MachineAccountsApi } from 'sailpoint-api-client';
import { Configuration } from 'sailpoint-api-client';

const configuration = new Configuration();
const apiInstance = new MachineAccountsApi(configuration);
const sourceId: string = 6d0458373bec4b4b80460992b76016da; // The ID of the source.
const createMachineAccountSubtypeV1Request: CreateMachineAccountSubtypeV1Request = {"technicalName":"foo","displayName":"Mr Foo","description":"fighters","type":"MACHINE"}; // 
const xSailPointExperimental: string = true; // Use this header to enable this experimental API. (optional)
const result = await apiInstance.createMachineAccountSubtypeV1({ sourceId: sourceId, createMachineAccountSubtypeV1Request: createMachineAccountSubtypeV1Request });
console.log(result);

[Back to top]

delete-machine-account-subtype-by-technical-name-v1

deprecated

This endpoint has been deprecated and may be replaced or removed in future versions of the API.

experimental

Delete subtype Delete a machine account subtype by source ID and technical name.

API Spec

Parameters

Name	Type	Description	Notes
sourceId	`string`	The ID of the source.	[default to undefined]
technicalName	`string`	The technical name of the subtype.	[default to undefined]
xSailPointExperimental	`string`	Use this header to enable this experimental API.	[optional] [default to 'true']

Return type

(empty response body)

HTTP request headers

Content-Type: Not defined
Accept: application/json

Example

import { MachineAccountsApi } from 'sailpoint-api-client';
import { Configuration } from 'sailpoint-api-client';

const configuration = new Configuration();
const apiInstance = new MachineAccountsApi(configuration);
const sourceId: string = 6d0458373bec4b4b80460992b76016da; // The ID of the source.
const technicalName: string = foo; // The technical name of the subtype.
const xSailPointExperimental: string = true; // Use this header to enable this experimental API. (optional)
const result = await apiInstance.deleteMachineAccountSubtypeByTechnicalNameV1({ sourceId: sourceId, technicalName: technicalName });
console.log(result);

[Back to top]

get-machine-account-subtype-by-id-v1

deprecated

This endpoint has been deprecated and may be replaced or removed in future versions of the API.

experimental

Retrieve subtype by subtype id Get a machine account subtype by its unique ID.

API Spec

Parameters

Name	Type	Description	Notes
subtypeId	`string`	The ID of the machine account subtype.	[default to undefined]
xSailPointExperimental	`string`	Use this header to enable this experimental API.	[optional] [default to 'true']

Return type

Sourcesubtype

HTTP request headers

Content-Type: Not defined
Accept: application/json

Example

import { MachineAccountsApi } from 'sailpoint-api-client';
import { Configuration } from 'sailpoint-api-client';

const configuration = new Configuration();
const apiInstance = new MachineAccountsApi(configuration);
const subtypeId: string = 43bdd144-4b17-4fce-a744-17c7fd3e717b; // The ID of the machine account subtype.
const xSailPointExperimental: string = true; // Use this header to enable this experimental API. (optional)
const result = await apiInstance.getMachineAccountSubtypeByIdV1({ subtypeId: subtypeId });
console.log(result);

[Back to top]

get-machine-account-subtype-by-technical-name-v1

deprecated

This endpoint has been deprecated and may be replaced or removed in future versions of the API.

experimental

Retrieve subtype by source and technicalName Get a machine account subtype by source ID and technical name.

API Spec

Parameters

Name	Type	Description	Notes
sourceId	`string`	The ID of the source.	[default to undefined]
technicalName	`string`	The technical name of the subtype.	[default to undefined]
xSailPointExperimental	`string`	Use this header to enable this experimental API.	[optional] [default to 'true']

Return type

Sourcesubtype

HTTP request headers

Content-Type: Not defined
Accept: application/json

Example

import { MachineAccountsApi } from 'sailpoint-api-client';
import { Configuration } from 'sailpoint-api-client';

const configuration = new Configuration();
const apiInstance = new MachineAccountsApi(configuration);
const sourceId: string = 6d0458373bec4b4b80460992b76016da; // The ID of the source.
const technicalName: string = foo; // The technical name of the subtype.
const xSailPointExperimental: string = true; // Use this header to enable this experimental API. (optional)
const result = await apiInstance.getMachineAccountSubtypeByTechnicalNameV1({ sourceId: sourceId, technicalName: technicalName });
console.log(result);

[Back to top]

get-machine-account-v1

experimental

Get machine account details Use this API to return the details for a single machine account by its ID.

API Spec

Parameters

Name	Type	Description	Notes
id	`string`	Machine Account ID.	[default to undefined]
xSailPointExperimental	`string`	Use this header to enable this experimental API.	[optional] [default to 'true']

Return type

Machineaccount

HTTP request headers

Content-Type: Not defined
Accept: application/json

Example

import { MachineAccountsApi } from 'sailpoint-api-client';
import { Configuration } from 'sailpoint-api-client';

const configuration = new Configuration();
const apiInstance = new MachineAccountsApi(configuration);
const id: string = ef38f94347e94562b5bb8424a56397d8; // Machine Account ID.
const xSailPointExperimental: string = true; // Use this header to enable this experimental API. (optional)
const result = await apiInstance.getMachineAccountV1({ id: id });
console.log(result);

[Back to top]

list-machine-account-subtypes-v1

deprecated

This endpoint has been deprecated and may be replaced or removed in future versions of the API.

experimental

Retrieve all subtypes by source Get all machine account subtypes for a given source.

API Spec

Parameters

Name	Type	Description	Notes
sourceId	`string`	The ID of the source.	[default to undefined]
filters	`string`	Filter results using the standard syntax described in V3 API Standard Collection Parameters Filtering is supported for the following fields and operators: displayName: eq, sw technicalName: eq, sw	[optional] [default to undefined]
sorters	`string`	Sort results using the standard syntax described in V3 API Standard Collection Parameters Sorting is supported for the following fields: displayName, technicalName	[optional] [default to undefined]
xSailPointExperimental	`string`	Use this header to enable this experimental API.	[optional] [default to 'true']
count	`boolean`	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 for more information.	[optional] [default to false]
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]

Return type

Array<Sourcesubtype>

HTTP request headers

Content-Type: Not defined
Accept: application/json

Example

import { MachineAccountsApi } from 'sailpoint-api-client';
import { Configuration } from 'sailpoint-api-client';

const configuration = new Configuration();
const apiInstance = new MachineAccountsApi(configuration);
const sourceId: string = 6d0458373bec4b4b80460992b76016da; // The ID of the source.
const filters: string = displayName eq "sail"; // 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* (optional)
const sorters: string = displayName; // 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** (optional)
const xSailPointExperimental: string = true; // Use this header to enable this experimental API. (optional)
const count: boolean = true; // 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&#x3D;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. (optional)
const limit: number = 250; // 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 = 0; // 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 result = await apiInstance.listMachineAccountSubtypesV1({ sourceId: sourceId });
console.log(result);

[Back to top]

list-machine-accounts-v1

experimental

List machine accounts This returns a list of machine accounts.

API Spec

Parameters

Name	Type	Description	Notes
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]
count	`boolean`	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 for more information.	[optional] [default to false]
filters	`string`	Filter results using the standard syntax described in V3 API Standard Collection Parameters 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	[optional] [default to undefined]
sorters	`string`	Sort results using the standard syntax described in V3 API Standard Collection Parameters 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	[optional] [default to undefined]
xSailPointExperimental	`string`	Use this header to enable this experimental API.	[optional] [default to 'true']

Return type

Array<Machineaccount>

HTTP request headers

Content-Type: Not defined
Accept: application/json

Example

import { MachineAccountsApi } from 'sailpoint-api-client';
import { Configuration } from 'sailpoint-api-client';

const configuration = new Configuration();
const apiInstance = new MachineAccountsApi(configuration);
const limit: number = 250; // 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 = 0; // 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 count: boolean = true; // 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&#x3D;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. (optional)
const filters: string = hasEntitlements eq true; // 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* (optional)
const sorters: string = id,name; // 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** (optional)
const xSailPointExperimental: string = true; // Use this header to enable this experimental API. (optional)
const result = await apiInstance.listMachineAccountsV1({  });
console.log(result);

[Back to top]

patch-machine-account-subtype-by-technical-name-v1

deprecated

This endpoint has been deprecated and may be replaced or removed in future versions of the API.

experimental

Patch subtype Update fields of a machine account subtype by source ID and technical name. Patchable fields include: displayName, description.

API Spec

Parameters

Name	Type	Description	Notes
sourceId	`string`	The ID of the source.	[default to undefined]
technicalName	`string`	The technical name of the subtype.	[default to undefined]
requestBody	`Array<object>`	A JSON of updated values JSON Patch standard.
xSailPointExperimental	`string`	Use this header to enable this experimental API.	[optional] [default to 'true']

Return type

Sourcesubtype

HTTP request headers

Content-Type: application/json-patch+json
Accept: application/json

Example

import { MachineAccountsApi } from 'sailpoint-api-client';
import { Configuration } from 'sailpoint-api-client';

const configuration = new Configuration();
const apiInstance = new MachineAccountsApi(configuration);
const sourceId: string = 6d0458373bec4b4b80460992b76016da; // The ID of the source.
const technicalName: string = foo; // The technical name of the subtype.
const requestBody: Array&lt;object&gt; = [{"op":"replace","path":"/displayName","value":"Test New DisplayName"}]; // A JSON of updated values [JSON Patch](https://tools.ietf.org/html/rfc6902) standard.
const xSailPointExperimental: string = true; // Use this header to enable this experimental API. (optional)
const result = await apiInstance.patchMachineAccountSubtypeByTechnicalNameV1({ sourceId: sourceId, technicalName: technicalName, requestBody: requestBody });
console.log(result);

[Back to top]

update-machine-account-v1

experimental

Update machine account details Use this API to update machine accounts details.

API Spec

Parameters

Name	Type	Description	Notes
id	`string`	Machine Account ID.	[default to undefined]
requestBody	`Array<object>`	A JSON of updated values JSON Patch standard. The following fields are patchable: * description * ownerIdentity * subType * accessType * environment * attributes * classificationMethod * manuallyEdited * nativeIdentity * uuid * source * manuallyCorrelated * enabled * locked * hasEntitlements * connectorAttributes
xSailPointExperimental	`string`	Use this header to enable this experimental API.	[optional] [default to 'true']

Return type

Machineaccount

HTTP request headers

Content-Type: application/json-patch+json
Accept: application/json

Example

import { MachineAccountsApi } from 'sailpoint-api-client';
import { Configuration } from 'sailpoint-api-client';

const configuration = new Configuration();
const apiInstance = new MachineAccountsApi(configuration);
const id: string = ef38f94347e94562b5bb8424a56397d8; // Machine Account ID.
const requestBody: Array&lt;object&gt; = [{"op":"add","path":"/environment","value":"test"}]; // 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
const xSailPointExperimental: string = true; // Use this header to enable this experimental API. (optional)
const result = await apiInstance.updateMachineAccountV1({ id: id, requestBody: requestBody });
console.log(result);

[Back to top]

create-machine-account-subtype-v1​

Parameters​

Return type​

HTTP request headers​

Example​

delete-machine-account-subtype-by-technical-name-v1​

Parameters​

Return type​

HTTP request headers​

Example​

get-machine-account-subtype-by-id-v1​

Parameters​

Return type​

HTTP request headers​

Example​

get-machine-account-subtype-by-technical-name-v1​

Parameters​

Return type​

HTTP request headers​

Example​

get-machine-account-v1​

Parameters​

Return type​

HTTP request headers​

Example​

list-machine-account-subtypes-v1​

Parameters​

Return type​

HTTP request headers​

Example​

list-machine-accounts-v1​

Parameters​

Return type​

HTTP request headers​

Example​

patch-machine-account-subtype-by-technical-name-v1​

Parameters​

Return type​

HTTP request headers​

Example​

update-machine-account-v1​

Parameters​

Return type​

HTTP request headers​

Example​

create-machine-account-subtype-v1

Parameters

Return type

HTTP request headers

Example

delete-machine-account-subtype-by-technical-name-v1

Parameters

Return type

HTTP request headers

Example

get-machine-account-subtype-by-id-v1

Parameters

Return type

HTTP request headers

Example

get-machine-account-subtype-by-technical-name-v1

Parameters

Return type

HTTP request headers

Example

get-machine-account-v1

Parameters

Return type

HTTP request headers

Example

list-machine-account-subtypes-v1

Parameters

Return type

HTTP request headers

Example

list-machine-accounts-v1

Parameters

Return type

HTTP request headers

Example

patch-machine-account-subtype-by-technical-name-v1

Parameters

Return type

HTTP request headers

Example

update-machine-account-v1

Parameters

Return type

HTTP request headers

Example