Sign in

v1

latestOpenAPI 3.1.02026-07-268342124.0 KB
challenge

Get user authenticators

Gets a list of the user's currently enrolled authenticators.

get/users/{userId}/authenticators

Path parameters

userIdstring required

The ID of the user.

Response

OK

userAuthenticatorIdstring required
verificationMethod'SMS' | 'AUTHENTICATOR_APP' | 'EMAIL_MAGIC_LINK' | 'EMAIL_OTP' | 'PUSH' | 'DEVICE' | 'SECURITY_KEY' | 'PASSKEY' | 'VERIFF' | 'IPROOV' | 'PALM_BIOMETRICS_RR' | 'IDVERSE' required
emailstring
phoneNumberstring
usernamestring
displayNamestring
createdAtstring date-time required
verifiedAtstring date-time
lastVerifiedAtstring date-time
previousSmsChannel'DEFAULT' | 'WHATSAPP'

The channel that was last used by the user to complete an SMS challenge. Only defined if the verification method is SMS.

deviceNamestring

The name of the device (e.g. 'iPhone 16 Pro'). Only used for PUSH verification methods.

Example response

[
  {
    "userAuthenticatorId": "4efd2d0d-3278-4e03-8143-d9a0850bebc0",
    "verificationMethod": "PASSKEY",
    "username": "jane.smith@authsignal.com",
    "displayName": "Jane Smith",
    "createdAt": "2024-05-13T04:59:02.640Z",
    "lastVerifiedAt": "2024-07-13T02:43:37.640Z",
    "verifiedAt": "2024-05-13T04:59:17.640Z",
    "webauthnCredential": {
      "credentialId": "71273a99-4a7b-47d4-82ab-9ea72b8f0a72",
      "deviceId": "d5a13d2d-8c34-4c90-938b-d8c6e3a88c5d",
      "name": "iCloud Keychain",
      "aaguid": "fbfc3007-154e-4ecc-8c0b-6e020557d7bd",
      "aaguidMapping": {
        "name": "iCloud Keychain",
        "svgIconDark": "data:image/svg+xml;base64...",
        "svgIconLight": "data:image/svg+xml;base64..."
      },
      "credentialBackedUp": true,
      "credentialDeviceType": "multiDevice",
      "authenticatorAttachment": "platform"
    }
  }
]