Skip to content
EntitlerDocs

POST/v1/customers/{external_id}/devices:signIn

Sign in a device

Signs a device in to the customer by its externalId, with an optional type and name. At the device limit it answers the refusal, the limit and the signed-in devices, or lockedUntil while the customer is locked out. Needs usage:write.

curl -X POST 'https://api.entitler.co/v1/customers/ada/devices:signIn' \
  -H "Authorization: Bearer $ENTITLER_KEY" \
  -H "Content-Type: application/json" \
  -d '{"name":"name","target":{"environmentId":"environmentId","projectId":"projectId","teamId":"teamId"},"type":"type"}'

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.

Request body

object

  • namestring
  • targetProductTarget
    • environmentIdstring
    • projectIdstring
    • teamIdstring
  • typestring

Responses

200The SignInDeviceResponse message.

SignInDeviceResponse

  • deviceDevice
    • externalIdstringrequired
    • idstringrequired
    • lastActiveAtintegerrequired

      at least 0; at most 18446744073709552000

    • namestring
    • 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

    • signedInAtintegerrequired

      at least 0; at most 18446744073709552000

    • typestring
  • devicesarray of Devicerequired
    • externalIdstringrequired
    • idstringrequired
    • lastActiveAtintegerrequired

      at least 0; at most 18446744073709552000

    • namestring
    • 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

    • signedInAtintegerrequired

      at least 0; at most 18446744073709552000

    • typestring
  • 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.

  • signedInbooleanrequired

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

Error

  • errorobjectrequired
    • codestringrequired
    • parametersobjectrequired

      Each value: string

    • reasonstringor nullrequired