Getting OU Information
Function
This API is used to get OU information. It can be called only from the organization's management account or from a member account that is a delegated administrator for a cloud service.
Debugging
You can debug this API through automatic authentication in API Explorer or use the SDK sample code generated by API Explorer.
Authorization Information
Each account has all the permissions required to call all APIs, but IAM users must be assigned the required permissions.
- If you are using role/policy-based authorization, see Permissions Policies and Supported Actions for details on the required permissions.
- If you are using identity policy-based authorization, the following identity policy-based permissions are required.
Action
Access Level
Resource Type (*: required)
Condition Key
Alias
Dependencies
organizations:ous:get
Read
ou *
g:ResourceTag/<tag-key>
-
-
URI
GET /v1/organizations/organizational-units/{organizational_unit_id}
|
Parameter |
Mandatory |
Type |
Description |
|---|---|---|---|
|
organizational_unit_id |
Yes |
String |
Unique ID of an OU. |
Request Parameters
|
Parameter |
Mandatory |
Type |
Description |
|---|---|---|---|
|
X-Security-Token |
No |
String |
Security token (session token) of your temporary security credentials. If a temporary security credential is used, this header is required. |
Response Parameters
Status code: 200
|
Parameter |
Type |
Description |
|---|---|---|
|
organizational_unit |
OrganizationalUnitDto object |
Details about a newly created organizational unit (OU). |
Example Requests
Getting OU Information
GET /v1/organizations/organizational-units/{organizational_unit_id}
Example Responses
Status code: 200
Successful
{
"organizational_unit" : {
"id" : "ou-taowxgy4xbme6m4x3c2iijbxw7yj8fcw",
"urn" : "organizations::0a6d25d23900d45c0faac010e0fb4de0:ou:o-fhkmi6mek7wlqdp6nideqhb47qwtjdsv/ou-taowxgy4xbme6m4x3c2iijbxw7yj8fcw",
"name" : "autoOU0923152729270Pkgk",
"created_at" : "2022-09-23T07:27:28Z"
}
}
Status Codes
|
Status Code |
Description |
|---|---|
|
200 |
Successful |
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