milvus-logo
LFAI
< Docs
  • RESTful

Create User

This operation creates a new user with a corresponding password.

POST
/v2/vectordb/users/create
Cluster Endpoint

The base URL for this API is in the following format:

http://localhost:19530

export CLUSTER_ENDPOINT="http://localhost:19530"
Parameters
Request-Timeoutintegerheader

The timeout duration for this operation. Setting this to None indicates that this operation times out when any response returns or an error occurs.

Example Value: 0
Authorizationstringheaderrequired

The authentication token should be a pair of colon-joined username and password, like username:password.

Example Value: Bearer {{TOKEN}}
Request Bodyapplication/json
userNamestring

The name of the target user. The value should start with a letter and can only contain underline, letters and numbers.

passwordstring<password>

The corresponding password to the user. The password must must include at least three of the following character types: uppercase letters, lowercase letters, numbers, and special characters.

export TOKEN="root:Milvus"


curl --request POST \
--url "${CLUSTER_ENDPOINT}/v2/vectordb/users/create" \
--header "Request-Timeout: 0" \
--header "Authorization: Bearer ${TOKEN}" \
--header "Content-Type: application/json" \
-d '{
    "userName": "myUser",
    "password": "P@ssw0rd"
}'
Responses200 - application/json

A success response

codeinteger

Response code.

Example Value: 0
dataobject

Response payload which is an empty object.

A failure response.

codeinteger

Response code.

messagestring

Error message.

{
    "code": 0,
    "data": {}
}