ListOrganizationalUnits - Identity as a Service - Alibaba Cloud Documentation Center

Queries the information of Employee Identity and Access Management (EIAM) organizational units by page.

Debugging

OpenAPI Explorer automatically calculates the signature value. For your convenience, we recommend that you call this operation in OpenAPI Explorer.

Debug

Authorization information

There is currently no authorization information disclosed in the API.

Request syntax

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

Request parameters

Parameter	Type	Required	Description	Example
Authorization	string	Yes	The authentication information. Format: 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 ID of the parent organizational unit.	ou_wovwffm62xifdziem7an7xxxxx
pageNumber	integer	No	The page number. Default value: 1.	1
pageSize	integer	No	The number of entries per page. Default value: 20. Valid values: 1 to 100.	20

Response parameters

Parameter	Type	Description	Example
	object	The response parameters.
totalCount	long	The total number of entries returned.	1000
data	array<object>	The queried organizational units.
	object	The queried organizational unit.
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. The external ID can be used to map external data to the data of the organizational unit in EIAM of Identity as a Service (IDaaS). By default, the external ID is the organizational unit ID. Note: 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. If the organizational unit was created in IDaaS, its source ID is the ID of the IDaaS instance. If the organizational unit was imported, its source ID is the enterprise ID in the source. For example, if the organizational unit was imported from DingTalk, its source ID is the corpId value of the enterprise in DingTalk.	idaas_ue2jvisn35ea5lmthk267xxxxx
createTime	long	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	long	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.	test organizational unit

Examples

Sample success responses

JSONformat

{
  "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": "test organizational unit"
    }
  ]
}

Error codes

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

Change history

Change time	Summary of changes	Operation
2023-10-24	The internal configuration of the API is changed, but the call is not affected	View Change Details