Sign in

v1

latestOpenAPI 3.1.02026-07-268342124.0 KB
authenticator configurations

Get authenticator configurations

Gets a list of the authenticators configured for the tenant.

get/authenticators

Response

OK

authenticatorIdstring required

The ID of the authenticator configuration.

verificationMethod'SMS' | 'AUTHENTICATOR_APP' | 'EMAIL_MAGIC_LINK' | 'EMAIL_OTP' | 'PUSH' | 'DEVICE' | 'SECURITY_KEY' | 'PASSKEY' | 'VERIFF' | 'IPROOV' | 'PALM_BIOMETRICS_RR' | 'IDVERSE' required
isActiveboolean required

Determines whether the authenticator configuration is currently active/enabled.

isEditableByUserboolean

Determines whether the user is able to edit the authenticator in the pre-built UI.

isHiddenToUserboolean

Determines whether the authenticator in hidden in the pre-built UI.

smsChannel'DEFAULT' | 'WHATSAPP'

For SMS authenticator configurations only. If set to DEFAULT, only regular SMS is allowed. If set to WHATSAPP, both regular SMS and WhatsApp messages are allowed.

Example response

[
  {
    "authenticatorId": "authenticator_123",
    "isActive": true,
    "verificationMethod": "SMS",
    "smsChannel": "WHATSAPP"
  }
]