Register a kiosk device

POST

/tenant/devices

curl --request POST \
  --url https://api-sandbox.trustink.io/tenant/devices \
  --header 'Authorization: Bearer <token>' \
  --header 'Content-Type: application/json' \
  --data '{ "name": "example" }'

• Sandbox
• Production

Answers the device’s token for the AppSync Events API once; only its hash is kept.

Authorizations

• tenantIdToken

Request Body^required

Media typeapplication/json

object

name

required

string

>= 1 characters <= 80 characters

Example^generated

{
  "name": "example"
}

Responses

201

The device, its channel and its token.

Media typeapplication/json

object

deviceId

required

string

name

required

string

created

required

string

token

required

string

channel

required

string

Example^generated

{
  "deviceId": "example",
  "name": "example",
  "created": "example",
  "token": "example",
  "channel": "example"
}

400

The request failed validation: validationErrors says where and why.

Media typeapplication/json

object

message

required

string

validationErrors

required

Array<object>

object

instancePath

required

string

keyword

required

string

params

required

object

key

additional properties

message

required

string

Example^generated

{
  "message": "example",
  "validationErrors": [
    {
      "instancePath": "example",
      "keyword": "example",
      "params": {
        "additionalProperty": "example"
      },
      "message": "example"
    }
  ]
}

401

No or an invalid Cognito ID token (API Gateway answers {message} only).

Media typeapplication/json

object

code

string

message

required

string

Example^generated

{
  "code": "example",
  "message": "example"
}

default

Something failed on the platform, or the request timed out (code TIMEOUT, 503); try again.

Media typeapplication/json

object

code

string

message

required

string

Example^generated

{
  "code": "example",
  "message": "example"
}