Autional Autional
API Reference GitHub autional.com →

PUT /mfa/sms/enroll

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

Multi-Factor Authentication `bearerAuth` application/json

Request Body

Schema: dto.SMSEnrollRequest

FieldTypeRequiredExampleConstraintsDescription
phone string Yes +8613800138000

Responses

StatusDescriptionSchema
201Registration Successfuldto.SMSEnrollDetailResponse
400Invalid Parametersgitee_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.SMSEnrollDetailResponse

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

dto.SMSEnrollResponse

FieldTypeRequiredExampleConstraintsDescription
enabled boolean No False
method_type string No sms
phone string No +8613800****000
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