¶ 管理用户

更新时间: 2021-04-25 05:57:05

此模块可以进行用户目录增删改查、搜索用户、刷新用户 token、管理用户分组、管理用户角色、管理用户策略授权等操作。

请使用以下方式使用该模块：

use Authing\Mgmt\ManagementClient;

$manageClient = new ManagementClient('YOUR_USERPOOL_ID', 'YOUR_USERPOOL_SECRET');

$usersManagementClient = $managementClient->users();
$usersManagementClient->create // 创建用户
$usersManagementClient->update   // 修改用户资料
$usersManagementClient->detail // 获取用户详情

¶ 创建用户

UsersManagementClient->create(array $userInfo)

此接口将以管理员身份创建用户，不需要进行手机号验证码检验等安全检测。用户的手机号、邮箱、用户名、externalId 用户池内唯一。

¶ 参数

userInfo <CreateUserInput> 用户资料
userInfo.email <string> 邮箱，用户池内唯一
userInfo.emailVerified <boolean> 邮箱是否已验证
userInfo.phone <string> 手机号
userInfo.phoneVerified <boolean> 手机号是否验证
userInfo.unionid <string> 以社会化登录的用户该字段为用户在第三方社会化登录服务商中的唯一 ID
userInfo.openid <string> 微信登录返回的 openid
userInfo.password <string> 密码
userInfo.registerSource <string> 注册来源，可以多选
userInfo.username <string> 用户名
userInfo.nickname <string> 昵称
userInfo.photo <string> 头像
userInfo.company <string> 公司
userInfo.browser <string> 浏览器
userInfo.loginsCount <number> 登录次数，当你从原有用户系统迁移到 Authing 时可以设置该字段。
userInfo.lastLogin <string> 上次登录时间, 符合 ISO8601 (opens new window) 格式的时间字符串。(如 "2017-06-07T14:34:08.700Z", "2017-06-07T14:34:08.700 or "2017-06-07T14:34:08+04:00")
userInfo.lastIP <string> 用户最近一次登录（或其他活动）的 IP
userInfo.signedUp <string> 注册时间，符合 ISO8601 (opens new window) 格式的时间字符串。(如 "2017-06-07T14:34:08.700Z", "2017-06-07T14:34:08.700 or "2017-06-07T14:34:08+04:00")
userInfo.blocked <boolean> 账号是否被禁用
userInfo.isDeleted <boolean> 标记账号是否被删除
userInfo.device <string> 设备
userInfo.lastIP <string> 最近登录的 IP
userInfo.name <string> Name
userInfo.givenName <string> Given Name
userInfo.familyName <string> Family Name
userInfo.middleName <string> Middle Name
userInfo.profile <string> Profile Url
userInfo.preferredUsername <string> Preferred Name
userInfo.website <string> 个人网站
userInfo.gender <string> 性别, M（Man）表示男性、F（Female）表示女性、未知表示 U（Unknown）
userInfo.birthdate <string> 生日
userInfo.zoneinfo <string> 时区
userInfo.locale <string> 语言
userInfo.address <string> 地址
userInfo.streetAddress <string> 街道地址
userInfo.locality <string> 地方
userInfo.region <string> 地域
userInfo.postalCode <string> 邮编
userInfo.city <string> 城市
userInfo.province <string> 省份
userInfo.country <string> 国家

¶ 示例

$email = "test@example.com";
$password = '123456';
$user = $managementClient->users()->create(
  (new CreateUserInput())
    ->withEmail($email)
    ->withPassword($password)
);

¶ 修改用户资料

UsersManagementClient->update(string $id, array $updates)

¶ 参数

id <string> 用户 ID
updates <UpdateUserInput> 修改的用户资料
updates.email <string> 邮箱
updates.emailVerified <boolean> 邮箱是否已验证
updates.phone <string> 手机号
updates.phoneVerified <boolean> 手机号是否验证
updates.unionid <string> 以社会化登录的用户该字段为用户在第三方社会化登录服务商中的唯一 ID
updates.openid <string> 微信登录返回的 openid
updates.password <string> 密码
updates.registerSource <string> 注册来源，可以多选
updates.tokenExpiredAt <string> token 过期时间，符合 ISO8601 (opens new window) 格式的时间字符串。(如 "2017-06-07T14:34:08.700Z", "2017-06-07T14:34:08.700 or "2017-06-07T14:34:08+04:00")。将该字段设置为小于当前时间可以让用户的 token 失效。
updates.username <string> 用户名
updates.nickname <string> 昵称
updates.photo <string> 头像
updates.company <string> 公司
updates.browser <string> 浏览器
updates.loginsCount <number> 登录次数，当你从原有用户系统迁移到 Authing 时可以设置该字段。
updates.lastLogin <string> 上次登录时间, 符合 ISO8601 (opens new window) 格式的时间字符串。(如 "2017-06-07T14:34:08.700Z", "2017-06-07T14:34:08.700 or "2017-06-07T14:34:08+04:00")
updates.lastIP <string> 用户最近一次登录（或其他活动）的 IP
updates.signedUp <string> 注册时间，符合 ISO8601 (opens new window) 格式的时间字符串。(如 "2017-06-07T14:34:08.700Z", "2017-06-07T14:34:08.700 or "2017-06-07T14:34:08+04:00")
updates.blocked <boolean> 账号是否被禁用
updates.device <string> 设备
updates.lastIP <string> 最近登录的 IP
updates.name <string> Name
updates.givenName <string> Given Name
updates.familyName <string> Family Name
updates.middleName <string> Middle Name
updates.profile <string> Profile Url
updates.preferredUsername <string> Preferred Name
updates.website <string> 个人网站
updates.gender <string> 性别, M（Man）表示男性、F（Female）表示女性、未知表示 U（Unknown）
updates.birthdate <string> 生日
updates.zoneinfo <string> 时区
updates.locale <string> 语言
updates.address <string> 地址
updates.streetAddress <string> 街道地址
updates.locality <string>
updates.region <string> 地域
updates.postalCode <string> 邮编
updates.city <string> 城市
updates.province <string> 省份
updates.country <string> 国家

¶ 示例

$user = $managementClient->users()->update(
  'userId', 
  [
    'email' => 'new email',
    'name' => 'new name',
  ]
);

¶ 获取用户详情

UsersManagementClient->detail(string $userId)

通过用户 ID 获取用户详情，如果你想通过 token 获取用户详情，请使用 AuthenticationClient SDK 。

¶ 参数

userId <string> 用户 ID

¶ 示例

$user = $managementClient->users()->detail("userId");

¶ 获取自定义数据

UsersManagementClient->listUdv(string $userId)

获取用户的自定义数据。你需要先在用户池定义用户自定义数据元信息。

¶ 参数

userId <string> 用户 ID

¶ 示例

$data = $userManagementClient->listUdv("userId");

¶ 批量获取自定义数据

UsersManagementClient->getUdfValueBatch(array $userIds)

批量获取多个用户的自定义数据。你需要先在用户池定义用户自定义数据元信息。

¶ 参数

userIds <string []> 用户 ID 列表

¶ 示例

$data = $userManagementClient->getUdfValueBatch(
  ["userId1", "userId2"]
);

¶ 设置自定义数据

UsersManagementClient->setUdfValue(string $userId, array $data)

设置用户的自定义数据。你需要先在用户池定义用户自定义数据元信息，且传入值的类型必须和定义的类型匹配。

¶ 参数

userId <string> 用户 ID
data <KeyValuePair> 自定义字段数据，类型为一个对象。

¶ 示例

$userManagementClient->setUdfValue(userId, [
  'school' => '华中科技大学',
  'age' => 20,
]);

¶ 批量设置自定义数据

UsersManagementClient->setUdfValueBatch(array $input)

批量设置多个用户的自定义数据。你需要先在用户池定义用户自定义数据元信息，且传入值的类型必须和定义的类型匹配。如果设置失败，会抛出异常，你需要对异常进行捕捉。

¶ 参数

input <string> 输入数据，结构请见示例。

¶ 示例

$userManagementClient->setUdfValueBatch([
  [
    'userId' => 'USER_ID1',
    'data' => (object)[
      'school' => '华中科技大学',
    ],
  ],
  [
    'userId' => 'USER_ID2',
    'data' => (object)[
      'school' => '清华大学',
      'age' => 100,
    ],
  ],
]);

¶ 删除自定义数据

UsersManagementClient->removeUdfValue(string $userId, string $key)

删除自定义数据。

¶ 参数

userId <string> 用户 ID
key <string> 自定义字段的 key 。

¶ 示例

$userManagementClient->removeUdfValue('USER_ID', 'school');

¶ 删除用户

UsersManagementClient->delete(string $userId)

通过用户 ID 删除用户。删除用户会联级删除此用户管理的所有相关数据，无法恢复，请谨慎操作。

¶ 参数

userId <string> 用户 ID

¶ 示例

$message = $managementClient->users()->delete("userId");

¶ 批量删除用户

UsersManagementClient->deleteMany(array $userIds)

批量删除用户，如果传入了不存在的用户 ID，会提示错误。

¶ 参数

userIds <string[]> 用户 ID 列表

¶ 示例

$message = $managementClient->users()->deleteMany(
  ["userId"]
);

¶ 批量获取用户

UsersManagementClient->batch(array $identifiers, array $options)

通过 id、username、email、phone、email、externalId 批量获取用户详情。

¶ 参数

identifiers <string[]> 需要查询的数据列表，如用户 ID 列表
options <object>
- options.queryField <string> 列表类型，可选值为 'id' ,'username' ,'phone' ,'email', 'externalId'，默认为 'id'

¶ 示例

// 通过手机号、用户池、邮箱、ExternalId 批量查找用户 PHP SDK
$users = $userManageClient->batch(
  [
    'externalId',
    // id, username, email, phone -> queryField
  ], 
  [
    // 'queryField' => 'id',
    // 'queryField' => 'username',
    // 'queryField' => 'email',
    // 'queryField' => 'phone',
    'queryField' => 'externalId',
  ]
);

¶ 获取用户列表

UsersManagementClient->paginate(int $page = 1, int $limit = 10)

获取用户池用户列表

¶ 参数

page <number> 页码数, 从 1 开始默认值为 : 1。
limit <number> 每页包含的用户数默认值为 : 10。

¶ 示例

userManagementClient->paginate();

¶ 获取已归档用户列表

UsersManagementClient->listArchivedUsers(int $page = 1, int $limit = 10)

获取用户池已归档用户列表

¶ 参数

page <number> 页码数, 从 1 开始默认值为 : 1。
limit <number> 每页包含的用户数默认值为 : 10。

¶ 示例

$userManagementClient->listArchivedUsers();

¶ 示例数据

{
  "totalCount": 1,
  "list": [
    {
      "id": "604a12a261a85949c8ad0259",
      "arn": "arn:cn:authing:604a12a22d45ab775db56160:user:604a12a261a85949c8ad0259",
      "userPoolId": "604a12a22d45ab775db56160",
      "status": "Activated",
      "username": "test",
      "email": null,
      "emailVerified": false,
      "phone": null,
      "phoneVerified": false,
      "unionid": null,
      "openid": null,
      "nickname": null,
      "registerSource": ["unknown"],
      "photo": "https://files.authing.co/authing-console/default-user-avatar.png",
      "password": null,
      "oauth": null,
      "token": null,
      "tokenExpiredAt": null,
      "loginsCount": 0,
      "lastLogin": null,
      "lastIP": null,
      "signedUp": "2021-03-11T20:52:50+08:00",
      "blocked": false,
      "isDeleted": false,
      "device": null,
      "browser": null,
      "company": null,
      "name": null,
      "givenName": null,
      "familyName": null,
      "middleName": null,
      "profile": null,
      "preferredUsername": null,
      "website": null,
      "gender": "U",
      "birthdate": null,
      "zoneinfo": null,
      "locale": null,
      "address": null,
      "formatted": null,
      "streetAddress": null,
      "locality": null,
      "region": null,
      "postalCode": null,
      "city": null,
      "province": null,
      "country": null,
      "createdAt": "2021-03-11T20:52:50+08:00",
      "updatedAt": "2021-03-11T20:52:50+08:00",
      "externalId": null
    }
  ]
}

¶ 检查用户是否存在

UsersManagementClient->exists(array $options)

通过用户名、邮箱、手机号或者 ExternalId 检查用户是否存在。

¶ 参数

options <Object>
options.username <string> 用户名，区分大小写。
options.email <string> 邮箱，邮箱不区分大小写。
options.phone <string> 手机号

¶ 示例

$userManagementClient->exists(
  [
    'username' => 'bob',
  ]
)

¶ 查找用户

UsersManagementClient->find(array $options)

通过用户名、邮箱、手机号、externalId 查找用户

¶ 参数

options <Object>
options.username <string> 用户名，区分大小写。
options.email <string> 邮箱，邮箱不区分大小写。
options.phone <string> 手机号
options.externalId <string> External Id

¶ 示例

$client = new ManagementClient('USERPOOL_ID', 'USERPOOL_SERCET');

$client->requestToken();
$userManageClient = $client->users();

// 通过 ExternalID 查用户信息 PHP
$user = $userManageClient->find(
  [
    // 'username' => 'username',
    // 'email' => 'email',
    // 'phone' => 'phone',
    'externalId' => 'externalId',
  ]
);

¶ 示例数据

{
  "totalCount": 1,
  "list": [
    {
      "id": "604a12a261a85949c8ad0259",
      "arn": "arn:cn:authing:604a12a22d45ab775db56160:user:604a12a261a85949c8ad0259",
      "userPoolId": "604a12a22d45ab775db56160",
      "status": "Activated",
      "username": "test",
      "email": null,
      "emailVerified": false,
      "phone": null,
      "phoneVerified": false,
      "unionid": null,
      "openid": null,
      "nickname": null,
      "registerSource": ["unknown"],
      "photo": "https://files.authing.co/authing-console/default-user-avatar.png",
      "password": null,
      "oauth": null,
      "token": null,
      "tokenExpiredAt": null,
      "loginsCount": 0,
      "lastLogin": null,
      "lastIP": null,
      "signedUp": "2021-03-11T20:52:50+08:00",
      "blocked": false,
      "isDeleted": false,
      "device": null,
      "browser": null,
      "company": null,
      "name": null,
      "givenName": null,
      "familyName": null,
      "middleName": null,
      "profile": null,
      "preferredUsername": null,
      "website": null,
      "gender": "U",
      "birthdate": null,
      "zoneinfo": null,
      "locale": null,
      "address": null,
      "formatted": null,
      "streetAddress": null,
      "locality": null,
      "region": null,
      "postalCode": null,
      "city": null,
      "province": null,
      "country": null,
      "createdAt": "2021-03-11T20:52:50+08:00",
      "updatedAt": "2021-03-11T20:52:50+08:00",
      "externalId": null
    }
  ]
}

¶ 搜索用户

UsersManagementClient->search($query, array $options, int page = 1, int limit = 10)

根据关键字根据关键字模糊搜索用户，该接口为分页接口。模糊搜索用户。

¶ 参数

query <null> 搜索内容
options <string[]> 选项
options.fields <string[]> 搜索用户字段，如果不指定，默认会从 username、nickname、email、phone、company、name、givenName、familyName、middleName、profile、preferredUsername 这些字段进行模糊搜索。如果你需要精确查找，请使用 find 方法。
page <number> 默认值为 : 1。
limit <number> 默认值为 : 10。

¶ 示例

$users = $managementClient->users()->search("query");

¶ 强制下线一批用户

UsersManagementClient->kick(array $userIds)

强制让一批用户在 Authing 下线。

¶ 参数

userIds <string[]> 用户 ID 数组

¶ 示例

$userManagementClient->kick(
  ['USER_ID1', 'USER_ID2']
);

¶ 示例数据

{ "code": 200, "message": "强制下线成功" }

¶ 检测密码是否合法

ManagementClient->isPasswordValid(string $password)

检测密码是否合法

¶ 参数

isPasswordValid <string> 要检测的密码

¶ 示例

use Authing\Mgmt\ManagementClient;

$management = new ManagementClient("AUTHING_USERPOOL_ID", "AUTHING_USERPOOL_SECRET");
// 获取管理员权限
$management->requestToken();
$password = 'php@-isok+_?';
// 检测 token 的最新状态，能够获取到该用户对应的 token
$management.isPasswordValid($password);

¶ 通过用户 ID 查找用户所在分组

UsersManagementClient->listGroups(string $userId)

获取用户的分组列表

¶ 参数

userId <string> 用户 ID

¶ 示例

$list = $managementClient->users()->listGroups("userId");

¶ 加入分组

UsersManagementClient->addGroup(string $userId, string $group)

将用户加入分组

¶ 参数

userId <string> 用户 ID
group <string> 分组 code

¶ 示例

$managementClient->users()->addGroup("userId", "group code");

¶ 退出分组

UsersManagementClient->removeGroup(string $userId, string $group)

退出分组

¶ 参数

userId <string> 用户 ID
group <string> 分组 code

¶ 示例

$managementClient->users()->removeGroup("userId", "group code");

¶ 获取用户角色列表

UsersManagementClient->listRoles(string $userId)

获取用户的角色列表

¶ 参数

userId <string> 用户 ID

¶ 示例

$roles = $managementClient->users()->listRoles("userId");

¶ 添加角色

UsersManagementClient->addRoles(string $userId, array $roles)

将用户加入角色

¶ 参数

userId <string> 用户 ID
roles <string []> 角色 code 列表

¶ 示例

$managementClient->users()->addRoles(
  "userId", 
  ["role code"]
);

¶ 移除角色

UsersManagementClient->removeRoles(string $userId, array $roles)

将用户从角色中移除

¶ 参数

userId <string> 用户 ID
roles <string> 角色 code 列表

¶ 示例

$message = $managementClient->users()->removeRoles(
  "userId", 
  ["role code"]
);

¶ 判断用户是否有某个角色

UsersManagementClient->hasRole(string $userId, string $roleCode, string $namespace)

判断用户是否有某个角色

¶ 参数

userId <string> 用户 ID；
roleCode <string> 角色 Code；
namespace <string> 权限分组的 code，详情请见使用权限分组管理权限资源。

¶ 示例

$namespace = 'code';
$roleCode = 'roleCode';
$usersManagementClient->hasRole('USERID', $roleCode, $namespace);

¶ 示例数据

true

¶ 获取用户被授权的所有资源列表

UsersManagementClient->listAuthorizedResources(string $userId, string $namespace, array opts = [])

获取一个用户被授权的所有资源，用户被授权的所有资源里面包括从角色、分组、组织机构继承的资源。

¶ 参数

userId <string> 用户 ID；
namespace <string> 权限分组的 code，详情请见使用权限分组管理权限资源；
options <array> 配置数组
options.resourceType <string> 可选，资源类型，默认会返回所有有权限的资源，现有资源类型如下：
- DATA: 数据类型；
- API: API 类型数据；
- MENU: 菜单类型数据；
- BUTTON: 按钮类型数据。

¶ 示例

use Authing\Mgmt\RolesManagementClient;
use Authing\Mgmt\UsersManagementClient;

$managementClient = new ManagementClient('USERPOOL_ID', 'SECRET');
$managementClient->requestToken();

$userManagementClient = new UsersManagementClient($managementClient);

$data = $userManagementClient->listAuthorizedResources('userId', "default");

¶ 示例数据

type 为资源类型；
code: 资源描述符，如果是 DATA 类型资源，格式为 resourceType:resourceId，如 books:* 表示所有书籍，books:1 表示 ID 为 1 的书籍。
actions: 用户被授权对该资源的操作。

{
  "totalCount": 12,
  "list": [
    {
      "code": "menu_a",
      "type": "MENU"
    },
    {
      "code": "menu_b",
      "type": "MENU"
    },
    {
      "code": "books:1",
      "type": "DATA",
      "actions": ["books:delete", "books:update"]
    }
  ]
}

¶ 获取审计日志列表

UsersManagementClient->listArchivedUsers(int $page = 1, int $limit = 10)

审计日志列表

¶ 参数

page <number> 页码数, 从 1 开始默认值为 : 1, 可选值。
limit <number> 每页包含的用户数默认值为 : 10, 可选值。

¶ 示例

$usersManagementClient->listArchivedUsers([
  'page' => 1,
  'limit' => 10,
])

上一篇: 多因素认证模块下一篇: 管理应用

本文是否有解决您的问题？

如果遇到其他问题，你可以在 authing-chat/community 联系我们。