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

Adding an Application Organization

Function

This API is used to add an application organization.

Constraints

null

URI

POST /api/v2/tenant/applications/{application_id}/organizations

Table 1 Path Parameters

Parameter

Mandatory

Type

Description

application_id

Yes

String

Application 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

org_code

Yes

String

Application organization code. The value can contain letters, digits, underscores (_), and hyphens (-).

name

Yes

String

Application organization name. The value can contain letters, digits, spaces, hyphens (-), underscores (_), and ampersands (&).

parent_id

No

String

This parameter needs to be transferred only when creating an application suborganization.

Response Parameters

Status code: 201

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

  • Add a root organization. Organization code: 10000; organization name: headquarter.

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

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

{
  "org_code": "10000",
  "name": "headquarter",
  "parent_id": ""
}

  • Add a suborganization. Organization code: 10001; organization name: development group; parent organization ID: 20210623103520050-C5AF-DD1A97...

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

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

{
  "org_code": "10001",
  "name": "development group",
  "parent_id": "20210623103520050-C5AF-DD1A97..."
}

Example Responses

Status code: 201

Request successful.

{
  "org_id" : "20210623103520050-C5AF-DD1A97..."
}

Status Codes

Status Code

Description

201

Request successful.

400

Invalid parameter.

Error Codes

See Error Codes.