Skip to main content

ListPrivilegeGroups

This operation lists all privilege groups and their included privileges.

go
func (c *Client) ListPrivilegeGroups(ctx context.Context, option ListPrivilegeGroupsOption, callOptions ...grpc.CallOption) ([]*entity.PrivilegeGroup, error)

Request Syntax​

Creates the request for ListPrivilegeGroups().

go
option := milvusclient.NewListPrivilegeGroupsOption()

groups, err := client.ListPrivilegeGroups(ctx, option)

BUILDER METHODS:

  • NewListPrivilegeGroupsOption()

    Creates the request for ListPrivilegeGroups().

RETURN TYPE:

[]entity.PrivilegeGroup, error*

RETURNS:

A list of privilege groups with their included privileges. Returns an error if the operation fails.

go
type PrivilegeGroup struct {
GroupName string
Privileges []string
}

PARAMETERS:

  • GroupName (string) -

    The name of the privilege group.

  • Privileges ([]string) -

    The list of granted privileges.

ERROR HANDLING:

  • error

    The operation fails. Check err != nil for failure details.

Example​

Demonstrates ListPrivilegeGroups() usage.

go
import (
"context"
"fmt"

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

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

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

groups, err := cli.ListPrivilegeGroups(ctx, milvusclient.NewListPrivilegeGroupsOption())
if err != nil {
// handle error
}
fmt.Println(groups)
Minimum SDK versionv3.0.x
Was this page helpful?