Querying User Details
Function
This API is used to query user details.
URI
GET /v2/{project_id}/instances/{instance_id}/users/{user_name}
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
Parameter |
Type |
Description |
---|---|---|
access_key |
String |
Username, which starts with a letter, consists of 7 to 64 characters and can contain only letters, digits, hyphens (-), and underscores (_). |
secret_key |
String |
Secret key. Use 8 to 32 characters. Contain at least three of the following character types:
|
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. |
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" : "**************", "topic_perms" : [ ], "white_remote_address" : "" }
Status Codes
Status Code |
Description |
---|---|
200 |
User details queried successfully. |
Error Codes
See Error Codes.
Feedback
Was this page helpful?
Provide feedbackThank you very much for your feedback. We will continue working to improve the documentation.See the reply and handling status in My Cloud VOC.
For any further questions, feel free to contact us through the chatbot.
Chatbot