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

Modifying an Application Organization

Function

This API is used to modify an application organization.

Constraints

null

URI

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

Table 1 Path Parameters

Parameter

Mandatory

Type

Description

application_id

Yes

String

Application ID.

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

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.

Response Parameters

Status code: 200

Table 4 Response body parameters

Parameter

Type

Description

org_id

String

Application 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 an organization attribute based on the application ID and organization ID. Name: development group; parent organization ID: 20201027162527852-B712-D040F4...

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

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

{
  "name": "development group",
  "parent_id": "20201027162527852-B712-D040F4..."
}

Example Responses

Status code: 200

Request successful.

{
  "org_id" : "20210623103520050-C5AF-DD1A9770E"
}

Status Codes

Status Code

Description

200

Request successful.

400

Invalid parameter.

Error Codes

See Error Codes.