Authing 开放 API
  1. MFA
Authing 开放 API
  • Authing 开放 API
  • 认证 API
    • 社会化登录
      • 移动端登录
        • 企业微信授权码认证
        • 易盾一键登录
        • 飞书移动端认证
      • 使用社会化身份源登录
      • 获取 Authing 缓存的微信小程序 AccessToken
    • 登录前
      • 登录
        • 邮箱登录
        • 用户名密码登录
        • 手机验证码登录
        • 手机号密码登录
        • LDAP 用户名密码登录
        • AD 用户名登录
        • sso 检测登录态
        • 检测 Token 登录状态
      • 密码操作
        • 密码强度检测
      • 授权
        • 【必读】授权类接口文档说明
        • code 换取 accessToken
        • authing token 换取 accessToken
        • client_credentials 模式获取 access_token
        • 获取 OIDC 授权码 code
        • 用 access_token 换取用户信息
        • 使用 refresh_token 获取新的 access_token 和 id_token
        • 检查 access_token 的有效性
        • 撤回 access token 或 refresh token
      • 注册
        • 邮箱注册
        • 用户名注册
        • 手机号注册
    • 登录后
      • CAS
        • 【必读】CAS 接口文档
        • 检验 CAS 1.0 Ticket 合法性
        • 通过远端服务验证票据合法性
      • 登录
        • 发送邮件
        • 发送短信验证码
      • 密码操作
        • 通过邮件验证码重置密码
        • 通过短信验证码重置密码
        • 通过首次登录的 Token 重置密码
        • 通过密码强制更新临时 Token 修改密码
        • 更新用户密码
        • 检查密码是否合法
      • 用户
        • 获取当前登录用户的信息
        • 获取当前登录用户
        • 修改用户资料
        • 更新用户手机号
        • 更新用户邮箱
        • 绑定邮箱
        • 解绑邮箱
        • 刷新用户 Token
        • 绑定手机号
        • 解绑手机号
        • 获取当前用户的自定义数据列表
        • 添加自定义数据 setUdv
        • 获取用户被授权的所有资源
        • 删除自定义数据
        • 获取用户所有部门
        • 设置自定义字段值
        • 判断当前用户是否有某个角色
        • 退出登录
        • 获取用户所在组织机构的路径
        • 用户安全等级 获取用户的安全等级评分
        • 获取当前用户能够访问的应用
        • 获取用户自身被授权的资源
        • 退出登录2
        • 更新用户信息
      • MFA
        • 获取 MFA 认证器
          GET
        • 请求 MFA 二维码和密钥信息
          POST
        • 确认绑定 MFA
          POST
        • 解绑 MFA 认证器
          DELETE
        • 检验二次验证 MFA 口令
          POST
        • 检测手机号或邮箱是否已被绑定
          POST
        • 通过图片 URL 绑定人脸
          POST
        • 人脸二次认证
          POST
        • 检验二次验证 MFA 短信验证码
          POST
        • 检验二次验证 MFA 邮箱验证码
          POST
        • 检验二次验证 MFA 恢复代码
          POST
  • 管理 API
    • 获取 Token
      • 获取 accessToken
    • 权限管理
      • 获取用户池下权限组列表
      • 创建用户池下权限组列表
      • 修改用户池下权限组列表
      • 删除用户池下权限组列表
      • 查询用户池下权限组详情
    • 管理分组
      • 分组列表
      • 获取分组详情
      • 修改分组
      • 删除分组
      • 添加成员
      • 分组成员查询
      • 创建分组
    • 审计日志
      • 用户行为日志列表
      • 管理员日志列表
      • 获取应用登录趋势
      • 获取用户池登录趋势
    • 资源管理
      • 资源列表
      • 创建资源
      • 资源详情
      • 修改资源
      • 删除资源
      • 授权业务资源
      • 撤销业务资源
      • 批量获取被授权的资源
      • 获取被授权的资源
    • 管理应用
      • 应用列表
      • 创建应用
      • 应用配置详情
      • 应用配置修改
      • 多因素认证开关
      • 已登录态用户查询
      • 获取应用授权记录
      • 拒绝 / 撤回 授权
      • 同意授权
      • 删除应用
      • 添加注册协议
      • 注册协议详情
      • 注册协议修改
      • 注册协议删除
      • 编程访问账号列表
      • 编程访问账号添加
      • 编程访问账号删除
      • 编程访问账号修改
      • 子账号开关查询
      • 子账号列表查询
      • 子账号添加
      • 子账号修改
      • 子账号删除
      • 应用密钥刷新
      • 保存应用租户配置
      • 获取应用关联的租户
    • 管理用户
      • 【必读】用户接口相关文档
      • 搜索用户
      • 删除用户
      • 批量删除用户
      • 刷新用户 Token
      • 获取用户角色列表
      • 列表查询(分页+条件)
      • 根据 ID 获取用户详情
      • 创建用户
      • 更新用户信息
      • 检测用户是否存在
      • 获取用户所在租户
      • 关联账号,将社交账号绑定到主账号
      • 主账号解绑社会化登录账号
      • 检查某个用户在应用下是否具备 Session 登录态
    • 管理注册白名单
      • 白名单列表查询
      • 添加白名单
      • 删除白名单
      • 开启或关闭白名单
    • 管理组织机构
      • 获取组织机构详情
      • 删除组织机构
      • 修改节点
      • 删除节点
      • 节点详情
      • 判断是否为根节点
      • 获取根节点
      • 获取子节点列表
      • 移动部门
      • 获取成员列表
      • 移动成员
      • 移除成员
      • 设置用户主部门
      • 列表查询
      • 创建组织机构
      • 创建节点
      • 搜索组织机构节点
      • 添加成员
      • 导入组织机构
      • 导出所有组织机构
      • 导出某个机构
    • 管理角色
      • 角色列表
      • 角色详情
      • 修改角色
      • 删除角色
      • 创建角色
      • v3 获取用户角色
    • 管理策略
      • 获取策略列表
      • 添加策略
      • 获取策略详情
      • 编辑策略
      • 删除策略
      • 批量删除策略
      • 获取策略授权记录
      • 添加策略授权
      • 撤销策略授权
      • 设置策略授权状态为关闭
      • 设置策略授权状态为开启
    • 个人中心
      • 个人信息查询
      • 获取身份源连接列表(web 端)
      • 用户身份源连接列表
      • 个人信息编辑
      • 认证信息查询
      • 认证信息修改
      • 安全等级查询
      • 用户解绑社会化登录账号
    • 用户池管理
      • 用户池
        • 基础信息修改
        • 用户池列表查询
        • 用户池详情
        • 用户池密钥刷新
        • 用户池删除
        • 用户池创建
        • 协作管理员列表
        • 协作管理员邀请
        • 协作管理员移除
        • 用户池安全登录设置修改
        • 密码安全设置修改
        • 获取环境变量
        • 添加环境变量
        • 删除环境变量
        • 获取协作管理员用户池列表
        • 开启关闭用户池
        • 打开用户池
      • 自定义字段
        • 自定义字段列表查询
        • 添加自定义字段
        • 删除自定义字段
        • 修改自定义字段
      • 消息服务
        • 邮件模板列表查询
        • 邮件模板更新
        • 第三方邮件服务查询
        • 第三方邮件服务更新
    • 账号绑定
      • 用户是否绑定了 MFA
      • 按类型解绑用户 MFA
      • 为用户导入 TOTP
    • 身份源
      • 【必读】身份源接口相关文档
      • 获取身份源模板列表
      • 获取指定身份源配置模板
      • 获取身份源列表
      • 获取身份源详细信息
      • 创建身份源
      • 更新身份源
      • 删除身份源
      • 创建身份源连接
      • 更新身份源连接
      • 删除身份源连接
      • 检查连接唯一标识是否冲突
      • 开关身份源连接
      • 批量开关身份源连接
      • 批量开关所有应用
      • 获取身份源连接对于应用的状态列表
      • 获取身份源对于应用的状态列表
    • 租户
      • 获取用户池下租户列表
      • 创建租户
      • 获取租户相关统计信息
      • 根据 ID 查询租户
      • 修改租户
      • 配置租户品牌化
      • 配置租户品牌化
      • 删除租户
    • 租户成员
      • 更新租户成员
      • 添加租户成员
      • 设置租户管理员
      • 取消租户管理员
      • 获取租户成员列表
      • 删除租户成员
  1. MFA

