Files

Chen, Junjie 7f68b84da4 DMS API-REF Initial Version

Reviewed-by: Hasko, Vladimir <vladimir.hasko@t-systems.com>
Co-authored-by: Chen, Junjie <chenjunjie@huawei.com>
Co-committed-by: Chen, Junjie <chenjunjie@huawei.com>

2022-12-08 00:34:44 +00:00

7.8 KiB

Raw Blame History

Querying User Permissions

Function

This API is used to query user permissions.

User management is supported only when SASL is enabled for the Kafka instance.

URI

GET /v1/{project_id}/instances/{instance_id}/topics/{topic_name}/accesspolicy

**Table 1** Path Parameters
Parameter	Mandatory	Type	Description
project_id	Yes	String	Project ID.
instance_id	Yes	String	Instance ID.
topic_name	Yes	String	Topic name.

Request Parameters

None

Response Parameters

Status code: 200

**Table 2** Response body parameters
Parameter	Type	Description
name	String	Topic name.
topic_type	Integer	Topic type.
policies	Array of PolicyEntity objects	Permission list.

**Table 3** PolicyEntity
Parameter	Type	Description
owner	Boolean	Whether the user is the one selected during topic creation.
user_name	String	Username.
access_policy	String	Permission type. all: publish and subscribe permissions. pub: publish permissions. sub: subscribe permissions.

Example Requests

Querying user permissions for a topic.

GET https://{endpoint}/v1/{project_id}/instances/{instance_id}/topics/{topic_name}/accesspolicy

Example Responses

Status code: 200

The query is successful.

{
  "name" : "topic-test",
  "policies" : [ {
    "owner" : false,
    "user_name" : "xxxa",
    "access_policy" : "pub"
  }, {
    "owner" : false,
    "user_name" : "root",
    "access_policy" : "all"
  } ],
  "topic_type" : 0
}

Status Codes

Status Code	Description
200	The query is successful.

Error Codes

See Error Codes.

Parent topic: User Management

7.8 KiB Raw Blame History