Querying Users Granted Permissions for a Consumer Group

Updated on 2022-09-14 GMT+08:00

View PDF

Function

This API is used to query the list of users that have been granted permissions for a consumer group.

URI

GET /v2/{engine}/{project_id}/instances/{instance_id}/groups/{group_id}/accesspolicy

**Table 1** Path Parameters
Parameter	Mandatory	Type	Description
engine	Yes	String	Message engine. Default: reliability
project_id	Yes	String	Project ID.
instance_id	Yes	String	Instance ID.
group_id	Yes	String	Consumer group.

**Table 2** Query Parameters
Parameter	Mandatory	Type	Description
offset	No	String	Offset, which is the position where the query starts. The value must be greater than or equal to 0.
limit	No	String	Number of records to query.

Request Parameters

None

Response Parameters

Status code: 200

**Table 3** Response body parameters
Parameter	Type	Description
policies	Array of policies objects	User list.
total	Number	Total number of users.
name	String	Name of the topic or consumer group.

**Table 4** policies
Parameter	Type	Description
access_key	String	Key.
white_remote_address	String	IP address whitelist.
admin	Boolean	Whether the user is an administrator.
perm	String	Permissions.

Example Requests

Querying the list of users granted permissions for a consumer group

GET https://{endpoint}/v2/{engine}/{project_id}/instances/{instance_id}/groups/{group_id}/accesspolicy

Example Responses

Status code: 200

List of users granted permissions for a consumer group queried successfully.

{
  "policies" : {
    "access_key" : "test_01",
    "secret_key" : "AAAAAgAAAAAAAAAHAAAAAQAAAAdqH2a/vCXyEfkugiYc6nmu+g6CQPoaXhajh+3pHjscvgAAAAAAAAAAAAAAEBSNBQuVKEq+9yvR6GbKcW4=",
    "white_remote_address" : "",
    "admin" : false,
    "perm" : ""
  },
  "total" : 1,
  "name" : "test"
}