文档首页/ 统一身份认证服务 IAM/ API参考/ API/ IAM用户管理/ 管理员查询IAM用户列表
更新时间：2024-11-18 GMT+08:00
查看PDF
分享

管理员查询IAM用户列表

功能介绍

该接口可以用于管理员查询IAM用户列表。

该接口可以使用全局区域的Endpoint和其他区域的Endpoint调用。IAM的Endpoint请参见：地区和终端节点。

调试

您可以在API Explorer中调试该接口。

URI

GET /v3/users

表1 Query参数

参数

是否必选

参数类型

描述

domain_id

否

String

IAM用户所属账号ID，获取方式请参见：获取账号、IAM用户、项目、用户组、区域、委托的名称和ID。

enabled

否

Boolean

是否启用IAM用户，true为启用，false为停用，默认为true。

name

否

String

IAM用户名。

password_expires_at

否

String

密码过期时间。该值为null表示未设置密码过期时间。

格式为：password_expires_at={operator}:{timestamp}。

timestamp格式为：YYYY-MM-DDTHH:mm:ssZ。示例：

password_expires_at=lt:2016-12-08T22:02:00Z
说明：
  • operator取值范围：lt，lte，gt，gte，eq，neq。
  • lt：过期时间小于timestamp。
  • lte：过期时间小于等于timestamp。
  • gt：过期时间大于timestamp。
  • gte：过期时间大于等于timestamp。
  • eq：过期时间等于timestamp。
  • neq：过期时间不等于timestamp。

请求参数

表2 请求Header参数

参数

是否必选

参数类型

描述

Content-Type

是

String

该字段内容填为“application/json;charset=utf8”。

X-Auth-Token

是

String

访问令牌，承载用户的身份、权限等信息。

token所需权限请参见授权项。

响应参数

表3 响应Body参数

参数

参数类型

描述

links

Object

资源链接信息。

users

Array of objects

IAM用户信息列表。
表4 links

参数

参数类型

描述

self

String

资源链接地址。

previous

String

前一邻接资源链接地址，不存在时为null。

next

String

后一邻接资源链接地址，不存在时为null。
表5 users

参数

参数类型

描述

name

String

IAM用户名。

links

Object

IAM用户的资源链接信息。

domain_id

String

IAM用户所属账号ID。

enabled

Boolean

IAM用户是否启用。true表示启用，false表示停用，默认为true。

id

String

IAM用户ID。

password_expires_at

String

IAM用户密码过期时间，“null”表示密码不过期。

说明：

UTC时间，格式为YYYY-MM-DDTHH:mm:ss.ssssss，日期和时间戳格式如：2023-06-28T08:56:33.710000。

description

String

IAM用户描述信息。

access_mode

String

IAM用户访问方式。

  • default：默认访问模式，编程访问和管理控制台访问。
  • programmatic：编程访问。
  • console：管理控制台访问。

pwd_status

Boolean

IAM用户密码状态。true：需要修改密码，false：正常。如果密码未设置，此字段可能不返回。

last_project_id

String

IAM用户退出系统前，在控制台最后访问的项目ID，如果用户无访问记录，此字段可能不返回。

pwd_strength

String

IAM用户的密码强度。high：密码强度高；mid：密码强度中等；low：密码强度低。如果用户未设置密码，此字段可能不返回。
表6 users.links

参数

参数类型

描述

self

String

资源链接地址。

previous

String

前一邻接资源链接地址，不存在时为null。

next

String

后一邻接资源链接地址，不存在时为null。

请求示例

管理员查询IAM用户列表。

GET https://iam.myhuaweicloud.com/v3/users

如需缩小查询范围，可以增加路径参数，如：

GET https://iam.myhuaweicloud.com/v3/users?domain_id=d78cbac186b744899480f25bd02...&enabled=true

响应示例

状态码为 200 时:

请求成功。

{
    "links": {
        "next": null,
        "previous": null,
        "self": "https://iam.myhuaweicloud.com/v3/users"
    },
    "users": [
        {
            "domain_id": "d78cbac186b744899480f25bd02...",
            "name": "IAMUserA",
            "description": "IAMDescriptionA",
            "password_expires_at": null,
            "links": {
                "next": null,
                "previous": null,
                "self": "https://iam.myhuaweicloud.com/v3/users/07667db96a00265f1fc0c003a3..."
            },
            "id": "07667db96a00265f1fc0c003a...",
            "enabled": true
        },
        {
            "pwd_status": true,
            "domain_id": "d78cbac186b744899480f25bd02...",
            "last_project_id": "065a7c66da0010992ff7c0031e5a...",

            "name": "IAMUserB",
            "description": "IAMDescriptionB",
            "password_expires_at": null,
            "links": {
                "next": null,
                "previous": null,
                "self": "https://iam.myhuaweicloud.com/v3/users/07609fb9358010e21f7bc003751c7..."
            },
            "id": "07609fb9358010e21f7bc003751c7...",
            "enabled": true
        }
    ]
}

返回值

返回值

描述

200

请求成功。

400

参数无效。

401

认证失败。

403

没有操作权限。

404

未找到相应的资源。

405

不允许的方法。

413

资源冲突。

500

请求体过大。

503

服务不可用。

错误码

无

父主题： IAM用户管理