enrollPlayer

POST

/api/v1/player/enroll

curl --request POST \
  --url https://example.com/api/v1/player/enroll \
  --header 'Content-Type: application/json' \
  --data '{ "pairingSessionId": "2489E9AD-2EE2-8E00-8EC9-32D5F69181C0", "enrollmentToken": "example" }'

Redeem a one-time enrollment token for the permanent device credential, returned exactly once. The enrollment token authenticates this call.

Request Body^required

Media typeapplication/json

object

pairingSessionId

required

string format: uuid

enrollmentToken

required

string

Example^generated

{
  "pairingSessionId": "2489E9AD-2EE2-8E00-8EC9-32D5F69181C0",
  "enrollmentToken": "example"
}

Responses

201

Device credential returned exactly once

Media typeapplication/json

object

data

required

object

screenId

required

string format: uuid

screenName

required

string

deviceCredential

required

Permanent device credential, returned exactly once.

string

Example^generated

{
  "data": {
    "screenId": "2489E9AD-2EE2-8E00-8EC9-32D5F69181C0",
    "screenName": "example",
    "deviceCredential": "example"
  }
}

409

Enrollment token already used