Authing 开放 API
  1. 身份源
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 认证器
        • 请求 MFA 二维码和密钥信息
        • 确认绑定 MFA
        • 解绑 MFA 认证器
        • 检验二次验证 MFA 口令
        • 检测手机号或邮箱是否已被绑定
        • 通过图片 URL 绑定人脸
        • 人脸二次认证
        • 检验二次验证 MFA 短信验证码
        • 检验二次验证 MFA 邮箱验证码
        • 检验二次验证 MFA 恢复代码
  • 管理 API
    • 获取 Token
      • 获取 accessToken
    • 权限管理
      • 获取用户池下权限组列表
      • 创建用户池下权限组列表
      • 修改用户池下权限组列表
      • 删除用户池下权限组列表
      • 查询用户池下权限组详情
    • 管理分组
      • 分组列表
      • 获取分组详情
      • 修改分组
      • 删除分组
      • 添加成员
      • 分组成员查询
      • 创建分组
    • 审计日志
      • 用户行为日志列表
      • 管理员日志列表
      • 获取应用登录趋势
      • 获取用户池登录趋势
    • 资源管理
      • 资源列表
      • 创建资源
      • 资源详情
      • 修改资源
      • 删除资源
      • 授权业务资源
      • 撤销业务资源
      • 批量获取被授权的资源
      • 获取被授权的资源
    • 管理应用
      • 应用列表
      • 创建应用
      • 应用配置详情
      • 应用配置修改
      • 多因素认证开关
      • 已登录态用户查询
      • 获取应用授权记录
      • 拒绝 / 撤回 授权
      • 同意授权
      • 删除应用
      • 添加注册协议
      • 注册协议详情
      • 注册协议修改
      • 注册协议删除
      • 编程访问账号列表
      • 编程访问账号添加
      • 编程访问账号删除
      • 编程访问账号修改
      • 子账号开关查询
      • 子账号列表查询
      • 子账号添加
      • 子账号修改
      • 子账号删除
      • 应用密钥刷新
      • 保存应用租户配置
      • 获取应用关联的租户
    • 管理用户
      • 【必读】用户接口相关文档
      • 搜索用户
      • 删除用户
      • 批量删除用户
      • 刷新用户 Token
      • 获取用户角色列表
      • 列表查询(分页+条件)
      • 根据 ID 获取用户详情
      • 创建用户
      • 更新用户信息
      • 检测用户是否存在
      • 获取用户所在租户
      • 关联账号,将社交账号绑定到主账号
      • 主账号解绑社会化登录账号
      • 检查某个用户在应用下是否具备 Session 登录态
    • 管理注册白名单
      • 白名单列表查询
      • 添加白名单
      • 删除白名单
      • 开启或关闭白名单
    • 管理组织机构
      • 获取组织机构详情
      • 删除组织机构
      • 修改节点
      • 删除节点
      • 节点详情
      • 判断是否为根节点
      • 获取根节点
      • 获取子节点列表
      • 移动部门
      • 获取成员列表
      • 移动成员
      • 移除成员
      • 设置用户主部门
      • 列表查询
      • 创建组织机构
      • 创建节点
      • 搜索组织机构节点
      • 添加成员
      • 导入组织机构
      • 导出所有组织机构
      • 导出某个机构
    • 管理角色
      • 角色列表
      • 角色详情
      • 修改角色
      • 删除角色
      • 创建角色
      • v3 获取用户角色
    • 管理策略
      • 获取策略列表
      • 添加策略
      • 获取策略详情
      • 编辑策略
      • 删除策略
      • 批量删除策略
      • 获取策略授权记录
      • 添加策略授权
      • 撤销策略授权
      • 设置策略授权状态为关闭
      • 设置策略授权状态为开启
    • 个人中心
      • 个人信息查询
      • 获取身份源连接列表(web 端)
      • 用户身份源连接列表
      • 个人信息编辑
      • 认证信息查询
      • 认证信息修改
      • 安全等级查询
      • 用户解绑社会化登录账号
    • 用户池管理
      • 用户池
        • 基础信息修改
        • 用户池列表查询
        • 用户池详情
        • 用户池密钥刷新
        • 用户池删除
        • 用户池创建
        • 协作管理员列表
        • 协作管理员邀请
        • 协作管理员移除
        • 用户池安全登录设置修改
        • 密码安全设置修改
        • 获取环境变量
        • 添加环境变量
        • 删除环境变量
        • 获取协作管理员用户池列表
        • 开启关闭用户池
        • 打开用户池
      • 自定义字段
        • 自定义字段列表查询
        • 添加自定义字段
        • 删除自定义字段
        • 修改自定义字段
      • 消息服务
        • 邮件模板列表查询
        • 邮件模板更新
        • 第三方邮件服务查询
        • 第三方邮件服务更新
    • 账号绑定
      • 用户是否绑定了 MFA
      • 按类型解绑用户 MFA
      • 为用户导入 TOTP
    • 身份源
      • 【必读】身份源接口相关文档
      • 获取身份源模板列表
        GET
      • 获取指定身份源配置模板
        GET
      • 获取身份源列表
        GET
      • 获取身份源详细信息
        GET
      • 创建身份源
        POST
      • 更新身份源
        PUT
      • 删除身份源
        DELETE
      • 创建身份源连接
        POST
      • 更新身份源连接
        PUT
      • 删除身份源连接
        DELETE
      • 检查连接唯一标识是否冲突
        POST
      • 开关身份源连接
        PUT
      • 批量开关身份源连接
        PUT
      • 批量开关所有应用
        PUT
      • 获取身份源连接对于应用的状态列表
        GET
      • 获取身份源对于应用的状态列表
        GET
    • 租户
      • 获取用户池下租户列表
      • 创建租户
      • 获取租户相关统计信息
      • 根据 ID 查询租户
      • 修改租户
      • 配置租户品牌化
      • 配置租户品牌化
      • 删除租户
    • 租户成员
      • 更新租户成员
      • 添加租户成员
      • 设置租户管理员
      • 取消租户管理员
      • 获取租户成员列表
      • 删除租户成员
  1. 身份源

