Authok认证API
  1. 多因素认证(MFA)
Authok认证API
  • 登录
    • 社会化登录
      GET
    • 数据库/AD/LDAP登录
      GET
    • 企业级登录(SAML)
      GET
    • 免密登录
      POST
  • 多因素认证(MFA)
    • 发起多因素质询请求
      POST
    • 基于一次性密码(OTP)进行多因素认证(MFA)
      POST
    • 基于OOB进行多因素认证(MFA)
      POST
    • 基于Recovery Code进行MFA认证
      POST
    • 关联/添加新的认证器
      POST
    • 获取认证器列表
      GET
    • 删除认证器
      DELETE
  • SAML
    • 介绍
    • 接收SAML请求进行初始化登录
      GET
    • 获取元数据
      GET
    • IdP初始化的单点登录流程(SSO)
      POST
  • WS-Federation
    • 接收WS-Federation请求用于初始化登录
      GET
    • 获取 WS-Federation 元数据
      GET
  • 应用授权
    • 授权码流程
      GET
    • 授权码流程(PKCE)
      GET
    • 隐式流程
      GET
  • 获取设备代码
    • 获取设备代码
      POST
  • 获取令牌
    • 授权码流程
      POST
    • 授权码流程(PKCE)
      POST
    • 客户端凭证流程
      POST
    • 资源所有者密码
      POST
    • 设备授权流程
      POST
    • 刷新令牌
      POST
    • 本地社会化登录的令牌交换
      POST
  • 注销(Logout)
    GET
  • 通过邮件修改密码
    POST
  • 通过短信验证码修改密码
    POST
  • 获取用户详情
    GET
  • 动态应用注册
    POST
  • 撤销刷新令牌
    POST
  1. 多因素认证(MFA)

关联/添加新的认证器

POST
/mfa/associate
mfa多因素认证

请求参数

Body 参数application/json
client_id
string 
应用ID
必需
应用ID
client_secret
string 
应用密钥
必需
应用密钥
authenticator_types
array[string]
认证器类型
必需
认证器类型
枚举值:
otpoob
oob_channel
array[string]
必需
应用支持的OOB通道. 多选, 可以为 "authok", "sms", "voice". 如果认证类型(authenticator_types)包含oob则为必须项.
枚举值:
authoksmsvoice
示例
{
    "client_id": "string",
    "client_secret": "string",
    "authenticator_types": [
        "otp"
    ],
    "oob_channel": [
        "authok"
    ]
}

示例代码

Shell
JavaScript
Java
Swift
Go
PHP
Python
HTTP
C
C#
Objective-C
Ruby
OCaml
Dart
R
请求示例请求示例
Shell
JavaScript
Java
Swift
curl --location --request POST 'http://127.0.0.1/mfa/associate' \
--header 'Content-Type: application/json' \
--data-raw '{
    "client_id": "string",
    "client_secret": "string",
    "authenticator_types": [
        "otp"
    ],
    "oob_channel": [
        "authok"
    ]
}'

返回响应

🟢200成功
application/json
Body
object {0}
示例
{}
上一页
基于Recovery Code进行MFA认证
下一页
获取认证器列表
Built with