huawei-cloud-api-definitions-WorkspaceApp 0.1.20260612

Huawei Cloud API definitions, generated from OpenAPI spec
Documentation
1
{"base_path":null,"components":null,"consumes":"[\"application/json\"]","definitions":{"AccountTypeEnum":{"description":"用户类型:\n* `USER` - 用户\n* `USER_GROUP` - 用户组","enum":["USER","USER_GROUP"],"example":"USER","type":"string"},"Authorization":{"description":"用户授权信息。","properties":{"account":{"description":"用户名(或用户组名)。","example":"zhangsan***","readOnly":true,"type":"string"},"account_id":{"description":"用户ID(或用户组ID)。","example":"6E2A6F79-4ECE-4405-A6F8-C0F1FE6774D6","readOnly":true,"type":"string"},"account_type":{"$ref":"#/definitions/AccountTypeEnum","description":"用户类型。","readOnly":true},"app_group_id":{"description":"应用组ID。","example":"1","readOnly":true,"type":"string"},"app_group_name":{"description":"应用组名称。","example":"办公软件应用组","readOnly":true,"type":"string"},"app_id":{"default":"","description":"应用ID (按照组授权时,该字段为空)。","example":"1","readOnly":true,"type":"string"},"app_name":{"default":"","description":"应用名称 (按照组授权时,该字段为空)。","example":"Chrome","readOnly":true,"type":"string"},"authorization_type":{"$ref":"#/definitions/AuthorizationTypeEnum","readOnly":true},"create_at":{"description":"发布时间。","example":"2022-03-07T10:40:43.858Z","format":"date-time","readOnly":true,"type":"string"},"domain":{"description":"域名称。","example":"siv.**.huawei.com","readOnly":true,"type":"string"},"id":{"description":"授权ID。","example":"439d64d37c8b495f97bc0d1662a36485","readOnly":true,"type":"string"},"platform_type":{"$ref":"#/definitions/PlatformTypeEnum","description":"平台类型。","readOnly":true}}},"AuthorizationTypeEnum":{"default":"APP_GROUP","description":"授权类型,基于应用(组)授权,默认为APP_GROUP授权。\n* `APP` - 按照应用授权(***尚未支持***)。\n* `APP_GROUP` - 按照应用组授权。","enum":["APP","APP_GROUP"],"example":"APP_GROUP","type":"string"},"BadRequestErrorResp":{"description":"API错误响应。","properties":{"error_code":{"description":"错误码,失败时返回。","example":"WKS.00211102","readOnly":true,"type":"string"},"error_msg":{"description":"错误描述。","example":"The parameter is invalid.","readOnly":true,"type":"string"}}},"ForbiddenErrorResp":{"description":"API错误响应。","properties":{"error_code":{"description":"错误码,失败时返回。","example":"WKS.00081102","readOnly":true,"type":"string"},"error_msg":{"description":"错误描述。","example":"User does not have permission to access this resource.","readOnly":true,"type":"string"}}},"InternalServerErrorResp":{"description":"API错误响应。","properties":{"error_code":{"description":"错误码,失败时返回。","example":"WKS.00211401","readOnly":true,"type":"string"},"error_msg":{"description":"错误描述。","example":"The requested operation failed. Please try again later.","readOnly":true,"type":"string"}}},"ListAppAuthorizationUserResp":{"allOf":[{"$ref":"#/definitions/PageResp"},{"properties":{"authorizations":{"description":"授权信息。","items":{"$ref":"#/definitions/Authorization"},"readOnly":true,"type":"array"}},"type":"object"}],"description":"查询应用授权用户响应结构体。"},"MethodNotAllowedErrorResp":{"description":"API错误响应。","properties":{"error_code":{"description":"错误码,失败时返回。","example":"WKS.00000405","readOnly":true,"type":"string"},"error_msg":{"description":"错误描述。","example":"The method specified in the request is not allowed for this resource.","readOnly":true,"type":"string"}}},"NotFoundErrorResp":{"description":"API错误响应。","properties":{"error_code":{"description":"错误码,失败时返回。","example":"WKS.00211902","readOnly":true,"type":"string"},"error_msg":{"description":"错误描述。","example":"The application does not exist","readOnly":true,"type":"string"}}},"PageResp":{"description":"API列表查询响应。\n\n**⚠ 警告: 此Model不生成java代码,允许其它Model中引用,请勿直接作为Model使用。**","properties":{"count":{"description":"总数。","example":0,"maximum":2147483647,"minimum":0,"type":"integer"}}},"PlatformTypeEnum":{"description":"平台类型:\n* `AD` - AD域\n* `LOCAL` - LiteAs\n* `SYSTEM` - 系统内置","enum":["AD","LOCAL","SYSTEM"],"example":"AD","type":"string"},"ServiceUnavailableErrorResp":{"description":"API错误响应。","properties":{"error_code":{"description":"错误码,失败时返回。","example":"WKS.00050902","readOnly":true,"type":"string"},"error_msg":{"description":"错误描述。","example":"The service is now unavailable to process the request.","readOnly":true,"type":"string"}}},"UnauthorizedErrorResp":{"description":"API错误响应。","properties":{"error_code":{"description":"错误码,失败时返回。","example":"WKS.00211302","readOnly":true,"type":"string"},"error_msg":{"description":"错误描述。","example":"User authorization error.","readOnly":true,"type":"string"}}}},"description":null,"group_id":"fe7dbee2e20f4aa589be7dce935a38ad","host":"appstream.cn-north-4.myhuaweicloud.com","id":"2a994d8ba8f2480eb3de250ddba63b33","info_version":"v1","method":"get","name":"ListAppGroupAuthorization","parameters":{},"paths":{"/v1/{project_id}/app-groups/actions/list-authorizations":{"get":{"description":"查询应用内已授权的用户列表。","operationId":"ListAppGroupAuthorization","parameters":[{"description":"用户Token。\n通过调用IAM服务获取用户Token接口获取(响应消息头中X-Subject-Token的值)。","in":"header","maxLength":2147483647,"minLength":1,"name":"X-Auth-Token","required":false,"type":"string","x-example":"MIIDkgYJKoZIhvcNAQcCoIIDgzCCXXXXXX..."},{"description":"项目ID。","in":"path","maxLength":128,"minLength":1,"name":"project_id","required":true,"type":"string","x-example":"2b31ed520xxxxxxebedb6e57xxxxxxxx"},{"default":10,"description":"单次查询的大小[1-100],默认值10。","in":"query","maximum":100,"minimum":1,"name":"limit","required":false,"type":"integer","x-example":"10"},{"default":0,"description":"查询的偏移量,默认值0。","in":"query","maximum":2147483647,"minimum":0,"name":"offset","required":false,"type":"integer","x-example":"0"},{"description":"应用组ID。","in":"query","maxLength":128,"minLength":0,"name":"app_group_id","required":false,"type":"string"},{"description":"应用授权的用户(组)ID,精确查询。","in":"query","maxLength":128,"minLength":0,"name":"account_id","required":false,"type":"string"},{"description":"应用授权的用户(组)名称,精确查询。","in":"query","maxLength":1024,"minLength":0,"name":"account","required":false,"type":"string"},{"description":"应用授权的用户(组)类型:\n* 'USER' - 用户\n* 'USER_GROUP' - 用户组","in":"query","name":"account_type","pattern":"^(USER|USER_GROUP)?$","required":false,"type":"string"}],"responses":{"200":{"description":"成功响应。","examples":{"application/json":{"authorizations":[{"account":"user000","account_type":"USER","app_group_id":"575772274859184146","app_group_name":"开放性API创建应用组测试","app_id":"","app_name":"","authorization_type":"APP_GROUP","create_at":"2023-06-06T14:14:05.576Z","domain":"wksapp***.huawei.com"}],"count":1}},"schema":{"$ref":"#/definitions/ListAppAuthorizationUserResp"}},"400":{"description":"由于包含语法错误,当前请求无法被服务器理解。","schema":{"$ref":"#/definitions/BadRequestErrorResp"}},"401":{"description":"鉴权失败。","schema":{"$ref":"#/definitions/UnauthorizedErrorResp"}},"403":{"description":"没有操作权限。","schema":{"$ref":"#/definitions/ForbiddenErrorResp"}},"404":{"description":"找不到资源。","schema":{"$ref":"#/definitions/NotFoundErrorResp"}},"405":{"description":"请求中指定的方法不被允许。","schema":{"$ref":"#/definitions/MethodNotAllowedErrorResp"}},"500":{"description":"服务内部错误,具体返回错误码请参见错误码说明。","schema":{"$ref":"#/definitions/InternalServerErrorResp"}},"503":{"description":"服务不可用。","schema":{"$ref":"#/definitions/ServiceUnavailableErrorResp"}}},"schemes":["https"],"security":[{"apig-auth-iam-used-authn5":[]}],"summary":"查询应用组授权记录","tags":["Authorization"],"x-api-type":"open-api","x-apiexplorer-hide":"N","x-apig-group":"internal,public","x-apigateway-backend":{"httpVpcEndpoints":{"description":"","method":"GET","name":"wks-appmanager-lb","path":"/v1/{project_id}/app-groups/actions/list-authorizations","scheme":"https","timeout":30000},"parameters":[{"description":"","in":"header","name":"X-Auth-Token","origin":"request","value":"X-Auth-Token"},{"description":"","in":"path","name":"project_id","origin":"request","value":"project_id"},{"description":"","in":"query","name":"limit","origin":"request","value":"limit"},{"description":"","in":"query","name":"offset","origin":"request","value":"offset"},{"description":"","in":"query","name":"account","origin":"request","value":"account"},{"description":"","in":"query","name":"app_group_id","origin":"request","value":"app_group_id"},{"description":"","in":"query","name":"account_type","origin":"request","value":"account_type"}],"type":"HTTP-VPC"},"x-apigateway-cors":false,"x-apigateway-match-mode":"NORMAL","x-apigateway-ratelimit":"workspace_default_get","x-apigateway-request-type":"public","x-is-registered":"Y","x-order":2,"x-request-examples-url-1":"GET /v1/a4da8115c9d8464ead3a38309130523f/app-groups/actions/list-authorizations?limit=10&app_group_id=575772274859184146&offset=0","x-support-hcs":"Y","x-support-sdk":"Y"}}},"product_short":"WorkspaceApp","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"}