获取指定身份源配置模板

GET
/api/v2/extIdpTmpl/{type}

请求参数

Path 参数
type
string 
必需
枚举值参考身份源接口相关文档
示例值:
github
Header 参数
x-authing-userpool-id
string 
用户池 ID
必需
示例值:
61b95d6c96d42670da568408
Authorization
string 
Token
必需
示例值:
Bearer Token

示例代码

Shell
JavaScript
Java
Swift
Go
PHP
Python
HTTP
C
C#
Objective-C
Ruby
OCaml
Dart
R
请求示例请求示例
Shell
JavaScript
Java
Swift
curl --location --request GET 'https://core.authing.cn/api/v2/extIdpTmpl/github' \
--header 'x-authing-userpool-id: 61b95d6c96d42670da568408' \
--header 'Authorization: Bearer Token'

返回响应

🟢200成功
application/json
Body
code
integer 
必需
message
string 
必需
data
object 
必需
type
string 
必需
name
string 
必需
name_en
string 
必需
desc
string 
必需
desc_en
string 
必需
logo
string 
必需
allowMultiple
boolean 
必需
allowMultipleConn
boolean 
必需
connectionTmpls
array [object {10}] 
必需
示例
{
  "code": 200,
  "message": "获取模板详细信息成功",
  "data": {
    "type": "github",
    "name": "GitHub",
    "name_en": "GitHub",
    "desc": "数以百万计的开发者和公司在全球最大、最先进的开发平台 GitHub 上构建、发布和维护他们的软件",
    "desc_en": "Millions of developers and companies build, publish and maintain their software on GitHub, the world's largest and most advanced development platform",
    "logo": "https://files.authing.co/authing-console/social-connections/icon_github.png",
    "allowMultiple": false,
    "allowMultipleConn": false,
    "connectionTmpls": [
      {
        "type": "github",
        "name": "GitHub",
        "name_en": "GitHub",
        "logo": "https://files.authing.co/authing-console/social-connections/icon_github.png",
        "description": "数以百万计的开发者和公司在全球最大、最先进的开发平台 GitHub 上构建、发布和维护他们的软件",
        "description_en": "Millions of developers and companies build, publish and maintain their software on GitHub, the world's largest and most advanced development platform",
        "hidden": false,
        "tooltip": {
          "zh-CN": "GitHub 登录",
          "en-US": "GitHub"
        },
        "fields": [
          {
            "key": "displayName",
            "label": "显示名称",
            "label_en": "Display Name",
            "type": "input",
            "required": true,
            "placeholder": "Authing 登录表单将会显示一个“{Display Name} 登录”的按钮",
            "placeholder_en": "The Authing login form will display a '{Display Name} Login' button"
          },
          {
            "key": "clientID",
            "label": "Client ID",
            "type": "input",
            "required": true,
            "placeholder": "请输入 Client ID",
            "placeholder_en": "Please enter the Client ID"
          },
          {
            "key": "clientSecret",
            "label": "Client Secret",
            "type": "input",
            "required": true,
            "placeholder": "请输入 Client Secret",
            "placeholder_en": "Please enter the Client Secret"
          },
          {
            "key": "callbackURL",
            "label": "Callback URL",
            "type": "input",
            "required": false,
            "placeholder": "请输入你的业务回调链接",
            "placeholder_en": "Please enter the Callback URL"
          },
          {
            "key": "scopes",
            "label": "Scopes",
            "type": "checkbox",
            "children": [
              {
                "label": "repo",
                "key": "repo"
              },
              {
                "label": "repo:status",
                "key": "repo:status"
              },
              {
                "label": "repo_deployment",
                "key": "repo_deployment"
              },
              {
                "label": "public_repo",
                "key": "public_repo"
              },
              {
                "label": "repo:invite",
                "key": "repo:invite"
              },
              {
                "label": "admin:repo_hook",
                "key": "admin:repo_hook"
              },
              {
                "label": "write:repo_hook",
                "key": "write:repo_hook"
              },
              {
                "label": "read:repo_hook",
                "key": "read:repo_hook"
              },
              {
                "label": "admin:org",
                "key": "admin:org"
              },
              {
                "label": "write:org",
                "key": "write:org"
              },
              {
                "label": "read:org",
                "key": "read:org"
              },
              {
                "label": "admin:public_key",
                "key": "admin:public_key"
              },
              {
                "label": "write:public_key",
                "key": "write:public_key"
              },
              {
                "label": "read:public_key",
                "key": "read:public_key"
              },
              {
                "label": "admin:org_hook",
                "key": "admin:org_hook"
              },
              {
                "label": "gist",
                "key": "gist"
              },
              {
                "label": "notifications",
                "key": "notifications"
              },
              {
                "label": "user",
                "key": "user"
              },
              {
                "label": "read:user",
                "key": "read:user"
              },
              {
                "label": "user:email",
                "key": "user:email"
              },
              {
                "label": "user:follow",
                "key": "user:follow"
              },
              {
                "label": "delete_repo",
                "key": "delete_repo"
              },
              {
                "label": "write:discussion",
                "key": "write:discussion"
              },
              {
                "label": "read:discussion",
                "key": "read:discussion"
              },
              {
                "label": "write:packages",
                "key": "write:packages"
              },
              {
                "label": "read:packages",
                "key": "read:packages"
              },
              {
                "label": "delete:packages",
                "key": "delete:packages"
              },
              {
                "label": "admin:gpg_key",
                "key": "admin:gpg_key"
              },
              {
                "label": "write:gpg_key",
                "key": "write:gpg_key"
              },
              {
                "label": "read:gpg_key",
                "key": "read:gpg_key"
              },
              {
                "label": "workflow",
                "key": "workflow"
              }
            ]
          },
          {
            "key": "redirectUrl",
            "label": "回调地址",
            "label_en": "Redirect Url",
            "type": "custom",
            "extra": "你需要将此链接配置到对应身份源的回调地址中",
            "extra_en": "You need to configure this link to the callback address of the corresponding identity source",
            "valueType": "redirectUrl"
          }
        ],
        "availableUserMatchFields": [
          {
            "name": "邮箱",
            "key": "email"
          }
        ]
      }
    ]
  }
}
上一页
获取身份源模板列表
下一页
获取身份源列表
Built with