¶ Create a department

Update time: 2025-07-23 07:34:21

This document is automatically generated based on https://github.com/authing/authing-docs-factory based on https://api-explorer.genauth.ai V3 API, and is consistent with API parameters and return results. If this document description is incorrect, please refer to V3 API.

Create a department by organization code, department name, parent department ID, and set various parameters.

¶ Method name

ManagementClient.create_department

¶ Request parameters

Name	Type	Is it required?	Default value	Description	Sample value
metadata	object	Yes	-	Metadata information
parentDepartmentId	string	Yes	-	Parent department id. If it is the root department, pass root	`6229c4deb3e4d8a20b6021ff`
name	string	Yes	-	Department name	`Development Department`
organizationCode	string	Yes	-	Organization Code (organizationCode)	`steamory`
openDepartmentId	string	no	-	Custom department ID, used to store custom IDs	`ou_7dab8a3d3cdccxxxxxx777c7ad535d62`
description	string	no	-	Department description	`Technical R&D Department`
code	string	no	-	Department identification code	`6229c4deb3e4d8a20b6021ff`
isVirtualNode	boolean	no	-	Is it a virtual department?
i18n	DepartmentI18nDto	no	-	Multi-language settings	`{"name":{"zh-CN":{"enabled":false,"value":"中文"},"en-US":{"enabled":false,"value":"English"}}}`
customData	object	No	-	Extended field data of department	`{"icon":"https://example.com/logo"}`
departmentIdType	string	No	department_id	The type of the parent department ID used in this call	`department_id`
postIdList	string[]	No	-	Post id list	`["xxx"]`
tenantId	string	No	-	Tenant ID	`623c20b2a062aaaaf41b17da`

¶ Request Response

Type: DepartmentSingleRespDto

Name	Type	Description
statusCode	number	Business status code, which can be used to determine whether the operation is successful. 200 means success.
message	string	Description
apiCode	number	Segmented error code, which can be used to get the specific error type (successful request does not return). For a detailed list of error codes, please see: API Code List (opens new window)
requestId	string	Request ID. Returned when the request fails.
data	DepartmentDto	Response data

Example results:

{
  "statusCode": 200,
  "message": "Success",
  "requestId": "934108e5-9fbf-4d24-8da1-c330328abd6c",
  "data": {
    "organizationCode": "steamory",
    "departmentId": "60b49eb83fd80adb96f26e68",
    "createdAt": "2022-07-03T03:20:30.000Z",
    "updatedAt": "2022-07-03T03:20:30.000Z",
    "openDepartmentId": "ou_7dab8a3d3cdccxxxxxx777c7ad535d62",
    "name": "RD",
    "leaderUserIds": "[\"60b49eb83fd80adb96f26e68\"]",
    "description": "RD Desc",
    "parentDepartmentId": "6229c4deb3e4d8a20b6021ff",
    "code": "6229c4deb3e4d8a20b6021ff",
    "parentDepartmentCode": "test",
    "membersCount": 11,
    "hasChildren": true,
    "i18n": {
      "name": {
        "zh-CN": {
          "enabled": false,
          "value": "中文"
        },
        "en-US": {
          "enabled": false,
          "value": "English"
        }
      }
    },
    "customData": {
      "icon": "https://example.com/logo"
    },
    "postIdList": "[\"xxx\"]",
    "status": "false",
    "allow": "[\"xxx\"]"
  }
}

¶ Data Structure

¶ DepartmentI18nDto

Name	Type	Is it required?	Description	Sample value
name	Yes	Multi-language-supported fields Nested type: LangObject.	`{"zh-CN":{"enabled":false,"value":"中文"},"en-US":{"enabled":false,"value":"English"}}`

¶ LangObject

Name	Type	Is it required?	Description
zh-CN	Yes	Multilingual Chinese content Nested type: LangUnit.	`{"enabled":false,"value":"中文"}`
en-US	Yes	Multilingual English content Nested type: LangUnit.	`{"enabled":false,"value":"English"}`
zh-TW	Yes	Multilingual Traditional Chinese content Nesting type: LangUnit.	`{"enabled":false,"value":"繁體中文"}`
ja-JP	Yes	Multilingual Japanese content Nesting type: LangUnit.	`{"enabled":false,"value":"日本語"}`

¶ LangUnit

Name	Type	Is it required?	Description	Sample value
enabled	boolean	yes	Whether it is enabled. If enabled, and the console selects this language, the content will be displayed. (Closed by default)
value	string	yes	Multilingual content

¶ DepartmentDto

Name	Type	Is it required?	Description	Sample value
organizationCode	string	yes	Organization Code (organizationCode)	`steamory`
departmentId	string	yes	Department system ID (automatically generated by the GenAuth system, cannot be modified)	`60b49eb83fd80adb96f26e68`
createdAt	string	yes	Department creation time	`2022-07-03T03:20:30.000Z`
updatedAt	string	no	modification time	`2022-07-03T03:20:30.000Z`
openDepartmentId	string	no	custom department ID, used to store custom IDs	`ou_7dab8a3d3cdccxxxxxx777c7ad535d62`
name	string	yes	department name	`Development Department`
leaderUserIds	array	no	department head ID	`["60b49eb83fd80adb96f26e68"]`
description	string	no	department description	`Technical R&D Department`
parentDepartmentId	string	yes	parent department ID, if it is a root department, pass root	`6229c4deb3e4d8a20b6021ff`
code	string	No	Department ID	`6229c4deb3e4d8a20b6021ff`
parentDepartmentCode	string	yes	Parent department code	`test`
membersCount	number	yes	Number of department members (only direct members)	`11`
hasChildren	boolean	yes	Whether to include child departments	`true`
isVirtualNode	boolean	no	Whether it is a virtual department
i18n	no	Multi-language settings Nested type: DepartmentI18nDto.	`{"name":{"zh-CN":{"enabled":false,"value":"中文"},"en-US":{"enabled":false,"value":"English"}}}`
customData	object	No	Extended field data of department	`{"icon":"https://example.com/logo"}`
posts	array	No	Positions associated with department
postIdList	array	No	Position id list	`["xxx"]`
status	boolean	No	Department status	`false`
allow	string	No	Access restriction	`["xxx"]`

¶ DepartmentI18nDto

Name	Type	Is it required?	Description	Sample value
name	Yes	Multi-language supported fields Nested type: LangObject.	`{"zh-CN":{"enabled":false,"value":"中文"},"en-US":{"enabled":false,"value":"English"}}`

¶ LangObject

Name	Type	Required	Description
zh-CN	Yes	Multilingual Chinese content Nested type: LangUnit.	`{"enabled":false,"value":"中文"}`
en-US	Yes	Multilingual English content Nested type: LangUnit.	`{"enabled":false,"value":"English"}`
zh-TW	Yes	Multilingual Traditional Chinese content Nested type: LangUnit.	`{"enabled":false,"value":"繁體中文"}`
ja-JP	Yes	Multilingual Japanese content Nested type: LangUnit.	`{"enabled":false,"value":"日本語"}`

¶ LangUnit

Name	Type	Is it required?	Description	Sample value
enabled	boolean	Yes	Whether it is enabled. If enabled, and the console selects this language, the content will be displayed. (Default is off)
value	string	Yes	Multilingual content

Previous article: Get Department Info Next article: Update Department