Update a Device

Note: The PATCH operation introduced in ActivID CMS 5.10 has been removed.

To change a device state, the client must send a POST request to: /aims/rs/scim/v2/Device/<id>/<action>.

The supported actions are: “activate”, “resume”, “revoke”, “suspend”, “terminate”. The request body must be a form containing the reason.

The possible HTTP status codes returned are:

  • 200: OK

  • 400: Bad Request

  • 401: Unauthorized

  • 403: Forbidden

  • 404: Not Found

Example request:

Copy
POST /aims/rs/scim/v2/Device/OP_2.047900503536900499999/SUSPEND HTTP/1.1
Host: cms.mycompany.com
Accept: application/scim+json
Content-Type: application/x-www-form-urlencoded
Authorization: Bearer h480djs93hd8
Content-Length: 11

reason=LOST

Example response:

Copy
HTTP/1.1 200 OK
Content-Type: application/scim+json
Location: https://cms.mycompany.com/aims/rs/scim/v2/Device/OP_2.047900503536900499999

{
  "id": "OP_2.047900503536900499999",
  "meta": {
    "created": "2023-03-23T14:14:05.049Z",
    "lastModified": "2023-03-23T14:14:05.049Z",
    "location": "https://cms.mycompany.com/aims/rs/scim/v2/Device/OP_2.047900503536900499999",
    "resourceType": "/NplBw9lKg9KwImVlRoY/"
  },
  "status": {
    "status": "ON_HOLD",
    "reason": "LOST"
  },
  "externalIds": [
    {
      "CUID": "47900503536900499999",
      "ATR": "3BD996FF8191FE1FC343323330302D4B4559BA"
    }
  ],
  "schemas": [
    "urn:hid:scim:api:cms:1.0:Device"
  ]
}