¶ 创建顶层组织机构

更新时间: 2024-10-10 07:28:40

创建组织机构，会创建一个只有一个节点的组织机构，可以选择组织描述信息、根节点自定义 ID、多语言等。

¶ 请求参数

名称	类型	必填	默认值	描述	示例值
organizationName	string	是	-	组织名称。	`蒸汽记忆`
organizationCode	string	是	-	组织 code。	`steamory`
description	string	否	-	组织描述信息。	`组织描述信息`
openDepartmentId	string	否	-	根节点自定义 ID。	`60b49eb83fd80adb96f26e68`
i18n	OrganizationNameI18nDto	否	-	多语言设置。	`{"organizationName":{"zh-CN":{"enabled":false,"value":"中文"},"en-US":{"enabled":false,"value":"English"}}}`

¶ 示例代码

from authing import ManagementClient

management_client = ManagementClient(
    access_key_id="AUTHING_USERPOOL_ID",
    access_key_secret="AUTHING_USERPOOL_SECRET",
)

data = management_client.create_organization(
     organization_code: "steamory",
     organization_name: "蒸汽记忆",
     description: "组织描述信息",
     open_department_id: "60b49eb83fd80adb96f26e68",
     i18n: {
         organization_name: {
         zh-_c_n: {
         enabled: false,
       value: false,
    },
       en-_u_s: {
         enabled: false,
       value: false,
    },
    },
    },
  
)

¶ 请求响应

类型： OrganizationSingleRespDto

名称	类型	描述
statusCode	number	业务状态码，可以通过此状态码判断操作是否成功，200 表示成功。
message	string	描述信息
apiCode	number	细分错误码，可通过此错误码得到具体的错误类型。
data	OrganizationDto	响应数据

示例结果：

{
  "statusCode": 200,
  "message": "操作成功",
  "apiCode": 20001,
  "data": {
    "organizationCode": "steamory",
    "organizationName": "蒸汽记忆",
    "description": "组织描述信息",
    "departmentId": "60b49eb83fd80adb96f26e68",
    "openDepartmentId": "60b49eb83fd80adb96f26e68",
    "hasChildren": true,
    "leaderUserIds": "[\"60b49eb83fd80adb96f26e68\"]",
    "membersCount": 150,
    "i18n": {
      "organizationName": {
        "zh-CN": {
          "enabled": false,
          "value": "中文"
        },
        "en-US": {
          "enabled": false,
          "value": "English"
        }
      }
    }
  }
}

¶ 数据结构

¶ OrganizationNameI18nDto

名称	类型	必填	描述
organizationName	是	支持多语言的字段。嵌套类型：LangObject。示例值： `[object Object]`

¶ LangObject

名称	类型	必填	描述
zh-CN	是	多语言的中文内容。嵌套类型：LangUnit。示例值： `[object Object]`
en-US	是	多语言的英文内容。嵌套类型：LangUnit。示例值： `[object Object]`

¶ LangUnit

名称	类型	必填	描述
enabled	boolean	是	是否已开启。若开启，且控制台选择该语言，则展示该内容。（默认关闭）。
value	boolean	是	多语言内容。

¶ OrganizationDto

名称	类型	必填	描述
organizationCode	string	是	组织 code。示例值： `steamory`
organizationName	string	是	组织名称。示例值： `蒸汽记忆`
description	string	否	组织描述信息。示例值： `组织描述信息`
departmentId	string	是	根节点 ID。示例值： `60b49eb83fd80adb96f26e68`
openDepartmentId	string	否	根节点自定义 ID。示例值： `60b49eb83fd80adb96f26e68`
hasChildren	boolean	是	是否包含子节点。示例值： `true`
leaderUserIds	array	否	部门负责人 ID。示例值： `["60b49eb83fd80adb96f26e68"]`
membersCount	number	是	部门人数。示例值： `150`
isVirtualNode	boolean	是	是否是虚拟部门。
i18n	否	多语言设置。嵌套类型：OrganizationNameI18nDto。示例值： `[object Object]`

¶ OrganizationNameI18nDto

名称	类型	必填	描述
organizationName	是	支持多语言的字段。嵌套类型：LangObject。示例值： `[object Object]`

¶ LangObject

名称	类型	必填	描述
zh-CN	是	多语言的中文内容。嵌套类型：LangUnit。示例值： `[object Object]`
en-US	是	多语言的英文内容。嵌套类型：LangUnit。示例值： `[object Object]`

¶ LangUnit

名称	类型	必填	描述
enabled	boolean	是	是否已开启。若开启，且控制台选择该语言，则展示该内容。（默认关闭）。
value	boolean	是	多语言内容。

上一篇: 获取顶层组织机构列表下一篇: 修改顶层组织机构