weaviate.rbac

Submodules

weaviate.rbac.models module

class weaviate.rbac.models.Actions

Bases: object

Backups

alias of BackupsAction

Cluster

alias of ClusterAction

Collections

alias of CollectionsAction

Data

alias of DataAction

Nodes

alias of NodesAction

Roles

alias of RolesAction

Tenants

alias of TenantsAction

Users

alias of UsersAction

class weaviate.rbac.models.BackupsAction(value, names=None, *, module=None, qualname=None, type=None, start=1, boundary=None)

Bases: str, _Action, Enum

MANAGE = 'manage_backups'

static values() → List[str]

pydantic model weaviate.rbac.models.BackupsPermissionOutput

Bases: _BackupsPermission

Create a new model by parsing and validating input data from keyword arguments.

Raises [ValidationError][pydantic_core.ValidationError] if the input data cannot be validated to form a valid model.

self is explicitly positional-only to allow self as a field name.

class weaviate.rbac.models.ClusterAction(value, names=None, *, module=None, qualname=None, type=None, start=1, boundary=None)

Bases: str, _Action, Enum

READ = 'read_cluster'

static values() → List[str]

pydantic model weaviate.rbac.models.ClusterPermissionOutput

Bases: _ClusterPermission

Create a new model by parsing and validating input data from keyword arguments.

Raises [ValidationError][pydantic_core.ValidationError] if the input data cannot be validated to form a valid model.

self is explicitly positional-only to allow self as a field name.

class weaviate.rbac.models.CollectionsAction(value, names=None, *, module=None, qualname=None, type=None, start=1, boundary=None)

Bases: str, _Action, Enum

CREATE = 'create_collections'

DELETE = 'delete_collections'

MANAGE = 'manage_collections'

READ = 'read_collections'

UPDATE = 'update_collections'

static values() → List[str]

pydantic model weaviate.rbac.models.CollectionsPermissionOutput

Bases: _CollectionsPermission

Create a new model by parsing and validating input data from keyword arguments.

Raises [ValidationError][pydantic_core.ValidationError] if the input data cannot be validated to form a valid model.

self is explicitly positional-only to allow self as a field name.

class weaviate.rbac.models.DataAction(value, names=None, *, module=None, qualname=None, type=None, start=1, boundary=None)

Bases: str, _Action, Enum

CREATE = 'create_data'

DELETE = 'delete_data'

MANAGE = 'manage_data'

READ = 'read_data'

UPDATE = 'update_data'

static values() → List[str]

pydantic model weaviate.rbac.models.DataPermissionOutput

Bases: _DataPermission

Create a new model by parsing and validating input data from keyword arguments.

Raises [ValidationError][pydantic_core.ValidationError] if the input data cannot be validated to form a valid model.

self is explicitly positional-only to allow self as a field name.

class weaviate.rbac.models.NodesAction(value, names=None, *, module=None, qualname=None, type=None, start=1, boundary=None)

Bases: str, _Action, Enum

READ = 'read_nodes'

static values() → List[str]

pydantic model weaviate.rbac.models.NodesPermissionOutput

Bases: _NodesPermission

Create a new model by parsing and validating input data from keyword arguments.

Raises [ValidationError][pydantic_core.ValidationError] if the input data cannot be validated to form a valid model.

self is explicitly positional-only to allow self as a field name.

class weaviate.rbac.models.NodesPermissions

Bases: object

static minimal(*, read: bool = False) → List[_Permission]

static verbose(*, collection: str | Sequence[str], read: bool = False) → List[_Permission]

class weaviate.rbac.models.PermissionBackup

Bases: TypedDict

collection: str

class weaviate.rbac.models.PermissionCollections

Bases: TypedDict

collection: str

tenant: str

class weaviate.rbac.models.PermissionData

Bases: TypedDict

collection: str

class weaviate.rbac.models.PermissionNodes

Bases: TypedDict

collection: str

verbosity: Literal['minimal', 'verbose']

class weaviate.rbac.models.PermissionRoles

Bases: TypedDict

role: str

scope: NotRequired[str]

class weaviate.rbac.models.Permissions

Bases: object

Nodes

alias of NodesPermissions

static backup(*, collection: str | Sequence[str], manage: bool = False) → List[_Permission]

static cluster(*, read: bool = False) → List[_Permission]

static collections(*, collection: str | Sequence[str], create_collection: bool = False, read_config: bool = False, update_config: bool = False, delete_collection: bool = False) → List[_Permission]

static data(*, collection: str | Sequence[str], create: bool = False, read: bool = False, update: bool = False, delete: bool = False) → List[_Permission]

static roles(*, role: str | Sequence[str], create: bool = False, read: bool = False, update: bool = False, delete: bool = False, scope: RoleScope | None = None) → List[_Permission]

