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

Creating an Organization

Function

This API is used to create an organization.

Constraints

null

URI

POST /api/v2/tenant/organizations

Request Parameters

Table 1 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 2 Request body parameters

Parameter

Mandatory

Type

Description

code

Yes

String

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

name

Yes

String

Organization name, which is unique at the level. The value can contain letters, digits, spaces, hyphens (-), underscores (_), and ampersands (&).

parent_id

No

String

Parent organization ID. This parameter needs to be transferred only when a sub-organization is created.

category

No

String

Organization type.

Response Parameters

Status code: 201

Table 3 Response body parameters

Parameter

Type

Description

org_id

String

Organization ID.

Status code: 400

Table 4 Response body parameters

Parameter

Type

Description

error_code

String

Error code.

error_msg

String

Error details.

Example Requests

Create an organization. Organization name: subdepartment; organization code: 1000001; parent organization code: 20210623103509267-6ABA-201FFC...; organization type: department.

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

Authorization: Bearer 334963fc-1e4a-473b-9096-52a929140...
{
  	 "code": "1000001",
	 "name": "subdepartment",
	 "parent_id": "20210623103509267-6ABA-201FFC...",
        "category": "department"
}

Example Responses

Status code: 201

Creation successful.

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

Status Codes

Status Code

Description

201

Creation successful.

400

Invalid parameter.

Error Codes

See Error Codes.

Parent topic: Organization Management