Partial update of device
PATCH/devices/v1/:id
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.
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.
Request
Responses
- 200
- 400
- 401
- 403
- 404
- 429
- 500
Updated device object.
Client Error - Returned if the request body is invalid.
Unauthorized - Returned if there is no authorization header, or if the JWT token is expired.
Forbidden - Returned if the user you are running as, doesn't have access to this end-point.
Not Found - returned if the request URL refers to a resource or object that does not exist
Too Many Requests - Returned in response to too many requests in a given period of time - rate limited. The Retry-After header in the response includes how long to wait before trying again.
Internal Server Error - Returned if there is an unexpected error.