Get authenticator

Get details about an authenticator.

POST

/

public

/

v1

/

query

/

get_authenticator

Authorizations

API Key

X-Stamp · string · required

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

WebAuthn (Passkey)

X-Stamp-WebAuthn · 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.

authenticatorId · string · required

Unique identifier for a given authenticator.

Response

A successful response returns the following fields:

authenticator · object · required

authenticator field

Show authenticator details

authenticator.transports

array

required

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

Show transports details

authenticator.transports.item

enum

required

item field

Enum options: AUTHENTICATOR_TRANSPORT_BLE, AUTHENTICATOR_TRANSPORT_INTERNAL, AUTHENTICATOR_TRANSPORT_NFC, AUTHENTICATOR_TRANSPORT_USB, AUTHENTICATOR_TRANSPORT_HYBRID

authenticator.attestationType

string

required

attestationType field

authenticator.aaguid

string

required

Identifier indicating the type of the Security Key.

authenticator.credentialId

string

required

Unique identifier for a WebAuthn credential.

authenticator.model

string

required

The type of Authenticator device.

authenticator.credential

object

required

credential field

Show credential details

authenticator.credential.publicKey

string

required

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

authenticator.credential.type

enum

required

type field

Enum 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

authenticator.authenticatorId

string

required

Unique identifier for a given Authenticator.

authenticator.authenticatorName

string

required

Human-readable name for an Authenticator.

authenticator.createdAt

object

required

createdAt field

Show createdAt details

authenticator.createdAt.seconds

string

required

seconds field

authenticator.createdAt.nanos

string

required

nanos field

authenticator.updatedAt

object

required

updatedAt field

Show updatedAt details

authenticator.updatedAt.seconds

string

required

seconds field

authenticator.updatedAt.nanos

string

required

nanos field

cURL

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

200

{
  "authenticator": {
    "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>"
    }
  }
}