GetUserIdByUserExternalId - Identity as a Service - Alibaba Cloud Documentation Center

Queries the ID of an Employee Identity and Access Management (EIAM) account based on the external ID.

Debugging

There is currently no authorization information disclosed in the API.

POST /v2/{instanceId}/{applicationId}/users/_/actions/getUserIdByExternalId HTTP/1.1

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.
userExternalId	string	Yes	The external ID of the account.	xxx001
userSourceType	string	Yes	The source type of the account. Valid values: build_in: The account was created in Identity as a Service (IDaaS). ding_talk: The account was imported from DingTalk. ad: The account was imported from Microsoft Active Directory (AD). ldap: The account was imported from a Lightweight Directory Access Protocol (LDAP) service.	build_in
userSourceId	string	Yes	The source ID of the account. If the account was created in IDaaS, its source ID is the ID of the IDaaS instance. If the account was imported, its source ID is the enterprise ID in the source. For example, if the account was imported from DingTalk, its source ID is the corpId value of the enterprise in DingTalk.	idaas_ue2jvisn35ea5lmthk267xxxxx

Parameter	Type	Description	Example
	object	The response parameters.
userId	string	The account ID.	user_d6sbsuumeta4h66ec3il7yxxxx

Sample success responses

JSONformat

{
  "userId": "user_d6sbsuumeta4h66ec3il7yxxxx"
}

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

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