Use GetOrganizationalUnitIdByExternalId to obtain an organizational unit ID from an external ID - Identity as a Service - Alibaba Cloud - Identity as a Service

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

POST /v2/{instanceId}/{applicationId}/organizationalUnits/_/actions/getOrganizationalUnitIdByExternalId 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

Request parameters

Parameter	Type	Required	Description	Example
Authorization	string	Yes	The authentication information. Format: Bearer ${access_token}. Example: Bearer ATxxxx.	Bearer AT8csE2seYxxxxxij
body	object	No	The request body.	xxx001
organizationalUnitExternalId	string	Yes	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 Employee Identity and Access Management (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	Yes	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	Yes	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

Response elements

Element	Type	Description	Example
	object	OrganizationalUnitIdObject
organizationalUnitId	string	The ID of the organizational unit.	ou_wovwffm62xifdziem7an7xxxxx

Examples

Success response

JSON format

{
  "organizationalUnitId": "ou_wovwffm62xifdziem7an7xxxxx"
}

Error codes

See Error Codes for a complete list.

Release notes

See Release Notes for a complete list.