创建组织单元 - CreateOrganizationalUnit
功能介绍
在根或父组织单元中创建组织单元。组织单元是账号的容器,使您能够对账号进行分组管理,并根据业务要求应用策略。此操作只能由组织的管理账号调用。
调试
您可以在API Explorer中调试该接口,支持自动认证鉴权。API Explorer可以自动生成SDK代码示例,并提供SDK代码示例调试功能。
授权信息
账号具备所有API的调用权限,如果使用账号下的IAM用户调用当前API,该IAM用户需具备调用API所需的权限。
- 如果使用角色与策略授权,具体权限要求请参见权限和授权项。
- 如果使用身份策略授权,需具备如下身份策略权限。
URI
POST /v1/organizations/organizational-units
请求参数
| 参数 | 是否必选 | 参数类型 | 描述 |
|---|---|---|---|
| X-Security-Token | 否 | String | 参数解释: 如果正在使用临时安全凭据,则此 header 是必需的,该值是临时安全凭据的安全令牌(会话令牌)。 约束限制: 不涉及 取值范围: 最小长度0、最大长度32768。 默认取值: 无默认值 |
| 参数 | 是否必选 | 参数类型 | 描述 |
|---|---|---|---|
| name | 是 | String | 参数解释: 要分配给新组织单元的名称。 约束限制: 必填字段 取值范围: 符合正则表达式:^[\u4e00-\u9fa5a-zA-Z0-9_- ]+$ 最小长度1、最大长度64。 默认取值: 无默认值 |
| parent_id | 是 | String | 参数解释: 要在其中创建新组织单元的根或组织单元的唯一标识符。 约束限制: 必填字段 取值范围: 符合正则表达式:^(?:r-[0-9a-z]{4,32}|ou-[0-9a-z]{8,32})$ 最大长度100。 默认取值: 无默认值 |
| tags | 否 | Array of TagDto objects | 参数解释: 要附加到新创建的组织单元的标签列表。 约束限制: 不涉及 取值范围: 最少0个、最多200个。 默认取值: 无默认值 |
| 参数 | 是否必选 | 参数类型 | 描述 |
|---|---|---|---|
| key | 是 | String | 参数解释: 标签键的密钥标识符或名称。 约束限制: 必填字段 取值范围: 符合正则表达式:^((?!sys|\s)[\p{L}\p{Z}\p{N}.:=+-@]*[\p{L}\p{N}.:=+-@])$ 最小长度1、最大长度128。 默认取值: 无 |
| value | 是 | String | 参数解释: 与标签键关联的字符串值。您可以将标签的值设置为空字符串,但不能将标签的值设置为NULL。 约束限制: 必填字段 取值范围: 符合正则表达式:^([\p{L}\p{Z}\p{N}_.:/=+-@]*)$ 最小长度0、最大长度255。 默认取值: 无 |
响应参数
状态码:201
| 参数 | 参数类型 | 描述 |
|---|---|---|
| organizational_unit | OrganizationalUnitDto object | 参数解释: 组织单元的详细信息。 约束限制: 必填字段 取值范围: 不涉及 默认取值: 无默认值 |
| 参数 | 参数类型 | 描述 |
|---|---|---|
| id | String | 参数解释: 与组织单元关联的唯一标识符(ID)。 约束限制: 必填字段 取值范围: 符合正则表达式:^ou-[0-9a-z]{8,32}$ 最小长度1、最大长度35。 默认取值: 无默认值 |
| urn | String | 参数解释: 组织单元的统一资源名称。 约束限制: 必填字段 取值范围: 最小长度1、最大长度1500。 默认取值: 无默认值 |
| name | String | 参数解释: 组织单元的名称。 约束限制: 必填字段 取值范围: 符合正则表达式:^[\u4e00-\u9fa5a-zA-Z0-9_- ]+$ 最小长度1、最大长度64。 默认取值: 无默认值 |
| created_at | String | 参数解释: 组织单元的创建时间。 约束限制: 必填字段 取值范围: 符合ISO 8601日期时间格式。 默认取值: 无默认值 |
请求示例
创建组织单元
POST https://{endpoint}/v1/organizations/organizational-units
{
"name" : "autoOU0923152728692gqQc",
"parent_id" : "ou-kz0blhbszb6w9a2lzb",
"tags" : [ {
"key" : "keystring",
"value" : "keystring"
} ]
} 响应示例
状态码:201
Successful
{
"organizational_unit" : {
"id" : "ou-fi0rv9jbjgc6nifokh65jjo8c24fnujv",
"urn" : "organizations::0a6d25d23900d45c0faac010e0fb4de0:ou:o-fhkmi6mek7wlqdp6nideqhb47qwtjdsv/ou-fi0rv9jbjgc6nifokh65jjo8c24fnujv",
"name" : "autoOU0923152728692gqQc",
"created_at" : "2022-09-23T07:27:28Z"
}
} 状态码
| 状态码 | 描述 |
|---|---|
| 201 | Successful |
错误码
请参见错误码。