Create Device

post http://{{url}}/v1/{clientId}/user-devices

Create Device

Behaviour

This API is designed to create a user device within Cortex.

The only required field in the body is deviceId - the rest are optional.

You can associate a device with an Cortex SSO (auth) ID by supplying an Cortex access token in the Authorization header, for example:

Authorization: Bearer {access_token}

This will populate the authId field automatically with their SSO ID.

Duration is measured in seconds.

Authentication

Authentication is required for this API using an API Key. This API key will be provided by the Cortex support team.

Header	What’s it for	Example Value
X-APP-ID	Defines the application the call is accessing from, e.g. android, ios, or web.	android
X-REALM	Defines the space or client the caller is trying to access, e.g. CORTEX.	cortex
X-API-KEY	Defines the key or password the caller is authenticating with. These will be stored per app ID and realm.

Responses

Language

Credentials

http

URL


xxxxxxxxxx
1
curl --request POST \
2
     --url http:///%7Burl%7D/v1/clientId/user-devices \
3
     --header 'accept: application/json' \
4
     --header 'content-type: application/json'


xxxxxxxxxx
 
1
{
2
  "status": "success",
3
  "metadata": {
4
    "createdAt": "2021-02-02T17:31:04.525Z"
5
  }
6
}

Content-Type
Content-Length
Connection
Vary
Date
X-Cache
Via
X-Amz-Cf-Pop
X-Amz-Cf-Id

200OK

401Unauthorized

409Conflict