Querying Registered OUs

Function

This API is used to query information about OUs registered with RGC.

URI

GET https://{endpoint}/v1/managed-organization/managed-organizational-units/{managed_organizational_unit_id}

**Table 1** Path Parameters
Parameter	Mandatory	Type	Description
managed_organizational_unit_id	Yes	String	ID of a registered OU.

Request Parameters

None

Response Parameters

Status code: 200

**Table 2** Response body parameters
Parameter	Type	Description
manage_account_id	String	Management account ID.
organizational_unit_id	String	ID of a registered OU.
organizational_unit_name	String	Name of a registered OU.
organizational_unit_status	String	Status of a registered OU.
organizational_unit_type	String	Type of an OU. CORE - Foundational OU CUSTOM - OU ROOT - Root OU
parent_organizational_unit_id	String	ID of a registered parent OU.
parent_organizational_unit_name	String	Name of a registered parent OU.
created_at	String	Time when a registered OU was created.
landing_zone_version	String	Landing zone version of a registered OU.
updated_at	String	Time when a registered OU was updated.
message	String	Error description.

Status code: 403

**Table 3** Response body parameters
Parameter	Type	Description
error_code	String	Error code.
error_msg	String	Error message.
request_id	String	Unique ID of the request.
encoded_authorization_message	String	Encrypted error message.
details	Array of ForbiddenErrorDetail objects	Error message indicating no permissions for cross-service invoking.

**Table 4** ForbiddenErrorDetail
Parameter	Type	Description
error_code	String	Error code.
error_msg	String	Error message.

Example Requests

Querying information about OUs registered with RGC

GET https://{endpoint}/v1/managed-organization/managed-organizational-units/{managed_organizational_unit_id}

Example Responses

Status code: 200

Request succeeded.

{
  "manage_account_id" : "string",
  "organizational_unit_id" : "string",
  "organizational_unit_name" : "string",
  "organizational_unit_status" : "string",
  "organizational_unit_type" : "CORE",
  "parent_organizational_unit_id" : "string",
  "parent_organizational_unit_name" : "string",
  "created_at" : "2023-11-21T06:51:08.882Z",
  "updated_at" : "2023-11-21T06:51:08.882Z"
}