- 快速开始
- 身份源(Connection)
- 应用(Client)
- 资源服务器(ResourceServer)
- 用户(User)
- 角色(Role)
- 分组(Group)
- 租户(Tenant)
- 组织(Organization)
- 动作(Action)
- 授权(Grant)
- 应用授权(ClientGrant)
- 日志(Log)
- 自定义域名(CusomDomain)
- 密钥(Key)
- 任务(Job)
- 多因素认证(MFA)
- 安全防护(AttackProtection)
- 品牌化(Branding)
分页查找用户
GET
/api/v1/users
用户
请求参数
Authorization
在 Header 添加参数
Authorization
,其值为在 Bearer 之后拼接 Token示例:
Authorization: Bearer ********************
Query 参数
page_size
integer
可选
示例值:
10
page
integer
页码
示例值:
1
sort
string
可选
示例值:
-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
每页显示数量
total
integer
记录总数
items
array[object (User) {34}]
必需
user_id
string
必需
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
可选
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