Skip to content
EntitlerDocs

GET/v1/customers/{external_id}/devices

List a customer's devices

Needs usage:read.

curl 'https://api.entitler.co/v1/customers/ada/devices' \
  -H "Authorization: Bearer $ENTITLER_KEY"

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.

Query parameters

NameTypeDescription
target.team_idstring
target.project_idstring
target.environment_idstring
page_sizeinteger (int64)
page_tokenstring

Responses

200The ListCustomerDevicesResponse message.

ListCustomerDevicesResponse

  • 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
  • inUseDeviceCount
    • countinteger (int64)required

      at least 0; at most 4294967295

    • limitinteger (int64)required

      at least 0; at most 4294967295

  • lockoutsarray of DeviceLockoutrequired
    • breachesinteger (int64)required

      at least 0; at most 4294967295

    • kindcommon.DeviceLimitKindrequired

      One of DEVICE_LIMIT_KIND_UNSPECIFIED, DEVICE_LIMIT_KIND_SIGNED_IN, DEVICE_LIMIT_KIND_IN_USE.

    • lockedUntilinteger

      at least 0; at most 18446744073709552000

  • nextPageTokenstring
  • signedInDeviceCount
    • countinteger (int64)required

      at least 0; at most 4294967295

    • limitinteger (int64)required

      at least 0; at most 4294967295

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

Error

  • errorobjectrequired
    • codestringrequired
    • parametersobjectrequired

      Each value: string

    • reasonstringor nullrequired