GetUser - 查询IAM用户详情--访问控制-火山引擎

文档中心

立即注册

导航

GetUser - 查询IAM用户详情

最近更新时间：2024.09.14 14:48:58首次发布时间：2021.02.23 10:42:32

查询指定IAM用户的详情信息。

调试

API Explorer

您可以通过 API Explorer 在线发起调用，无需关注签名生成过程，快速获取调用结果。

去调试

请求参数

下表仅列出该接口特有的请求参数和部分公共参数。更多信息请见公共参数。

参数	类型	是否必填	示例值	描述
Action	String	是	GetUser	要执行的操作，取值：GetUser。
Version	String	是	2018-01-01	API的版本，取值：2018-01-01。
UserName	String	否	Bob	用户名。长度1~64，仅支持英文、数字、下划线、"."、"-"、"@"、","，必须指定ID、UserName、AccessKeyID三个参数其一，不能同时指定。
AccessKeyID	String	否	AKLTZjIwYzBjYzczNWQ4NDkwN******3NzViZTgzZDAxYjE	用户密钥ID。必须指定ID、UserName、AccessKeyID三个参数其一，不能同时指定。
ID	Long	否	10000	用户Id。必须指定ID、UserName、AccessKeyID三个参数其一，不能同时指定。

返回参数

下表仅列出本接口特有的返回参数。更多信息请参见返回结构。

参数	类型	示例值	描述
User	Object	请参考数据结构内具体参数示例值。	用户的数据结构。

请求示例

GET /?Action=GetUser&Version=2018-01-01 HTTP/1.1
Host: iam.volcengineapi.com
X-Date: 20240914T032245Z
Authorization: HMAC-SHA256 Credential=Adfks******wekfwe/20240914/cn-beijing/iam/request, SignedHeaders=host;x-date, Signature=47a7d934ff7b37c03938******cd7b8278a40a1057690c401e92246a0e41085f

返回示例

{
  "ResponseMetadata": {
    "RequestId": "202409141122492010602481737A326E",
    "Action": "GetUser",
    "Version": "2018-01-01",
    "Service": "iam",
    "Region": "cn-beijing"
  },
  "Result": {
    "User": {
      "Id": 10000,
      "UserName": "Bob",
      "AccountId": 2000000000,
      "Trn": "trn:iam::2000000000:user/Bob",
      "DisplayName": "鲍勃",
      "Description": "鲍勃",
      "MobilePhone": "+86130******00",
      "MobilePhoneIsVerify": true,
      "Email": "abc**@**.com",
      "EmailIsVerify": true,
      "CreateDate": "20240813T053809Z",
      "UpdateDate": "20240813T053809Z"
    }
  }
}

错误码

下表为您列举了该接口与业务逻辑相关的错误码。公共错误码请参见公共错误码文档。

状态码	错误码	错误信息	说明
400	InvalidUserName	Invalid UserName '%s', err: '%s'.	用户名称不合法。
400	InvalidParameter	The parameter 'AccessKeyID' is invalid	Access Key Id不合法。