Endpoint Overview
GET
/api/admin/users/v4/users/{user_id}/otpCheck OTP configuration
DELETE
/api/admin/users/v4/users/{user_id}/otpDelete OTP
One Time Passwords
Check OTP configuration
Returns whether the user has enrolled an authenticator app for OTP-based two-factor authentication via the is_set flag.
- Requires
VIEWpermission on the target user. - Use the delete endpoint to revoke an existing enrollment.
Path Params
user_id stringrequiredUnique identifier of a user.
Query Params
embed string[]Options for embedding additional data in OTP (two-factor authentication) responses:
ACTIONS: Include available actions for the OTP configuration (delete)
Response Body
200 OKError Codes
- FEATURE_DISABLED
- PERMISSION_MISSING
Delete OTP
Revokes the user's OTP enrollment. On next login the user is prompted to enrol a new authenticator.
- Requires
EDITpermission on the target user. - Idempotent: returns
200withis_set: falseeven if no OTP was previously configured.
Path Params
user_id stringrequiredUnique identifier of a user.
Query Params
embed string[]Options for embedding additional data in OTP (two-factor authentication) responses:
ACTIONS: Include available actions for the OTP configuration (delete)
Response Body
200 OKError Codes
- FEATURE_DISABLED
- PERMISSION_MISSING