API Reference
- Overview
- Organizations
- Invitations
- Policies
- Features
Wallets and Private Keys
- Wallets
- Signing
- Private Keys
- Private Key Tags
Users
- Users
- User Tags
- User Recovery
- User Auth
Credentials
- Authenticators
- API keys
- Sessions
Activities
- Activities
- Consensus
Get Authenticators
Get details about authenticators for a user
POST
/
public
/
v1
/
query
/
get_authenticators
curl --request POST \
--url https://api.turnkey.com/public/v1/query/get_authenticators \
--header 'Content-Type: application/json' \
--header 'X-Stamp: <api-key>' \
--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>"
}
}
]
}Authorizations
Body
application/json
Unique identifier for a given Organization.
Unique identifier for a given User.
Response
200 - application/json
A successful response.
A list of authenticators.
Types of transports that may be used by an Authenticator (e.g., USB, NFC, BLE).
Available options:
AUTHENTICATOR_TRANSPORT_BLE, AUTHENTICATOR_TRANSPORT_INTERNAL, AUTHENTICATOR_TRANSPORT_NFC, AUTHENTICATOR_TRANSPORT_USB, AUTHENTICATOR_TRANSPORT_HYBRID Identifier indicating the type of the Security Key.
Unique identifier for a WebAuthn credential.
The type of Authenticator device.
The public component of a cryptographic key pair used to sign messages and transactions.
Available 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 Unique identifier for a given Authenticator.
Human-readable name for an Authenticator.
Was this page helpful?
curl --request POST \
--url https://api.turnkey.com/public/v1/query/get_authenticators \
--header 'Content-Type: application/json' \
--header 'X-Stamp: <api-key>' \
--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>"
}
}
]
}