Devices

This set of API calls allows you to fetch and manipulate Keyless enabled devices.

Get user devices

get

Get user devices

Authorizations

X-Api-Key

X-Api-KeystringRequired

The customer service api key

Path parameters

userIdstring · Uppercase HEX stringRequired

The user id

Responses

200

User devices

application/json

userIdstring · HEXRequired

An HEX string representing the user id

Example: 0123456789ABCDEF

sdkCustomerIdnumberRequired

Customer unique identifier

publicSigningKeystringRequired

Device public signing key

publicEncryptionKeystringRequired

Device public encryption key

statestringRequired

Device state

Example: ACTIVE

infostringOptionalDeprecatedExample: Always set to '2'

createdAtstringRequiredExample: 2020-01-02T03:04:05.242194378

osVersionstringOptional

Device operation system version

sdkVersionstringOptional

Device's SDK version

deletedAtstringOptional

Deletion date time

Example: 2020-01-02T03:04:05.242194378

400

Request is invalid and shouldn't be retried if the request is unchanged

application/json

401

Unauthorized request, the request can't be processed unless you provide a valid authentication method

application/json

404

Resource not found

application/json

406

Not acceptable representation

application/json

500

An internal error occurred, please try again later or contact the support.

application/json

get

/users/{userId}/devices

HTTPcURLJavaScriptPython

GET /v2/users/{userId}/devices HTTP/1.1
X-Api-Key: YOUR_API_KEY
Accept: */*

[
  {
    "userId": "0123456789ABCDEF",
    "sdkCustomerId": 1,
    "publicSigningKey": "text",
    "publicEncryptionKey": "text",
    "state": "ACTIVE",
    "createdAt": "2020-01-02T03:04:05.242194378",
    "osVersion": "text",
    "sdkVersion": "text",
    "deletedAt": "2020-01-02T03:04:05.242194378"
  }
]

Delete user device

delete

Delete user device

Authorizations

X-Api-Key

X-Api-KeystringRequired

The customer service api key

Path parameters

userIdstring · Uppercase HEX stringRequired

The user id

publicSigningKeystringRequired

Public signing key

Responses

200

Device successfully deleted

application/json

Positive feedback on the operation result

successbooleanRequired

Always true

400

Request is invalid and shouldn't be retried if the request is unchanged

application/json

401

Unauthorized request, the request can't be processed unless you provide a valid authentication method

application/json

404

Resource not found

application/json

406

Not acceptable representation

application/json

500

An internal error occurred, please try again later or contact the support.

application/json

delete

/users/{userId}/devices/{publicSigningKey}

HTTPcURLJavaScriptPython

DELETE /v2/users/{userId}/devices/{publicSigningKey} HTTP/1.1
X-Api-Key: YOUR_API_KEY
Accept: */*

{
  "success": true
}