All Products
Search

This Product

    Resource Access Management:GetUser

    Document Center

    Resource Access Management:GetUser

    Last Updated:Mar 30, 2026

    Queries the information about a RAM user.

    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

    The table below describes the authorization required to call this API. You can define it in a Resource Access Management (RAM) policy. The table's columns are detailed below:

    • Action: The actions can be used in the Action element of RAM permission policy statements to grant permissions to perform the operation.

    • API: The API that you can call to perform the action.

    • Access level: The predefined level of access granted for each API. Valid values: create, list, get, update, and delete.

    • Resource type: The type of the resource that supports authorization to perform the action. It indicates if the action supports resource-level permission. The specified resource must be compatible with the action. Otherwise, the policy will be ineffective.

      • For APIs with resource-level permissions, required resource types are marked with an asterisk (*). Specify the corresponding Alibaba Cloud Resource Name (ARN) in the Resource element of the policy.

      • For APIs without resource-level permissions, it is shown as All Resources. Use an asterisk (*) in the Resource element of the policy.

    • Condition key: The condition keys defined by the service. The key allows for granular control, applying to either actions alone or actions associated with specific resources. In addition to service-specific condition keys, Alibaba Cloud provides a set of common condition keys applicable across all RAM-supported services.

    • Dependent action: The dependent actions required to run the action. To complete the action, the RAM user or the RAM role must have the permissions to perform all dependent actions.

    Action

    Access level

    Resource type

    Condition key

    Dependent action

    ram:GetUser

    get

    *User

    acs:ram::{#accountId}:user/{#UserName}

    		 None None

    Request parameters

    Parameter

    Type

    Required

    Description

    Example
    UserPrincipalName

    string

    No

    The logon name of the RAM user.

    The name is in the format of <username>@<AccountAlias>.onaliyun.com. <username> indicates the name of the RAM user. <AccountAlias>.onaliyun.com indicates the default domain name.

    The value of UserPrincipalName must be 1 to 128 characters in length and can contain letters, digits, periods (.), hyphens (-), and underscores (_). The value of <username> must be 1 to 64 characters in length.

    Note

    You must specify only one of the following parameters: UserPrincipalName, UserId, and UserAccessKeyId.

    test@example.onaliyun.com
    UserId

    string

    No

    The ID of the RAM user.

    Note

    You must specify only one of the following parameters: UserPrincipalName, UserId, and UserAccessKeyId.

    20732900249392****
    UserAccessKeyId

    string

    No

    The AccessKey ID of the RAM user.

    Note

    You must specify only one of the following parameters: UserPrincipalName, UserId, and UserAccessKeyId.

    LTAI*******************

    Response elements

    Element

    Type

    Description

    Example

    object

    User

    object

    The information about the RAM user.

    DisplayName

    string

    The display name of the RAM user.

    test
    UserPrincipalName

    string

    The logon name of the RAM user.

    test@example.onaliyun.com
    Email

    string

    The email address of the RAM user.

    Note

    This parameter is valid only on the China site (aliyun.com).

    alice@example.com
    UpdateDate

    string

    The time when the information about the RAM user was updated.

    2020-10-13T07:39:22Z
    MobilePhone

    string

    The mobile phone number of the RAM user.

    Note

    This parameter is valid only on the China site (aliyun.com).

    86-1868888****
    UserId

    string

    The ID of the RAM user.

    20732900249392****
    Comments

    string

    The description.

    This is a cloud computing engineer.
    LastLoginDate

    string

    The last time when the RAM user logged on to the Alibaba Cloud Management Console.

    2020-10-12T09:12:00Z
    CreateDate

    string

    The time when the RAM user was created.

    2020-10-12T09:12:00Z
    ProvisionType

    string

    The source of the RAM user. Valid value:

    • Manual: The RAM user is manually created in the RAM console.

    • SCIM: The RAM user is mapped by using System for Cross-domain Identity Management (SCIM).

    • CloudSSO: The RAM user is mapped from a CloudSSO user.

    CloudSSO
    Tags

    object

    Tag

    array<object>

    The tags.

    object

    TagKey

    string

    The tag key.

    operator
    TagValue

    string

    The tag value.

    alice
    UserName

    string

    The username of the RAM user, which is the prefix of the logon name of the RAM user.

    test
    RequestId

    string

    The request ID.

    4507D1CD-526A-4E2B-A1E2-3AB045D1EE0B

    Examples

    Success response

    JSON format

    {
  "User": {
    "DisplayName": "test",
    "UserPrincipalName": "test@example.onaliyun.com",
    "Email": "alice@example.com",
    "UpdateDate": "2020-10-13T07:39:22Z",
    "MobilePhone": "86-1868888****",
    "UserId": "20732900249392****",
    "Comments": "This is a cloud computing engineer.",
    "LastLoginDate": "2020-10-12T09:12:00Z",
    "CreateDate": "2020-10-12T09:12:00Z",
    "ProvisionType": "CloudSSO",
    "Tags": {
      "Tag": [
        {
          "TagKey": "operator",
          "TagValue": "alice"
        }
      ]
    },
    "UserName": "test"
  },
  "RequestId": "4507D1CD-526A-4E2B-A1E2-3AB045D1EE0B"
}

    Error codes

    See Error Codes for a complete list.

    Release notes

    See Release Notes for a complete list.