Help Center/ Workspace/ API Reference/ Workspace Application Streaming APIs/ Application Authorization Management/ Querying Application Group Authorization Records
Updated on 2026-05-21 GMT+08:00
View PDF
Share

Querying Application Group Authorization Records

Function

Queries authorized users of an application.

Debugging

You can debug this API through automatic authentication in API Explorer or use the SDK sample code generated by API Explorer.

Authorization Information

Each account has all the permissions required to call all APIs, but IAM users must be assigned the required permissions.

  • If you are using role/policy-based authorization, see Permissions Policies and Supported Actions for details on the required permissions.
  • If you are using identity policy-based authorization, the following identity policy-based permissions are required.

    Action

    Access Level

    Resource Type (*: required)

    Condition Key

    Alias

    Dependencies

    workspace:appGroup:listAuthorization

    List

    appGroup *

    -

    -

    -

URI

GET /v1/{project_id}/app-groups/actions/list-authorizations

Table 1 Path Parameters

Parameter

Mandatory

Type

Description

project_id

Yes

String

Project ID.
Table 2 Query Parameters

Parameter

Mandatory

Type

Description

limit

No

Integer

The number of records for each query ranges from 1 to 100. The default value is 10.

offset

No

Integer

Query offset. The default value is 0.

app_group_id

No

String

Application group ID.

account_id

No

String

ID of the user or user group authorized to use an application. Exact query is supported.

account

No

String

Name of the authorized user (group). Exact query is supported.

account_type

No

String

Type of the authorized user (group). Options:

  • USER

  • USER_GROUP.

Request Parameters

Table 3 Request header parameters

Parameter

Mandatory

Type

Description

X-Auth-Token

No

String

User token

It can be obtained by calling the IAM API used to obtain a user token. The value of X-Subject-Token in the response header is the user token.

Response Parameters

Status code: 200

Table 4 Response body parameters

Parameter

Type

Description

count

Integer

Total.

authorizations

Array of Authorization objects

Authorization information.
Table 5 Authorization

Parameter

Type

Description

id

String

Authorization ID.

account_id

String

User ID (or user group ID).

account

String

Name of a user or user group.

app_id

String

Application ID. (This parameter is left blank for group-based authorization.).

app_name

String

Application name. (This parameter is left blank for group-based authorization.).

app_group_id

String

Application group ID.

app_group_name

String

Application group name.

authorization_type

String

Authorization type.

  • APP (not supported): Application-based authorization.

  • APP_GROUP (default): Application group-based authorization.

account_type

String

User type.

platform_type

String

Platform type.

domain

String

Domain name.

create_at

String

Publish time.

Status code: 400

Table 6 Response body parameters

Parameter

Type

Description

error_code

String

Error code, which is returned upon failure.

error_msg

String

Error message.

Status code: 401

Table 7 Response body parameters

Parameter

Type

Description

error_code

String

Error code, which is returned upon failure.

error_msg

String

Error message.

Status code: 403

Table 8 Response body parameters

Parameter

Type

Description

error_code

String

Error code, which is returned upon failure.

error_msg

String

Error message.

Status code: 404

Table 9 Response body parameters

Parameter

Type

Description

error_code

String

Error code, which is returned upon failure.

error_msg

String

Error message.

Status code: 405

Table 10 Response body parameters

Parameter

Type

Description

error_code

String

Error code, which is returned upon failure.

error_msg

String

Error message.

Status code: 500

Table 11 Response body parameters

Parameter

Type

Description

error_code

String

Error code, which is returned upon failure.

error_msg

String

Error message.

Status code: 503

Table 12 Response body parameters

Parameter

Type

Description

error_code

String

Error code, which is returned upon failure.

error_msg

String

Error message.

Example Requests

GET /v1/a4da8115c9d8464ead3a38309130523f/app-groups/actions/list-authorizations?limit=10&app_group_id=575772274859184146&offset=0

Example Responses

Status code: 200

Response to a successful request.

{
  "count" : 1,
  "authorizations" : [ {
    "account" : "user000",
    "app_id" : "",
    "app_name" : "",
    "app_group_id" : "575772274859184146",
    "app_group_name" : "Open Test for the API for Creating an Application Group",
    "authorization_type" : "APP_GROUP",
    "account_type" : "USER",
    "domain" : "wksapp***.huawei.com",
    "create_at" : "2023-06-06T14:14:05.576Z"
  } ]
}

Status Codes

Status Code

Description

200

Response to a successful request.

400

The request cannot be understood by the server due to malformed syntax.

401

Authentication failed.

403

Permissions required.

404

No resources found.

405

The request method is not allowed.

500

An internal service error occurred. For details, see the error code description.

503

Service unavailable.

Error Codes

See Error Codes.