请求 MFA 二维码和密钥信息

POST
/api/v2/mfa/totp/associate
参数说明:authenticator_type 该接口用的是 totp

请求参数

Header 参数
Authorization
string 
用户 Token
必需
示例值:
Bearer sdsdfsdfsdff
x-authing-userpool-id
string 
用户池 Token
必需
示例值:
59f86b4832eb28071bdd9214
Body 参数application/json
authenticator_type
string 
必需
authenticator_type
source
string 
必需
SELF-用户自主开启,APPLICATION-应用强制开启
示例
{
  "authenticator_type": "string",
  "source": "string"
}

示例代码

Shell
JavaScript
Java
Swift
Go
PHP
Python
HTTP
C
C#
Objective-C
Ruby
OCaml
Dart
R
请求示例请求示例
Shell
JavaScript
Java
Swift
curl --location --request POST 'https://core.authing.cn/api/v2/mfa/totp/associate' \
--header 'Authorization: Bearer sdsdfsdfsdff	' \
--header 'x-authing-userpool-id: 59f86b4832eb28071bdd9214' \
--header 'Content-Type: application/json' \
--data-raw '{
    "authenticator_type": "string",
    "source": "string"
}'

返回响应

🟢200成功
application/json
Body
code
integer 
必需
message
string 
必需
data
object 
必需
authenticator_type
string 
必需
secret
string 
必需
qrcode_uri
string 
必需
qrcode_data_url
string 
必需
recovery_code
string 
必需
示例
{
  "code": 200,
  "message": "获取 MFA 密钥成功",
  "data": {
    "authenticator_type": "totp",
    "secret": "IYMD6V23LV6TIWQP",
    "qrcode_uri": "otpauth://totp/%E6%B5%8B%E8%AF%95:root%40authing.cn?secret=IYMD6V23LV6TIWQP&period=30&digits=6&algorithm=SHA1&issuer=%E6%B5%8B%E8%AF%95",
    "qrcode_data_url": "data:image/png;base64,iVBORw0KGgoAAAANSUhEUgAAAOQAAADkCAYAAACIV4iNAAAAAklEQVR4AewaftIAAAwySURBVO3BQW4sy7LgQDKh/W+ZfYY+CiBRJd34r93M/mGtdYWHtdY1HtZa13hYa13jYa11jYe11jUe1lrXeFhrXeNhrXWNh7XWNR7WWtd4WGtd42GtdY2HtdY1HtZa13hYa13jhw+p/KWKE5U3Kt5QmSomlaliUjmpmFSmikllqvgmlZOKSWWqmFTeqDhRmSomlb9U8YmHtdY1HtZa13hYa13jhy+r+CaVNyomlaliUpkqTiomlU9UnFRMKicqU8WkMlVMKicVJxUnFZPKico3VXyTyjc9rLWu8bDWusbDWusaP/wylTcq3lD5JpWTiqniEyp/qWJS+YTKVPFGxRsq36TyRsVvelhrXeNhrXWNh7XWNX74/1zFicqJylQxqZxUTConFZPKicpJxaQyVUwqU8WJyicqTir+lzysta7xsNa6xsNa6xo//I+rOFGZKqaKN1Smim9S+UTFScWkMlWcqPymiv9lD2utazysta7xsNa6xg+/rOIvVUwqn1B5o2JSOal4o+INlUllqphUpopJZaqYKiaVqWJSOVGZKr6p4iYPa61rPKy1rvGw1rrGD1+mcrOKSeWNiknljYpJZaqYVE5UpoqTikllqphUpopJZar4RMWkcqIyVZyo3OxhrXWNh7XWNR7WWtf44UMVN6s4qXhD5Y2Kk4pPVLyh8kbFpHKi8gmVb6r4v+RhrXWNh7XWNR7WWtf44UMqU8Wk8k0VU8WkMlWcqJxUnKi8oTJVTConKv+XqUwVb6hMFScq31Txmx7WWtd4WGtd42GtdQ37h1+kMlV8k8pJxaTyiYo3VKaKSeWkYlI5qThRmSomlaniEypTxaRyUvGGyhsVN3lYa13jYa11jYe11jXsHz6gclLxhspJxaQyVUwqJxWTylRxojJVfJPKVDGpTBWTylTxhspUMan8X1JxojJVTCpTxTc9rLWu8bDWusbDWusa9g8fUHmj4jep/KaKE5WTik+oTBWTyknFpDJVnKhMFScqU8WJylTxhspJxaRyUvGXHtZa13hYa13jYa11DfuHL1I5qThROal4Q2WqeEPljYpvUvlExaRyUjGpTBWTyknFb1KZKiaVk4oTlaliUpkqPvGw1rrGw1rrGg9rrWvYP3yRyhsVk8pUMan8pYpJZaqYVKaKSeWkYlI5qThR+UsVb6icVLyhclIxqUwVJypTxTc9rLWu8bDWusbDWusa9g8fUDmpmFS+qeJEZaqYVE4qJpWp4hMqb1RMKlPFpDJVTCpTxSdUTiomlTcqPqEyVUwqn6j4xMNa6xoPa61rPKy1rvHD5SomlU+oTBWfUDmpmFROKiaVk4qTikllqphUpoo3KiaVNyomlUnljYrfVPFND2utazysta7xsNa6xg+XU5kqTlSmiknlv1QxqUwqU8WJyknFVDGpTBUnKp9QmSomlaniEyonKicVk8pvelhrXeNhrXWNh7XWNewfPqByUvFNKt9UcaIyVUwqJxWfUJkqJpWp4kTljYoTlaliUpkq3lCZKiaVk4oTlaniv/Sw1rrGw1rrGg9rrWv88KGKSWVSmSpOVN6oeEPlROUTFScqU8WkcqLyhspUMalMFZPKGypTxaQyVUwqU8WkclIxqUwVU8WkMlWcqEwVn3hYa13jYa11jYe11jV++JDKVDGpnKicVJyovFExqZxUnFScqJyoTBWTylRxonKiMlVMKlPFpHJScVLxiYoTlROVk4r/0sNa6xoPa61rPKy1rvHDL6uYVN5QmSqmihOVT6icVEwqJxWTyknFpDJVTBWTylTxhspJxRsqJxUnKicVk8pJxYnKScU3Pay1rvGw1rrGw1rrGj98mcpJxaRyUjGpTBWTyonKVDGpTBWfqJhUpoo3Kk5UTlSmir9UcaIyVZxUTCqfUDmp+E0Pa61rPKy1rvGw1rqG/cMHVE4qJpXfVDGpvFHxl1Smiknlv1RxonJSMamcVEwqU8WkcpOKTzysta7xsNa6xsNa6xo/fFnFpDJVTCpTxRsqk8pUMal8QmWq+ETFpHJS8YbKScUbKlPFpDKpTBUnKp+oeENlqphUTiq+6WGtdY2HtdY1HtZa1/jhQxUnFZPKGypTxUnFpPKXVE4qJpVPqEwVn1A5qZhUTiomlaliqphUPqEyVZyo/Jce1lrXeFhrXeNhrXWNHz6kMlVMKlPFpHJS8YbKVDGpvKHyTSpTxYnKScUnVL6p4qTiROWbKt6omFSmikllqvjEw1rrGg9rrWs8rLWuYf/wi1RuUjGpTBVvqJxUnKhMFZPKX6o4UZkqTlTeqJhUpopJ5ZsqTlSmim96WGtd42GtdY2HtdY17B++SGWqeENlqjhRmSpOVKaKSeWk4g2VqWJSeaNiUpkqTlSmikllqriJylTxhspUMalMFScqU8UnHtZa13hYa13jYa11jR8+pPKGyknFpPJNFd+kMlWcqEwVk8pfUjlRmSomlaliUpkqJpVvUjmpmFSmikllqvhND2utazysta7xsNa6xg9/rOKNit+k8omKNyo+oTJVTCpTxRsVk8pJxUnFGxVvqEwVk8pJxUnFScU3Pay1rvGw1rrGw1rrGvYPX6RyUjGpvFHxhspUMalMFZPKVHGi8kbFicpU8YbKVDGpnFRMKlPFpHJSMam8UXGiMlVMKicVk8obFZ94WGtd42GtdY2HtdY1fviQyicqPqHyiYpJ5RMVn1CZKiaVqeITFScqn6iYVE4qJpUTlTcqJpU3Kn7Tw1rrGg9rrWs8rLWu8cMvq3hD5Y2KSeUNlU+o3ERlqphUpopJ5aTipOKkYlJ5Q+Wk4psqJpWp4pse1lrXeFhrXeNhrXWNH/6YyhsV36TyRsUbFZPKVHGiMqmcqLxRcVIxqUwqU8WkMlVMKm9UnKicqEwVU8WkMlX8pYe11jUe1lrXeFhrXeOHL6uYVKaKN1ROKk4qTlR+U8WJyknFpPIJlaliUjmpOKk4qZhU3lCZKv5SxW96WGtd42GtdY2HtdY17B/+QyonFScq31RxonJSMalMFW+oTBWfUJkqPqEyVUwqU8WJyjdV/F/ysNa6xsNa6xoPa61r/PDLVN6omFSmik9UTConKicVk8pUMamcVJyoTBWTylQxVbyhclLxCZU3Kk5UTlSmiknlExWfeFhrXeNhrXWNh7XWNewfvkjlpGJSOal4Q2WqmFSmikllqphUpoo3VKaK36QyVUwqb1RMKm9UnKhMFZPKScWJyicqftPDWusaD2utazysta5h//BFKlPFGypvVEwqv6niDZWTihOVqeJEZaqYVKaKv6TyiYoTlZOKE5WpYlI5qfjEw1rrGg9rrWs8rLWu8cMvUzmpmCq+qWJSmSomlf+SylTxRsWkMlVMKlPFJ1ROKiaVk4q/VDGp/KWHtdY1HtZa13hYa13D/uEDKm9UvKFyUvGGyknFicpUMalMFW+o/KaKN1SmihOVNypOVP5SxX/pYa11jYe11jUe1lrX+OFDFb+p4kTlpOIvVUwqJxVvVLyh8obKicpUMVV8QuUTFW+oTCpTxV96WGtd42GtdY2HtdY1fviQyl+qmCreqDhReUNlqpgqfpPKVPGGyhsVJypTxRsVb6icqEwVJxWTyhsVn3hYa13jYa11jYe11jV++LKKb1I5UTmpeKPiDZVPqHyi4g2VqWJSmSpOVKaKSeWkYlL5poo3VKaKE5VvelhrXeNhrXWNh7XWNX74ZSpvVHyi4kTlpGJSmSqmikllqjipOFGZVL5J5UTlN6mcVJyoTCqfqJhUpoqp4pse1lrXeFhrXeNhrXWNH/7HqEwVU8WkMql8k8pvqviEyhsVk8pJxYnKVHGiclJxonKiMlWcqEwVn3hYa13jYa11jYe11jV++B+nMlVMFZPKicobFScqU8UbKicVk8pUMal8k8obKp9QeaPiRGWq+E0Pa61rPKy1rvGw1rrGD7+s4jdVTCpTxYnKVDGpTBVvqPylim+qOKl4o2JSeaPiROWbKv7Sw1rrGg9rrWs8rLWu8cOXqfwllaniN6lMFf+likllqpgqJpWp4kTlEypTxYnKicpU8ZtUftPDWusaD2utazysta5h/7DWusLDWusaD2utazysta7xsNa6xsNa6xoPa61rPKy1rvGw1rrGw1rrGg9rrWs8rLWu8bDWusbDWusaD2utazysta7x/wAtUK70FBR/VAAAAABJRU5ErkJggg==",
    "recovery_code": "9084-044c-4b0b-63f8-da34-d886"
  }
}
上一页
获取 MFA 认证器
下一页
确认绑定 MFA
Built with