Unlock authenticator by type

Request

Unlocks a user's authenticator by type. Use optional unlock_type to limit the unlock operation to a specific lock type, such as manual (via Admin Portal or /lock) or automatic (via lockout policy). Note that TOTP authenticators locked due to the automatic lockout policy cannot be unlocked.

Required permissions: apps:edit, [appId]:edit, authenticators:edit.

Security

ClientAccessToken

Path

user_idstringrequired

ID of the user

authenticator_typestringrequired

Authenticator type to unlock.

Enum:"totp""email_magic_link""email_otp""sms_otp""direct_otp""webauthn""password""mobile_biometric""pin_authenticator""face"

Bodyapplication/json

unlock_typestring

Defines the type of lock to clear: manual (authenticator locked manually in the Admin Portal or via /lock endpoint) or automatic (authenticator locked automatically after failed login attempts as defined by the lockout policy).

Enum:"manual""automatic""any"

curl -i -X POST \
  'https://api.sbx.transmitsecurity.io/cis/v1/users/{user_id}/authenticators/types/{authenticator_type}/unlock' \
  -H 'Authorization: Bearer <YOUR_TOKEN_HERE>' \
  -H 'Content-Type: application/json' \
  -d '{
    "unlock_type": "manual"
  }'

Responses

User Unlocked