huawei-cloud-api-definitions-Workspace 0.1.20240210

Huawei Cloud API definitions, generated from OpenAPI spec
Documentation
1
{"base_path":null,"components":null,"consumes":"[\"application/json\"]","definitions":{"BaseResponse":{"description":"API响应基类","properties":{"error_code":{"description":"错误码。","maxLength":12,"minLength":0,"type":"string"},"error_msg":{"description":"错误描述。","maxLength":1000,"minLength":0,"type":"string"}}},"UserDetail":{"properties":{"account_expires":{"description":"账号有效期最后一天对应的UTC时间,以毫秒为单位。","format":"int64","maximum":55,"minimum":1,"type":"integer"},"account_type":{"description":"帐号类型(0:用户;1:用户组)。","format":"int32","maximum":55,"minimum":1,"type":"integer"},"active_type":{"description":"激活类型,默认为用户激活。\n* USER_ACTIVATE: 用户激活\n* ADMIN_ACTIVATE: 管理员激活","enum":["ADMIN_ACTIVATE","USER_ACTIVATE"],"example":"admin_activate","maxLength":50,"minLength":0,"type":"string"},"description":{"description":"用户描述。","maxLength":255,"minLength":0,"type":"string"},"disabled":{"description":"账户是否禁用,true表示被禁用,false表示未禁用。","type":"boolean"},"distinguished_name":{"description":"用户在域树上的唯一位置。","maxLength":55,"minLength":1,"type":"string"},"enabled_change_password":{"description":"是否允许修改密码,true表示允许修改密码,false表示不允许。","type":"boolean"},"full_name":{"description":"全名。","maxLength":55,"minLength":1,"type":"string"},"group_names":{"description":"加入的组列表。","items":{"maxLength":255,"minLength":0,"type":"string"},"maxItems":50,"minItems":1,"type":"array"},"id":{"description":"用户id。","maxLength":255,"minLength":0,"type":"string"},"is_pre_user":{"description":"是否是预创建的用户,true表示是预创建用户,false表示不是预创建用户","type":"boolean"},"locked":{"description":"账户是否被锁定,true表示被锁定,false表示未锁定。","type":"boolean"},"next_login_change_password":{"description":"下次登录是否需要重置密码,true表示需要重置密码,false表示不需要。","type":"boolean"},"object_sid":{"description":"用户sid。","maxLength":255,"minLength":1,"type":"string"},"password_never_expired":{"description":"密码是否永不过期,true表示密码永不过期,false表示密码会过期。","type":"boolean"},"sam_account_name":{"description":"登录名(windows以前版本)。","maxLength":55,"minLength":1,"type":"string"},"total_desktops":{"description":"用户绑定桌面云总数。","format":"int32","maximum":55,"minimum":1,"type":"integer"},"user_email":{"description":"用户邮箱。","maxLength":255,"minLength":1,"pattern":"^((([0-9a-zA-Z_]+)|([0-9a-zA-Z]+[_.0-9a-zA-Z-]*[0-9a-zA-Z]+))@([a-zA-Z0-9-_]+[.])+[a-zA-Z0-9]+)$","type":"string"},"user_expired":{"description":"账户是否过期,true表示过期,false表示未过期。","type":"boolean"},"user_name":{"description":"桌面用户名。","maxLength":255,"minLength":0,"type":"string"},"user_phone":{"description":"手机号。","maxLength":20,"minLength":1,"type":"string"},"user_principal_name":{"description":"用户登录名。","maxLength":55,"minLength":1,"type":"string"},"when_created":{"description":"UTC时间毫秒数对应的字符,格式为:yyyy-MM-ddTHH:mm:ss.SSSZ。","maxLength":55,"minLength":1,"type":"string"}}},"UserDetailResponse":{"properties":{"user_detail":{"$ref":"#/definitions/UserDetail","description":"用户详情。"}}}},"description":null,"group_id":"7383c32d5d5e4d0481c071faeb994404","host":"workspace.cn-north-4.myhuaweicloud.com","id":"2e076d6572954a82bc006b1aff3b5212","info_version":"v2","method":"get","name":"ListUserDetail","parameters":{},"paths":{"/v2/{project_id}/users/{user_id}":{"get":{"description":"该接口用于查询指定的桌面用户详情。","operationId":"ListUserDetail","parameters":[{"description":"用户Token。\n\n通过调用IAM服务获取用户Token接口获取(响应消息头中X-Subject-Token的值)。","in":"header","maxLength":15000,"minLength":1,"name":"X-Auth-Token","required":true,"type":"string","x-example":"MIIDkgYJKoZIhvcNAQcCoIIDgzCCXXXXXX..."},{"description":"发送的实体的MIME类型,如:application/json。","in":"header","maxLength":255,"minLength":1,"name":"Content-Type","required":true,"type":"string","x-example":"application/json"},{"description":"项目ID。","in":"path","maxLength":255,"minLength":1,"name":"project_id","required":true,"type":"string","x-example":"2b31ed520xxxxxxebedb6e57xxxxxxxx"},{"description":"用户ID。","in":"path","maxLength":255,"minLength":1,"name":"user_id","required":true,"type":"string","x-example":"4021af9xxxx801742f0167460010"}],"responses":{"200":{"description":"查询桌面用户详细信息响应。","examples":{"application/json":{"user_detail":{"account_expires":0,"account_type":0,"description":"api测试用户。","disabled":false,"distinguished_name":"api-test","enabled_change_password":true,"full_name":"api-test","group_names":["DomainUsers"],"id":"8a2c3f9579d240820179d51e6caf0001","locked":false,"next_login_change_password":true,"object_sid":"8a2c3f9579d240820179d51e6caf0001","password_never_expired":false,"sam_account_name":"api-test","total_desktops":0,"user_email":"test@huawei.com","user_expired":false,"user_name":"api-test","when_created":"2021-06-03T19:43:31.000Z"}}},"schema":{"$ref":"#/definitions/UserDetailResponse"}},"400":{"description":"由于包含语法错误,当前请求无法被服务器理解。","schema":{"$ref":"#/definitions/BaseResponse"}},"401":{"description":"鉴权失败。","schema":{"$ref":"#/definitions/BaseResponse"}},"403":{"description":"没有操作权限。","schema":{"$ref":"#/definitions/BaseResponse"}},"404":{"description":"找不到资源。","schema":{"$ref":"#/definitions/BaseResponse"}},"405":{"description":"请求中指定的方法不被允许。","schema":{"$ref":"#/definitions/BaseResponse"}},"500":{"description":"服务内部错误,具体返回错误码请参见错误码说明。","schema":{"$ref":"#/definitions/BaseResponse"}},"503":{"description":"服务不可用。","schema":{"$ref":"#/definitions/BaseResponse"}}},"schemes":["https"],"summary":"查询用户详情信息","tags":["User"],"x-apiexplorer-hide":"N","x-apig-group":"public,internal_token","x-apigateway-request-type":"public","x-is-registered":"Y","x-request-examples-url-1":"GET /v2/0bec5db98280d2d02fd6c00c2de791ce/users/8a2c3f9579d240820179d51e6caf0001","x-support-sdk":"Y"}}},"product_short":"Workspace","region_id":"cn-north-4","schemes":["HTTPS"],"security_definitions":null,"summary":"查询用户详情信息","tags":"用户","uri":null,"version":"2.0"}