milvus-logo
LFAI
< Docs
  • RESTful

Describe User

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

This operation describes the detailed information of a specific user.

Example

export MILVUS_URI="localhost:19530"

curl --location --request POST "http://${MILVUS_URI}/v2/vectordb/users/describe" \
--header "Content-Type: application/json" \
--data-raw '{
    "userName": "milvusAdmin"
}'

Possible response is similar to the following.

{
    "code": 0,
    "data": [
        "admin"
    ]
}

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"
}
ParameterDescription
userName *string
The name of the user to describe.

Response

Returns the name of the roles assigned to the specified user.

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.
messagestring
Indicates the possible reason for the reported error.
dataarray
A list of roles already assigned to the user.
data[]string
A list of item objects.