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}
Parameter |
Mandatory |
Type |
Description |
---|---|---|---|
managed_organizational_unit_id |
Yes |
String |
ID of a registered OU. |
Request Parameters
None
Response Parameters
Status code: 200
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.
|
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
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. |
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" }
Status Codes
Status Code |
Description |
---|---|
200 |
Request succeeded. |
403 |
No permissions. |
Error Codes
See Error Codes.
Feedback
Was this page helpful?
Provide feedbackThank you very much for your feedback. We will continue working to improve the documentation.See the reply and handling status in My Cloud VOC.
For any further questions, feel free to contact us through the chatbot.
Chatbot