static tenants(*, collection: str | Sequence[str], create: bool = False, read: bool = False, update: bool = False, delete: bool = False) → List[_Permission]

static users(*, user: str | Sequence[str], read: bool = False, assign_and_revoke: bool = False) → List[_Permission]

class weaviate.rbac.models.PermissionsTenants

Bases: TypedDict

collection: str

tenant: str

class weaviate.rbac.models.PermissionsUsers

Bases: TypedDict

users: str

class weaviate.rbac.models.Role(name: str, cluster_permissions: List[weaviate.rbac.models.ClusterPermissionOutput], collections_permissions: List[weaviate.rbac.models.CollectionsPermissionOutput], data_permissions: List[weaviate.rbac.models.DataPermissionOutput], roles_permissions: List[weaviate.rbac.models.RolesPermissionOutput], users_permissions: List[weaviate.rbac.models.UsersPermissionOutput], backups_permissions: List[weaviate.rbac.models.BackupsPermissionOutput], nodes_permissions: List[weaviate.rbac.models.NodesPermissionOutput], tenants_permissions: List[weaviate.rbac.models.TenantsPermissionOutput])

Bases: object

backups_permissions: List[BackupsPermissionOutput]

cluster_permissions: List[ClusterPermissionOutput]

collections_permissions: List[CollectionsPermissionOutput]

data_permissions: List[DataPermissionOutput]

name: str

nodes_permissions: List[NodesPermissionOutput]

property permissions: List[ClusterPermissionOutput | CollectionsPermissionOutput | DataPermissionOutput | RolesPermissionOutput | UsersPermissionOutput | BackupsPermissionOutput | NodesPermissionOutput | TenantsPermissionOutput]

roles_permissions: List[RolesPermissionOutput]

tenants_permissions: List[TenantsPermissionOutput]

users_permissions: List[UsersPermissionOutput]

class weaviate.rbac.models.RoleScope(value, names=None, *, module=None, qualname=None, type=None, start=1, boundary=None)

Bases: str, BaseEnum

Scope of the role permission.

ALL = 'all'

MATCH = 'match'

class weaviate.rbac.models.RolesAction(value, names=None, *, module=None, qualname=None, type=None, start=1, boundary=None)

Bases: str, _Action, Enum

CREATE = 'create_roles'

DELETE = 'delete_roles'

MANAGE = 'manage_roles'

READ = 'read_roles'

UPDATE = 'update_roles'

static values() → List[str]

pydantic model weaviate.rbac.models.RolesPermissionOutput

Bases: _RolesPermission

Create a new model by parsing and validating input data from keyword arguments.

Raises [ValidationError][pydantic_core.ValidationError] if the input data cannot be validated to form a valid model.

self is explicitly positional-only to allow self as a field name.

class weaviate.rbac.models.TenantsAction(value, names=None, *, module=None, qualname=None, type=None, start=1, boundary=None)

Bases: str, _Action, Enum

CREATE = 'create_tenants'

DELETE = 'delete_tenants'

READ = 'read_tenants'

UPDATE = 'update_tenants'

static values() → List[str]

pydantic model weaviate.rbac.models.TenantsPermissionOutput

Bases: _TenantsPermission

Create a new model by parsing and validating input data from keyword arguments.

Raises [ValidationError][pydantic_core.ValidationError] if the input data cannot be validated to form a valid model.

self is explicitly positional-only to allow self as a field name.

class weaviate.rbac.models.User(user_id: str, roles: Dict[str, weaviate.rbac.models.Role])

Bases: object

roles: Dict[str, Role]

user_id: str

class weaviate.rbac.models.UsersAction(value, names=None, *, module=None, qualname=None, type=None, start=1, boundary=None)

Bases: str, _Action, Enum

ASSIGN_AND_REVOKE = 'assign_and_revoke_users'

READ = 'read_users'

static values() → List[str]

pydantic model weaviate.rbac.models.UsersPermissionOutput

Bases: _UsersPermission

Create a new model by parsing and validating input data from keyword arguments.

Raises [ValidationError][pydantic_core.ValidationError] if the input data cannot be validated to form a valid model.

self is explicitly positional-only to allow self as a field name.

class weaviate.rbac.models.WeaviatePermission

Bases: dict

action: str

backups: PermissionBackup | None

collections: PermissionCollections | None

data: PermissionData | None

nodes: PermissionNodes | None

roles: PermissionRoles | None

tenants: PermissionsTenants | None

users: PermissionsUsers | None

class weaviate.rbac.models.WeaviatePermissionRequired

Bases: TypedDict

action: str

class weaviate.rbac.models.WeaviateRole

Bases: TypedDict

name: str

permissions: List[WeaviatePermission]

class weaviate.rbac.models.WeaviateUser

Bases: TypedDict

groups: List[str]

roles: List[WeaviateRole] | None

username: str

weaviate.rbac.roles module