¶ 设置用户所在部门
更新时间: 2024-10-10 07:28:40
通过用户 ID,设置用户所在部门,可以选择指定用户 ID 类型等。
¶ 请求参数
名称 | 类型 | 必填 | 默认值 | 描述 | 示例值 |
---|---|---|---|---|---|
departments | SetUserDepartmentDto[] | 是 | - | 部门信息。 | [{"departmentId":"60b49eb83fd80adb96f26e68","isLeader":true,"isMainDepartment":true}] |
userId | string | 是 | - | 用户 ID。 | 6229ffaxxxxxxxxcade3e3d9 |
options | SetUserDepartmentsOptionsDto | 否 | - | 可选参数。 |
¶ 示例代码
import { ManagementClient } from 'authing-node-sdk';
// 在 Node.js 中引用:
// const { ManagementClient } = require('authing-node-sdk');
const managementClient = new ManagementClient({
accessKeyId: 'AUTHING_USERPOOL_ID',
accessKeySecret: 'AUTHING_USERPOOL_SECRET',
});
(async () => {
const result = await managementClient.setUserDepartments({
userId: '6229ffaxxxxxxxxcade3e3d9',
departments: [{
departmentId: '60b49eb83fd80adb96f26e68',
isLeader: true,
isMainDepartment: true,
}],
options: {
userIdType: 'user_id',
},
});
})();
¶ 请求响应
类型: IsSuccessRespDto
名称 | 类型 | 描述 |
---|---|---|
statusCode | number | 业务状态码,可以通过此状态码判断操作是否成功,200 表示成功。 |
message | string | 描述信息 |
apiCode | number | 细分错误码,可通过此错误码得到具体的错误类型。 |
data | IsSuccessDto | 操作是否成功 |
示例结果:
{
"statusCode": 200,
"message": "操作成功",
"apiCode": 20001,
"data": {
"success": true
}
}
¶ 数据结构
¶ SetUserDepartmentDto
名称 | 类型 | 必填 | 描述 |
---|---|---|---|
departmentId | string | 是 | 部门 id。 示例值: 60b49eb83fd80adb96f26e68 |
isLeader | boolean | 否 | 是否是部门 leader。 示例值: true |
isMainDepartment | boolean | 否 | 是否是主部门。 示例值: true |
¶ SetUserDepartmentsOptionsDto
名称 | 类型 | 必填 | 描述 |
---|---|---|---|
userIdType | string | 否 | 用户 ID 类型,可以指定为用户 ID、手机号、邮箱、用户名和 externalId。。 枚举值:user_id ,external_id ,phone ,email ,username |
¶ IsSuccessDto
名称 | 类型 | 必填 | 描述 |
---|---|---|---|
success | boolean | 是 | 操作是否成功。 示例值: true |