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 端)
      • 用户身份源连接列表
      • 个人信息编辑
      • 认证信息查询
      • 认证信息修改
      • 安全等级查询
      • 用户解绑社会化登录账号
    • 用户池管理
      • 用户池
        • 基础信息修改
          POST
        • 用户池列表查询
          GET
        • 用户池详情
          GET
        • 用户池密钥刷新
          POST
        • 用户池删除
          DELETE
        • 用户池创建
          POST
        • 协作管理员列表
          GET
        • 协作管理员邀请
          POST
        • 协作管理员移除
          POST
        • 用户池安全登录设置修改
          POST
        • 密码安全设置修改
          POST
        • 获取环境变量
          GET
        • 添加环境变量
          POST
        • 删除环境变量
          DELETE
        • 获取协作管理员用户池列表
          GET
        • 开启关闭用户池
          POST
        • 打开用户池
          POST
      • 自定义字段
        • 自定义字段列表查询
        • 添加自定义字段
        • 删除自定义字段
        • 修改自定义字段
      • 消息服务
        • 邮件模板列表查询
        • 邮件模板更新
        • 第三方邮件服务查询
        • 第三方邮件服务更新
    • 账号绑定
      • 用户是否绑定了 MFA
      • 按类型解绑用户 MFA
      • 为用户导入 TOTP
    • 身份源
      • 【必读】身份源接口相关文档
      • 获取身份源模板列表
      • 获取指定身份源配置模板
      • 获取身份源列表
      • 获取身份源详细信息
      • 创建身份源
      • 更新身份源
      • 删除身份源
      • 创建身份源连接
      • 更新身份源连接
      • 删除身份源连接
      • 检查连接唯一标识是否冲突
      • 开关身份源连接
      • 批量开关身份源连接
      • 批量开关所有应用
      • 获取身份源连接对于应用的状态列表
      • 获取身份源对于应用的状态列表
    • 租户
      • 获取用户池下租户列表
      • 创建租户
      • 获取租户相关统计信息
      • 根据 ID 查询租户
      • 修改租户
      • 配置租户品牌化
      • 配置租户品牌化
      • 删除租户
    • 租户成员
      • 更新租户成员
      • 添加租户成员
      • 设置租户管理员
      • 取消租户管理员
      • 获取租户成员列表
      • 删除租户成员
  1. 用户池

协作管理员列表

GET
/api/v2/cooperators

请求参数

Header 参数
Authorization
string 
必需
用户池管理员 Token
示例值:
Bearer token
x-authing-userpool-id
string 
用户池 ID
必需
示例值:
59f86b4832eb28071bdd9214

示例代码

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/cooperators' \
--header 'Authorization: Bearer token' \
--header 'x-authing-userpool-id: 59f86b4832eb28071bdd9214'

返回响应

