Get Authenticators

curl --request POST \
  --url https://api.turnkey.com/public/v1/query/get_authenticators \
  --header 'Accept: application/json' \
  --header 'Content-Type: application/json' \
  --header "X-Stamp: <string> (see Authorizations)" \
  --data '{
    "organizationId": "<string>",
    "userId": "<string>"
}'

{
  "authenticators": [
    {
      "transports": [
        "<AUTHENTICATOR_TRANSPORT_BLE>"
      ],
      "attestationType": "<string>",
      "aaguid": "<string>",
      "credentialId": "<string>",
      "model": "<string>",
      "credential": {
        "publicKey": "<string>",
        "type": "<CREDENTIAL_TYPE_WEBAUTHN_AUTHENTICATOR>"
      },
      "authenticatorId": "<string>",
      "authenticatorName": "<string>",
      "createdAt": {
        "seconds": "<string>",
        "nanos": "<string>"
      },
      "updatedAt": {
        "seconds": "<string>",
        "nanos": "<string>"
      }
    }
  ]
}

curl --request POST \
  --url https://api.turnkey.com/public/v1/query/get_authenticators \
  --header 'Accept: application/json' \
  --header 'Content-Type: application/json' \
  --header "X-Stamp: <string> (see Authorizations)" \
  --data '{
    "organizationId": "<string>",
    "userId": "<string>"
}'

{
  "authenticators": [
    {
      "transports": [
        "<AUTHENTICATOR_TRANSPORT_BLE>"
      ],
      "attestationType": "<string>",
      "aaguid": "<string>",
      "credentialId": "<string>",
      "model": "<string>",
      "credential": {
        "publicKey": "<string>",
        "type": "<CREDENTIAL_TYPE_WEBAUTHN_AUTHENTICATOR>"
      },
      "authenticatorId": "<string>",
      "authenticatorName": "<string>",
      "createdAt": {
        "seconds": "<string>",
        "nanos": "<string>"
      },
      "updatedAt": {
        "seconds": "<string>",
        "nanos": "<string>"
      }
    }
  ]
}

POST

public

query

get_authenticators

Authorizations

X-Stamp

string

required

Cryptographically signed (stamped) request to be passed in as a header. For more info, see here.

Body

organizationId

string

required

Unique identifier for a given Organization.

userId

string

required

Unique identifier for a given User.

Response

A successful response returns the following fields:

authenticators

array

required

A list of authenticators.

Show authenticators details

authenticators.transports

array

required

Types of transports that may be used by an Authenticator (e.g., USB, NFC, BLE).

Show transports details

authenticators.transports.item

enum

required

item fieldEnum options: AUTHENTICATOR_TRANSPORT_BLE, AUTHENTICATOR_TRANSPORT_INTERNAL, AUTHENTICATOR_TRANSPORT_NFC, AUTHENTICATOR_TRANSPORT_USB, AUTHENTICATOR_TRANSPORT_HYBRID

authenticators.attestationType

string

required

attestationType field

authenticators.aaguid

string

required

Identifier indicating the type of the Security Key.

authenticators.credentialId

string

required

Unique identifier for a WebAuthn credential.

authenticators.model

string

required

The type of Authenticator device.

authenticators.credential

object

required

credential field

Show credential details

authenticators.credential.publicKey

string

required

The public component of a cryptographic key pair used to sign messages and transactions.

authenticators.credential.type

enum

required

type fieldEnum options: CREDENTIAL_TYPE_WEBAUTHN_AUTHENTICATOR, CREDENTIAL_TYPE_API_KEY_P256, CREDENTIAL_TYPE_RECOVER_USER_KEY_P256, CREDENTIAL_TYPE_API_KEY_SECP256K1, CREDENTIAL_TYPE_EMAIL_AUTH_KEY_P256, CREDENTIAL_TYPE_API_KEY_ED25519, CREDENTIAL_TYPE_OTP_AUTH_KEY_P256, CREDENTIAL_TYPE_READ_WRITE_SESSION_KEY_P256, CREDENTIAL_TYPE_OAUTH_KEY_P256, CREDENTIAL_TYPE_LOGIN

authenticators.authenticatorId

string

required

Unique identifier for a given Authenticator.

authenticators.authenticatorName

string

required

Human-readable name for an Authenticator.

authenticators.createdAt

object

required

createdAt field

Show createdAt details

authenticators.createdAt.seconds

string

required

seconds field

authenticators.createdAt.nanos

string

required

nanos field

authenticators.updatedAt

object

required

updatedAt field

Show updatedAt details

authenticators.updatedAt.seconds

string

required

seconds field

authenticators.updatedAt.nanos

string

required

nanos field

curl --request POST \
  --url https://api.turnkey.com/public/v1/query/get_authenticators \
  --header 'Accept: application/json' \
  --header 'Content-Type: application/json' \
  --header "X-Stamp: <string> (see Authorizations)" \
  --data '{
    "organizationId": "<string>",
    "userId": "<string>"
}'

{
  "authenticators": [
    {
      "transports": [
        "<AUTHENTICATOR_TRANSPORT_BLE>"
      ],
      "attestationType": "<string>",
      "aaguid": "<string>",
      "credentialId": "<string>",
      "model": "<string>",
      "credential": {
        "publicKey": "<string>",
        "type": "<CREDENTIAL_TYPE_WEBAUTHN_AUTHENTICATOR>"
      },
      "authenticatorId": "<string>",
      "authenticatorName": "<string>",
      "createdAt": {
        "seconds": "<string>",
        "nanos": "<string>"
      },
      "updatedAt": {
        "seconds": "<string>",
        "nanos": "<string>"
      }
    }
  ]
}

Get Authenticator Get Configs

Activities

Queries

Get Authenticators

Authorizations

Body

Response