Updated on 2024-12-30 GMT+08:00

Querying Application Account Details

Function

This API is used to query application account details.

Constraints

null

URI

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

Table 1 Path Parameters

Parameter

Mandatory

Type

Description

application_id

Yes

String

Application ID.

account_id

Yes

String

Application account ID.

Request Parameters

Table 2 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 3 Response body parameters

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 4 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 5 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 6 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 7 Response body parameters

Parameter

Type

Description

error_code

String

Error code.

error_msg

String

Error details.

Example Requests

Query an application account details based on the application ID and application account ID.

GET https://{domain_name}/api/v2/tenant/applications/{application_id}/accounts/{account_id}

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

Example Responses

Status code: 200

Request successful.

{
  "id" : "5C00-C91355BC0",
  "account_name" : "example01",
  "name" : "Example 1",
  "account_type" : "BASIC_ACCOUNT",
  "org_id" : "20201027162527852-B712-D040F4C71",
  "disabled" : false,
  "extension" : {
    "age" : "18"
  },
  "roles" : [ {
    "role_id" : "20220210090626329-AFAE-EB2862B3A",
    "role_code" : "admin",
    "role_name" : "Administrator",
    "privileges" : [ {
      "privilege_id" : "20220210135202250-92C8-D89EC88C6",
      "privilege_code" : "demo_privilege",
      "privilege_name" : "Permission example",
      "resource_items" : [ {
        "item_id" : "20201027161283642-R582-7230F4E84",
        "item_code" : "demo_item",
        "item_name" : "Item example",
        "item_parentid" : null
      } ]
    } ]
  } ]
}

Status Codes

Status Code

Description

200

Request successful.

400

Invalid parameter.

Error Codes

See Error Codes.