Authenticator Configurations

Update Authenticator Configuration

Updates an authenticator configuration by authenticator ID.

patch/authenticator-configurations/{authenticator_id}

Path parameters

authenticator_idstring required

The authenticator ID used to identify the authenticator configuration.

Request body

authenticatorIdstring required

The ID of the authenticator configuration.

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 request

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

Response