查询IAM用户登录信息 - ShowLoginProfileV5
功能介绍
该接口可以用于查询指定IAM用户的登录信息。
调试
您可以在API Explorer中调试该接口,支持自动认证鉴权。API Explorer可以自动生成SDK代码示例,并提供SDK代码示例调试功能。
授权信息
账号根用户具备所有API的调用权限,如果使用账号下的IAM用户调用当前API,该IAM用户需具备如下身份策略权限,更多的权限说明请参见权限和授权项。
| 授权项 | 访问级别 | 资源类型(*为必须) | 条件键 | 别名 | 依赖的授权项 |
|---|---|---|---|---|---|
| iam:users:showLoginProfileV5 | Read | user * | g:ResourceTag/<tag-key> | - | - |
URI
GET /v5/users/{user_id}/login-profile
| 参数 | 是否必选 | 参数类型 | 描述 |
|---|---|---|---|
| user_id | 是 | String | IAM用户ID。 |
请求参数
无
响应参数
状态码:200
| 参数 | 参数类型 | 描述 |
|---|---|---|
| login_profile | LoginProfile object | IAM用户登录信息。 |
| 参数 | 参数类型 | 描述 |
|---|---|---|
| user_id | String | IAM用户ID。 |
| password_reset_required | Boolean | IAM用户下次登录时是否需要修改密码。 |
| password_expires_at | String | IAM用户密码过期时间。 |
| created_at | String | IAM用户登录信息创建时间。 |
状态码:403
| 参数 | 参数类型 | 描述 |
|---|---|---|
| error_code | String | 错误码。 |
| error_msg | String | 错误信息。 |
| request_id | String | 请求ID。 |
| encoded_authorization_message | String | 加密后的认证失败信息,可以通过STS5解密接口进行解密。 |
状态码:404
| 参数 | 参数类型 | 描述 |
|---|---|---|
| error_code | String | 错误码。 |
| error_msg | String | 错误信息。 |
| request_id | String | 请求ID。 |
请求示例
查询指定IAM用户的登录信息。
GET https://{endpoint}/v5/users/{user_id}/login-profile 响应示例
状态码:200
请求成功。
{
"login_profile" : {
"user_id" : "user",
"password_reset_required" : true,
"password_expires_at" : "2023-09-13T08:03:10.781Z",
"created_at" : "2023-09-13T08:03:10.781Z"
}
} 状态码
| 状态码 | 描述 |
|---|---|
| 200 | 请求成功。 |
| 403 | 没有操作权限。 |
| 404 | 未找到相应的资源。 |
错误码
请参见错误码。