WeaviateEx.RBAC.Permissions (WeaviateEx v0.7.4)

View Source

Builder API for constructing RBAC permissions.

This module provides a fluent API for creating permissions that can be assigned to roles. Each builder function returns either a single Permission struct or a list of Permission structs (when multiple actions are specified).

Examples

# Full access to a collection
Permissions.collections("Article", [:create, :read, :update, :delete])

# Read data from specific tenant
Permissions.data("Article", :read, tenant: "tenant-a")

# Manage all backups
Permissions.backups(:manage)

# Verbose node info
Permissions.nodes(:verbose)

# Multiple permissions for a role
permissions = [
  Permissions.collections("Article", [:read, :update]),
  Permissions.data("Article", [:read, :create]),
  Permissions.cluster()
]

Wildcards

Use :all to create permissions that apply to all resources:

Permissions.collections(:all, :read)  # Read all collections
Permissions.data(:all, :read)         # Read data from all collections
Permissions.users(:all, :read)        # Read all users

Summary

Types

actions()
collection_or_all()
name_or_all()

Functions

alias_permission(actions)

Create alias permission(s).

alias_permission(alias_name, actions)
backups(action \\ :manage)

Create backups permission.

cluster(action \\ :read)

Create cluster permission.

collections(actions)

Create collections permission(s).

collections(collection, actions)
data(actions)

Create data permission(s).

data(collection, actions)
data(collection, actions, opts)
flatten(permission)

Flatten a nested structure of permissions into a single list.

groups(actions)

Create groups permission(s) (OIDC groups).

groups(group, actions)
nodes(verbosity \\ :minimal, opts \\ [])

Create nodes permission.

replicate(actions)

Create replicate permission(s).

replicate(collection, actions)
roles(actions)

Create roles permission(s).

roles(role, actions)
roles(role, actions, opts)
tenants(actions)

Create tenants permission(s).

tenants(collection, actions)
tenants(collection, actions, opts)
users(actions)

Create users permission(s).

users(user, actions)

Types

actions()

@type actions() :: atom() | [atom()]

collection_or_all()

@type collection_or_all() :: String.t() | :all

name_or_all()

@type name_or_all() :: String.t() | :all

Functions

alias_permission(actions)

@spec alias_permission(actions()) ::
  WeaviateEx.RBAC.Permission.t() | [WeaviateEx.RBAC.Permission.t()]

Create alias permission(s).

Named alias_permission because alias is a reserved word in Elixir.

Parameters

  • alias_name - Alias name or :all for wildcard. Defaults to "*".
  • actions - Single action atom or list of actions

Examples

Permissions.alias_permission("my-alias", :create)
Permissions.alias_permission(:all, [:create, :read, :delete])

alias_permission(alias_name, actions)

@spec alias_permission(name_or_all(), actions()) ::
  WeaviateEx.RBAC.Permission.t() | [WeaviateEx.RBAC.Permission.t()]

backups(action \\ :manage)

@spec backups(atom()) :: WeaviateEx.RBAC.Permission.t()

Create backups permission.

Parameters

  • action - Action atom (typically :manage). Defaults to :manage.

Examples

Permissions.backups()
Permissions.backups(:manage)

cluster(action \\ :read)

@spec cluster(atom()) :: WeaviateEx.RBAC.Permission.t()

Create cluster permission.

Parameters

  • action - Action atom (typically :read). Defaults to :read.

Examples

Permissions.cluster()
Permissions.cluster(:read)

collections(actions)

@spec collections(actions()) ::
  WeaviateEx.RBAC.Permission.t() | [WeaviateEx.RBAC.Permission.t()]

Create collections permission(s).

Parameters

  • collection - Collection name or :all for wildcard. Defaults to "*".
  • actions - Single action atom or list of actions

Examples

Permissions.collections("Article", :read)
Permissions.collections("Article", [:create, :read, :update])
Permissions.collections(:all, :manage)
Permissions.collections(:read)  # All collections, single action

collections(collection, actions)

@spec collections(collection_or_all(), actions()) ::
  WeaviateEx.RBAC.Permission.t() | [WeaviateEx.RBAC.Permission.t()]

data(actions)

@spec data(actions()) ::
  WeaviateEx.RBAC.Permission.t() | [WeaviateEx.RBAC.Permission.t()]

Create data permission(s).

Parameters

  • collection - Collection name or :all for wildcard. Defaults to "*".
  • actions - Single action atom or list of actions
  • opts - Optional filters:
    • :tenant - Filter by tenant (or :all for wildcard)
    • :object - Filter by object UUID

Examples

Permissions.data("Article", :read)
Permissions.data("Article", :read, tenant: "tenant-a")
Permissions.data("Article", [:create, :update], tenant: :all)

data(collection, actions)

@spec data(collection_or_all(), actions()) ::
  WeaviateEx.RBAC.Permission.t() | [WeaviateEx.RBAC.Permission.t()]

data(collection, actions, opts)

