Get authenticator

Get details about an authenticator.

organizationId · string · required

Unique identifier for a given organization.

authenticatorId · string · required

Unique identifier for a given authenticator.

A successful response returns the following fields:

authenticator · object · required

authenticator field

Show authenticator details

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>"
}'

import { Turnkey } from "@turnkey/sdk-server";

const turnkeyClient = new Turnkey({
  apiBaseUrl: "https://api.turnkey.com",
  apiPublicKey: process.env.API_PUBLIC_KEY!,
  apiPrivateKey: process.env.API_PRIVATE_KEY!,
  defaultOrganizationId: process.env.ORGANIZATION_ID!,
});

const response = await turnkeyClient.apiClient().getAuthenticator({
  organizationId: "<string> (Unique identifier for a given organization.)",
  authenticatorId: "<string> (Unique identifier for a given authenticator.)"
});

200

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