修改部门
更新时间: 2024-10-10 07:28:40
通过组织 code、部门 ID,修改部门,可以设置多种参数。
请求参数
名称 | 类型 | 必填 | 默认值 | 描述 | 示例值 |
---|
departmentId | string | 是 | - | 部门系统 ID(为 Authing 系统自动生成,不可修改)。 | 60b49eb83fd80adb96f26e68 |
organizationCode | string | 是 | - | 组织 Code(organizationCode)。 | steamory |
leaderUserIds | array[] | 否 | - | 部门负责人 ID。 | ["60b49eb83fd80adb96f26e68"] |
description | string | 否 | - | 部门描述。 | 技术研发部门 |
code | string | 否 | - | 部门识别码。 | 6229c4deb3e4d8a20b6021ff |
i18n | I18nDto | 否 | - | 多语言设置。 | {"name":{"zh-CN":{"enabled":false,"value":"中文"},"en-US":{"enabled":false,"value":"English"}}} |
name | string | 否 | - | 部门名称。 | 开发部 |
departmentIdType | string | 否 | department_id | 此次调用中使用的部门 ID 的类型。 枚举值:department_id ,open_department_id | department_id |
parentDepartmentId | string | 否 | - | 父部门 ID。 | 6229c4deb3e4d8a20b6021ff |
customData | object | 否 | - | 自定义数据,传入的对象中的 key 必须先在用户池定义相关自定义字段。 | {"icon":"https://example.com/icon"} |
示例代码
请求响应
类型: DepartmentSingleRespDto
名称 | 类型 | 描述 |
---|
statusCode | number | 业务状态码,可以通过此状态码判断操作是否成功,200 表示成功。 |
message | string | 描述信息 |
apiCode | number | 细分错误码,可通过此错误码得到具体的错误类型。 |
data | DepartmentDto | 响应数据 |
示例结果:
数据结构
I18nDto
名称 | 类型 | 必填 | 描述 |
---|
name | 是 | 支持多语言的字段。嵌套类型:LangObject。 示例值: [object Object] |
LangObject
名称 | 类型 | 必填 | 描述 |
---|
zh-CN | 是 | 多语言的中文内容。嵌套类型:LangUnit。 示例值: [object Object] |
en-US | 是 | 多语言的英文内容。嵌套类型:LangUnit。 示例值: [object Object] |
LangUnit
名称 | 类型 | 必填 | 描述 |
---|
enabled | boolean | 是 | 是否已开启。若开启,且控制台选择该语言,则展示该内容。(默认关闭)。 |
value | boolean | 是 | 多语言内容。 |
DepartmentDto
名称 | 类型 | 必填 | 描述 |
---|
organizationCode | string | 是 | 组织 Code(organizationCode)。 示例值: steamory |
departmentId | string | 是 | 部门系统 ID(为 Authing 系统自动生成,不可修改)。 示例值: 60b49eb83fd80adb96f26e68 |
createdAt | string | 是 | 部门创建时间。 示例值: 2022-07-03T02:20:30.000Z |
openDepartmentId | string | 否 | 自定义部门 ID,用于存储自定义的 ID。 示例值: ou_7dab8a3d3cdccxxxxxx777c7ad535d62 |
name | string | 是 | 部门名称。 示例值: 开发部 |
leaderUserIds | array | 否 | 部门负责人 ID。 示例值: ["60b49eb83fd80adb96f26e68"] |
description | string | 否 | 部门描述。 示例值: 技术研发部门 |
parentDepartmentId | string | 是 | 父部门 id。 示例值: 6229c4deb3e4d8a20b6021ff |
code | string | 否 | 部门识别码。 示例值: 6229c4deb3e4d8a20b6021ff |
membersCount | number | 是 | 部门人数(仅包含直属成员)。 示例值: 11 |
hasChildren | boolean | 是 | 是否包含子部门。 示例值: true |
isVirtualNode | boolean | 否 | 是否是虚拟部门。 |
i18n | 否 | 多语言设置。嵌套类型:I18nDto。 示例值: [object Object] |
customData | object | 否 | 部门的扩展字段数据。 示例值: [object Object] |
I18nDto
名称 | 类型 | 必填 | 描述 |
---|
name | 是 | 支持多语言的字段。嵌套类型:LangObject。 示例值: [object Object] |
LangObject
名称 | 类型 | 必填 | 描述 |
---|
zh-CN | 是 | 多语言的中文内容。嵌套类型:LangUnit。 示例值: [object Object] |
en-US | 是 | 多语言的英文内容。嵌套类型:LangUnit。 示例值: [object Object] |
LangUnit
名称 | 类型 | 必填 | 描述 |
---|
enabled | boolean | 是 | 是否已开启。若开启,且控制台选择该语言,则展示该内容。(默认关闭)。 |
value | boolean | 是 | 多语言内容。 |