weaviate.rbac

class weaviate.rbac._RolesAsync(connection)[source]

Bases: _RolesExecutor[ConnectionAsync]

Parameters:

connection (ConnectionType)

class weaviate.rbac._Roles(connection)[source]

Bases: _RolesExecutor[ConnectionSync]

Parameters:

connection (ConnectionType)

weaviate.rbac.models

class weaviate.rbac.models.UserTypes(*values)[source]

Bases: str, Enum

DB_DYNAMIC = 'db_user'
DB_STATIC = 'db_env_user'
OIDC = 'oidc'
class weaviate.rbac.models.UserAssignment(user_id: str, user_type: weaviate.rbac.models.UserTypes)[source]

Bases: object

Parameters:
user_id: str
user_type: UserTypes
class weaviate.rbac.models.WeaviateUserAssignment[source]

Bases: TypedDict

userId: str
userType: str
class weaviate.rbac.models.RoleScope(*values)[source]

Bases: str, BaseEnum

Scope of the role permission.

MATCH = 'match'
ALL = 'all'
class weaviate.rbac.models.PermissionData[source]

Bases: TypedDict

collection: str
tenant: str
class weaviate.rbac.models.PermissionCollections[source]

Bases: TypedDict

collection: str
class weaviate.rbac.models.PermissionsTenants[source]

Bases: TypedDict

collection: str
tenant: str
class weaviate.rbac.models.PermissionNodes[source]

Bases: TypedDict

collection: str
verbosity: Literal['minimal', 'verbose']
class weaviate.rbac.models.PermissionBackup[source]

Bases: TypedDict

collection: str
class weaviate.rbac.models.PermissionRoles[source]

Bases: TypedDict

role: str
scope: NotRequired[str]
class weaviate.rbac.models.PermissionsUsers[source]

Bases: TypedDict

users: str
class weaviate.rbac.models.WeaviatePermissionRequired[source]

Bases: TypedDict

action: str
class weaviate.rbac.models.WeaviatePermission[source]

Bases: WeaviatePermissionRequired

data: PermissionData | None
collections: PermissionCollections | None
nodes: PermissionNodes | None
backups: PermissionBackup | None
roles: PermissionRoles | None
tenants: PermissionsTenants | None
users: PermissionsUsers | None
action: str
class weaviate.rbac.models.WeaviateRole[source]

Bases: TypedDict

name: str
permissions: List[WeaviatePermission]
class weaviate.rbac.models.WeaviateUser[source]

Bases: TypedDict

user_id: str
roles: List[WeaviateRole] | None
groups: List[str]
class weaviate.rbac.models.WeaviateDBUserRoleNames[source]

Bases: TypedDict

userId: str
roles: List[str]
groups: List[str]
active: bool
dbUserType: str
class weaviate.rbac.models._Action[source]

Bases: object

class weaviate.rbac.models.CollectionsAction(*values)[source]

Bases: str, _Action, Enum

CREATE = 'create_collections'
READ = 'read_collections'
UPDATE = 'update_collections'
DELETE = 'delete_collections'
MANAGE = 'manage_collections'
static values()[source]
Return type:

List[str]

class weaviate.rbac.models.TenantsAction(*values)[source]

Bases: str, _Action, Enum

CREATE = 'create_tenants'
READ = 'read_tenants'
UPDATE = 'update_tenants'
DELETE = 'delete_tenants'
static values()[source]
Return type:

List[str]

class weaviate.rbac.models.DataAction(*values)[source]

Bases: str, _Action, Enum

CREATE = 'create_data'
READ = 'read_data'
UPDATE = 'update_data'
DELETE = 'delete_data'
MANAGE = 'manage_data'
static values()[source]
Return type:

List[str]

class weaviate.rbac.models.RolesAction(*values)[source]

Bases: str, _Action, Enum

MANAGE = 'manage_roles'
CREATE = 'create_roles'
READ = 'read_roles'
UPDATE = 'update_roles'
DELETE = 'delete_roles'
static values()[source]
Return type:

List[str]

class weaviate.rbac.models.UsersAction(*values)[source]

Bases: str, _Action, Enum

CREATE = 'create_users'
READ = 'read_users'
UPDATE = 'update_users'
DELETE = 'delete_users'
ASSIGN_AND_REVOKE = 'assign_and_revoke_users'
static values()[source]
Return type:

List[str]

class weaviate.rbac.models.ClusterAction(*values)[source]

Bases: str, _Action, Enum

READ = 'read_cluster'
static values()[source]
Return type:

List[str]

class weaviate.rbac.models.NodesAction(*values)[source]

Bases: str, _Action, Enum

READ = 'read_nodes'
static values()[source]
Return type:

List[str]

class weaviate.rbac.models.BackupsAction(*values)[source]

Bases: str, _Action, Enum

MANAGE = 'manage_backups'
static values()[source]
Return type:

List[str]

pydantic model weaviate.rbac.models._Permission[source]

