Skip to content
EntitlerDocs

POST/v1/customers/{external_id}/devices/{device_id}/sessions

Start device session

Needs usage:write.

curl -X POST 'https://api.entitler.co/v1/customers/ada/devices/<device_id>/sessions' \
  -H "Authorization: Bearer $ENTITLER_KEY" \
  -H "Content-Type: application/json" \
  -d '{"leaseSeconds":1,"target":{"environmentId":"environmentId","projectId":"projectId","teamId":"teamId"}}'

Credentials

Send any one of these:

  • Bearer token

Path parameters

NameTypeDescription
external_idrequiredstringThe customer's external ID, or me for the customer a customer token or identity token names.
device_idrequiredstring

Request body

object

  • leaseSecondsinteger (int64)

    at least 0; at most 4294967295

  • targetProductTarget
    • environmentIdstring
    • projectIdstring
    • teamIdstring

Responses

200The StartDeviceSessionResponse message.

StartDeviceSessionResponse

  • limitinteger (int64)

    at least 0; at most 4294967295

  • lockedUntilinteger

    at least 0; at most 18446744073709552000

  • refusalDeviceRefusal

    One of DEVICE_REFUSAL_UNSPECIFIED, DEVICE_REFUSAL_LIMIT_REACHED, DEVICE_REFUSAL_TYPE_NOT_ENTITLED, DEVICE_REFUSAL_LOCKED.

  • sessionDeviceSession
    • deviceIdstringrequired
    • expiresAtintegerrequired

      at least 0; at most 18446744073709552000

    • idstringrequired
    • leaseSecondsinteger (int64)required

      at least 0; at most 4294967295

    • startedAtintegerrequired

      at least 0; at most 18446744073709552000

  • sessionsarray of DeviceSessionrequired
    • deviceIdstringrequired
    • expiresAtintegerrequired

      at least 0; at most 18446744073709552000

    • idstringrequired
    • leaseSecondsinteger (int64)required

      at least 0; at most 4294967295

    • startedAtintegerrequired

      at least 0; at most 18446744073709552000

  • startedbooleanrequired

ErrorA refusal, with the HTTP status of its gRPC code.

Error

  • errorobjectrequired
    • codestringrequired
    • parametersobjectrequired

      Each value: string

    • reasonstringor nullrequired