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

Querying Application Organization Details

Function

This API is used to query application organization details.

Constraints

null

URI

GET /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

Application organization ID.

Request Parameters

Table 2 Request header parameters

Parameter

Mandatory

Type

Description

Authorization

Yes

String

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

Response Parameters

Status code: 200

Table 3 Response body parameters

Parameter

Type

Description

org_id

String

Application organization ID.

org_code

String

Application organization code.

name

String

Application organization name.

parent_id

String

Parent 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

Query the organization details based on the application ID and organization ID.

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

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

Example Responses

Status code: 200

Request successful.

{
  "org_id" : "20210623103520050-C5AF-DD1A97...",
  "org_code" : "10000",
  "name" : "Headquarter",
  "parent_id" : null
}

Status Codes

Status Code

Description

200

Request successful.

400

Invalid parameter.

Error Codes

See Error Codes.