Updated on 2023-05-06 GMT+08:00

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.

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

Username.

secret_key

String

Secret key.

white_remote_address

String

IP address whitelist.

admin

Boolean

Whether the user is an administrator.

default_topic_perm

String

Default topic permissions.

default_group_perm

String

Default consumer group permissions.

topic_perms

Array of topic_perms objects

Special topic permissions.

group_perms

Array of group_perms objects

Special consumer group permissions.

Table 3 topic_perms

Parameter

Type

Description

name

String

Topic name.

perm

String

Permissions.

Table 4 group_perms

Parameter

Type

Description

name

String

Consumer group name.

perm

String

Permissions.

Example Requests

Querying user details

GET https://{endpoint}/v2/{project_id}/instances/{instance_id}/users/{user_name}?offset=0&limit=10

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" : "x1234567@",
  "topic_perms" : [ ],
  "white_remote_address" : ""
}

Status Codes

Status Code

Description

200

User details queried successfully.

Error Codes

See Error Codes.