Help Center/ OneAccess/ API Reference/ OneAccess APIs/ Management APIs/ Organization Management/ Modifying an Organization
Updated on 2024-12-30 GMT+08:00
View PDF
Share

Modifying an Organization

Function

This API is used to modify a specified organization.

Constraints

null

URI

PUT /api/v2/tenant/organizations/{org_id}

Table 1 Path Parameters

Parameter

Mandatory

Type

Description

org_id

Yes

String

Organization ID.

Request Parameters

Table 2 Request header parameters

Parameter

Mandatory

Type

Description

Content-Type

Yes

String

Set this field to "application/json;charset=utf8".

Authorization

Yes

String

Authentication credential. The value is "Bearer {access_token}". access_token is obtained by calling the API for obtaining an access credential.
Table 3 Request body parameters

Parameter

Mandatory

Type

Description

code

No

String

Organization code. If this parameter is left empty, the organization code is not changed by default. The value can contain letters, digits, underscores (_), and hyphens (-).

name

No

String

Organization name. If this parameter is left empty, the organization name is not changed by default. The value can contain letters, digits, spaces, hyphens (-), underscores (_), and ampersands (&).

parent_id

No

String

Parent organization ID.

category

No

String

Organization type.

Response Parameters

Status code: 200

Table 4 Response body parameters

Parameter

Type

Description

org_id

String

Organization ID.

Status code: 400

Table 5 Response body parameters

Parameter

Type

Description

error_code

String

Error code.

error_msg

String

Error details.

Example Requests

Modify organization information. Organization code: TestOrg; organization name: testing organization; parent organization: root organization; organization type: department.

PUT https://{domain_name}/api/v2/tenant/organizations/{org_id}

Authorization: Bearer 334963fc-1e4a-473b-9096-52a929140...

{
    "code": "TestOrg",
    "name": "testing organization",
    "parent_id": "",
    "category": "department"
}

Example Responses

Status code: 200

Request successful.

{
  "org_id" : "20210623103509267-6ABA-201FFC..."
}

Status Codes

Status Code

Description

200

Request successful.

400

Invalid parameter.

Error Codes

See Error Codes.

Parent topic: Organization Management