Updated on 2026-11-03 GMT+08:00

Granting User Permissions

Function

Configure user permissions.

User management is supported only when SASL is enabled for Kafka instances.

Calling Method

For details, see Calling APIs.

Authorization Information

Each account has all the permissions required to call all APIs, but IAM users must be assigned the required permissions.

  • If you are using role/policy-based authorization, see Permissions Policies and Supported Actions for details on the required permissions.
  • If you are using identity policy-based authorization, the following identity policy-based permissions are required.

    Action

    Access Level

    Resource Type (*: required)

    Condition Key

    Alias

    Dependencies

    dms:topic:setAccessPolicy

    Write

    kafka

    • g:ResourceTag/<tag-key>

    • g:EnterpriseProjectId

    dms:instance:modify

    -

    topic *

    -

URI

POST /v1/{project_id}/instances/{instance_id}/topics/accesspolicy

Table 1 Path Parameters

Parameter

Mandatory

Type

Description

project_id

Yes

String

Definition

Project ID. For details, see Obtaining a Project ID.

Constraints

N/A

Range

N/A

Default Value

N/A

instance_id

Yes

String

Definition

Instance ID. To obtain it, call the API for querying all instances.

Constraints

N/A

Range

N/A

Default Value

N/A

Request Parameters

Table 2 Request body parameters

Parameter

Mandatory

Type

Description

topics

No

Array of AccessPolicyTopicEntity objects

Definition

Topic list. Each element represents a specific topic and its corresponding permission policy.

Constraints

This field is used for single topic configuration or old batch configuration.

batch_topic_name

No

Array of strings

Definition

List of topic names for batch operations.

Constraints

This parameter is mandatory when new batch authorization (batch_policy) is enabled. This field contains only the topic name. The permission policy is specified by batch_policy.

batch_policy

No

Array of AccessPolicyEntity objects

Definition

Permission list.

Constraints

This parameter is mandatory when new batch authorization (batch_topic_name) is enabled.

Table 3 AccessPolicyTopicEntity

Parameter

Mandatory

Type

Description

name

Yes

String

Definition

Topic name.

Constraints

N/A

Range

N/A

Default Value

N/A

policies

Yes

Array of AccessPolicyEntity objects

Definition

Permission list.

Constraints

N/A

Table 4 AccessPolicyEntity

Parameter

Mandatory

Type

Description

user_name

No

String

Definition

Username.

Constraints

This parameter is mandatory when you set user permissions.

Range

N/A

Default Value

N/A

access_policy

No

String

Definition

Permission type.

Constraints

This parameter is mandatory when you set user permissions.

Range

  • all: subscribe and publish permissions.

  • pub: publish permissions.

  • sub: subscribe permissions.

Default Value

N/A

Response Parameters

Status code: 200

Table 5 Response body parameters

Parameter

Type

Description

job_id

String

Definition

Background task ID.

Range

N/A

Status code: 400

Table 6 Response body parameters

Parameter

Type

Description

error_code

String

Definition

Error code.

Range

N/A

error_msg

String

Definition

Error description.

Range

N/A

Status code: 403

Table 7 Response body parameters

Parameter

Type

Description

error_code

String

Definition

Error code.

Range

N/A

error_msg

String

Definition

Error description.

Range

N/A

Example Requests

  • Granting the root user the permission to publish and subscribe to topic-test

    POST https://{endpoint}/v1/{project_id}/instances/{instance_id}/topics/accesspolicy
    
    {
      "topics" : [ {
        "name" : "topic-test",
        "policies" : [ {
          "user_name" : "root",
          "access_policy" : "all"
        } ]
      } ]
    }
  • Configure user permissions for topics in batches.

    POST https://{endpoint}/v1/{project_id}/instances/{instance_id}/topics/accesspolicy
    
    {
      "batch_topic_name" : [ "topic-1", "topic-2" ],
      "batch_policy" : [ {
        "user_name" : "root",
        "access_policy" : "all"
      }, {
        "user_name" : "admin",
        "access_policy" : "all"
      } ]
    }

Example Responses

Status code: 200

{
  "job_id" : "8a2c259182ab0e9d0182ab1882560010"
}

SDK Sample Code

