milvus-logo
LFAI
< Docs
  • RESTful

Create User

POST
http://${MILVUS_URI}/v2/vectordb/users/create

This operation creates a new user with a corresponding password.

Example

export MILVUS_URI="localhost:19530"

curl --location --request POST "http://${MILVUS_URI}/v2/vectordb/users/create" \
--header "Content-Type: application/json" \
--data-raw '{
    "password": "P@ssw0rd",
    "userName": "milvusAdmin"
}'

Possible response is similar to the following :

{
    "code": 200,
    "data": {}
}

Request

Parameters

  • Header parameters

    ParameterDescription
    Request-Timeoutinteger
    The timeout duration for this operation.
    Setting this to None indicates that this operation timeouts when any response arrives or any error occurs.
    Authorizationstring
    The authentication token.
  • No query parameters required

  • No path parameters required

Request Body

{
    "userName": "string",
    "password": "string"
}
ParameterDescription
userName *string
The name of the target user. The value should start with a letter and can only contain underline, letters and numbers.
password *string
The corresponding password to the new user to create.
The password must be a string of 8 to 64 characters and must include at least three of the following character types: uppercase letters, lowercase letters, numbers, and special characters.

Response

None

Response Bodies

  • Response body if we process your request successfully
{
    "code": "integer",
    "data": {}
}
  • Response body if we failed to process your request
{
    "code": integer,
    "message": string
}

Properties

The properties in the returned response are listed in the following table.

PropertyDescription
codeinteger
Indicates whether the request succeeds.
  • 200: The request succeeds.
  • Others: Some error occurs.
dataobject
messagestring
Indicates the possible reason for the reported error.

Feedback

Was this page helpful?