ListAuthorizedAppsByUser - 查询用户已授权的应用列表

更新时间:
复制 MD 格式

分页查询指定用户通过按应用授权获得访问权限的应用,可按交付组 ID、交付组名称、应用 ID、应用名称进行模糊筛选。

接口说明

接口说明

本接口按应用粒度查询指定用户已获授权的应用,只返回按应用维度授权给该用户的记录(例如通过 AuthorizeUsersForApp 接口完成的授权);通过 AuthorizeInstanceGroup 接口对整个交付组进行的授权不在本接口的返回结果中。

返回结果按“交付组 + 应用”组合去重,每条记录对应一个交付组内的一个应用。

前置条件

  • 用户已存在于当前账号下;用户不存在时返回错误码 User.NotFound。可调用 DescribeUsers 接口获取用户名。

  • 应用所在的交付组已创建,且该应用已按应用维度授权给该用户;尚未做过按应用授权时,返回的应用列表为空。

参数说明

  • EndUserId 和 ProductType 为必填。 ProductType 填写 CloudApp,表示无影云应用。

  • AppInstanceGroupId、AppId、AppInstanceGroupName、AppName 为可选筛选条件,均为模糊匹配,可任意组合同时传入;全部省略时返回该用户全部按应用授权的记录。

  • 使用 PageNumber 和 PageSize 分页,PageNumber 从 1 开始,PageSize 取值范围为 1~100;结合返回的 TotalCount 判断是否继续查询。

调用顺序

  1. 调用 ListAppInstanceGroup 或 GetAppInstanceGroup 接口,获取交付组 ID(AppInstanceGroupId)以及交付组内已部署应用的应用 ID(Apps 列表中的 AppId)。

  2. 调用 AuthorizeUsersForApp 接口,将应用授权给目标用户。

  3. 调用本接口,查询该用户已获授权的应用。

调试

您可以在OpenAPI Explorer中直接运行该接口,免去您计算签名的困扰。运行成功后,OpenAPI Explorer可以自动生成SDK代码示例。

调试

授权信息

当前API暂无授权信息透出。

请求参数

名称

类型

必填

描述

示例值

ProductType

string

是

产品类型。必填,取值不区分大小写。

本接口查询的是按应用授权的记录,该授权方式适用于无影云应用交付组。取值:

  • CloudApp:无影云应用。

CloudApp

PageNumber

integer

是

查询结果的页码,必填,从 1 开始。

1

PageSize

integer

是

每页返回的记录数,必填,取值范围为 1~100。

10

AppInstanceGroupId

string

否

交付组 ID,用于筛选结果。按包含关系模糊匹配,可与其他筛选参数组合使用。可调用 ListAppInstanceGroup 接口获取。

aig-9ciijz60n4xsv****

AppId

string

否

应用 ID,用于筛选结果。按包含关系模糊匹配,可与其他筛选参数组合使用。可通过 GetAppInstanceGroup 接口返回的 Apps 列表获取。

ca-i87mycyn419nu****

EndUserId

string

是

要查询的用户名,必填。该用户须已存在于当前账号下,可调用 DescribeUsers 接口获取用户名。

alice

AppInstanceGroupName

string

否

交付组名称,用于筛选结果。按名称模糊匹配,可与其他筛选参数组合使用。

办公应用

AppName

string

否

应用名称,用于筛选结果。按名称模糊匹配,可与其他筛选参数组合使用。

办公应用

返回参数

名称

类型

描述

示例值

object

Schema of Response

Apps

array<object>

已授权给该用户的应用列表。每条记录对应一个交付组内的一个应用。

object

AppIcon

string

应用图标的访问地址。无法获取该应用的部署详情时为空。

https://app-center-icon-****.png

AppId

string

应用 ID。

ca-i87mycyn419nu****

AppInstanceGroupId

string

该应用所属交付组的 ID。

aig-9ciijz60n4xsv****

AppInstanceGroupName

string

该应用所属交付组的名称。无法获取交付组信息时,返回值与 AppInstanceGroupId 相同。

办公应用

AppName

string

应用名称。无法获取该应用的部署详情时,返回值与 AppId 相同。

办公应用

AppVersion

string

应用版本。无法获取该应用的部署详情时为空。

1.0.0

AppVersionName

string

应用版本名称。无法获取该应用的部署详情时为空。

初始版本

AuthorizedUserCount

integer

该应用在所属交付组内已授权的用户数量。无法获取该应用的部署详情时为空。

3

PageNumber

integer

当前返回结果的页码。

1

PageSize

integer

每页返回的记录数。

10

RequestId

string

请求 ID。

1CBAFFAB-B697-4049-A9B1-67E1FC5F****

TotalCount

integer

符合查询条件的授权记录总数。

15

示例

正常返回示例

JSON格式

{
  "Apps": [
    {
      "AppIcon": "https://app-center-icon-****.png",
      "AppId": "ca-i87mycyn419nu****",
      "AppInstanceGroupId": "aig-9ciijz60n4xsv****",
      "AppInstanceGroupName": "办公应用",
      "AppName": "办公应用",
      "AppVersion": "1.0.0",
      "AppVersionName": "初始版本",
      "AuthorizedUserCount": 3
    }
  ],
  "PageNumber": 1,
  "PageSize": 10,
  "RequestId": "1CBAFFAB-B697-4049-A9B1-67E1FC5F****",
  "TotalCount": 15
}

错误码

访问错误中心查看更多错误码。

变更历史

更多信息,参考变更详情。