Bases: BaseModel, Generic[ActionT]

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 actions: Set[ActionT] [Required]
abstractmethod _to_weaviate()[source]
Return type:

List[WeaviatePermission]

_abc_impl = <_abc._abc_data object>
pydantic model weaviate.rbac.models._CollectionsPermission[source]

Bases: _Permission[CollectionsAction]

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 collection: str [Required]
_to_weaviate()[source]
Return type:

List[WeaviatePermission]

_abc_impl = <_abc._abc_data object>
pydantic model weaviate.rbac.models._TenantsPermission[source]

Bases: _Permission[TenantsAction]

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 collection: str [Required]
field tenant: str [Required]
_to_weaviate()[source]
Return type:

List[WeaviatePermission]

_abc_impl = <_abc._abc_data object>
pydantic model weaviate.rbac.models._NodesPermission[source]

Bases: _Permission[NodesAction]

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 collection: str [Required]
field verbosity: Literal['minimal', 'verbose'] [Required]
_to_weaviate()[source]
Return type:

List[WeaviatePermission]

_abc_impl = <_abc._abc_data object>
pydantic model weaviate.rbac.models._RolesPermission[source]

Bases: _Permission[RolesAction]

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 role: str [Required]
field scope: str | None = None
_to_weaviate()[source]
Return type:

List[WeaviatePermission]

_abc_impl = <_abc._abc_data object>
pydantic model weaviate.rbac.models._UsersPermission[source]

Bases: _Permission[UsersAction]

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 users: str [Required]
_to_weaviate()[source]
Return type:

List[WeaviatePermission]

_abc_impl = <_abc._abc_data object>
pydantic model weaviate.rbac.models._BackupsPermission[source]

Bases: _Permission[BackupsAction]

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 collection: str [Required]
_to_weaviate()[source]
Return type:

List[WeaviatePermission]

_abc_impl = <_abc._abc_data object>
pydantic model weaviate.rbac.models._ClusterPermission[source]

Bases: _Permission[ClusterAction]

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.

_to_weaviate()[source]
Return type:

List[WeaviatePermission]

_abc_impl = <_abc._abc_data object>
pydantic model weaviate.rbac.models._DataPermission[source]

Bases: _Permission[DataAction]

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 collection: str [Required]
field tenant: str [Required]
_to_weaviate()[source]
Return type:

List[WeaviatePermission]

_abc_impl = <_abc._abc_data object>
pydantic model weaviate.rbac.models.CollectionsPermissionOutput[source]

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.

field actions: Set[ActionT] [Required]
field collection: str [Required]
_abc_impl = <_abc._abc_data object>
pydantic model weaviate.rbac.models.DataPermissionOutput[source]

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.

field actions: Set[ActionT] [Required]
field collection: str [Required]
field tenant: str [Required]
_abc_impl = <_abc._abc_data object>
pydantic model weaviate.rbac.models.RolesPermissionOutput[source]

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.

field actions: Set[ActionT] [Required]
field role: str [Required]
field scope: str | None = None
_abc_impl = <_abc._abc_data object>
pydantic model weaviate.rbac.models.UsersPermissionOutput[source]

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.

field actions: Set[ActionT] [Required]
field users: str [Required]
_abc_impl = <_abc._abc_data object>
pydantic model weaviate.rbac.models.ClusterPermissionOutput[source]

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.

field actions: Set[ActionT] [Required]
_abc_impl = <_abc._abc_data object>
pydantic model weaviate.rbac.models.BackupsPermissionOutput[source]

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.

field actions: Set[ActionT] [Required]
field collection: str [Required]
_abc_impl = <_abc._abc_data object>
pydantic model weaviate.rbac.models.NodesPermissionOutput[source]

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.

field actions: Set[ActionT] [Required]
field collection: str [Required]
field verbosity: Verbosity [Required]
_abc_impl = <_abc._abc_data object>
pydantic model weaviate.rbac.models.TenantsPermissionOutput[source]

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.

_abc_impl = <_abc._abc_data object>
class weaviate.rbac.models.RoleBase(name: str)[source]

Bases: object

Parameters:

name (str)

name: 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])[source]

Bases: RoleBase

Parameters:
cluster_permissions: List[ClusterPermissionOutput]
collections_permissions: List[CollectionsPermissionOutput]
data_permissions: List[DataPermissionOutput]
roles_permissions: List[RolesPermissionOutput]
users_permissions: List[UsersPermissionOutput]
backups_permissions: List[BackupsPermissionOutput]
nodes_permissions: List[NodesPermissionOutput]
tenants_permissions: List[TenantsPermissionOutput]
property permissions: List[ClusterPermissionOutput | CollectionsPermissionOutput | DataPermissionOutput | RolesPermissionOutput | UsersPermissionOutput | BackupsPermissionOutput | NodesPermissionOutput | TenantsPermissionOutput]
classmethod _from_weaviate_role(role)[source]
Parameters:

role (WeaviateRole)

Return type:

Role

