listGrant()

Addedv2.4.x

This operation lists the privileges granted to the specified role.

await milvusClient.listGrant(data)

Request Syntax

 milvusClient.listGrants({
   roleName: 'roleName',
   object: 'Collection',
   objectName: '*'
 });

PARAMETERS:

• roleName (string)

  The target role name

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

• object (string)

  The name of a valid privilege object group. Possible values are Global, Collection, and User.

• objectName (string)

  The name of a specific object in the specified object group. Using a wildcard (*) indicates that all privileges in the specified group are to be granted.

• timeout (number)

  The timeout duration of this operation.

Returns Promise<SelectGrantResponse>

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

{
    "entities": [
        {
            db_name: string,
            grantor: { privilege: { name: string }, user: { name: string } },
            object: { name: string },
            object_name: string,
            role: { name: string }
        }
    ],
    "status": ResStatus

PARAMETERS:

• entities (GrantEntity[]) -

  A list of grant entities, each of which is shaped as follows:

  • db_name (string) -

    The name of the database in which the privilege has been granted.

  • grantor (Grantor) -

    A Grantor object that is shaped as follows:

    • privilege (PrivilegeEntity) -

      A PrivilegeEntity object that is shaped as follows:

      • name (string) -

        The name of the granted privilege.

    • user (User) -

      A User object that is shaped as follows:

      • name (string) -

        The name of the user that grants the above privilege to the role.

  • object (ObjectEntity) -

    An ObjectEntity object that is shaped as follows:

    • name (string) -

      The name of the object entity.

  • object_name (string) -

    The name of a specific object within the above object entity.

  • role (RoleEntity) -

    A RoleEntity object that is shaped as follows:

    • name (string) -

      The name of the role to which the privilege has been granted.

• status (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.listGrant({
   roleName: 'roleName',
   object: 'Collection',
   objectName: '*'
 });