Create Device

POST 
/v1/:clientId/user-devices

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

You can associate a device with an InCrowd SSO (auth) ID by supplying an InCrowd 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.

Request

Path Parameters

clientId stringrequired

Header Parameters

X-API-KEY string
Example: bsKXkZhhdczuaHZ4xwVGk47Mbm77Epcf
X-REALM string
Example: incrowd
X-APP-ID string
Example: ios
CloudFront-Viewer-Longitude number
Example: 50.8268325
CloudFront-Viewer-Latitude number
Example: 0.2
CloudFront-Viewer-Country string
Example: GB
Accept-Language string
Example: en-gb
Authorization string
[Optional] InCrowd access token
Example: Bearer {{access_token}}

application/json

Body

object

Responses

200

OK

Response Headers

• Content-Type

  string

• Content-Length

  integer

• Connection

  string

• Vary

  string

• Date

  string

• X-Cache

  string

• Via

  string

• X-Amz-Cf-Pop

  string

• X-Amz-Cf-Id

  string

application/json

Schema

Schema

object

Example (from schema)

{}

Example

{
  "status": "success",
  "metadata": {
    "createdAt": "2021-02-02T17:31:04.525Z"
  }
}

401

Unauthorized

Response Headers

• Content-Type

  string

• Vary

  string

• Date

  string

• Content-Length

  integer

application/json

Schema

Schema

object

Example (from schema)

{}

Example

{
  "status": "fail",
  "error": {
    "code": "unauthorized",
    "domain": "device-tags"
  },
  "message": "Unauthorized",
  "metadata": {
    "createdAt": "2021-05-04T11:16:55.798Z"
  }
}

409

Conflict

Response Headers

• Content-Type

  string

• Vary

  string

• Date

  string

• Content-Length

  integer

application/json

Schema

Schema

object

Example (from schema)

{}

Example

{
  "status": "fail",
  "error": {
    "code": "device_exists",
    "domain": "device-tags"
  },
  "message": "Device with ID [1234-567810] exists",
  "metadata": {
    "createdAt": "2021-05-04T11:17:23.863Z"
  }
}

Loading...