修改组织
功能介绍
修改指定组织。
接口约束
无
URI
PUT /api/v2/tenant/organizations/{org_id}
|
参数 |
是否必选 |
参数类型 |
描述 |
|---|---|---|---|
|
org_id |
是 |
String |
组织id。 |
请求参数
|
参数 |
是否必选 |
参数类型 |
描述 |
|---|---|---|---|
|
Content-Type |
是 |
String |
该字段内容填为“application/json;charset=utf8”。 |
|
Authorization |
是 |
String |
认证凭据,值:Bearer {access_token},access_token通过“获取访问凭据”接口获取。 |
|
参数 |
是否必选 |
参数类型 |
描述 |
|---|---|---|---|
|
code |
否 |
String |
组织编码,组织编码为空时默认不修改,可输入中英文、数字、下划线和中划线。 最大长度:64 |
|
name |
否 |
String |
组织名称,组织名称为空时默认不修改,可输入中英文、数字、空格、中划线、下划线和&。 最大长度:100 |
|
parent_id |
否 |
String |
父组织id。 |
|
category |
否 |
String |
组织类型。 缺省值:department:部门 枚举值:
|
响应参数
状态码: 200
|
参数 |
参数类型 |
描述 |
|---|---|---|
|
org_id |
String |
组织ID。 |
状态码: 400
|
参数 |
参数类型 |
描述 |
|---|---|---|
|
error_code |
String |
错误编号。 |
|
error_msg |
String |
错误详情。 |
请求示例
修改组织信息,组织编码为TestOrg,组织名为测试机构,父组织为根组织,组织类型为部门。
PUT https://{domain_name}/api/v2/tenant/organizations/{org_id}
Authorization: Bearer 334963fc-1e4a-473b-9096-52a929140...
{
"code": "TestOrg",
"name": "测试机构",
"parent_id": "",
"category": "department"
}
响应示例
状态码: 200
请求成功。
{
"org_id" : "20210623103509267-6ABA-201FFC..."
}
状态码
|
状态码 |
描述 |
|---|---|
|
200 |
请求成功。 |
|
400 |
参数无效。 |
错误码
请参见错误码。