The SDK sample code is as follows.

  • Granting the root user the permission to publish and subscribe to topic-test

     1
     2
     3
     4
     5
     6
     7
     8
     9
    10
    11
    12
    13
    14
    15
    16
    17
    18
    19
    20
    21
    22
    23
    24
    25
    26
    27
    28
    29
    30
    31
    32
    33
    34
    35
    36
    37
    38
    39
    40
    41
    42
    43
    44
    45
    46
    47
    48
    49
    50
    51
    52
    53
    54
    55
    56
    57
    58
    59
    60
    61
    62
    63
    64
    65
    package com.huaweicloud.sdk.test;
    
    import com.huaweicloud.sdk.core.auth.ICredential;
    import com.huaweicloud.sdk.core.auth.BasicCredentials;
    import com.huaweicloud.sdk.core.exception.ConnectionException;
    import com.huaweicloud.sdk.core.exception.RequestTimeoutException;
    import com.huaweicloud.sdk.core.exception.ServiceResponseException;
    import com.huaweicloud.sdk.kafka.v2.region.KafkaRegion;
    import com.huaweicloud.sdk.kafka.v2.*;
    import com.huaweicloud.sdk.kafka.v2.model.*;
    
    import java.util.List;
    import java.util.ArrayList;
    
    public class UpdateTopicAccessPolicySolution {
    
        public static void main(String[] args) {
            // The AK and SK used for authentication are hard-coded or stored in plaintext, which has great security risks. It is recommended that the AK and SK be stored in ciphertext in configuration files or environment variables and decrypted during use to ensure security.
            // In this example, AK and SK are stored in environment variables for authentication. Before running this example, set environment variables CLOUD_SDK_AK and CLOUD_SDK_SK in the local environment
            String ak = System.getenv("CLOUD_SDK_AK");
            String sk = System.getenv("CLOUD_SDK_SK");
            String projectId = "{project_id}";
    
            ICredential auth = new BasicCredentials()
                    .withProjectId(projectId)
                    .withAk(ak)
                    .withSk(sk);
    
            KafkaClient client = KafkaClient.newBuilder()
                    .withCredential(auth)
                    .withRegion(KafkaRegion.valueOf("<YOUR REGION>"))
                    .build();
            UpdateTopicAccessPolicyRequest request = new UpdateTopicAccessPolicyRequest();
            request.withInstanceId("{instance_id}");
            UpdateTopicAccessPolicyReq body = new UpdateTopicAccessPolicyReq();
            List<AccessPolicyEntity> listTopicsPolicies = new ArrayList<>();
            listTopicsPolicies.add(
                new AccessPolicyEntity()
                    .withUserName("root")
                    .withAccessPolicy(AccessPolicyEntity.AccessPolicyEnum.fromValue("all"))
            );
            List<AccessPolicyTopicEntity> listbodyTopics = new ArrayList<>();
            listbodyTopics.add(
                new AccessPolicyTopicEntity()
                    .withName("topic-test")
                    .withPolicies(listTopicsPolicies)
            );
            body.withTopics(listbodyTopics);
            request.withBody(body);
            try {
                UpdateTopicAccessPolicyResponse response = client.updateTopicAccessPolicy(request);
                System.out.println(response.toString());
            } catch (ConnectionException e) {
                e.printStackTrace();
            } catch (RequestTimeoutException e) {
                e.printStackTrace();
            } catch (ServiceResponseException e) {
                e.printStackTrace();
                System.out.println(e.getHttpStatusCode());
                System.out.println(e.getRequestId());
                System.out.println(e.getErrorCode());
                System.out.println(e.getErrorMsg());
            }
        }
    }
    
  • Configure user permissions for topics in batches.

     1
     2
     3
     4
     5
     6
     7
     8
     9
    10
    11
    12
    13
    14
    15
    16
    17
    18
    19
    20
    21
    22
    23
    24
    25
    26
    27
    28
    29
    30
    31
    32
    33
    34
    35
    36
    37
    38
    39
    40
    41
    42
    43
    44
    45
    46
    47
    48
    49
    50
    package com.huaweicloud.sdk.test;
    
    import com.huaweicloud.sdk.core.auth.ICredential;
    import com.huaweicloud.sdk.core.auth.BasicCredentials;
    import com.huaweicloud.sdk.core.exception.ConnectionException;
    import com.huaweicloud.sdk.core.exception.RequestTimeoutException;
    import com.huaweicloud.sdk.core.exception.ServiceResponseException;
    import com.huaweicloud.sdk.kafka.v2.region.KafkaRegion;
    import com.huaweicloud.sdk.kafka.v2.*;
    import com.huaweicloud.sdk.kafka.v2.model.*;
    
    
    public class UpdateTopicAccessPolicySolution {
    
        public static void main(String[] args) {
            // The AK and SK used for authentication are hard-coded or stored in plaintext, which has great security risks. It is recommended that the AK and SK be stored in ciphertext in configuration files or environment variables and decrypted during use to ensure security.
            // In this example, AK and SK are stored in environment variables for authentication. Before running this example, set environment variables CLOUD_SDK_AK and CLOUD_SDK_SK in the local environment
            String ak = System.getenv("CLOUD_SDK_AK");
            String sk = System.getenv("CLOUD_SDK_SK");
            String projectId = "{project_id}";
    
            ICredential auth = new BasicCredentials()
                    .withProjectId(projectId)
                    .withAk(ak)
                    .withSk(sk);
    
            KafkaClient client = KafkaClient.newBuilder()
                    .withCredential(auth)
                    .withRegion(KafkaRegion.valueOf("<YOUR REGION>"))
                    .build();
            UpdateTopicAccessPolicyRequest request = new UpdateTopicAccessPolicyRequest();
            request.withInstanceId("{instance_id}");
            body.withUpdateTopicAccessPolicyReq("{\"batch_topic_name\":[\"topic-1\",\"topic-2\"],\"batch_policy\":[{\"user_name\":\"root\",\"access_policy\":\"all\"},{\"user_name\":\"admin\",\"access_policy\":\"all\"}]}");
            request.withBody(listUpdateTopicAccessPolicyReqUpdateTopicAccessPolicyReq);
            try {
                UpdateTopicAccessPolicyResponse response = client.updateTopicAccessPolicy(request);
                System.out.println(response.toString());
            } catch (ConnectionException e) {
                e.printStackTrace();
            } catch (RequestTimeoutException e) {
                e.printStackTrace();
            } catch (ServiceResponseException e) {
                e.printStackTrace();
                System.out.println(e.getHttpStatusCode());
                System.out.println(e.getRequestId());
                System.out.println(e.getErrorCode());
                System.out.println(e.getErrorMsg());
            }
        }
    }
    
  • Granting the root user the permission to publish and subscribe to topic-test

     1
     2
     3
     4
     5
     6
     7
     8
     9
    10
    11
    12
    13
    14
    15
    16
    17
    18
    19
    20
    21
    22
    23
    24
    25
    26
    27
    28
    29
    30
    31
    32
    33
    34
    35
    36
    37
    38
    39
    40
    41
    42
    43
    44
    45
    46
    47
    # coding: utf-8
    
    import os
    from huaweicloudsdkcore.auth.credentials import BasicCredentials
    from huaweicloudsdkkafka.v2.region.kafka_region import KafkaRegion
    from huaweicloudsdkcore.exceptions import exceptions
    from huaweicloudsdkkafka.v2 import *
    
    if __name__ == "__main__":
        # The AK and SK used for authentication are hard-coded or stored in plaintext, which has great security risks. It is recommended that the AK and SK be stored in ciphertext in configuration files or environment variables and decrypted during use to ensure security.
        # In this example, AK and SK are stored in environment variables for authentication. Before running this example, set environment variables CLOUD_SDK_AK and CLOUD_SDK_SK in the local environment
        ak = os.environ["CLOUD_SDK_AK"]
        sk = os.environ["CLOUD_SDK_SK"]
        projectId = "{project_id}"
    
        credentials = BasicCredentials(ak, sk, projectId)
    
        client = KafkaClient.new_builder() \
            .with_credentials(credentials) \
            .with_region(KafkaRegion.value_of("<YOUR REGION>")) \
            .build()
    
        try:
            request = UpdateTopicAccessPolicyRequest()
            request.instance_id = "{instance_id}"
            listPoliciesTopics = [
                AccessPolicyEntity(
                    user_name="root",
                    access_policy="all"
                )
            ]
            listTopicsbody = [
                AccessPolicyTopicEntity(
                    name="topic-test",
                    policies=listPoliciesTopics
                )
            ]
            request.body = UpdateTopicAccessPolicyReq(
                topics=listTopicsbody
            )
            response = client.update_topic_access_policy(request)
            print(response)
        except exceptions.ClientRequestException as e:
            print(e.status_code)
            print(e.request_id)
            print(e.error_code)
            print(e.error_msg)
    
  • Configure user permissions for topics in batches.

     1
     2
     3
     4
     5
     6
     7
     8
     9
    10
    11
    12
    13
    14
    15
    16
    17
    18
    19
    20
    21
    22
    23
    24
    25
    26
    27
    28
    29
    30
    31
    32
    33
    # coding: utf-8
    
    import os
    from huaweicloudsdkcore.auth.credentials import BasicCredentials
    from huaweicloudsdkkafka.v2.region.kafka_region import KafkaRegion
    from huaweicloudsdkcore.exceptions import exceptions
    from huaweicloudsdkkafka.v2 import *
    
    if __name__ == "__main__":
        # The AK and SK used for authentication are hard-coded or stored in plaintext, which has great security risks. It is recommended that the AK and SK be stored in ciphertext in configuration files or environment variables and decrypted during use to ensure security.
        # In this example, AK and SK are stored in environment variables for authentication. Before running this example, set environment variables CLOUD_SDK_AK and CLOUD_SDK_SK in the local environment
        ak = os.environ["CLOUD_SDK_AK"]
        sk = os.environ["CLOUD_SDK_SK"]
        projectId = "{project_id}"
    
        credentials = BasicCredentials(ak, sk, projectId)
    
        client = KafkaClient.new_builder() \
            .with_credentials(credentials) \
            .with_region(KafkaRegion.value_of("<YOUR REGION>")) \
            .build()
    
        try:
            request = UpdateTopicAccessPolicyRequest()
            request.instance_id = "{instance_id}"
            request.body = listUpdateTopicAccessPolicyReqUpdateTopicAccessPolicyReq
            response = client.update_topic_access_policy(request)
            print(response)
        except exceptions.ClientRequestException as e:
            print(e.status_code)
            print(e.request_id)
            print(e.error_code)
            print(e.error_msg)
    
  • Granting the root user the permission to publish and subscribe to topic-test

     1
     2
     3
     4
     5
     6
     7
     8
     9
    10
    11
    12
    13
    14
    15
    16
    17
    18
    19
    20
    21
    22
    23
    24
    25
    26
    27
    28
    29
    30
    31
    32
    33
    34
    35
    36
    37
    38
    39
    40
    41
    42
    43
    44
    45
    46
    47
    48
    49
    50
    51
    52
    53
    54
    55
    56
    57
    58
    59
    60
    61
    62
    63
    64
    65
    66
    67
    package main
    
    import (
    	"fmt"
    	"github.com/huaweicloud/huaweicloud-sdk-go-v3/core/auth/basic"
        kafka "github.com/huaweicloud/huaweicloud-sdk-go-v3/services/kafka/v2"
    	"github.com/huaweicloud/huaweicloud-sdk-go-v3/services/kafka/v2/model"
        region "github.com/huaweicloud/huaweicloud-sdk-go-v3/services/kafka/v2/region"
    )
    
    func main() {
        // The AK and SK used for authentication are hard-coded or stored in plaintext, which has great security risks. It is recommended that the AK and SK be stored in ciphertext in configuration files or environment variables and decrypted during use to ensure security.
        // In this example, AK and SK are stored in environment variables for authentication. Before running this example, set environment variables CLOUD_SDK_AK and CLOUD_SDK_SK in the local environment
        ak := os.Getenv("CLOUD_SDK_AK")
        sk := os.Getenv("CLOUD_SDK_SK")
        projectId := "{project_id}"
    
        auth, err := basic.NewCredentialsBuilder().
            WithAk(ak).
            WithSk(sk).
            WithProjectId(projectId).
            SafeBuild()
    
        if err != nil {
            fmt.Println(err)
            return
        }
    
        hcClient, err := kafka.KafkaClientBuilder().
             WithRegion(region.ValueOf("<YOUR REGION>")).
             WithCredential(auth).
             SafeBuild()
    
    
        if err != nil {
            fmt.Println(err)
            return
        }
    
        client := kafka.NewKafkaClient(hcClient)
    
        request := &model.UpdateTopicAccessPolicyRequest{}
    	request.InstanceId = "{instance_id}"
    	userNamePolicies:= "root"
    	accessPolicyPolicies:= model.GetAccessPolicyEntityAccessPolicyEnum().ALL
    	var listPoliciesTopics = []model.AccessPolicyEntity{
            {
                UserName: &userNamePolicies,
                AccessPolicy: &accessPolicyPolicies,
            },
        }
    	var listTopicsbody = []model.AccessPolicyTopicEntity{
            {
                Name: "topic-test",
                Policies: listPoliciesTopics,
            },
        }
    	request.Body = &model.UpdateTopicAccessPolicyReq{
    		Topics: listTopicsbody,
    	}
    	response, err := client.UpdateTopicAccessPolicy(request)
    	if err == nil {
            fmt.Printf("%+v\n", response)
        } else {
            fmt.Println(err)
        }
    }
    
  • Configure user permissions for topics in batches.

     1
     2
     3
     4
     5
     6
     7
     8
     9
    10
    11
    12
    13
    14
    15
    16
    17
    18
    19
    20
    21
    22
    23
    24
    25
    26
    27
    28
    29
    30
    31
    32
    33
    34
    35
    36
    37
    38
    39
    40
    41
    42
    43
    44
    45
    46
    47
    48
    49
    50
    51
    52
    package main
    
    import (
    	"fmt"
    	"github.com/huaweicloud/huaweicloud-sdk-go-v3/core/auth/basic"
        kafka "github.com/huaweicloud/huaweicloud-sdk-go-v3/services/kafka/v2"
    	"github.com/huaweicloud/huaweicloud-sdk-go-v3/services/kafka/v2/model"
        region "github.com/huaweicloud/huaweicloud-sdk-go-v3/services/kafka/v2/region"
    )
    
    func main() {
        // The AK and SK used for authentication are hard-coded or stored in plaintext, which has great security risks. It is recommended that the AK and SK be stored in ciphertext in configuration files or environment variables and decrypted during use to ensure security.
        // In this example, AK and SK are stored in environment variables for authentication. Before running this example, set environment variables CLOUD_SDK_AK and CLOUD_SDK_SK in the local environment
        ak := os.Getenv("CLOUD_SDK_AK")
        sk := os.Getenv("CLOUD_SDK_SK")
        projectId := "{project_id}"
    
        auth, err := basic.NewCredentialsBuilder().
            WithAk(ak).
            WithSk(sk).
            WithProjectId(projectId).
            SafeBuild()
    
        if err != nil {
            fmt.Println(err)
            return
        }
    
        hcClient, err := kafka.KafkaClientBuilder().
             WithRegion(region.ValueOf("<YOUR REGION>")).
             WithCredential(auth).
             SafeBuild()
    
    
        if err != nil {
            fmt.Println(err)
            return
        }
    
        client := kafka.NewKafkaClient(hcClient)
    
        request := &model.UpdateTopicAccessPolicyRequest{}
    	request.InstanceId = "{instance_id}"
    	var updateTopicAccessPolicyReqUpdateTopicAccessPolicyReq interface{} = "{\"batch_topic_name\":[\"topic-1\",\"topic-2\"],\"batch_policy\":[{\"user_name\":\"root\",\"access_policy\":\"all\"},{\"user_name\":\"admin\",\"access_policy\":\"all\"}]}"
    	request.Body = listUpdateTopicAccessPolicyReqUpdateTopicAccessPolicyReq
    	response, err := client.UpdateTopicAccessPolicy(request)
    	if err == nil {
            fmt.Printf("%+v\n", response)
        } else {
            fmt.Println(err)
        }
    }
    

For SDK sample code of more programming languages, see the Sample Code tab in API Explorer. SDK sample code can be automatically generated.

Status Codes

Status Code

Description

200

User permission setting task submitted successfully.

400

Invalid parameters.

403

Authentication failed.

Error Codes

See Error Codes.