huawei-cloud-api-definitions-Workspace 0.1.20260116

Huawei Cloud API definitions, generated from OpenAPI spec
Documentation
1
{"base_path":null,"components":null,"consumes":"[\"application/json\",\"application/json;charset=utf-8\",\"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_detail":{"description":"错误详情。","maxLength":1000,"minLength":0,"type":"string"},"error_msg":{"description":"错误描述。","maxLength":1000,"minLength":0,"type":"string"}}},"OperateUserReq":{"properties":{"op_type":{"description":"操作类型,可选值为:\n- LOCK:锁定用户。\n- UNLOCK:解锁用户。\n- RESET_PWD:重置用户密码。","enum":["LOCK","UNLOCK","RESET_PWD"],"maxLength":55,"minLength":0,"type":"string"}},"required":["op_type"]}},"description":null,"group_id":"7383c32d5d5e4d0481c071faeb994404","host":"workspace.cn-north-4.myhuaweicloud.com","id":"e0ad52def9a241aaad77acd6bc2bd045","info_version":"v2","method":"post","name":"ChangeUserStatus","parameters":{},"paths":{"/v2/{project_id}/users/{user_id}/actions":{"post":{"consumes":["application/json"],"description":"该接口用于操作用户,包含三种操作:锁定、解锁和重置密码(重置密码建议使用/v2/{project_id}/users/{user_id}/random-password接口,在没有通知方式的情况下必须使用/v2/{project_id}/users/{user_id}/random-password接口)。","operationId":"ChangeUserStatus","parameters":[{"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"},{"description":"操作用户请求类。","in":"body","name":"ChangeUserStatusRequestBody","required":true,"schema":{"$ref":"#/definitions/OperateUserReq"}}],"produces":["application/json"],"responses":{"204":{"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-imports":["com.huawei.workspace.auth.iam5.ResourceType"],"x-is-registered":"Y","x-methodAnnotations":["@EnableAuth","@WksIamAuthMeta(resourceType=ResourceType.USER, resourceField=\"user_id\")","@IamAuthMeta(authLevel = IamAuthLevel.INSTANCE, abacAction = \"workspace:users:operate\", needApigwJwtAuthCheck = false, authContextInitializerName = \"workspaceInstanceAuthContextInitializer\", needRbacCheck = false, needAbacResourceCheck = true)","@CtsMeta(serviceType = \"Workspace\", resourceType = \"workspace\", traceName = \"changeUserStatus\")"],"x-request-examples-1":{"op_type":"LOCK"},"x-request-examples-2":{"op_type":"UNLOCK"},"x-request-examples-3":{"op_type":"RESET_PWD"},"x-request-examples-text-1":"{\n  \"op_type\": \"LOCK\"\n}","x-request-examples-url-1":"POST /v2/0bec5db98280d2d02fd6c00c2de791ce/users/8a2c3f9479d5cf360179d622364f0008/actions","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"}