Variable permissionsConst

Type Declaration

• aliases: (
      args: {
          alias: string | string[];
          collection: string | string[];
          create?: boolean;
          delete?: boolean;
          read?: boolean;
          update?: boolean;
      },
  ) => AliasPermission[]

  Create a set of permissions specific to Weaviate's collection aliasing functionality.

• backup: (
      args: { collection: string | string[]; manage?: boolean },
  ) => BackupsPermission[]

  Create a set of permissions specific to Weaviate's backup functionality.

  For all collections, provide the collection argument as '*'.

• cluster: (args: { read?: boolean }) => ClusterPermission[]

  Create a set of permissions specific to Weaviate's cluster endpoints.

• collections: (
      args: {
          collection: string | string[];
          create_collection?: boolean;
          delete_collection?: boolean;
          read_config?: boolean;
          update_config?: boolean;
      },
  ) => CollectionsPermission[]

  Create a set of permissions specific to any operations involving collections.

  For all collections, provide the collection argument as '*'.

• data: (
      args: {
          collection: string | string[];
          create?: boolean;
          delete?: boolean;
          read?: boolean;
          tenant?: string | string[];
          update?: boolean;
      },
  ) => DataPermission[]

  Create a set of permissions specific to any operations involving objects within collections and tenants.

  For all collections, provide the collection argument as '*'. For all tenants, provide the tenant argument as '*'.

  Providing arrays of collections and tenants will create permissions for each combination of collection and tenant. E.g., data({ collection: ['A', 'B'], tenant: ['X', 'Y'] }) will create permissions for tenants X and Y in both collections A and B.

• groups: {
      oidc: (
          args: {
              assignAndRevoke?: boolean;
              groupID: string | string[];
              read?: boolean;
          },
      ) => GroupsPermission[];
  }

  This namespace contains methods to create permissions specific to RBAC groups.

  • oidc: (
        args: {
            assignAndRevoke?: boolean;
            groupID: string | string[];
            read?: boolean;
        },
    ) => GroupsPermission[]

    Create a set of permissions for 'oidc' groups.

• mcp: (
      args: { create?: boolean; read?: boolean; update?: boolean },
  ) => McpPermission[]

  Create a set of permissions specific to Weaviate's MCP (Model Context Protocol) functionality.

  Requires Weaviate v1.37.0 or later.

• nodes: {
      minimal: (args: { read?: boolean }) => NodesPermission[];
      verbose: (
          args: { collection: string | string[]; read?: boolean },
      ) => NodesPermission[];
  }

  This namespace contains methods to create permissions specific to nodes.

  • minimal: (args: { read?: boolean }) => NodesPermission[]

    Create a set of permissions specific to reading nodes with verbosity set to minimal.

  • verbose: (args: { collection: string | string[]; read?: boolean }) => NodesPermission[]

    Create a set of permissions specific to reading nodes with verbosity set to verbose.

• replicate: (
      args: {
          collection: string | string[];
          create?: boolean;
          delete?: boolean;
          read?: boolean;
          shard: string | string[];
          update?: boolean;
      },
  ) => ReplicatePermission[]

  Create a set of permissions specific to shard replica movement operations.

  For all collections, provide the collection argument as '*'. For all shards, provide the shard argument as '*'.

  Providing arrays of collections and shards will create permissions for each combination of collection and shard. E.g., replicate({ collection: ['A', 'B'], shard: ['X', 'Y'] }) will create permissions for shards X and Y in both collections A and B.

• roles: (
      args: {
          create?: boolean;
          delete?: boolean;
          read?: boolean;
          role: string | string[];
          update?: boolean;
      },
  ) => RolesPermission[]

  Create a set of permissions specific to any operations involving roles.

• tenants: (
      args: {
          collection: string | string[];
          create?: boolean;
          delete?: boolean;
          read?: boolean;
          tenant?: string | string[];
          update?: boolean;
      },
  ) => TenantsPermission[]

  Create a set of permissions specific to any operations involving tenants.

  For all collections, provide the collection argument as '*'. For all tenants, provide the tenant argument as '*'.

  Providing arrays of collections and tenants will create permissions for each combination of collection and tenant. E.g., tenants({ collection: ['A', 'B'], tenant: ['X', 'Y'] }) will create permissions for tenants X and Y in both collections A and B.

• users: (
      args: {
          assignAndRevoke?: boolean;
          read?: boolean;
          user: string | string[];
      },
  ) => UsersPermission[]

  Create a set of permissions specific to any operations involving users.