更新时间:2024-07-25 GMT+08:00

修改用户信息

功能介绍

该接口用于修改租户下对应的用户信息。

URI

  • URI格式

    PATCH /v3/users/{user_id}

  • URI参数说明

    参数

    是否必选

    类型

    说明

    user_id

    String

    用户ID。

请求

  • Request Header参数说明

    参数

    是否必选

    类型

    说明

    Content-Type

    String

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

    X-Auth-Token

    String

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

  • Request Body参数说明

    参数

    是否必选

    类型

    说明

    name

    String

    用户名,长度5~32之间,首位不能为数字,特殊字符只能包含“下划线_、中划线-、和空格”。

    domain_id

    String

    用户所在domain的ID。

    enabled

    Boolean

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

    password

    String

    用户的新密码。
    • 至少包含以下四种字符中的两种: 大写字母、小写字母、数字和特殊字符;
    • 不能与用户名以及用户名的倒序;
    • 不能包含手机号和邮箱;
    • 必须满足账户设置中密码策略的要求;

    default_project_id

    String

    用户默认的project ID。

    description

    String

    用户的描述信息。

  • 请求样例
    1.按照以下模板创建临时文件${filename}.json。${filename}是临时文件名,用户可以自定义。
    {
        "user": {
            "name": "james1234",
            "default_project_id": "88b16b6440684467b8825d7d96e154d8",
            "enabled": false,
            "password": "********"
        }
    }
    2.在${filename}.json文件同目录下,执行如下curl命令。
    curl -i -k -H 'Accept:application/json' -H 'Content-Type:application/json;charset=utf8' -H "X-Auth-Token:$token" -X POST -d @${filename}.json https://sample.domain.com/v3/users/2c1c6c54e59141b889c99e6fada5f19f
    3.在${filename}.json文件同目录下,执行如下命令删除临时文件${filename}.json。
    rm ${filename}.json

响应

  • Response Body参数说明

    参数

    是否必选

    类型

    说明

    user

    JSONObject

    user对象。

  • user格式说明

    参数

    是否必选

    类型

    说明

    enabled

    Boolean

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

    id

    String

    用户ID。

    domain_id

    String

    用户所在domain的ID。

    name

    String

    用户名称。

    links

    JSONObject

    用户的资源链接。

    description

    String

    用户的描述信息。

    default_project_id

    String

    用户默认的project ID。

    password_expires_at

    String

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

  • 响应样例
    {
        "user": {
            "name": "james1234",
            "links": {
                "self": "https://sample.domain.com/v3/users/6d8b04e3bf99445b8f76300903e5bf32"
            },
            "description": {
            },
            "domain_id": "88b16b6440684467b8825d7d96e154d8",
            "enabled": false,
            "id": "6d8b04e3bf99445b8f76300903e5bf32",
            "default_project_id": "88b16b6440684467b8825d7d96e154d8",
            "password_expires_at": "2016-12-07T00:00:00.000000Z"
        }
    }

状态码

状态码

说明

200

请求成功。

400

请求错误。

401

认证失败。

403

鉴权失败。

404

找不到资源。

405

不允许的方法。

409

资源冲突。

413

请求体过大。

500

内部服务错误。

503

服务不可用。