Authok管理API
  1. 身份源(Connection)
Authok管理API
  • 快速开始
    • 获取Token
  • 身份源(Connection)
    • 创建身份源
      POST
    • 根据ID查找身份源
      GET
    • 更新身份源
      PATCH
    • 删除身份源
      DELETE
    • 获取身份源列表
      GET
    • 获取身份源的状态
      GET
    • 删除身份源的给定用户
      DELETE
  • 应用(Client)
    • 查找应用
      GET
    • 创建应用
      POST
    • 更新应用
      PATCH
    • 删除应用
      DELETE
    • 获取应用列表
      GET
    • 轮换密钥
      POST
  • 资源服务器(ResourceServer)
    • 创建资源服务器
      POST
    • 获取资源服务器
      GET
    • 更新资源服务器
      PATCH
    • 删除资源服务器
      DELETE
    • 获取资源服务器列表
      GET
  • 用户(User)
    • 创建用户
      POST
    • 获取用户详情
      GET
    • 修改用户详情
      PATCH
    • 删除用户
      DELETE
    • 分页查找用户
      GET
    • 给用户添加权限
      POST
    • 删除用户的权限
      DELETE
    • 获取用户的权限列表
      GET
    • 获取用户的角色列表
      GET
    • 给用户添加角色
      POST
    • 删除用户的角色
      DELETE
    • 关联用户
      POST
    • 解除用户关联
      DELETE
    • 获取用户所在的组织列表
      GET
  • 角色(Role)
    • 创建角色
    • 获取角色信息
    • 更新角色信息
    • 删除角色
    • 获取角色列表
    • 获取角色的权限列表
    • 删除角色的权限
    • 分配权限给角色
    • 获取角色的用户列表
    • 分配角色给用户
    • 从给定角色中移除用户
  • 分组(Group)
  • 租户(Tenant)
    • 获取当前租户详情
    • 修改租户详情
  • 组织(Organization)
    • 创建组织
    • 获取组织详情
    • 更新组织
    • 删除组织
    • 获取组织列表
    • 根据标识符查找组织
    • 获取组织开启的身份源
    • 获取组织的成员列表
    • 从组织中删除成员
    • 添加成员到组织
    • 获取组织的邀请列表
    • 创建邀请
    • 获取邀请详情
    • 删除邀请
    • 获取组织开启的身份源列表
    • 给组织添加身份源
    • 获取组织开启的身份源详情
    • 从组织中删除给定的身份源
    • 修改组织关联的身份源配置
    • 获取成员关联的角色列表
  • 动作(Action)
    • 创建动作
    • 获取动作列表
    • 更新动作
    • 删除动作
    • 测试动作
    • 获取触发器列表
    • 获取触发器/动作绑定列表
    • 更新触发器/动作绑定
  • 授权(Grant)
  • 应用授权(ClientGrant)
    • 创建应用授权
    • 查找应用授权
    • 更新应用授权
    • 删除应用授权
    • 获取应用授权列表
  • 日志(Log)
  • 自定义域名(CusomDomain)
    • 创建自定义域名
    • 获取自定义域名
    • 更新自定义域名
    • 删除自定义域名
    • 获取自定义域名列表
    • 验证自定义域名
  • 密钥(Key)
    • 获取应用的所有密钥列表
    • 根据ID获取给定密钥
    • 轮换密钥
    • 撤销密钥
  • 任务(Job)
  • 多因素认证(MFA)
  • 安全防护(AttackProtection)
  • 品牌化(Branding)
  1. 身份源(Connection)

获取身份源列表

GET
/api/v1/connections
身份源

请求参数

Authorization
在 Header 添加参数
Authorization
,其值为在 Bearer 之后拼接 Token
示例:
Authorization: Bearer ********************
Query 参数
page
integer 
页码
可选
示例值:
1
page_size
integer 
可选
分页大小. 最多100
示例值:
10
sort
string 
可选
排序, -代表降序(DESC), 默认为升序(ASC), 用":"分割多个排序字段
示例值:
-created_at:name
fields
string 
可选
指定获取的字段集,用","分割
strategy_type
string 
身份源类型
可选
示例值:
social

示例代码

Shell
JavaScript
Java
Swift
Go
PHP
Python
HTTP
C
C#
Objective-C
Ruby
OCaml
Dart
R
请求示例请求示例
Shell
JavaScript
Java
Swift
curl --location -g --request GET 'https://..authok.cn/api/v1/connections'

返回响应

🟢200成功
application/json
Body
meta
object (PageMeta) 
必需
page
integer 
页码
必需
页码
page_size
integer 
每页显示数量
必需
每页显示数量, 不得超过100
total
integer 
记录总数
必需
记录总数
items
array[object (Connection) {7}] 
必需
id
string 
身份源ID
必需
name
string 
身份源唯一标识
必需
strategy
string 
必需
身份源策略(等同身份提供者标识符)
display_name
string  | null 
可读名称
必需
options
object 
必需
身份源配置(根据strategy不同,配置不同)
metadata
object  | null 
必需
元数据, 用户自定义
enabled_clients
array[string]
开启的应用
必需
示例
{
  "meta": {
    "page": 1,
    "page_size": 20,
    "total": 100
  },
  "items": [
    {
      "id": "con_3j2ijiofjoiej",
      "name": "wechat:pc",
      "strategy": "wechat:pc",
      "display_name": "微信PC登录",
      "enabled_clients": [
        "3j2932o3ij4jo",
        "3u29fjj2o3ji3"
      ]
    },
    {
      "id": "80",
      "name": "量压计人",
      "strategy": "magna laboris ut cillum",
      "display_name": "市你活",
      "enabled_clients": [
        "esse adipisicing aliqua",
        "amet minim ea",
        "sunt dolor aliqua",
        "ea dolor aute deserunt cupidatat"
      ]
    }
  ]
}
修改于 2022-03-19 21:41:35
上一页
删除身份源
下一页
获取身份源的状态
Built with