weaviate.rbac.models._join_permissions(permissions)[source]
Parameters:

permissions (List[T])

Return type:

List[T]

class weaviate.rbac.models.Actions[source]

Bases: object

Data

alias of DataAction

Collections

alias of CollectionsAction

Roles

alias of RolesAction

Cluster

alias of ClusterAction

Nodes

alias of NodesAction

Backups

alias of BackupsAction

Tenants

alias of TenantsAction

Users

alias of UsersAction

class weaviate.rbac.models.NodesPermissions[source]

Bases: object

static verbose(*, collection, read=False)[source]
Parameters:

  • collection (str | Sequence[str])

  • read (bool)

Return type:

List[_Permission]

static minimal(*, read=False)[source]
Parameters:

read (bool)

Return type:

List[_Permission]

class weaviate.rbac.models.Permissions[source]

Bases: object

Nodes

alias of NodesPermissions

static data(*, collection, tenant=None, create=False, read=False, update=False, delete=False)[source]
Parameters:

  • collection (str | Sequence[str])

  • tenant (str | Sequence[str] | None)

  • create (bool)

  • read (bool)

  • update (bool)

  • delete (bool)

Return type:

List[_Permission]

static collections(*, collection, create_collection=False, read_config=False, update_config=False, delete_collection=False)[source]
Parameters:

  • collection (str | Sequence[str])

  • create_collection (bool)

  • read_config (bool)

  • update_config (bool)

  • delete_collection (bool)

Return type:

List[_Permission]

static tenants(*, collection, tenant=None, create=False, read=False, update=False, delete=False)[source]
Parameters:

  • collection (str | Sequence[str])

  • tenant (str | Sequence[str] | None)

  • create (bool)

  • read (bool)

  • update (bool)

  • delete (bool)

Return type:

List[_Permission]

static roles(*, role, create=False, read=False, update=False, delete=False, scope=None)[source]
Parameters:

  • role (str | Sequence[str])

  • create (bool)

  • read (bool)

  • update (bool)

  • delete (bool)

  • scope (RoleScope | None)

Return type:

List[_Permission]

static users(*, user, create=False, read=False, update=False, delete=False, assign_and_revoke=False)[source]
Parameters:

  • user (str | Sequence[str])

  • create (bool)

  • read (bool)

  • update (bool)

  • delete (bool)

  • assign_and_revoke (bool)

Return type:

List[_Permission]

static backup(*, collection, manage=False)[source]
Parameters:

  • collection (str | Sequence[str])

  • manage (bool)

Return type:

List[_Permission]

static cluster(*, read=False)[source]
Parameters:

read (bool)

Return type:

List[_Permission]

pydantic model weaviate.rbac.models._Permission[source]

Bases: BaseModel, Generic[ActionT]

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 actions: Set[ActionT] [Required]
abstractmethod _to_weaviate()[source]
Return type:

List[WeaviatePermission]

_abc_impl = <_abc._abc_data object>
pydantic model weaviate.rbac.models._Permission[source]

Bases: BaseModel, Generic[ActionT]

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 actions: Set[ActionT] [Required]
abstractmethod _to_weaviate()[source]
Return type:

List[WeaviatePermission]

_abc_impl = <_abc._abc_data object>
pydantic model weaviate.rbac.models._Permission[source]

Bases: BaseModel, Generic[ActionT]

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 actions: Set[ActionT] [Required]
abstractmethod _to_weaviate()[source]
Return type:

List[WeaviatePermission]

_abc_impl = <_abc._abc_data object>
pydantic model weaviate.rbac.models._Permission[source]

Bases: BaseModel, Generic[ActionT]

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 actions: Set[ActionT] [Required]
abstractmethod _to_weaviate()[source]
Return type:

List[WeaviatePermission]

_abc_impl = <_abc._abc_data object>
pydantic model weaviate.rbac.models._Permission[source]

Bases: BaseModel, Generic[ActionT]

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 actions: Set[ActionT] [Required]
abstractmethod _to_weaviate()[source]
Return type:

List[WeaviatePermission]

_abc_impl = <_abc._abc_data object>
pydantic model weaviate.rbac.models._Permission[source]

Bases: BaseModel, Generic[ActionT]

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 actions: Set[ActionT] [Required]
abstractmethod _to_weaviate()[source]
Return type:

List[WeaviatePermission]

_abc_impl = <_abc._abc_data object>
pydantic model weaviate.rbac.models._Permission[source]

Bases: BaseModel, Generic[ActionT]

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 actions: Set[ActionT] [Required]
abstractmethod _to_weaviate()[source]
Return type:

List[WeaviatePermission]

_abc_impl = <_abc._abc_data object>
pydantic model weaviate.rbac.models._Permission[source]

Bases: BaseModel, Generic[ActionT]

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 actions: Set[ActionT] [Required]
abstractmethod _to_weaviate()[source]
Return type:

List[WeaviatePermission]

_abc_impl = <_abc._abc_data object>

weaviate.rbac.roles