milvus-logo
LFAI
< Docs
  • Java

addUserToRole()

A MilvusClient interface. This method associates a Milvus user with a Milvus role.

Note: By being associated with a role, the user has been granted permissions bound to the role.
R<RpcStatus> addUserToRole(AddUserToRoleParam requestParam);

AddUserToRoleParam

Use the AddUserToRoleParam.Builder to construct an AddUserToRoleParam object.

import io.milvus.param.AddUserToRoleParam;
AddUserToRoleParam.Builder builder = AddUserToRoleParam.newBuilder();

Methods of AddUserToRoleParam.Builder:

MethodDescriptionParameters
withRoleName(String roleName)Sets the role name.
The role name cannot be empty or null.
roleName: The role name used to create the privilege.
withUsername(String username)Sets the username.
The username cannot be empty or null.
username: The user name.

The AddUserToRoleParam.Builder.build() can throw the following exceptions:

  • ParamException: error if the parameter is invalid.

Returns

This method catches all the exceptions and returns an R<RpcStatus> object.

  • If the API fails on the server side, it returns an error code and an error message.
  • If the API fails due to RPC exceptions, it returns R.Status.Unknown and error message of the exception.
  • If the API succeeds, it returns R.Status.Success.

Example

import io.milvus.param.AddUserToRoleParam;

R<RpcStatus> response = client.addUserToRole(AddUserToRoleParam.newBuilder()
            .withRoleName(roleName)
            .withUserName(userName)
            .build());

if (response.getStatus() != R.Status.Success.getCode()) {
    throw new RuntimeException(response.getMessage());
}