文档首页 > > API参考> 用户管理> 查询用户列表

查询用户列表

分享
更新时间: 2019/08/15 GMT+08:00

功能介绍

该接口用于查询用户列表。

该接口可以使用全局区域的域名和其他区域的域名调用,全局区域的域名为iam.myhuaweicloud.com

URI

  • URI格式

    GET /v3/users

  • 参数说明

    参数

    是否必选

    类型

    说明

    domain_id

    String

    用户所属的domain的ID。

    enabled

    String

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

    name

    String

    用户名。

    password_expires_at

    String

    密码过期时间,格式为:password_expires_at={operator}:{timestamp}。

    示例:

    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
    • timestamp格式为YYYY-MM-DDTHH:mm:ssZ

请求

  • Request Header参数说明

    参数

    是否必选

    类型

    说明

    Content-Type

    String

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

    X-Auth-Token

    String

    已认证的拥有Security Administrator权限的token。

  • 请求样例
    curl -i -k -H 'Accept:application/json' -H 'Content-Type:application/json;charset=utf8' -H "X-Auth-Token:$token" -X GET https://172.30.48.86:31943/v3/users

响应

  • Response Body参数说明

    参数

    是否必选

    类型

    说明

    users

    JSONArray

    用户列表。

    links

    JSONObject

    用户资源的链接。

  • user格式说明

    参数

    是否必选

    类型

    说明

    description

    String

    用户的描述。

    domain_id

    String

    用户所属租户的ID。

    enabled

    Boolean

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

    id

    String

    用户的ID。

    links

    JSONObject

    用户资源的链接。

    name

    String

    用户的名称。

    password_expires_at

    String

    密码过期时间(UTC时间),“null”表示密码不过期。

    pwd_status

    Boolean

    密码状态,true:需要修改密码,false:正常。

    pwd_strength

    String

    用户的密码强度。high:密码强度高;mid:密码强度中等;low:密码强度低。

    mobile

    String

    用户的手机号。

    email

    String

    用户的邮箱。

    forceResetPwd

    Boolean

    用户下次登录是否强制重置密码。

    default_project_id

    String

    用户登录控制台后默认跳转的项目ID。

    last_project_id

    String

    用户退出系统前,在控制台最后访问的项目的ID。

  • 响应样例
    {
        "users": [{
            "name": "username",
            "links": {
                "self": "https://sample.domain.com/v3/users/6d8b04e3bf99445b8f76300xxx"
            },
            "description": "1234",
            "domain_id": "88b16b6440684467b8825d7xxx",
            "enabled": false,
            "id": "6d8b04e3bf99445b8f763009xxx",
            "default_project_id": "263fd9",
            "password_expires_at": "2016-12-07T00:00:00.000000Z",
            "pwd_status": true,
            "pwd_strength": "high",
            "mobile": "",
            "email": "",
            "forceResetPwd": false,
            "last_project_id": ""
        }],
        "links": {
            "self": "https://sample.domain.com/v3/users?domain_id=88b16b6440684467b882xxx154d8&enabled=false",
            "previous": null,
            "next": null
        }
    }

状态码

状态码

说明

200

请求成功。

400

请求错误。

401

认证失败。

403

鉴权失败。

404

找不到资源。

405

不允许的方法。

413

请求体过大。

500

内部服务错误。

503

服务不可用。

分享:

    相关文档

    相关产品

文档是否有解决您的问题?

提交成功!

非常感谢您的反馈,我们会继续努力做到更好!

反馈提交失败,请稍后再试!

*必选

请至少选择或填写一项反馈信息

字符长度不能超过200

提交反馈 取消

如您有其它疑问,您也可以通过华为云社区问答频道来与我们联系探讨

跳转到云社区