All Products
Search

This Product

    Identity as a Service:GetUser

    Document Center

    Identity as a Service:GetUser

    Last Updated:Mar 30, 2026

    Retrieves the details of an Employee Identity and Access Management (EIAM) account.

    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

    GET /v2/{instanceId}/{applicationId}/users/{userId} 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
    userId

    string

    Yes

    The account ID.

    user_d6sbsuumeta4h66ec3il7yxxxx

    Request parameters

    Parameter

    Type

    Required

    Description

    Example
    Authorization

    string

    Yes

    The authentication information. The value is in the Bearer ${access_token} format. Example: Bearer ATxxxx.

    Bearer AT8csE2seYxxxxxij

    Response elements

    Element

    Type

    Description

    Example

    object

    The response parameters.

    instanceId

    string

    The instance ID.

    idaas_ue2jvisn35ea5lmthk267xxxxx
    organizationalUnits

    array<object>

    The organizational units to which the account belongs.

    object

    The organizational unit.

    organizationalUnitId

    string

    The ID of the organizational unit.

    ou_wovwffm62xifdziem7an7xxxxx
    organizationalUnitName

    string

    The name of the organizational unit.

    name001
    primary

    boolean

    Indicates whether the organizational unit is the primary organizational unit.

    true
    primaryOrganizationalUnitId

    string

    The ID of the primary organizational unit of the account.

    ou_wovwffm62xifdziem7an7xxxxx
    customFields

    array<object>

    The extended fields of the account.

    object

    fieldName

    string

    The name of the extended field.

    xxxx
    fieldValue

    string

    The value of the extended field. Field values are returned as strings regardless of the data types of the fields. For example, true or false is returned for a Boolean field.

    字段数据值
    userId

    string

    The account ID.

    user_d6sbsuumeta4h66ec3il7yxxxx
    username

    string

    The username of the account.

    name001
    displayName

    string

    The display name of the account.

    display_name001
    passwordSet

    boolean

    Indicates whether the password is set.

    true
    phoneRegion

    string

    The country code of the mobile number. For example, the country code of China is 86 without 00 or +.

    86
    phoneNumber

    string

    The mobile number of the user who owns the account.

    156xxxxxxx
    phoneNumberVerified

    boolean

    Indicates whether the mobile number has been verified. A value of true indicates that the mobile number has been verified by the user or has been set to the verified status by the administrator. A value of false indicates that the mobile number has not been verified.

    true
    email

    string

    The email address of the user.

    example@example.com
    emailVerified

    boolean

    Indicates whether the email address has been verified. A value of true indicates that the email address has been verified by the user or has been set to the verified status by the administrator. A value of false indicates that the email address has not been verified.

    true
    userExternalId

    string

    The external ID of the account. The external ID can be used to map external data to the data of the account in EIAM of Identity as a Service (IDaaS). By default, the external ID is the account ID.

    Note: For accounts with the same source type and source ID, each account has a unique external ID.

    user_d6sbsuumeta4h66ec3il7yxxxx
    userSourceType

    string

    The source type of the account. Valid values:

    • build_in: The account was created in 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

    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
    status

    string

    The status of the account. Valid values: enabled disabled

    enabled
    accountExpireTime

    integer

    The time when the account expires. This value is a UNIX timestamp representing the number of milliseconds that have elapsed since January 1, 1970, 00:00:00 UTC.

    1652085686179
    registerTime

    integer

    The time when the account was registered. This value is a UNIX timestamp representing the number of milliseconds that have elapsed since January 1, 1970, 00:00:00 UTC.

    1652085686179
    lockExpireTime

    integer

    The time when the account lock expires. This value is a UNIX timestamp representing the number of milliseconds that have elapsed since January 1, 1970, 00:00:00 UTC.

    1652085686179
    createTime

    integer

    The time when the account was created. This value is a UNIX timestamp representing the number of milliseconds that have elapsed since January 1, 1970, 00:00:00 UTC.

    1652085686179
    updateTime

    integer

    The time when the account was last modified. This value is a UNIX timestamp representing the number of milliseconds that have elapsed since January 1, 1970, 00:00:00 UTC.

    1652085686179
    description

    string

    The description of the account.

    测试账户
    groups

    array<object>

    The groups to which the account belongs.

    object

    The information about the group to which the account belongs.

    groupId

    string

    The group ID.

    group_ufdsasn35ea5lmthk267xxxxx
    groupName

    string

    The group name.

    name_test
    description

    string

    The group description.

    description_demo

    Examples

    Success response

    JSON format

    {
  "instanceId": "idaas_ue2jvisn35ea5lmthk267xxxxx",
  "organizationalUnits": [
    {
      "organizationalUnitId": "ou_wovwffm62xifdziem7an7xxxxx",
      "organizationalUnitName": "name001",
      "primary": true
    }
  ],
  "primaryOrganizationalUnitId": "ou_wovwffm62xifdziem7an7xxxxx",
  "customFields": [
    {
      "fieldName": "xxxx",
      "fieldValue": "字段数据值"
    }
  ],
  "userId": "user_d6sbsuumeta4h66ec3il7yxxxx",
  "username": "name001",
  "displayName": "display_name001",
  "passwordSet": true,
  "phoneRegion": "86",
  "phoneNumber": "156xxxxxxx",
  "phoneNumberVerified": true,
  "email": "example@example.com",
  "emailVerified": true,
  "userExternalId": "user_d6sbsuumeta4h66ec3il7yxxxx",
  "userSourceType": "build_in",
  "userSourceId": "idaas_ue2jvisn35ea5lmthk267xxxxx",
  "status": "enabled",
  "accountExpireTime": 1652085686179,
  "registerTime": 1652085686179,
  "lockExpireTime": 1652085686179,
  "createTime": 1652085686179,
  "updateTime": 1652085686179,
  "description": "测试账户",
  "groups": [
    {
      "groupId": "group_ufdsasn35ea5lmthk267xxxxx",
      "groupName": "name_test",
      "description": "description_demo"
    }
  ]
}

    Error codes

    See Error Codes for a complete list.

    Release notes

    See Release Notes for a complete list.