ListAuthorizedAppsByUser

Updated at:

Queries the applications for which a specified user has obtained access permissions through per-application authorization by paging. You can filter results by delivery group ID, delivery group name, application ID, or application name using fuzzy match.

Operation description

Operation description

This operation queries the applications that a specified user is authorized to access at the application granularity. Only records authorized at the application level are returned (for example, authorizations completed through the AuthorizeUsersForApp operation). Authorizations granted to an entire delivery group through the AuthorizeInstanceGroup operation are not included in the response.

The results are deduplicated by the combination of delivery group and application. Each record corresponds to one application within one delivery group.

Before you begin

  • The user must already exist under the current account. If the user does not exist, the error code User.NotFound is returned. Call the DescribeUsers operation to obtain the username.

  • The delivery group that contains the application must already be created, and the application must have been authorized to the user at the application level. If no per-application authorization has been performed, an empty application list is returned.

Parameter description

  • EndUserId and ProductType are required. Set ProductType to CloudApp, which indicates WUYING Cloud Application.

  • AppInstanceGroupId, AppId, AppInstanceGroupName, and AppName are optional filter conditions. All of them use fuzzy match and can be combined in any way. If all are omitted, all per-application authorization records for the user are returned.

  • Use PageNumber and PageSize for paging. PageNumber starts from 1, and PageSize ranges from 1 to 100. Use the returned TotalCount to determine whether to continue querying.

Call sequence

  1. Call the ListAppInstanceGroup or GetAppInstanceGroup operation to obtain the delivery group ID (AppInstanceGroupId) and the application IDs of deployed applications within the delivery group (AppId in the Apps list).

  2. Call the AuthorizeUsersForApp operation to authorize the application to the target user.

  3. Call this operation to query the applications that the user is authorized to access.

Try it now

Try this API in OpenAPI Explorer, no manual signing needed. Successful calls auto-generate SDK code matching your parameters. Download it with built-in credential security for local usage.

Test

RAM authorization

No authorization for this operation. If you encounter issues with this operation, contact technical support.

Request parameters

Parameter

Type

Required

Description

Example

ProductType

string

Yes

The product type. Required. The value is case-insensitive.

This operation queries per-application authorization records. This authorization method applies to WUYING Cloud Application delivery groups. Valid values:

  • CloudApp: WUYING Cloud Application.

CloudApp

PageNumber

integer

Yes

The page number of the results. Required. The value starts from 1.

1

PageSize

integer

Yes

The number of records per page. Required. Valid values: 1 to 100.

10

AppInstanceGroupId

string

No

The delivery group ID used to filter results. Fuzzy match by containment is used. This parameter can be combined with other filter parameters. Call the ListAppInstanceGroup operation to obtain the delivery group ID.

aig-9ciijz60n4xsv****

AppId

string

No

The application ID used to filter results. Fuzzy match by containment is used. This parameter can be combined with other filter parameters. You can obtain the application ID from the Apps list returned by the GetAppInstanceGroup operation.

ca-i87mycyn419nu****

EndUserId

string

Yes

The username to query. Required. The user must already exist under the current account. Call the DescribeUsers operation to obtain the username.

alice

AppInstanceGroupName

string

No

The delivery group name used to filter results. Fuzzy match by name is used. This parameter can be combined with other filter parameters.

OfficeApp

AppName

string

No

The application name used to filter results. Fuzzy match by name is used. This parameter can be combined with other filter parameters.

OfficeApp

Response elements

Element

Type

Description

Example

object

Schema of Response

Apps

array<object>

The list of applications authorized to the user. Each record corresponds to one application within one delivery group.

object

AppIcon

string

The URL of the application icon. This value is empty if the deployment details of the application cannot be obtained.

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

AppId

string

The application ID.

ca-i87mycyn419nu****

AppInstanceGroupId

string

The ID of the delivery group to which the application belongs.

aig-9ciijz60n4xsv****

AppInstanceGroupName

string

The name of the delivery group to which the application belongs. If the delivery group information cannot be obtained, the value is the same as AppInstanceGroupId.

OfficeApp

AppName

string

The application name. If the deployment details of the application cannot be obtained, the value is the same as AppId.

OfficeApp

AppVersion

string

The application version. This value is empty if the deployment details of the application cannot be obtained.

1.0.0

AppVersionName

string

The application version name. This value is empty if the deployment details of the application cannot be obtained.

InitialVersion

AuthorizedUserCount

integer

The number of authorized users for the application within its delivery group. This value is empty if the deployment details of the application cannot be obtained.

3

PageNumber

integer

The page number of the returned results.

1

PageSize

integer

The number of records per page.

10

RequestId

string

The request ID.

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

TotalCount

integer

The total number of authorization records that match the query conditions.

15

Examples

Success response

JSON format

{
  "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
}

Error codes

See Error Codes for a complete list.

Release notes

See Release Notes for a complete list.