All Products
Search
Document Center

Identity as a Service:GetUserIdByUsername

Last Updated:Sep 10, 2024

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

Debugging

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

Authorization information

There is currently no authorization information disclosed in the API.

Request syntax

POST /v2/{instanceId}/{applicationId}/users/_/actions/getUserIdByUsername

Request parameters

ParameterTypeRequiredDescriptionExample
AuthorizationstringYes

The authentication information. Format: Bearer ${access_token}. Example: Bearer ATxxxx.

Bearer xxxx
instanceIdstringYes

The instance ID.

idaas_ue2jvisn35ea5lmthk267xxxxx
applicationIdstringYes

The application ID.

app_mkv7rgt4d7i4u7zqtzev2mxxxx
bodyobjectNo

The request body.

usernamestringYes

The username of the account.

username_001

Response parameters

ParameterTypeDescriptionExample
object

The response parameters.

userIdstring

The account ID.

user_d6sbsuumeta4h66ec3il7yxxxx

Examples

Sample success responses

JSONformat

{
  "userId": "user_d6sbsuumeta4h66ec3il7yxxxx"
}

Error codes

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

Change history

Change timeSummary of changesOperation
2023-10-24The internal configuration of the API is changed, but the call is not affectedView Change Details