ListOrganizationalUnits - Identity as a Service - Alibaba Cloud Documentation Center

Queries the information about organizational units in Identity as a Service (IDaaS) Employee IAM (EIAM) by page.

Debugging

You can run this interface directly in OpenAPI Explorer, saving you the trouble of calculating signatures. After running successfully, OpenAPI Explorer can automatically generate SDK code samples.

Debug

Authorization information

There is currently no authorization information disclosed in the API.

Request parameters

Parameter	Type	Required	Description	Example
InstanceId	string	Yes	The ID of the instance.	idaas_ue2jvisn35ea5lmthk267xxxxx
PageNumber	long	No	The number of the page to return. Default value: 1.	1
PageSize	long	No	The number of entries to return on each page. Default value: 20.	20
OrganizationalUnitIds	array	No	The IDs of organizational units.
	string	No	The ID of organizational unit.	ou_wovwffm62xifdziem7an7xxxxx
OrganizationalUnitName	string	No	The name of the organizational unit.	name_001
OrganizationalUnitNameStartsWith	string	No	Organization name, matching left	name
ParentId	string	No	The ID of the parent organizational unit.	ou_wovwffm62xifdziem7an7xxxxx

Response parameters

Parameter	Type	Description	Example
	object	The response data.
RequestId	string	The ID of the request.	0441BD79-92F3-53AA-8657-F8CE4A2B912A
TotalCount	long	The number of entries in the list.	100
OrganizationalUnits	array<object>	The list of data objects of organizational units.
OrganizationalUnit	object	The data object of the organizational unit.
OrganizationalUnitId	string	The ID of the organizational unit.	ou_wovwffm62xifdziem7an7xxxxx
ParentId	string	The ID of the parent organizational unit.	ou_wovwffm62xifdziem7an7xxxxx
OrganizationalUnitExternalId	string	The external ID of the organizational unit. The external ID can be used by external data to map the data of the organizational unit in IDaaS EIAM. By default, the external ID is the organizational unit ID. For organizational units with the same source type and source ID, each organizational unit has a unique external ID.	ou_wovwffm62xifdziem7an7xxxxx
OrganizationalUnitSourceType	string	The source type of the organizational unit. Valid values: build_in: The organizational unit was created in IDaaS. ding_talk: The organizational unit was imported from DingTalk. ad: The organizational unit was imported from Microsoft Active Directory (AD). ldap: The organizational unit was imported from a Lightweight Directory Access Protocol (LDAP) service.	build_in
OrganizationalUnitSourceId	string	The source ID of the organizational unit.	idaas_ue2jvisn35ea5lmthk267xxxxx
CreateTime	long	The time when the organizational unit was created. This value is a UNIX timestamp. Unit: milliseconds.	1652085686179
UpdateTime	long	The time when the organizational unit was last updated. The value is a UNIX timestamp. Unit: milliseconds.	1652085686179
Description	string	The description of the organizational unit.	Test organizational unit
InstanceId	string	The ID of the instance.	idaas_ue2jvisn35ea5lmthk267xxxxx
Leaf	boolean	Indicates whether the node is a leaf node.	false

Examples

Sample success responses

JSONformat

{
  "RequestId": "0441BD79-92F3-53AA-8657-F8CE4A2B912A",
  "TotalCount": 100,
  "OrganizationalUnits": [
    {
      "OrganizationalUnitId": "ou_wovwffm62xifdziem7an7xxxxx",
      "OrganizationalUnitName": "test_organizationalUnit_name",
      "ParentId": "ou_wovwffm62xifdziem7an7xxxxx",
      "OrganizationalUnitExternalId": "ou_wovwffm62xifdziem7an7xxxxx",
      "OrganizationalUnitSourceType": "build_in",
      "OrganizationalUnitSourceId": "idaas_ue2jvisn35ea5lmthk267xxxxx",
      "CreateTime": 1652085686179,
      "UpdateTime": 1652085686179,
      "Description": "Test organizational unit\n",
      "InstanceId": "idaas_ue2jvisn35ea5lmthk267xxxxx",
      "Leaf": false
    }
  ]
}

Error codes

For a list of error codes, visit the Service error codes.

Change history

Change time	Summary of changes	Operation
2023-06-21	The request parameters of the API has changed. The response structure of the API has changed	View Change Details
2023-04-04	The response structure of the API has changed	View Change Details
2023-03-21	The request parameters of the API has changed. The response structure of the API has changed	View Change Details