GetOrganizationalUnitIdByExternalId - Identity as a Service

Obtains the ID of an organizational unit based on the external ID

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

POST /v2/{instanceId}/{applicationId}/organizationalUnits/_/actions/getOrganizationalUnitIdByExternalId

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
body	object	No	The request body.
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 parameters

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

Examples

Sample success responses

JSONformat

{
  "organizationalUnitId": "ou_wovwffm62xifdziem7an7xxxxx"
}

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