Querying User Details

Function

This API is used to query user details.

URI

GET /v2/{project_id}/instances/{instance_id}/users/{user_name}

**Table 1** Path Parameters
Parameter	Mandatory	Type	Description
project_id	Yes	String	Project ID. For details about how to obtain it, see Obtaining a Project ID.
instance_id	Yes	String	Instance ID.
user_name	Yes	String	Username.

Request Parameters

None

Response Parameters

Status code: 200

**Table 2** Response body parameters
Parameter	Type	Description
access_key	String	Definition Username. Range N/A
secret_key	String	Definition Secret key. Range N/A
white_remote_address	String	Definition IP address whitelist. Range N/A
admin	Boolean	Definition Whether the user is an administrator. Range true: Yes false: No
default_topic_perm	String	Definition Default topic permissions. Range PUB: publish permissions. SUB: subscribe permissions. PUB\|SUB: subscribe and publish permissions. DENY: no permission.
default_group_perm	String	Definition Default consumer group permissions. Range SUB: subscribe permissions. DENY: no permission.
topic_perms	Array of topic_perms objects	Definition Special topic permissions.
group_perms	Array of group_perms objects	Definition Special consumer group permissions.

**Table 3** topic_perms
Parameter	Type	Description
name	String	Definition Topic name. Range N/A
perm	String	Definition Topic permission. Range PUB: publish permissions. SUB: subscribe permissions. PUB\|SUB: subscribe and publish permissions. DENY: no permission.

**Table 4** group_perms
Parameter	Type	Description
name	String	Definition Consumer group name. Range N/A
perm	String	Definition Consumer group permissions. Range SUB: subscribe permissions. DENY: no permission.

Example Requests

Querying user details

GET https://{endpoint}/v2/{project_id}/instances/{instance_id}/users/{user_name}

Example Responses

Status code: 200

User details queried successfully.

{
  "access_key" : "test_01",
  "admin" : false,
  "default_group_perm" : "DENY",
  "default_topic_perm" : "SUB",
  "group_perms" : [ ],
  "secret_key" : "Abcd1234!",
  "topic_perms" : [ ],
  "white_remote_address" : ""
}