listGrants()

Addedv2.3.xModifiedv3.0.x

This operation lists the privileges granted to the specified role.

await milvusClient.listGrants(data)

Request Syntax

 milvusClient.listGrants({
   roleName: 'roleName',
 });

PARAMETERS:

• roleName (string)

  The target role name

  Setting this to the name of a non-existing role may result in errors.

RETURNS Promise<SelectGrantResponse>

This method returns a promise that resolves to a SelectGrantResponse object.

{
    entities: GrantEntity[],
    status:  ResStatus
}

PARAMETERS:

• entities (GrantEntity[]) - A list of grants attached to the requested role. Each entry pairs a privilege with the target object and the principal that granted it. For the full GrantEntity field reference, refer to the describeRole() doc.

• ResStatus A ResStatus object.

  • code (number) -

    A code that indicates the operation result. It remains 0 if this operation succeeds.

  • error_code (string | number) -

    An error code that indicates an occurred error. It remains Success if this operation succeeds.

  • reason (string) -

    The reason that indicates the reason for the reported error. It remains an empty string if this operation succeeds.

Example

 milvusClient.listGrants({
   roleName: 'roleName',
 });