DevicesApi
Use this API to list, view, and update devices, and to get tenant-wide device counts. A device is a machine identity that represents an endpoint, such as a laptop or server, discovered from a connected source. You can update a device's owners, description, and environment; the discovered device attributes are read-only.
All URIs are relative to https://sailpoint.api.identitynow.com
| Method | HTTP request | Description |
|---|---|---|
| get-device-counts-v1 | GET /devices/v1/device-counts | Get device counts |
| get-device-v1 | GET /devices/v1/{id} | Get device |
| list-devices-v1 | GET /devices/v1 | List devices |
| update-device-v1 | PATCH /devices/v1/{id} | Partial update of device |
get-device-counts-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 device counts This API returns tenant-wide device counts: the total number of devices, a breakdown by operating system, the average number of agents per device, and counts of devices without recent data and devices with active agents.
Because the counts cover every device in the tenant, the caller needs the idn:mis-identity:read right. Owning devices does not grant access to this API.
When Machine Identity Security is not enabled for the tenant, this API returns 404. When the devices API is not
enabled for the tenant, this API returns 403.
Parameters
| Name | Type | Description | Notes |
|---|---|---|---|
| xSailPointExperimental | string | Use this header to enable this experimental API. | [optional] [default to 'true'] |
Return type
DeviceSummary
HTTP request headers
- Content-Type: Not defined
- Accept: application/json
Example
import { DevicesApi } from '@sailpoint/api-client';
import { Configuration } from '@sailpoint/api-client';
const configuration = new Configuration();
const apiInstance = new DevicesApi(configuration);
const xSailPointExperimental: string = true; // Use this header to enable this experimental API. (optional)
const result = await apiInstance.getDeviceCountsV1({ });
console.log(result);
get-device-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 device This API returns a single device by its ID.
A caller who owns the device can view it. Other callers need the idn:mis-identity:read right.
The ID must be a UUID; any other value returns 400. When no device exists for the ID, this API returns 400 for callers who hold the idn:mis-identity:read right and 404 for other callers.
When Machine Identity Security is not enabled for the tenant, this API returns 404. When the devices API is not
enabled for the tenant, this API returns 403.
Parameters
| Name | Type | Description | Notes |
|---|---|---|---|
| id | string | Device ID. | [default to undefined] |
| xSailPointExperimental | string | Use this header to enable this experimental API. | [optional] [default to 'true'] |
Return type
Device
HTTP request headers
- Content-Type: Not defined
- Accept: application/json
Example
import { DevicesApi } from '@sailpoint/api-client';
import { Configuration } from '@sailpoint/api-client';
const configuration = new Configuration();
const apiInstance = new DevicesApi(configuration);
const id: string = 5be33d3e-c54d-4ed7-af73-2380543e8283; // Device ID.
const xSailPointExperimental: string = true; // Use this header to enable this experimental API. (optional)
const result = await apiInstance.getDeviceV1({ id: id });
console.log(result);
list-devices-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 devices This API returns a list of devices.
A caller who owns the devices can list them. Other callers need the idn:mis-identity:read right. A caller
without that right must filter the request to devices they own, for example owners.primaryIdentity.id eq "me";
if any returned device is not owned by the caller, this API returns 403. In owners.primaryIdentity.id and
owners.secondaryIdentity.id filters, the value me resolves to the calling identity.
Source sub-admins only see devices on the sources they manage.
When Machine Identity Security is not enabled for the tenant, this API returns 404. When the devices 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: id: eq, in name: eq, in, sw nativeIdentity: eq, in, sw subtype: eq, in hostname: eq, in, sw os.type: eq, in, sw os.version: eq, in, sw sentinelVersion: eq, in, sw detectionModuleVersion: eq, in, sw email: eq, in, sw description: eq, in, sw environment: eq, in, sw datasetId: eq, in, sw resource.id: eq, in resource.type: 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, nativeIdentity, hostname, os.type, os.version, sentinelVersion, detectionModuleVersion, email, description, environment, datasetId, resource.id, resource.type, source.name, owners.primaryIdentity.name, 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<Device>
HTTP request headers
- Content-Type: Not defined
- Accept: application/json
Example
import { DevicesApi } from '@sailpoint/api-client';
import { Configuration } from '@sailpoint/api-client';
const configuration = new Configuration();
const apiInstance = new DevicesApi(configuration);
const filters: string = hostname sw "lab-"; // 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* **subtype**: *eq, in* **hostname**: *eq, in, sw* **os.type**: *eq, in, sw* **os.version**: *eq, in, sw* **sentinelVersion**: *eq, in, sw* **detectionModuleVersion**: *eq, in, sw* **email**: *eq, in, sw* **description**: *eq, in, sw* **environment**: *eq, in, sw* **datasetId**: *eq, in, sw* **resource.id**: *eq, in* **resource.type**: *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 = hostname; // 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, nativeIdentity, hostname, os.type, os.version, sentinelVersion, detectionModuleVersion, email, description, environment, datasetId, resource.id, resource.type, source.name, owners.primaryIdentity.name, 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.listDevicesV1({ });
console.log(result);
update-device-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 device Use this API to update a device using a JSON Patch payload.
Patchable fields are owners, description, and environment. A patch that targets any other field,
including the discovered device attributes, 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.
A caller who owns the device can update it. Other callers need the idn:mis-identity:update right.
The ID must be a UUID; any other value returns 400. When no device exists for the ID, this API returns 400 for callers who hold the idn:mis-identity:update right and 404 for other callers.
When Machine Identity Security is not enabled for the tenant, this API returns 404. When the devices API is not
enabled for the tenant, this API returns 403.
Parameters
| Name | Type | Description | Notes |
|---|---|---|---|
| id | string | Device 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
Device
HTTP request headers
- Content-Type: application/json-patch+json
- Accept: application/json
Example
import { DevicesApi } from '@sailpoint/api-client';
import { Configuration } from '@sailpoint/api-client';
import { JsonPatchOperation } from '@sailpoint/api-client/dist/devices/api';
const configuration = new Configuration();
const apiInstance = new DevicesApi(configuration);
const id: string = 5be33d3e-c54d-4ed7-af73-2380543e8283; // Device 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.updateDeviceV1({ id: id, jsonPatchOperation: jsonPatchOperation });
console.log(result);