DescribeUser()

This operation returns detailed information about a user, including their assigned roles.

func (c *Client) DescribeUser(ctx context.Context, opt DescribeUserOption, callOpts ...grpc.CallOption) (*entity.User, error)

Request Syntax

option := milvusclient.NewDescribeUserOption(userName)

result, err := client.DescribeUser(ctx, option)

PARAMETERS:

  • userName (string)

    The name of the user.

RETURN TYPE:

*entity.User, error

RETURNS:

The user description including assigned roles. Returns an error if the operation fails.

EXCEPTIONS:

  • error

    Check err != nil for failure details.

Example

import (
    "context"
    "fmt"

    "github.com/milvus-io/milvus/client/v2/milvusclient"
)

ctx, cancel := context.WithCancel(context.Background())
defer cancel()

cli, err := milvusclient.New(ctx, &milvusclient.ClientConfig{
    Address: "localhost:19530",
})
if err != nil {
    // handle error
}
defer cli.Close(ctx)

user, err := cli.DescribeUser(ctx, milvusclient.NewDescribeUserOption("my_user"))
if err != nil {
    // handle error
}
fmt.Println(user)

Try Managed Milvus for Free

Zilliz Cloud is hassle-free, powered by Milvus and 10x faster.

Get Started
Feedback

Was this page helpful?