Autional Autional
API Reference GitHub autional.com →

PUT /mfa/email/enroll

Register Email MFA authentication method for the user. Reference: OWASP ASVS V2.8.

Multi-Factor Authentication `bearerAuth` application/json

Request Body

Schema: dto.EmailEnrollRequest

FieldTypeRequiredExampleConstraintsDescription
email string Yes user@example.com

Responses

StatusDescriptionSchema
201Registration successfuldto.EmailEnrollDetailResponse
400Invalid parametergitee_com_linmes_authms_base_dto.SimpleResponse
401Unauthenticatedgitee_com_linmes_authms_base_dto.SimpleResponse
500Internal server errorgitee_com_linmes_authms_base_dto.SimpleResponse

Referenced Schemas

dto.EmailEnrollDetailResponse

FieldTypeRequiredExampleConstraintsDescription
code integer No
data dto.EmailEnrollResponse No
message string No
timestamp string No

dto.EmailEnrollResponse

FieldTypeRequiredExampleConstraintsDescription
email string No user@example.com
enabled boolean No False
method_type string No email
status string No pending_verification
verified boolean No False

gitee_com_linmes_authms_base_dto.SimpleResponse

FieldTypeRequiredExampleConstraintsDescription
code integer No
message string No
timestamp string No