ListOrganizationalUnits - Identity as a Service - Alibaba Cloud Documentation Center

Performs a paged query to retrieve organization information from EIAM.

Operation description

To retrieve the direct child organizations of the root organization, set the request parameter as follows:

{
  "parentOrganizationalUnitId": "ou_root"
}

Try it now

Try this API in OpenAPI Explorer, no manual signing needed. Successful calls auto-generate SDK code matching your parameters. Download it with built-in credential security for local usage.

Test

RAM authorization

No authorization for this operation. If you encounter issues with this operation, contact technical support.

Request syntax

GET /v2/{instanceId}/{applicationId}/organizationalUnits HTTP/1.1

Request parameters

Parameter	Type	Required	Description	Example
Authorization	string	Yes	The authentication information. The value must be in the format of `Bearer ${access_token}`. Example: `Bearer ATxxxx`.	Bearer AT8csE2seYxxxxxij
instanceId	string	Yes	The instance ID.	idaas_ue2jvisn35ea5lmthk267xxxxx
applicationId	string	Yes	The application ID.	app_mkv7rgt4d7i4u7zqtzev2mxxxx
parentId	string	Yes	The parent organization ID.	ou_wovwffm62xifdziem7an7xxxxx
pageNumber	integer	No	The page number. The default value is 1.	1
pageSize	integer	No	The number of records on each page. The default value is 20. The value can range from 1 to 100.	20

Response elements

Element	Type	Description	Example
	object	The response.
totalCount	integer	The total number of records.	1000
data	array<object>	A list of data objects.
	object	The data object.
instanceId	string	The instance ID.	idaas_ue2jvisn35ea5lmthk267xxxxx
organizationalUnitId	string	The organization ID.	ou_wovwffm62xifdziem7an7xxxxx
organizationalUnitName	string	The organization name.	name001
parentId	string	The parent organization ID.	ou_wovwffm62xifdziem7an7xxxxx
organizationalUnitExternalId	string	The external ID of the organization. This ID is used to map external data to the organization's data in IDaaS. The default value is the IDaaS organization ID. Note: The external ID must be unique for the same source type and source ID.	ou_wovwffm62xifdziem7an7xxxxx
organizationalUnitSourceType	string	The source type of the organization. Valid values: `build_in`: The organization is created in IDaaS. `ding_talk`: The organization is imported from DingTalk. `ad`: The organization is imported from Active Directory (AD). `ldap`: The organization is imported from LDAP.	build_in
organizationalUnitSourceId	string	The source ID of the organization. For the `build_in` type, the default value is the instance ID. For other types, the value is the enterprise ID from the source. For example, if the source is DingTalk, the value is the `corpId` of the DingTalk enterprise.	idaas_ue2jvisn35ea5lmthk267xxxxx
createTime	integer	The time when the organization was created. This is a UNIX timestamp. Unit: milliseconds.	1652083425923
updateTime	integer	The time when the organization was last updated. This is a UNIX timestamp. Unit: milliseconds.	1652083425923
description	string	The description of the organization.	测试组织

Examples

Success response

JSON format

{
  "totalCount": 1000,
  "data": [
    {
      "instanceId": "idaas_ue2jvisn35ea5lmthk267xxxxx",
      "organizationalUnitId": "ou_wovwffm62xifdziem7an7xxxxx",
      "organizationalUnitName": "name001",
      "parentId": "ou_wovwffm62xifdziem7an7xxxxx",
      "organizationalUnitExternalId": "ou_wovwffm62xifdziem7an7xxxxx",
      "organizationalUnitSourceType": "build_in",
      "organizationalUnitSourceId": "idaas_ue2jvisn35ea5lmthk267xxxxx",
      "createTime": 1652083425923,
      "updateTime": 1652083425923,
      "description": "测试组织"
    }
  ]
}

Error codes

See Error Codes for a complete list.

Release notes

See Release Notes for a complete list.