BusinessApplicationsApi

A Business Application groups machine identities (for example AI agents or applications) under a common owner and sanctioned status. Business Applications can be defined out-of-the-box, discovered from a source, or created by an administrator. Signatures on a Business Application drive automatic correlation of machine identities to it; sanctioned status is independent metadata that machine identities inherit once linked. All URIs are relative to https://sailpoint.api.identitynow.com

Method	HTTP request	Description
create-business-application-v1	POST `/business-applications/v1`	Create Business Application
get-business-application-v1	GET `/business-applications/v1/{id}`	Get Business Application
list-business-applications-v1	GET `/business-applications/v1`	List Business Applications
update-business-application-v1	PATCH `/business-applications/v1/{id}`	Update Business Application

create-business-application-v1

Create Business Application Creates a custom Business Application. Requires the idn:business-application:create right, the Machine Identity Security product to be enabled, and the custom Business Application feature to be enabled for the tenant. The name must be unique within the tenant, and any provided signatures must not already be assigned to another Business Application.

API Spec

Parameters

Name	Type	Description	Notes
businessApplication	`BusinessApplication`

Return type

BusinessApplication

HTTP request headers

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

Example

import { BusinessApplicationsApi } from 'sailpoint-api-client';
import { Configuration } from 'sailpoint-api-client';
import { BusinessApplication } from 'sailpoint-api-client/dist/business_applications/api';

const configuration = new Configuration();
const apiInstance = new BusinessApplicationsApi(configuration);
const businessApplication: BusinessApplication = {
  "owner" : {
    "name" : "William Wilson",
    "id" : "2c91808568c529c60168cca6f90c1313",
    "type" : "IDENTITY"
  },
  "vendor" : "Cursor",
  "created" : "2026-01-15T13:45:12.312Z",
  "origin" : "",
  "name" : "Cursor",
  "description" : "AI coding assistant used by the platform engineering team.",
  "modified" : "2026-02-20T09:31:47.882Z",
  "id" : "a1b2c3d4-e5f6-7890-abcd-ef1234567890",
  "source" : {
    "name" : "William Wilson",
    "id" : "2c91808568c529c60168cca6f90c1313",
    "type" : "IDENTITY"
  },
  "signatures" : [ {
    "name" : "cursor",
    "type" : "AI Agent"
  }, {
    "name" : "cursor",
    "type" : "AI Agent"
  } ],
  "additionalOwners" : [ {
    "name" : "William Wilson",
    "id" : "2c91808568c529c60168cca6f90c1313",
    "type" : "IDENTITY"
  }, {
    "name" : "William Wilson",
    "id" : "2c91808568c529c60168cca6f90c1313",
    "type" : "IDENTITY"
  } ],
  "sanctionedStatus" : ""
}; // 
const result = await apiInstance.createBusinessApplicationV1({ businessApplication: businessApplication });
console.log(result);

[Back to top]

get-business-application-v1

Get Business Application Returns a single Business Application by ID for the requesting tenant. Requires the idn:business-application:read right and the Machine Identity Security product to be enabled.

API Spec

Parameters

Name	Type	Description	Notes
id	`string`	Business Application ID.	[default to undefined]

Return type

BusinessApplication

HTTP request headers

Content-Type: Not defined
Accept: application/json

Example

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

const configuration = new Configuration();
const apiInstance = new BusinessApplicationsApi(configuration);
const id: string = a1b2c3d4-e5f6-7890-abcd-ef1234567890; // Business Application ID.
const result = await apiInstance.getBusinessApplicationV1({ id: id });
console.log(result);

[Back to top]

list-business-applications-v1

List Business Applications Returns the list of Business Applications defined for the requesting tenant. Requires the idn:business-application:read right and the Machine Identity Security product to be enabled for the tenant.

API Spec

Parameters

Name	Type	Description	Notes
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 name: eq, co vendor: eq, co signatures.type: eq, co signatures.name: eq, co source.name: eq, co sanctionedStatus: eq	[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, sanctionedStatus	[optional] [default to undefined]
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<BusinessApplication>

HTTP request headers

Content-Type: Not defined
Accept: application/json

Example

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

const configuration = new Configuration();
const apiInstance = new BusinessApplicationsApi(configuration);
const filters: string = sanctionedStatus eq "SANCTIONED"; // 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*  **name**: *eq, co*  **vendor**: *eq, co*  **signatures.type**: *eq, co*  **signatures.name**: *eq, co*  **source.name**: *eq, co*  **sanctionedStatus**: *eq* (optional)
const sorters: string = 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, sanctionedStatus** (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.listBusinessApplicationsV1({  });
console.log(result);

[Back to top]

update-business-application-v1

Update Business Application Updates a Business Application using the JSON Patch standard. Requires the idn:business-application:update right and the Machine Identity Security product to be enabled. Patchable fields: name, description, owner, additionalOwners, sanctionedStatus, and signatures. Modifying signatures additionally requires the custom Business Application feature to be enabled.

API Spec

Parameters

Name	Type	Description	Notes
id	`string`	Business Application ID.	[default to undefined]
jsonPatchOperation	`Array<JsonPatchOperation>`	A JSON array of patch operations per RFC 6902.

Return type

BusinessApplication

HTTP request headers

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

Example

import { BusinessApplicationsApi } from 'sailpoint-api-client';
import { Configuration } from 'sailpoint-api-client';
import { JsonPatchOperation } from 'sailpoint-api-client/dist/business_applications/api';

const configuration = new Configuration();
const apiInstance = new BusinessApplicationsApi(configuration);
const id: string = a1b2c3d4-e5f6-7890-abcd-ef1234567890; // Business Application ID.
const jsonPatchOperation: Array<JsonPatchOperation> = {
  "op" : "replace",
  "path" : "/description",
  "value" : "New description"
}{
  "op" : "replace",
  "path" : "/description",
  "value" : "New description"
}; // A JSON array of patch operations per RFC 6902.
const result = await apiInstance.updateBusinessApplicationV1({ id: id, jsonPatchOperation: jsonPatchOperation });
console.log(result);

[Back to top]

create-business-application-v1​

Parameters​

Return type​

HTTP request headers​

Example​

get-business-application-v1​

Parameters​

Return type​

HTTP request headers​

Example​

list-business-applications-v1​

Parameters​

Return type​

HTTP request headers​

Example​

update-business-application-v1​

Parameters​

Return type​

HTTP request headers​

Example​

create-business-application-v1

Parameters

Return type

HTTP request headers

Example

get-business-application-v1

Parameters

Return type

HTTP request headers

Example

list-business-applications-v1

Parameters

Return type

HTTP request headers

Example

update-business-application-v1

Parameters

Return type

HTTP request headers

Example