Authok管理API
  1. 用户(User)
Authok管理API
  • 快速开始
    • 获取Token
  • 身份源(Connection)
    • 创建身份源
      POST
    • 根据ID查找身份源
      GET
    • 更新身份源
      PATCH
    • 删除身份源
      DELETE
    • 获取身份源列表
      GET
    • 获取身份源的状态
      GET
    • 删除身份源的给定用户
      DELETE
  • 应用(Client)
    • 查找应用
      GET
    • 创建应用
      POST
    • 更新应用
      PATCH
    • 删除应用
      DELETE
    • 获取应用列表
      GET
    • 轮换密钥
      POST
  • 资源服务器(ResourceServer)
    • 创建资源服务器
    • 获取资源服务器
    • 更新资源服务器
    • 删除资源服务器
    • 获取资源服务器列表
  • 用户(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. 用户(User)

分页查找用户

GET
/api/v1/users
用户

请求参数

Authorization
在 Header 添加参数
Authorization
,其值为在 Bearer 之后拼接 Token
示例:
Authorization: Bearer ********************
Query 参数
page_size
integer 
可选
每页显示数量, 不得超过100
示例值:
10
page
integer 
页码
可选
示例值:
1
sort
string 
可选
排序, -代表降序(DESC), 默认为升序(ASC), 用":"分割多个排序字段
示例值:
-created_at
fields
string 
可选
指定获取的字段集,用","分割
示例值:
user_id,name,nickname
connection
string 
身份源唯一标识
可选
示例值:
wechat:pc

示例代码

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/users'

返回响应

🟢200成功
application/json
Body
meta
object (PageMeta) 
必需
page
integer 
页码
必需
页码
page_size
integer 
每页显示数量
必需
每页显示数量, 不得超过100
total
integer 
记录总数
必需
记录总数
items
array[object (User) {34}] 
必需
user_id
string 
必需
用户ID(租户内唯一)
connection
string 
身份源
必需
name
string 
姓名
可选
email
string 
邮箱
可选
email_verified
boolean 
邮箱是否验证
可选
phone_number
string 
手机号
可选
phone_country_code
string 
手机国家代码
可选
phone_number_verified
boolean 
手机号是否验证
可选
logins_count
integer 
登录累积次数
必需
blocked
boolean 
必需
账号是否被锁定(锁定后无法正常登录)
identities
array[object (Identity) {6}] 
绑定的身份信息列表
必需
user_metadata
object 
可选
用户元数据(用户属性,用户可设置)
app_metadata
object 
可选
应用元数据(应用级别设置,用户不可设置)
signup_at
string 
注册时间
必需
updated_at
string 
最后更新时间
必需
created_at
string 
用户创建时间
必需
username
string 
可选
用户名(唯一标识符, 可用于用户名/密码登录)
nickname
string 
昵称
可选
given_name
string 
名
可选
family_name
string 
姓
可选
picture
string  | null 
头像地址
可选
verify_email
boolean 
邮箱是否已经过验证
可选
gender
integer 
可选
性别. 0: 未知; 1: 男; 2: 女
birthdate
string 
生日
可选
locale
string 
区域
可选
country
string 
所在国家
可选
city
string 
城市
可选
province
string 
省份
可选
region
string 
南山区
可选
address
string 
详细地址
可选
postal_code
string 
邮政编码
可选
signup_ip
string 
注册IP
必需
last_login
string 
最后登录时间
必需
last_ip
string 
最后登录IP
必需
示例
{
  "meta": {
    "page": 1,
    "page_size": 20,
    "total": 100
  },
  "items": {
    "user_id": "authok|32jjf9uwfjew0ejfjffeio",
    "connection": "authok",
    "logins_count": 1002,
    "blocked": false,
    "identities": [
      {
        "connection": "wechat",
        "user_id": "67",
        "provider": "56",
        "is_social": false,
        "access_token": "aliqua in mollit",
        "profile_data": {
          "email": "s.vtjnf@qq.com",
          "emailVerified": false,
          "name": "一切西叫结于",
          "username": "高平",
          "given_name": "具两第原走当好",
          "phone_number": "56",
          "phone_number_verified": true,
          "family_name": "子一为们作",
          "picture": "http://dummyimage.com/400x400",
          "city": "新界",
          "province": "黑龙江省",
          "country": "voluptate laborum non sed est",
          "gender": 66,
          "nickname": "邹军",
          "openid": "87",
          "unionid": "71"
        }
      },
      {
        "connection": "wechat",
        "user_id": "61",
        "provider": "12",
        "is_social": true,
        "access_token": "eiusmod minim esse",
        "profile_data": {
          "email": "i.ewwqcosfn@qq.com",
          "emailVerified": true,
          "name": "育应马观经动",
          "username": "张平",
          "given_name": "斯主年走成和多",
          "phone_number": "85",
          "phone_number_verified": true,
          "family_name": "厂些习无参许机",
          "picture": "http://dummyimage.com/400x400",
          "city": "呼和浩特市",
          "province": "云南省",
          "country": "pariatur occaecat",
          "gender": 92,
          "nickname": "吴秀英",
          "openid": "71",
          "unionid": "75"
        }
      },
      {
        "connection": "wechat",
        "user_id": "37",
        "provider": "51",
        "is_social": false,
        "access_token": "Excepteur id",
        "profile_data": {
          "email": "k.wrpw@qq.com",
          "emailVerified": false,
          "name": "子步空她",
          "username": "万桂英",
          "given_name": "动叫务精头",
          "phone_number": "9",
          "phone_number_verified": true,
          "family_name": "还造心求品影红",
          "picture": "http://dummyimage.com/400x400",
          "city": "临夏回族自治州",
          "province": "云南省",
          "country": "ea fugiat tempor",
          "gender": 21,
          "nickname": "吕刚",
          "openid": "85",
          "unionid": "59"
        }
      },
      {
        "connection": "wechat",
        "user_id": "91",
        "provider": "67",
        "is_social": false,
        "access_token": "Lorem magna officia",
        "profile_data": {
          "email": "m.uwmeiuper@qq.com",
          "emailVerified": true,
          "name": "名离方总流完",
          "username": "秦超",
          "given_name": "想你她东",
          "phone_number": "25",
          "phone_number_verified": true,
          "family_name": "它影常必农学带",
          "picture": "http://dummyimage.com/400x400",
          "city": "楚雄彝族自治州",
          "province": "贵州省",
          "country": "id",
          "gender": 46,
          "nickname": "孔娟",
          "openid": "82",
          "unionid": "24"
        }
      }
    ],
    "signup_at": "2022-03-12 22:33:44",
    "updated_at": "2022-03-12 23:33:44",
    "signup_ip": "22.33.21.52",
    "last_login": "2022-03-13 18:22:12",
    "last_ip": "22.33.21.53",
    "created_at": "2022-03-11 23:33:44",
    "verify_email": true,
    "picture": "https://img.gavatars.com/a.png",
    "nickname": "fioman",
    "given_name": "雷",
    "birthdate": "1987-04-23",
    "phone_country_code": "86",
    "name": "李雷",
    "gender": 1,
    "phone_number_verified": true,
    "family_name": "李",
    "city": "深圳",
    "province": "广东",
    "email_verified": true,
    "region": "区域",
    "email": "fioman@qq.com",
    "phone_number": "18600002222",
    "address": "粤海街道办A座A03室",
    "postal_code": "518000",
    "country": "中国",
    "locale": "zh",
    "username": "fioman"
  }
}
修改于 2022-03-13 20:33:10
上一页
删除用户
下一页
给用户添加权限
Built with