Querying the Application Account List

Function

This API is used to query the list of accounts that are authorized to access an application.

Constraints

null

URI

GET /api/v2/tenant/applications/{application_id}/accounts

**Table 1** Path Parameters
Parameter	Mandatory	Type	Description
application_id	Yes	String	Application ID.

**Table 2** Query Parameters
Parameter	Mandatory	Type	Description
account_type	No	String	Account type. The value is fixed at BASIC_ACCOUNT (common application account), ORPHAN_ACCOUNT (orphan account), or PUBLIC_ACCOUNT (public account). This value can be left blank, which means to query all accounts.
offset	Yes	Integer	Page number.
limit	Yes	Integer	Number of data records on each page.

Request Parameters

**Table 3** Request header parameters
Parameter	Mandatory	Type	Description
Authorization	Yes	String	Authentication credential. The value is "Bearer {access_token}". access_token is obtained by calling the API for obtaining an access credential.

Response Parameters

Status code: 200

**Table 4** Response body parameters
Parameter	Type	Description
total	Long	Total number of application accounts.
accounts	Array of AccountDetail objects	List of users who respond to the request.

**Table 5** AccountDetail
Parameter	Type	Description
id	String	Application account ID.
account_name	String	Application account name.
account_type	String	Application account type.
name	String	Real name.
disabled	Boolean	Whether disabled.
org_id	String	Application organization ID.
roles	Array of RolesInfo objects	Role information.
extension	Object	Custom extended attribute.

**Table 6** RolesInfo
Parameter	Type	Description
role_id	String	Role ID.
role_code	String	Role code.
role_name	String	Role name.
privileges	Array of PrivilegeInfo objects	Permission set.

**Table 7** PrivilegeInfo
Parameter	Type	Description
privilege_id	String	Permission ID.
privilege_code	String	Permission code.
privilege_name	String	Permission name.
resource_items	Array of ResourceItem objects	Resource item set.

**Table 8** ResourceItem
Parameter	Type	Description
item_id	String	Item ID.
item_code	String	Item code.
item_name	String	Item name.
item_parentid	String	Parent item ID.

Status code: 400

**Table 9** Response body parameters
Parameter	Type	Description
error_code	String	Error code.
error_msg	String	Error details.

Example Requests

Query a common account list in an application by application ID in the pagination mode. The first 100 records are returned. If the number of records is less than 100, all records are returned.

GET https://{domain_name}/api/v2/tenant/applications/{application_id}/accounts?account_type=BASIC_ACCOUNT&offset=0&limit=100

Authorization: Bearer 334963fc-1e4a-473b-9096-52a929140...

Example Responses

Status code: 200

Request successful.

{
  "total" : 1,
  "accounts" : [ {
    "id" : "20210621095850460-5A8A-03D94B540",
    "account_name" : "Test01",
    "account_type" : "BASIC_ACCOUNT",
    "name" : "Example01",
    "disabled" : false,
    "org_id" : "20210621095942194-560B-57E3CC...",
    "extension" : { }
  } ]
}