CapabilitiesApi
Use this API to list, view, and update capabilities. A capability is something a machine identity such as an AI agent can use, for example an MCP server, a tool, a skill, a plugin, or a process, discovered from a connected source. You can update a capability's owners, description, and environment; the values discovered from the source are read-only.
All URIs are relative to https://sailpoint.api.identitynow.com
| Method | HTTP request | Description |
|---|---|---|
| get-capability-v1 | GET /capabilities/v1/{id} | Get capability |
| list-capabilities-v1 | GET /capabilities/v1 | List capabilities |
| update-capability-v1 | PATCH /capabilities/v1/{id} | Partial update of capability |
get-capability-v1
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 capability This API returns a single capability by its ID.
The ID must be a UUID; any other value returns 400. When no capability exists for the ID, this API returns 404.
When Machine Identity Security is not enabled for the tenant, this API returns 404. When the capabilities API is
not enabled for the tenant, this API returns 403.
Parameters
| Name | Type | Description | Notes |
|---|---|---|---|
| id | string | Capability ID. | [default to undefined] |
| xSailPointExperimental | string | Use this header to enable this experimental API. | [optional] [default to 'true'] |
Return type
Capability
HTTP request headers
- Content-Type: Not defined
- Accept: application/json
Example
import { CapabilitiesApi } from '@sailpoint/api-client';
import { Configuration } from '@sailpoint/api-client';
const configuration = new Configuration();
const apiInstance = new CapabilitiesApi(configuration);
const id: string = 9b1c2d3e-4f5a-4b6c-8d7e-9f0a1b2c3d4e; // Capability ID.
const xSailPointExperimental: string = true; // Use this header to enable this experimental API. (optional)
const result = await apiInstance.getCapabilityV1({ id: id });
console.log(result);
list-capabilities-v1
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.
List capabilities This API returns a list of capabilities.
Source sub-admins only see capabilities on the sources they manage.
When Machine Identity Security is not enabled for the tenant, this API returns 404. When the capabilities API is
not enabled for the tenant, this API returns 403.
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: name: eq, in, sw nativeIdentity: eq, in, sw type: eq, in environment: eq, in datasetId: eq, in resource.id: eq, in source.id: eq, in source.name: eq, in, sw owners.primary.id: eq, in owners.primary.name: eq, in, sw owners.primaryIdentity.id: eq, in owners.primaryIdentity.name: eq, in, sw owners.secondaryIdentity.id: eq, in owners.secondaryIdentity.name: eq, in, sw owners.secondaryGovernanceGroup.id: eq, in owners.secondaryGovernanceGroup.name: eq, in, sw owners.governanceGroup.id: eq, in owners.governanceGroup.name: eq, in, sw created: gt, ge, lt, le modified: gt, ge, lt, 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: created, modified, name, type, source.id, source.name, resource.id, environment, datasetId, nativeIdentity, owners.primary.id, owners.primary.name, owners.primaryIdentity.id, owners.primaryIdentity.name, owners.secondaryIdentity.id, owners.secondaryIdentity.name, owners.secondaryGovernanceGroup.id, owners.secondaryGovernanceGroup.name, owners.governanceGroup.id, owners.governanceGroup.name | [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 API Standard Collection Parameters for more information. | [optional] [default to false] |
| limit | number | Max number of results to return. See 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 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
Array<Capability>
HTTP request headers
- Content-Type: Not defined
- Accept: application/json
Example
import { CapabilitiesApi } from '@sailpoint/api-client';
import { Configuration } from '@sailpoint/api-client';
const configuration = new Configuration();
const apiInstance = new CapabilitiesApi(configuration);
const filters: string = type eq "MCP"; // 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: **name**: *eq, in, sw* **nativeIdentity**: *eq, in, sw* **type**: *eq, in* **environment**: *eq, in* **datasetId**: *eq, in* **resource.id**: *eq, in* **source.id**: *eq, in* **source.name**: *eq, in, sw* **owners.primary.id**: *eq, in* **owners.primary.name**: *eq, in, sw* **owners.primaryIdentity.id**: *eq, in* **owners.primaryIdentity.name**: *eq, in, sw* **owners.secondaryIdentity.id**: *eq, in* **owners.secondaryIdentity.name**: *eq, in, sw* **owners.secondaryGovernanceGroup.id**: *eq, in* **owners.secondaryGovernanceGroup.name**: *eq, in, sw* **owners.governanceGroup.id**: *eq, in* **owners.governanceGroup.name**: *eq, in, sw* **created**: *gt, ge, lt, le* **modified**: *gt, ge, lt, le* (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: **created, modified, name, type, source.id, source.name, resource.id, environment, datasetId, nativeIdentity, owners.primary.id, owners.primary.name, owners.primaryIdentity.id, owners.primaryIdentity.name, owners.secondaryIdentity.id, owners.secondaryIdentity.name, owners.secondaryGovernanceGroup.id, owners.secondaryGovernanceGroup.name, owners.governanceGroup.id, owners.governanceGroup.name** (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=true** if that value will not be used. See [API Standard Collection Parameters](https://developer.sailpoint.com/docs/api/standard-collection-parameters) for more information. (optional)
const limit: number = 250; // Max number of results to return. See [API Standard Collection Parameters](https://developer.sailpoint.com/docs/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 [API Standard Collection Parameters](https://developer.sailpoint.com/docs/api/standard-collection-parameters) for more information. (optional)
const xSailPointExperimental: string = true; // Use this header to enable this experimental API. (optional)
const result = await apiInstance.listCapabilitiesV1({ });
console.log(result);
update-capability-v1
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.
Partial update of capability Use this API to update a capability using a JSON Patch payload.
Patchable fields are description, environment, and owners. A patch that targets any other field,
including the values discovered from the source, returns 400.
owners.primary is a single IDENTITY reference. owners.secondary holds either up to ten IDENTITY references or
exactly one GOVERNANCE_GROUP reference, not both; any other combination returns 400.
The ID must be a UUID; any other value returns 400. When no capability exists for the ID, this API returns 404.
When Machine Identity Security is not enabled for the tenant, this API returns 404. When the capabilities API is
not enabled for the tenant, this API returns 403.
Parameters
| Name | Type | Description | Notes |
|---|---|---|---|
| id | string | Capability ID. | [default to undefined] |
| jsonPatchOperation | Array<JsonPatchOperation> | A JSON of updated values JSON Patch standard. | |
| xSailPointExperimental | string | Use this header to enable this experimental API. | [optional] [default to 'true'] |
Return type
Capability
HTTP request headers
- Content-Type: application/json-patch+json
- Accept: application/json
Example
import { CapabilitiesApi } from '@sailpoint/api-client';
import { Configuration } from '@sailpoint/api-client';
import { JsonPatchOperation } from '@sailpoint/api-client/dist/capabilities/api';
const configuration = new Configuration();
const apiInstance = new CapabilitiesApi(configuration);
const id: string = 9b1c2d3e-4f5a-4b6c-8d7e-9f0a1b2c3d4e; // Capability ID.
const jsonPatchOperation: Array<JsonPatchOperation> = {
"op" : "replace",
"path" : "/description",
"value" : "New description"
}; // 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.updateCapabilityV1({ id: id, jsonPatchOperation: jsonPatchOperation });
console.log(result);