🟢200成功
application/json
Body
code
integer 
必需
message
string 
必需
data
array [object {4}] 
必需
user
object 
可选
type
string 
可选
authorizedApps
array [object {56}] 
可选
policies
object 
可选
示例
{
  "code": 200,
  "message": "",
  "data": [
    {
      "user": {
        "userPoolId": "59f86b4832eb28071bdd9214",
        "displayName": "2222@123.com",
        "id": "614dbc2a3b1131bcf7f8990f",
        "photo": "https://files.authing.co/authing-console/default-user-avatar.png"
      },
      "type": "app",
      "authorizedApps": [
        {
          "qrcodeScanning": {
            "redirect": false,
            "interval": 1500
          },
          "id": "61dcf7ae63800e70877e3258",
          "createdAt": "2022-01-11T03:21:18.866Z",
          "updatedAt": "2022-01-11T03:21:18.948Z",
          "userPoolId": "59f86b4832eb28071bdd9214",
          "protocol": "oidc",
          "isOfficial": false,
          "isDeleted": false,
          "isDefault": false,
          "isDemo": false,
          "name": "efwefwe",
          "description": null,
          "secret": "2a031ebb341af91ad61e240840476591",
          "identifier": "rgwrgre",
          "jwks": {
            "keys": [
              {
                "e": "AQAB",
                "n": "wK6d7jG4tCQTQL87iUT1h4J2xIWemzIRwN1s2Vy84ALQnnuyWid9aUyy3DL9Qa_z-wBi05YAh_ZA7xcEtN30vugDRSwYFjdWxvxKOOKVhg8B97l3e9idNhMdFAkuNaFwCo2H1UbYIPdOCcUmfeK4Gq02xSEf31dR0gj__ihDz0KLylwcCEFChfY8ugQt7RgWWMsHPpcuuFsKQljv-lCfZI99d-EeZw8xpJ36_h4RwIYBYb1lsJbkf0QGBNPQfx4xM9wLCKYBTTPwVC8GUlU4uk6pB9WeKWAHRll35u6nAmyy_DcEp8xsJDd4jKRfGoMzlMzs4_j9LMms28GHKBVrOQ",
                "d": "quh4F3atAcRZ-31kfr7XFoqndGudIsXHr434Zdj3g6-bgmfv7D3I5OTuZZkowOIkhIh0IH-WGwNX13tQZmnWFJvRgsK43sPZSgkwgMKipFWdhjFRhV2_HN7ZVRNLlLCMpB-j047SWHNkGhBwswquCKOJyFM4ZS-b2LS49KSceTJgPgJuTCtzTcgnyOFZV4i6fWvME39cAP609vDo1ds3O4-0aofVnsPyLG5bfr1cqbwexet6B0yU5TjklCChw1uXF6pk1n69Hji-d1AY5ws5FPWN9HFtnbv0SA2Y71fjFh4PWjlAqhvyqeMZzc-s71Asx7fAOD-Dhi76sAvMExbb8Q",
                "p": "6QA1uZI2bv2WP2WFJnU1gKLIlTy4EAS6jAjRE3y03PQA13_bOJlt8DQ700p5bsZJWy0S4LbxghDjcG5SDAp8mPsuIS5yPoM0yKJJomaaNDsbd3PJI8E84-tl9XTIUUmw7Cy8c9ES7V6LzlpTB4xJ0XGO-F2t3TH8kNCNZCPF2V0",
                "q": "07OTx3pxXibNIuvP0RcSFIcjXcZVg9_Dd_WowA042CbQqX2qW9Cb21WLRi0JKDTlqGcvmFgi_XpueZVx1JLe8m_-ccTNJgjIbyoogQVUXQSN8JB4nCTZLyqWtRTiyEiDmDvwPc-7pTEpItzB-LSgDeEcjEE1A6NLaHRtUfidT40",
                "dp": "kL3Yohb6SaiulWNze5iETAzTniHCFfFaEXPIrdpiYIATpct_W4G0ketg3rj9BpuXJlSxzXbYQHxNTaK6xVAeZspitaosvjizqY9nPsOON7QgM-xxnwyDzvKEvB538kdc6NpBl5DhuSNqph3mRmIX2Uw6DH_laeuLgkqMCxFN7uE",
                "dq": "BJZDgXL5udyFXVhWrGUfkypKbeG6QJ08kwDTozWmIajVpJaAdnTSq7HyzpZzOFfNEhUKRvbB61QXyLKgQMbd5crfbH-jIkvWa_Ix5nnDFjDfEnNO6bMysX7uvQWy1Dwd_dJupig2HKIwDf1Shp0DSsmx4KgZCfcjzyOWqswEPJE",
                "qi": "x8ELXrLmj-uOuHLA5qe3NL5mI1A2Pxr5m5XRrSxkLwG23R7Y7x-JxrJgPob-xVlKFBKJtOF6HS4vD-RZV2K4jaeU3W9GLaJS5P7KMbZ38kkLKsiFlFi_u1DJ_HrMLyB-Mh4aktd2E_d759XQOg1IHuYhTFGChLEcNLge8Bgv0_o",
                "kty": "RSA",
                "kid": "SjtbJmttCpEAH23ztOv_QAmeBUQLnqoMdUCtSl-PMj0",
                "alg": "RS256",
                "use": "sig"
              }
            ]
          },
          "ssoPageCustomizationSettings": null,
          "logo": "https://files.authing.co/authing-console/default-app-logo.png",
          "redirectUris": [
            "http://console.authing.localhost:3000/console/get-started/61dcf7ae63800e70877e3258"
          ],
          "logoutRedirectUris": [],
          "initLoginUrl": null,
          "oidcProviderEnabled": true,
          "oauthProviderEnabled": false,
          "samlProviderEnabled": false,
          "casProviderEnabled": false,
          "registerDisabled": false,
          "loginTabs": [
            "phone-code",
            "password"
          ],
          "passwordTabConfig": {
            "enabledLoginMethods": [
              "username-password",
              "email-password",
              "phone-password"
            ]
          },
          "defaultLoginTab": "password",
          "registerTabs": [
            "email",
            "phone"
          ],
          "defaultRegisterTab": "email",
          "extendsFieldsEnabled": false,
          "extendsFields": [],
          "complateFiledsPlace": [],
          "skipComplateFileds": false,
          "ext": null,
          "css": "/* \n  Edit login page css\n  eg:\n  .authing-guard-layout {\n    background: black !important;\n  }\n  Change the background color\n*/",
          "oidcConfig": {
            "grant_types": [
              "authorization_code",
              "password",
              "refresh_token"
            ],
            "response_types": [
              "code"
            ],
            "id_token_signed_response_alg": "HS256",
            "token_endpoint_auth_method": "client_secret_post",
            "authorization_code_expire": 600,
            "id_token_expire": 1209600,
            "access_token_expire": 1209600,
            "refresh_token_expire": 2592000,
            "cas_expire": 1209600,
            "skip_consent": true,
            "redirect_uris": [
              "http://console.authing.localhost:3000/console/get-started/61dcf7ae63800e70877e3258"
            ],
            "post_logout_redirect_uris": [],
            "client_id": "61dcf7ae63800e70877e3258",
            "client_secret": "2a031ebb341af91ad61e240840476591"
          },
          "oidcJWEConfig": null,
          "samlConfig": null,
          "oauthConfig": {
            "id": "61dcf7ae63800e70877e3258",
            "client_secret": "2a031ebb341af91ad61e240840476591",
            "redirect_uris": [
              "http://console.authing.localhost:3000/console/get-started/61dcf7ae63800e70877e3258"
            ],
            "grants": [
              "authorization_code"
            ],
            "access_token_lifetime": 1209600,
            "refresh_token_lifetime": 2592000,
            "introspection_endpoint_auth_method": "client_secret_post",
            "revocation_endpoint_auth_method": "client_secret_post"
          },
          "casConfig": null,
          "asaConfig": null,
          "showAuthorizationPage": false,
          "enableSubAccount": false,
          "enableDeviceMutualExclusion": false,
          "loginRequireEmailVerified": false,
          "agreementEnabled": false,
          "isIntegrate": false,
          "ssoEnabled": false,
          "template": null,
          "skipMfa": false,
          "casExpireBaseBrowser": false,
          "isAsa": false,
          "appType": "INDIVIDUAL",
          "guardVersion": "v2",
          "permissionStrategy": {
            "enabled": false,
            "defaultStrategy": "ALLOW_ALL",
            "allowPolicyId": null,
            "denyPolicyId": null
          }
        }
      ],
      "policies": {
        "totalCount": 0,
        "list": []
      }
    }
  ]
}
上一页
用户池创建
下一页
协作管理员邀请
Built with