describeUser()

This operation returns the roles assigned to a user and the user description.

Java

public DescribeUserResp describeUser(DescribeUserReq request)

Request Syntax

Java

DescribeUserResp resp = client.describeUser(DescribeUserReq.builder()
    .userName(String userName)
    .build()
);

BUILDER METHODS:

• userName(String userName)

  [REQUIRED]

  The name of the user to describe.

RETURNS:

DescribeUserResp

The response contains userName, roles, and description.

EXCEPTIONS:

• MilvusClientException

  This exception will be raised when any error occurs during this operation.

Example

Java

import io.milvus.v2.service.rbac.request.DescribeUserReq;
import io.milvus.v2.service.rbac.response.DescribeUserResp;

DescribeUserResp resp = client.describeUser(DescribeUserReq.builder()
    .userName("analyst_user")
    .build());
System.out.println(resp.getDescription());