Validate a ContentRequest

To validate a content request before submitting it, the client must send a POST request to: /aims/rs/scim/v2/ContentRequest/validate.

If the ContentRequest type is “update”, the server performs the following actions:

  • Return a DeviceUpdate in the response that describes what will happen to the device at the end of the update.

Any other ContentRequest type is refused.

The possible HTTP status codes returned are:

  • 200: OK

  • 400: Bad Request

  • 401: Unauthorized

  • 403: Forbidden

Example request:

Copy 
POST /aims/rs/scim/v2/ContentRequest/validate
Host: cms.mycompany.com
Accept: application/scim+json
Content-Type: application/scim+json
Authorization: Bearer h480djs93hd8
Content-Length: ...
 
{
  "type": "update",
  "parameters": [
    {
      "id": "string",
      "value": "string",
      "type": "string",
      "encoding": "none"
    }
  ],
  "target": {
    "devicePolicy": {},
    "device": {}
  },
  "wallet": {},
  "schemas": [
    "urn:hid:scim:api:cms:1.0:ContentRequest"
  ]
}

Example response:

Copy 
HTTP/1.1 201 Created
Content-Type: application/scim+json
Location: https://cms.mycompany.com/aims/rs/scim/v2/ContentRequests/16548
 
{
  "id": "string",
  "meta": {
    "created": "2024-09-24T14:56:34.110Z",
    "lastModified": "2024-09-24T14:56:34.110Z",
    "location": "http://cms.mycompany.com/aims/rs/scim/v2/ContentRequest/validate",
    "resourceType": "/hbBEdaxJYwnv2K47hjW6OW3a9C1hL"
  },
  "type": "update",
  "parameters": [
    {
      "id": "string",
      "value": "string",
      "type": "string",
      "encoding": "none"
    }
  ],
  "target": {
    "devicePolicy": {
      "\\$ref": "string",
      "value": "C2300 - Authentication only",
      "display": "string",
      "type": "string"
    },
    "device": {
      "\\$ref": "string",
      "value": "OP_2.047900503004400044309",
      "display": "string",
      "type": "string"
    }
  },
  "reason": "damaged",
  "wallet": {
    "\\$ref": "string",
    "value": "c28941b2-44f7-476c-abb9-63ef75a699ad",
    "display": "string",
    "type": "string"
  },
  "status": "requested",
  "schemas": [
    "urn:hid:scim:api:cms:1.0:ContentRequest"
  ],
  "urn:hid:scim:api:cms:1.0:DeviceUpdate": {
    "credentials": [
      {
        "id": "string",
        "name": "string",
        "schema": "string",
        "action": "none",
        "reason": "unchanged",
        "status": "string",
        "recovery": {
          "source": "credential",
          "credential": {
            "\\$ref": "string",
            "value": "string",
            "display": "string",
            "type": "string"
          },
          "version": 0
        }
      }
    ]
  }
}