Creating a User

Function

This API is used to create a user.

URI

POST /v2/{project_id}/instances/{instance_id}/users

**Table 1** Path Parameters
Parameter	Mandatory	Type	Description
project_id	Yes	String	Definition Project ID. For details about how to obtain it, see Obtaining a Project ID. Constraints N/A Range N/A Default Value N/A
instance_id	Yes	String	Definition Instance ID. You can call the API for querying all instances to obtain the instance ID. The instance ID is in the response body. Constraints N/A Range N/A Default Value N/A

Request Parameters

**Table 2** Request body parameters
Parameter	Mandatory	Type	Description
access_key	Yes	String	Definition Username. Constraints Starts with a letter, consists of 7 to 64 characters, and contains only letters, digits, hyphens (-), and underscores (_). Range N/A Default Value N/A
secret_key	Yes	String	Definition Key. Constraints 8 to 32 characters. Cannot start with a hyphen (-) and must contain at least three of the following character types: Uppercase letters Lowercase letters Digits Special characters `~!@#$%^&()-_=+\\|[{}];:'",<.>/?. Cannot be the username or the username spelled backwards. Range* N/A Default Value N/A
white_remote_address	No	String	Definition IP address whitelist. Constraints N/A Range N/A Default Value N/A
admin	No	Boolean	Definition Whether the user is an administrator. Constraints N/A Range true: Yes false: No Default Value N/A
default_topic_perm	No	String	Definition Default topic permissions. Constraints N/A Range PUB: publish permission. SUB: subscribe permission. PUB\|SUB: subscribe and publish permissions. DENY: no permission. Default Value N/A
default_group_perm	No	String	Definition Default consumer group permissions. Constraints N/A Range SUB: subscribe permission. DENY: no permission. Default Value N/A
topic_perms	No	Array of topic_perms objects	Definition Special topic permissions. Constraints N/A Range N/A Default Value N/A
group_perms	No	Array of group_perms objects	Definition Special consumer group permissions. Constraints N/A Range N/A Default Value N/A

**Table 3** topic_perms
Parameter	Mandatory	Type	Description
name	No	String	Definition Topic name. Constraints N/A Range N/A Default Value N/A
perm	No	String	Definition Topic permissions. Constraints N/A Range PUB: publish permission. SUB: subscribe permission. PUB\|SUB: subscribe and publish permissions. DENY: no permission. Default Value N/A

**Table 4** group_perms
Parameter	Mandatory	Type	Description
name	No	String	Definition Consumer group name. Constraints N/A Range N/A Default Value N/A
perm	No	String	Definition Consumer group permissions. Constraints N/A Range SUB: subscribe permission. DENY: no permission. Default Value N/A

Response Parameters

Status code: 200

**Table 5** Response body parameters
Parameter	Type	Description
access_key	String	Definition Username. Constraints N/A Range N/A Default Value N/A
secret_key	String	Definition Key. Constraints N/A Range N/A Default Value N/A
white_remote_address	String	Definition IP address whitelist. Constraints N/A Range N/A Default Value N/A
admin	Boolean	Definition Whether the user is an administrator. Constraints N/A Range true: Yes false: No Default Value N/A
default_topic_perm	String	Definition Default topic permissions. Constraints N/A Range PUB: publish permission. SUB: subscribe permission. PUB\|SUB: subscribe and publish permissions. DENY: no permission. Default Value N/A
default_group_perm	String	Definition Default consumer group permissions. Constraints N/A Range SUB: subscribe permission. DENY: no permission. Default Value N/A
topic_perms	Array of topic_perms objects	Definition Special topic permissions. Constraints N/A Range N/A Default Value N/A
group_perms	Array of group_perms objects	Definition Special consumer group permissions. Constraints N/A Range N/A Default Value N/A

**Table 6** topic_perms
Parameter	Type	Description
name	String	Definition Topic name. Constraints N/A Range N/A Default Value N/A
perm	String	Definition Topic permissions. Constraints N/A Range PUB: publish permission. SUB: subscribe permission. PUB\|SUB: subscribe and publish permissions. DENY: no permission. Default Value N/A

**Table 7** group_perms
Parameter	Type	Description
name	String	Definition Consumer group name. Constraints N/A Range N/A Default Value N/A
perm	String	Definition Consumer group permissions. Constraints N/A Range SUB: subscribe permission. DENY: no permission. Default Value N/A

Example Requests

Creating a non-administrator user with permissions to publish and subscribe to topic1 and group1

POST https://{endpoint}/v2/{project_id}/instances/{instance_id}/users

{
  "access_key" : "user_name",
  "secret_key" : "Abcd1234!",
  "white_remote_address" : "",
  "admin" : false,
  "default_topic_perm" : "DENY",
  "default_group_perm" : "DENY",
  "topic_perms" : [ {
    "name" : "topic1",
    "perm" : "PUB|SUB"
  } ],
  "group_perms" : [ {
    "name" : "group1",
    "perm" : "PUB|SUB"
  } ]
}

Example Responses

Status code: 200

The creation is successful.

{
  "access_key" : "test_01",
  "admin" : false,
  "default_group_perm" : "DENY",
  "default_topic_perm" : "SUB",
  "group_perms" : [ ],
  "secret_key" : "Abcd1234!",
  "topic_perms" : [ ],
  "white_remote_address" : ""
}

Status Codes

Status Code	Description
200	The creation is successful.

Error Codes

See Error Codes.

Parent Topic: User Management

Previous topic: User Management

Next topic: Querying the User List

Feedback

Was this page helpful?

Helpful Not helpful

Provide feedback

Thank you very much for your feedback. We will continue working to improve the documentation.

The system is busy. Please try again later.