@spec data(collection_or_all(), actions(), keyword()) ::
  WeaviateEx.RBAC.Permission.t() | [WeaviateEx.RBAC.Permission.t()]

flatten(permission)

@spec flatten(
  WeaviateEx.RBAC.Permission.t()
  | [WeaviateEx.RBAC.Permission.t() | [WeaviateEx.RBAC.Permission.t()]]
) :: [WeaviateEx.RBAC.Permission.t()]

Flatten a nested structure of permissions into a single list.

Useful when combining multiple permission builders.

Examples

nested = [
  Permissions.collections("A", [:read, :update]),
  [Permissions.cluster(), Permissions.nodes()]
]
Permissions.flatten(nested)
# => [%Permission{}, %Permission{}, %Permission{}, %Permission{}]

groups(actions)

@spec groups(actions()) ::
  WeaviateEx.RBAC.Permission.t() | [WeaviateEx.RBAC.Permission.t()]

Create groups permission(s) (OIDC groups).

Parameters

  • group - Group name or :all for wildcard. Defaults to "*".
  • actions - Single action atom or list of actions

Examples

Permissions.groups("engineering", :read)
Permissions.groups(:all, :assign_and_revoke)

groups(group, actions)

@spec groups(name_or_all(), actions()) ::
  WeaviateEx.RBAC.Permission.t() | [WeaviateEx.RBAC.Permission.t()]

nodes(verbosity \\ :minimal, opts \\ [])

@spec nodes(
  :minimal | :verbose,
  keyword()
) :: WeaviateEx.RBAC.Permission.t()

Create nodes permission.

Parameters

  • verbosity - :minimal or :verbose. Defaults to :minimal.
  • opts - Optional keyword list:
    • :collection - Filter to specific collection (only valid with :verbose)

Examples

Permissions.nodes()          # Minimal verbosity
Permissions.nodes(:minimal)
Permissions.nodes(:verbose)

# With collection filter (verbose only)
Permissions.nodes(:verbose, collection: "Article")

replicate(actions)

@spec replicate(actions()) ::
  WeaviateEx.RBAC.Permission.t() | [WeaviateEx.RBAC.Permission.t()]

Create replicate permission(s).

Parameters

  • collection - Collection name or :all for wildcard. Defaults to "*".
  • actions - Single action atom or list of actions

Examples

Permissions.replicate("Article", :create)
Permissions.replicate(:all, [:create, :read])

replicate(collection, actions)

@spec replicate(collection_or_all(), actions()) ::
  WeaviateEx.RBAC.Permission.t() | [WeaviateEx.RBAC.Permission.t()]

roles(actions)

@spec roles(actions()) ::
  WeaviateEx.RBAC.Permission.t() | [WeaviateEx.RBAC.Permission.t()]

Create roles permission(s).

Parameters

  • role - Role name or :all for wildcard. Defaults to "*".
  • actions - Single action atom or list of actions
  • opts - Optional filters:
    • :scope - Permission scope: :match or :all

Examples

Permissions.roles("admin", :read)
Permissions.roles(:all, [:create, :read, :delete])
Permissions.roles("admin", :read, scope: :match)
Permissions.roles("*", :manage, scope: :all)

roles(role, actions)

@spec roles(name_or_all(), actions()) ::
  WeaviateEx.RBAC.Permission.t() | [WeaviateEx.RBAC.Permission.t()]

roles(role, actions, opts)

@spec roles(name_or_all(), actions(), keyword()) ::
  WeaviateEx.RBAC.Permission.t() | [WeaviateEx.RBAC.Permission.t()]

tenants(actions)

@spec tenants(actions()) ::
  WeaviateEx.RBAC.Permission.t() | [WeaviateEx.RBAC.Permission.t()]

Create tenants permission(s).

Parameters

  • collection - Collection name or :all for wildcard. Defaults to "*".
  • actions - Single action atom or list of actions
  • opts - Optional filters:
    • :tenant - Filter by specific tenant

Examples

Permissions.tenants("MyCollection", :create)
Permissions.tenants("MyCollection", [:create, :read, :delete])
Permissions.tenants(:all, :read, tenant: "tenant-a")

tenants(collection, actions)

@spec tenants(collection_or_all(), actions()) ::
  WeaviateEx.RBAC.Permission.t() | [WeaviateEx.RBAC.Permission.t()]

tenants(collection, actions, opts)

@spec tenants(collection_or_all(), actions(), keyword()) ::
  WeaviateEx.RBAC.Permission.t() | [WeaviateEx.RBAC.Permission.t()]

users(actions)

@spec users(actions()) ::
  WeaviateEx.RBAC.Permission.t() | [WeaviateEx.RBAC.Permission.t()]

Create users permission(s).

Parameters

  • user - User ID or :all for wildcard. Defaults to "*".
  • actions - Single action atom or list of actions

Examples

Permissions.users("john", :read)
Permissions.users(:all, :assign_and_revoke)

users(user, actions)

@spec users(name_or_all(), actions()) ::
  WeaviateEx.RBAC.Permission.t() | [WeaviateEx.RBAC.Permission.t()]