更新 - cloudpods

更新

请求参数

Path 参数

string

必需

The Id or Name of user

Body 参数application/json

user

object (UserUpdateInput)

可选

allow_web_console

boolean

可选

description

string

资源描述

可选

displayname

string

可选

string

可选

enable_mfa

boolean

可选

enabled

boolean

是否启用

可选

is_system_account

boolean

可选

lang

string

可选

mobile

string

可选

name

string

资源名称

可选

password

string

可选

skip_password_complexity_check

boolean

可选

示例

{
    "user": {
        "allow_web_console": true,
        "description": "string",
        "displayname": "string",
        "email": "string",
        "enable_mfa": true,
        "enabled": true,
        "is_system_account": true,
        "lang": "string",
        "mobile": "string",
        "name": "string",
        "password": "string",
        "skip_password_complexity_check": true
    }
}

示例代码

Shell

JavaScript

Java

Swift

PHP

Python

HTTP

Objective-C

Ruby

OCaml

Dart

返回响应

🟢200成功

application/json

Body

user

object (UserDetails)

可选

allow_web_console

boolean

可选

是否允许登录Web控制台，如果是用于API访问的用户，可禁用web控制台登录

can_delete

boolean

可选

资源是否可以删除, 若为flase, delete_fail_reason会返回不能删除的原因

示例值:

true

can_update

boolean

可选

资源是否可以更新, 若为false,update_fail_reason会返回资源不能删除的原因

示例值:

true

created_at

string <date-time>

资源创建时间

可选

credential_count

integer <int64>

可选

归属该用户的密钥凭证（含AKSK，TOTP，Secret等）的数量

default_project_id

string

可选

deprecated

delete_fail_reason

object (Error)

可选

deleted

boolean

资源是否被删除

可选

deleted_at

string <date-time>

资源删除时间

可选

description

string

资源描述信息

可选

displayname

string

可选

显示名称，用户登录后显示在右上角菜单入口

domain_id

string

域Id

可选

string

用户邮箱

可选

enable_mfa

boolean

是否开启MFA

可选

enabled

boolean

资源是否启用

可选

ext_resource

object

可选

外部资源统计信息（资源类别：数量）

ext_resources_last_update

string <date-time>

可选

外部资源统计信息上次更新时间

ext_resources_next_update

string <date-time>

可选

外部资源统计信息下次更新时间

extra

object

额外信息

可选

failed_auth_at

string <date-time>

上传登录失败的时间

可选

failed_auth_count

integer <int64>

连续登录失败的次数

可选

group_count

integer <int64>

可选

用户归属用户组的数量

groups

array[object (SUserGroup) {4}]

用户归属的组

可选

string

资源UUID

可选

idps

array[object (IdpResourceInfo) {6}]

可选

该用户关联的外部认证源的认证信息

is_emulated

boolean

可选

是否是模拟资源, 部分从公有云上同步的资源并不真实存在, 例如宿主机
list 接口默认不会返回这类资源，除非显示指定 is_emulate=true 过滤参数

is_local

boolean

可选

该用户是否为本地用户（SQL维护的用户）

is_system_account

boolean

可选

是否为系统账号，系统账号不会检查密码复杂度，默认不在列表显示

lang

string

可选

用户的默认语言设置，默认是zh_CN

last_active_at

string <date-time>

上次登录时间

可选

last_login_ip

string

上次用户登录IP

可选

last_login_source

string

可选

上次用户登录方式，可能值有：web（web控制台），cli（命令行climc），API（api）

metadata

object

标签

可选

mobile

string

用户手机号

可选

name

string

资源名称

可选

need_reset_password

boolean

可选

登录后是否需要重置密码

password_expires_at

string <date-time>

可选

密码过期时间（如果开启了密码过期）

password_reset_hint

string

可选

重置密码原因: admin_reset|expire

pending_deleted

boolean

可选

资源是否处于回收站中

pending_deleted_at

string <date-time>

资源放入回收站时间

可选

project_count

integer <int64>

用户归属项目的数量

可选

project_domain

string

可选

资源归属项目的域名称

projects

array[object (SFetchDomainObjectWithMetadata) {5}]

可选

用户归属的的项目信息

record_checksum

string

可选

update_fail_reason

object (Error)

可选

update_version

integer <int64>

资源被更新次数

可选

updated_at

string <date-time>

资源更新时间

可选

示例

{
    "user": {
        "allow_web_console": true,
        "can_delete": true,
        "can_update": true,
        "created_at": "2019-08-24T14:15:22Z",
        "credential_count": 0,
        "default_project_id": "string",
        "delete_fail_reason": {
            "class": "string",
            "code": 0,
            "details": "string"
        },
        "deleted": true,
        "deleted_at": "2019-08-24T14:15:22Z",
        "description": "string",
        "displayname": "string",
        "domain_id": "string",
        "email": "string",
        "enable_mfa": true,
        "enabled": true,
        "ext_resource": {
            "property1": 0,
            "property2": 0
        },
        "ext_resources_last_update": "2019-08-24T14:15:22Z",
        "ext_resources_next_update": "2019-08-24T14:15:22Z",
        "extra": {},
        "failed_auth_at": "2019-08-24T14:15:22Z",
        "failed_auth_count": 0,
        "group_count": 0,
        "groups": [
            {
                "Domain": "string",
                "DomainId": "string",
                "Id": "string",
                "Name": "string"
            }
        ],
        "id": "string",
        "idps": [
            {
                "idp": "string",
                "idp_driver": "string",
                "idp_entity_id": "string",
                "idp_id": "string",
                "is_sso": true,
                "template": "string"
            }
        ],
        "is_emulated": true,
        "is_local": true,
        "is_system_account": true,
        "lang": "string",
        "last_active_at": "2019-08-24T14:15:22Z",
        "last_login_ip": "string",
        "last_login_source": "string",
        "metadata": {
            "property1": "string",
            "property2": "string"
        },
        "mobile": "string",
        "name": "string",
        "need_reset_password": true,
        "password_expires_at": "2019-08-24T14:15:22Z",
        "password_reset_hint": "string",
        "pending_deleted": true,
        "pending_deleted_at": "2019-08-24T14:15:22Z",
        "project_count": 0,
        "project_domain": "string",
        "projects": [
            {
                "domain": "string",
                "domain_id": "string",
                "id": "string",
                "metadata": {
                    "property1": "string",
                    "property2": "string"
                },
                "name": "string"
            }
        ],
        "record_checksum": "string",
        "update_fail_reason": {
            "class": "string",
            "code": 0,
            "details": "string"
        },
        "update_version": 0,
        "updated_at": "2019-08-24T14:15:22Z"
    }
}