多因素认证 API

更新时间: 2022-03-22 10:58:40

MFA 检测

检测手机号或者邮箱是否可以被用作 MFA

func mfaCheck(phone: String?, email: String?, completion: @escaping(Int, String?, Bool?) -> Void)

参数

• phone 被检测的手机号。可以为空
• email 被检测的邮箱。可以为空

示例

AuthClient().mfaCheck(phone: "13012345678", email: nil) { code, message, ok in
    if (code == 200) {
        if (ok) {
            
        }
    }
}

AuthClient().mfaCheck(phone: nil, email: "abc@gmail.com") { code, message, ok in
    if (code == 200) {
        if (ok) {
            
        }
    }
}

短信验证

通过短信进行多因素认证

func mfaVerifyByPhone(phone: String, code: String, completion: @escaping(Int, String?, UserInfo?) -> Void)

参数

• phone 手机号码
• code 短信验证码

示例

AuthClient().mfaVerifyByPhone(phone: "13012345678", code: "1234") { code, message, userInfo in
    // userInfo 用户信息
}

邮箱验证

通过邮件验证码进行多因素认证

func mfaVerifyByEmail(email: String, code: String, completion: @escaping(Int, String?, UserInfo?) -> Void)

参数

• email 邮箱地址
• code 邮件验证码

示例

AuthClient().mfaVerifyByEmail(email: "abc@gmail.com", code: "1234") { code, message, userInfo in
    // userInfo 用户信息
}

TOTP 验证

通过一次性密码 TOTP (Time-based One Time Password) 进行多因素认证

func mfaVerifyByOTP(code: String, completion: @escaping(Int, String?, UserInfo?) -> Void)

参数

• code TOTP code

示例

AuthClient().mfaVerifyByTOTP(code: "1234") { code, message, userInfo in
    // userInfo 用户信息
}

恢复码验证

用户在绑定 TOTP 时会得到一个恢复码，用户需要安全保存该恢复码，在调用此 API 时，将其作为参数传入。

注意，恢复码验证成功后，会生成新的恢复码，旧的恢复码失效

func mfaVerifyByRecoveryCode(code: String, completion: @escaping(Int, String?, UserInfo?) -> Void)

参数

• code 恢复码

示例

AuthClient().mfaVerifyByRecoveryCode(code: "1234") { code, message, userInfo in
    // userInfo 用户信息
}