Help Center/ OneAccess/ API Reference/ OneAccess APIs/ Management APIs/ User Management/ Querying All Authorized Application Accounts of a User

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

View PDF

Querying All Authorized Application Accounts of a User

Function

This API is used to query all authorized application accounts of a user.

Constraints

null

URI

GET /api/v2/tenant/users/{user_id}/accounts

**Table 1** Path Parameters
Parameter	Mandatory	Type	Description
user_id	Yes	String	User 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
total	Integer	Total number.
accounts	Array of Accounts objects	Application account list.

**Table 4** Accounts
Parameter	Type	Description
id	String	Application account ID.
application_id	String	Application ID.
account_name	String	Application account name.
account_type	String	Application account type.
name	String	Real name.
extension	Object	Custom extended attribute.

Status code: 400

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

Example Requests

Query all authorized application accounts of a user based on the transferred user_id.

GET https://{domain_name}/api/v2/tenant/users/{user_id}/accounts

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

Example Responses

Status code: 200

Request successful.

{
  "total" : 1,
  "accounts" : [ {
    "id" : "20210621095952398-57D5-B75A129DB",
    "account_name" : "Test01",
    "account_type" : "BASIC_ACCOUNT",
    "application_id" : "20210621095843929-CC99-9E7B3BC1F",
    "name" : "test",
    "extension" : { }
  } ]
}