Queries the ID of an Employee Identity and Access Management (EIAM) account based on the external ID.
Try it now
Test
RAM authorization
Request syntax
POST /v2/{instanceId}/{applicationId}/users/_/actions/getUserIdByExternalId HTTP/1.1Path 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. |
|
| userExternalId |
string |
Yes |
The external ID of the account. |
xxx001 |
| userSourceType |
string |
Yes |
The source type of the account. Valid values:
|
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 |
Response elements
|
Element |
Type |
Description |
Example |
|
object |
The response parameters. |
||
| userId |
string |
The account ID. |
user_d6sbsuumeta4h66ec3il7yxxxx |
Examples
Success response
JSON format
{
"userId": "user_d6sbsuumeta4h66ec3il7yxxxx"
}Error codes
See Error Codes for a complete list.
Release notes
See Release Notes for a complete list.