Update User Device State

To change the state of a device assigned to the authenticated user, the client must send a POST request to: /aims/rs/scim/v2/Self/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/Self/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/Self/Device/OP_2.047900503536900499999

{
  "id": "string",
  "meta": {
    "created": "2024-09-26T07:53:00.313Z",
    "lastModified": "2024-09-26T07:53:00.313Z",
    "location": "https://cms.mycompany.com/aims/rs/scim/v2/Self/Device/OP_2.047900503536900499999",
    "resourceType": "/M85TV2gSzxuo3Px1ArJCUv_xe0mvD"
  },
  "status": {
    "status": "AVAILABLE",
    "reason": "NONE"
  },
  "externalIds": [
    {
      "id": "string",
      "type": "string"
    }
  ],
  "schemas": [
    "urn:hid:scim:api:cms:1.0:Device"
  ],
  "credentials": [
    {
      "\\$ref": "string",
      "value": "string",
      "display": "string",
      "type": "Credential",
      "urn:hid:scim:api:cms:1.0:CredentialData": {
        "type": "string"
      }
    }
  ],
  "policy": {
    "\\$ref": "string",
    "value": "string",
    "display": "string",
    "type": "DevicePolicy"
  },
  "issuanceDate": "2024-09-26T07:53:00.315Z"
}