Retrieves the information about an organizational unit.
Try it now
Test
RAM authorization
Request syntax
GET /v2/{instanceId}/{applicationId}/organizationalUnits/{organizationalUnitId} HTTP/1.1
Path Parameters
|
Parameter |
Type |
Required |
Description |
Example |
| instanceId |
string |
Yes |
The instance ID. |
idaas_ue2jvisn35ea5lmthk267xxxxx |
| applicationId |
string |
Yes |
The application ID. |
app_mkv7rgt4d7i4u7zqtzev2mxxxx |
| organizationalUnitId |
string |
Yes |
The ID of the organizational unit. |
ou_wovwffm62xifdziem7an7xxxxx |
Request parameters
|
Parameter |
Type |
Required |
Description |
Example |
| Authorization |
string |
Yes |
The authentication information. Format: Bearer ${access_token}. Example: Bearer ATxxxx. |
Bearer AT8csE2seYxxxxxij |
Response elements
|
Element |
Type |
Description |
Example |
|
object |
The response parameters. |
||
| instanceId |
string |
The instance ID. |
idaas_ue2jvisn35ea5lmthk267xxxxx |
| organizationalUnitId |
string |
The ID of the organizational unit. |
ou_wovwffm62xifdziem7an7xxxxx |
| organizationalUnitName |
string |
The name of the organizational unit. |
name001 |
| parentId |
string |
The ID of the parent organizational unit. |
ou_wovwffm62xifdziem7an7xxxxx |
| organizationalUnitExternalId |
string |
The external ID of the organizational unit. |
id_wovwffm62xifdziem7an7xxxxx |
| organizationalUnitSourceType |
string |
The source type of the organizational unit. Valid values:
|
build_in |
| organizationalUnitSourceId |
string |
The source ID of the organizational unit. |
id_wovwffm62xifdziem7an7xxxxx |
| createTime |
integer |
The time when the organizational unit was created. This value is a UNIX timestamp representing the number of milliseconds that have elapsed since January 1, 1970, 00:00:00 UTC. |
1652083425923 |
| updateTime |
integer |
The time when the organizational unit was last updated. This value is a UNIX timestamp representing the number of milliseconds that have elapsed since January 1, 1970, 00:00:00 UTC. |
1652083425923 |
| description |
string |
The description of the organizational unit. |
xxxxx |
Examples
Success response
JSON format
{
"instanceId": "idaas_ue2jvisn35ea5lmthk267xxxxx",
"organizationalUnitId": "ou_wovwffm62xifdziem7an7xxxxx",
"organizationalUnitName": "name001",
"parentId": "ou_wovwffm62xifdziem7an7xxxxx",
"organizationalUnitExternalId": "id_wovwffm62xifdziem7an7xxxxx",
"organizationalUnitSourceType": "build_in",
"organizationalUnitSourceId": "id_wovwffm62xifdziem7an7xxxxx",
"createTime": 1652083425923,
"updateTime": 1652083425923,
"description": "xxxxx"
}
Error codes
See Error Codes for a complete list.
Release notes
See Release Notes for a complete list.