weaviate.rbac

Submodules

weaviate.rbac.models module

class weaviate.rbac.models.Actions[source]

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

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

Bases: str, _Action, Enum

MANAGE = 'manage_backups'

static values() → List[str][source]

class weaviate.rbac.models.BackupsPermission(collection: str, action: weaviate.rbac.models.BackupsAction)[source]

Bases: object

action: BackupsAction

collection: str

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

Bases: str, _Action, Enum

READ = 'read_cluster'

static values() → List[str][source]

class weaviate.rbac.models.ClusterPermission(action: weaviate.rbac.models.ClusterAction)[source]

Bases: object

action: ClusterAction

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

Bases: str, _Action, Enum

CREATE = 'create_collections'

DELETE = 'delete_collections'

MANAGE = 'manage_collections'

READ = 'read_collections'

UPDATE = 'update_collections'

static values() → List[str][source]

class weaviate.rbac.models.CollectionsPermission(collection: str, action: weaviate.rbac.models.CollectionsAction)[source]

Bases: object

action: CollectionsAction

collection: str

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

Bases: str, _Action, Enum

CREATE = 'create_data'

DELETE = 'delete_data'

MANAGE = 'manage_data'

READ = 'read_data'

UPDATE = 'update_data'

static values() → List[str][source]

class weaviate.rbac.models.DataPermission(collection: str, action: weaviate.rbac.models.DataAction)[source]

Bases: object

action: DataAction

collection: str

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

Bases: str, _Action, Enum

READ = 'read_nodes'

static values() → List[str][source]

class weaviate.rbac.models.NodesPermission(collection: str | None, verbosity: Literal['minimal', 'verbose'], action: weaviate.rbac.models.NodesAction)[source]

Bases: object

action: NodesAction

collection: str | None

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

class weaviate.rbac.models.PermissionBackup[source]

Bases: TypedDict

collection: str

class weaviate.rbac.models.PermissionCollections[source]

Bases: TypedDict

collection: str

tenant: str

class weaviate.rbac.models.PermissionData[source]

Bases: TypedDict

collection: str

object: str

tenant: str

class weaviate.rbac.models.PermissionNodes[source]

Bases: TypedDict

collection: str

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

class weaviate.rbac.models.PermissionRoles[source]

Bases: TypedDict

role: str

class weaviate.rbac.models.Permissions[source]

Bases: object

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

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

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

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

static nodes(*, collection: str | Sequence[str], verbosity: Literal['minimal', 'verbose'] = 'minimal', read: bool = False) → List[_Permission][source]

static roles(*, role: str | Sequence[str], read: bool = False, manage: bool = False) → List[_Permission][source]

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

class weaviate.rbac.models.PermissionsTenants[source]

Bases: TypedDict

collection: str

tenant: str

Bases: object

backups_permissions: List[BackupsPermission]

cluster_permissions: List[ClusterPermission]

collections_permissions: List[CollectionsPermission]

data_permissions: List[DataPermission]

name: str

nodes_permissions: List[NodesPermission]

property permissions: List[ClusterPermission | CollectionsPermission | DataPermission | RolesPermission | UsersPermission | BackupsPermission | NodesPermission | TenantsPermission]

roles_permissions: List[RolesPermission]

tenants_permissions: List[TenantsPermission]

users_permissions: List[UsersPermission]

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

Bases: str, _Action, Enum

MANAGE = 'manage_roles'

READ = 'read_roles'

static values() → List[str][source]

class weaviate.rbac.models.RolesPermission(role: str, action: weaviate.rbac.models.RolesAction)[source]

Bases: object

action: RolesAction

role: str

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

Bases: str, _Action, Enum

CREATE = 'create_tenants'

DELETE = 'delete_tenants'

READ = 'read_tenants'

UPDATE = 'update_tenants'

static values() → List[str][source]

pydantic model weaviate.rbac.models.TenantsPermission[source]

Bases: _Permission

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.

field action: TenantsAction [Required]

field collection: str [Required]

class weaviate.rbac.models.User(name: str)[source]

Bases: object

name: str

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