huawei-cloud-api-definitions-Workspace 0.1.20250711

Huawei Cloud API definitions, generated from OpenAPI spec
Documentation
1
{"base_path":null,"components":null,"consumes":"[\"application/json\",\"application/json;charset=utf-8\"]","definitions":{"BaseResponse":{"description":"API响应基类。","properties":{"encoded_authorization_message":{"description":"加密后的详细拒绝原因,用户可以自行调用STS服务的decode-authorization-message接口进行解密。","readOnly":true,"type":"string"},"error_code":{"description":"错误码。","maxLength":12,"minLength":0,"type":"string"},"error_msg":{"description":"错误描述。","maxLength":1000,"minLength":0,"type":"string"}}},"BatchCreateUsersReq":{"properties":{"users":{"description":"创建单个用户请求。","items":{"$ref":"#/definitions/CreateUserRequest"},"maxItems":200,"minItems":1,"type":"array","x-maxLength":200,"x-minLength":1}},"required":["users"]},"CreateUserRequest":{"properties":{"account_expires":{"description":"账户过期时间,0表示永远不过期。时间格式:yyyy-MM-ddTHH:mm:ssZ或yyyy-MM-ddTHH:mm:ss.SSSZ。","maxLength":55,"minLength":0,"type":"string"},"active_type":{"description":"激活类型,默认为用户激活。\n* USER_ACTIVATE: 用户激活\n* ADMIN_ACTIVATE: 管理员激活","enum":["USER_ACTIVATE","ADMIN_ACTIVATE"],"example":"ADMIN_ACTIVATE","maxLength":50,"minLength":0,"type":"string"},"alias_name":{"description":"别名。","maxLength":55,"minLength":0,"type":"string"},"description":{"description":"用户描述,字符串长度区间[0, 255]。","maxLength":255,"minLength":0,"type":"string"},"enable_change_password":{"default":true,"description":"是否允许用户更改密码,缺省值为true,后续此字段无效,创建时都为true。","type":"boolean"},"enterprise_project_id":{"description":"企业项目ID","maxLength":255,"minLength":0,"type":"string"},"group_ids":{"description":"用户组的专有ID列表。","items":{"maxLength":55,"minLength":0,"type":"string"},"maxItems":5,"minItems":1,"type":"array"},"next_login_change_password":{"default":true,"description":"下次登录是否必须更改密码,缺省值为true。后续此字段无效,创建时都为true。","type":"boolean"},"password":{"description":"用户初始密码。管理员激活模式需要输入。","maxLength":20,"minLength":0,"type":"string","x-isSensitive":true},"user_email":{"description":"用户邮箱。","maxLength":64,"minLength":0,"type":"string","x-isSensitive":true},"user_info_map":{"description":"用户信息映射,包含用户的服务等级、操作模式和类型。","maxLength":255,"minLength":0,"type":"string"},"user_name":{"description":"用户名称。","maxLength":32,"minLength":0,"pattern":"[a-zA-Z0-9]{1,32}|[a-zA-Z0-9][a-zA-Z0-9._-]{0,30}[a-zA-Z0-9-]$","type":"string"},"user_phone":{"description":"用户手机号。","maxLength":20,"minLength":0,"type":"string","x-isSensitive":true}},"required":["user_name"]}},"description":null,"group_id":"7383c32d5d5e4d0481c071faeb994404","host":"workspace.cn-north-4.myhuaweicloud.com","id":"2d3c28a269d64849b1a06e07038fdf30","info_version":"v2","method":"post","name":"BatchCreateUsers","parameters":{"Content-Type":{"description":"发送的实体的MIME类型,如:application/json。","in":"header","maxLength":255,"minLength":1,"name":"Content-Type","required":true,"type":"string","x-example":"application/json"}},"paths":{"/v2/{project_id}/users/batch-create":{"post":{"consumes":["application/json"],"description":"该接口用于批量创建用户。","operationId":"BatchCreateUsers","parameters":[{"description":"用户Token。\n\n通过调用IAM服务获取用户Token接口获取(响应消息头中X-Subject-Token的值)。","in":"header","maxLength":40000,"minLength":1,"name":"X-Auth-Token","required":false,"type":"string","x-example":"MIIDkgYJKoZIhvcNAQcCoIIDgzCCXXXXXX..."},{"$ref":"#/parameters/Content-Type"},{"description":"项目ID。","in":"path","maxLength":255,"minLength":1,"name":"project_id","required":true,"type":"string","x-example":"2b31ed520xxxxxxebedb6e57xxxxxxxx"},{"description":"该接口用于批量创建用户请求。","in":"body","name":"BatchCreateUsersRequestBody","required":true,"schema":{"$ref":"#/definitions/BatchCreateUsersReq"}}],"produces":["application/json"],"responses":{"200":{"description":"创建云桌面用户响应。"},"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-addValid":true,"x-api-type":"open-api","x-apiexplorer-hide":"N","x-apig-group":"public,internal_token","x-apigateway-request-type":"public","x-is-registered":"Y","x-methodAnnotations":["@EnableAuth","@WksIamAuthMeta(operationType = OperationType.LIST, resourceType=ResourceType.USER)","@IamAuthMeta(authLevel = IamAuthLevel.INSTANCE_LIST, abacAction = \"workspace:users:batchCreate\",  needApigwJwtAuthCheck = false, authContextInitializerName = \"workspaceListAuthContextInitializer\", needRbacCheck = false, needAbacResourceCheck = true)","@CtsMeta(serviceType = \"Workspace\", resourceType = \"workspace\", traceName = \"batchCreateUsers\")"],"x-request-examples-1":{"users":[{"user_email":"xxx@mail.com","user_name":"abc"}]},"x-request-examples-url-1":"POST /v2/0bec5db98280d2d02fd6c00c2de791ce/users/batch-create","x-support-sdk":"Y"}}},"product_short":"Workspace","region_id":"cn-north-4","schemes":["HTTPS"],"security_definitions":{"apig-auth-app":{"in":"header","name":"Authorization","type":"apiKey","x-apigateway-auth-type":"AppSigv1"},"apig-auth-iam":{"in":"header","name":"unused","type":"apiKey","x-apigateway-auth-type":"IAM"},"apig-auth-iam-used-authn5":{"in":"header","name":"unused","type":"apiKey","x-apigateway-auth-opt":{"inner-auth-type":"iam_auth_n5"},"x-apigateway-auth-type":"IAM"}},"summary":"批量创建用户","tags":"用户","uri":null,"version":"2.0"}