weaviate.rbac

class weaviate.rbac._RolesAsync(connection)

Bases: _RolesExecutor[ConnectionAsync]

Parameters:

connection (ConnectionType)

class weaviate.rbac._Roles(connection)

Bases: _RolesExecutor[ConnectionSync]

Parameters:

connection (ConnectionType)

weaviate.rbac.models

class weaviate.rbac.models.UserTypes(*values)

Bases: str, Enum

DB_DYNAMIC = 'db_user'

DB_STATIC = 'db_env_user'

OIDC = 'oidc'

class weaviate.rbac.models.GroupTypes(*values)

Bases: str, Enum

OIDC = 'oidc'

class weaviate.rbac.models.UserAssignment(user_id: str, user_type: weaviate.rbac.models.UserTypes)

Bases: object

Parameters:

• user_id (str)

• user_type (UserTypes)

user_id: str

user_type: UserTypes

class weaviate.rbac.models.GroupAssignment(group_id: str, group_type: weaviate.rbac.models.GroupTypes)

Bases: object

Parameters:

• group_id (str)

• group_type (GroupTypes)

group_id: str

group_type: GroupTypes

class weaviate.rbac.models.WeaviateUserAssignment

Bases: TypedDict

userId: str

userType: str

class weaviate.rbac.models.RoleScope(*values)

Bases: str, BaseEnum

Scope of the role permission.

MATCH = 'match'

ALL = 'all'

class weaviate.rbac.models.PermissionData

Bases: TypedDict

collection: str

tenant: str

class weaviate.rbac.models.PermissionCollections

Bases: TypedDict

collection: str

class weaviate.rbac.models.PermissionsTenants

Bases: TypedDict

collection: str

tenant: str

class weaviate.rbac.models.PermissionNodes

Bases: TypedDict

collection: str

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

class weaviate.rbac.models.PermissionBackup

Bases: TypedDict

collection: str

class weaviate.rbac.models.PermissionReplicate

Bases: TypedDict

collection: str

shard: str

class weaviate.rbac.models.PermissionRoles

Bases: TypedDict

role: str

scope: NotRequired[str]

class weaviate.rbac.models.PermissionsUsers

Bases: TypedDict

users: str

class weaviate.rbac.models.PermissionsGroups

Bases: TypedDict

group: str

groupType: str

class weaviate.rbac.models.PermissionsAlias

Bases: TypedDict

alias: str

collection: str

class weaviate.rbac.models.WeaviatePermissionRequired

Bases: TypedDict

action: str

class weaviate.rbac.models.WeaviatePermission

Bases: WeaviatePermissionRequired

data: PermissionData | None

collections: PermissionCollections | None

nodes: PermissionNodes | None

backups: PermissionBackup | None

replicate: PermissionReplicate | None

roles: PermissionRoles | None

tenants: PermissionsTenants | None

users: PermissionsUsers | None

aliases: PermissionsAlias | None

groups: PermissionsGroups | None

action: str

class weaviate.rbac.models.WeaviateRole

Bases: TypedDict

name: str

permissions: List[WeaviatePermission]

class weaviate.rbac.models.WeaviateUser

Bases: TypedDict

user_id: str

roles: List[WeaviateRole] | None

groups: List[str]

class weaviate.rbac.models.WeaviateDBUserRoleNames

Bases: TypedDict

userId: str

roles: List[str]

groups: List[str]

active: bool

dbUserType: str

createdAt: NotRequired[str]

lastUsedAt: NotRequired[str]

apiKeyFirstLetters: NotRequired[str]

class weaviate.rbac.models._Action

Bases: object

class weaviate.rbac.models.AliasAction(*values)

Bases: str, _Action, Enum

CREATE = 'create_aliases'

READ = 'read_aliases'

UPDATE = 'update_aliases'

DELETE = 'delete_aliases'

static values()

Return type:

List[str]

class weaviate.rbac.models.CollectionsAction(*values)

Bases: str, _Action, Enum

CREATE = 'create_collections'

READ = 'read_collections'

UPDATE = 'update_collections'

DELETE = 'delete_collections'

MANAGE = 'manage_collections'

static values()

Return type:

List[str]

class weaviate.rbac.models.TenantsAction(*values)

Bases: str, _Action, Enum

CREATE = 'create_tenants'

READ = 'read_tenants'

UPDATE = 'update_tenants'

DELETE = 'delete_tenants'

static values()

Return type:

List[str]

class weaviate.rbac.models.DataAction(*values)

Bases: str, _Action, Enum

CREATE = 'create_data'

READ = 'read_data'

UPDATE = 'update_data'

DELETE = 'delete_data'

MANAGE = 'manage_data'

static values()

Return type:

List[str]

class weaviate.rbac.models.RolesAction(*values)

Bases: str, _Action, Enum

MANAGE = 'manage_roles'

CREATE = 'create_roles'

READ = 'read_roles'

UPDATE = 'update_roles'

DELETE = 'delete_roles'

static values()

Return type:

List[str]

class weaviate.rbac.models.GroupAction(*values)

Bases: str, _Action, Enum

READ = 'read_groups'

ASSIGN_AND_REVOKE = 'assign_and_revoke_groups'

static values()

Return type:

List[str]

class weaviate.rbac.models.UsersAction(*values)

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()

Return type:

List[str]

class weaviate.rbac.models.ClusterAction(*values)

Bases: str, _Action, Enum

READ = 'read_cluster'

static values()

Return type:

List[str]

class weaviate.rbac.models.NodesAction(*values)

Bases: str, _Action, Enum

READ = 'read_nodes'

static values()

Return type:

List[str]

class weaviate.rbac.models.BackupsAction(*values)

Bases: str, _Action, Enum

MANAGE = 'manage_backups'

static values()

Return type:

List[str]

class weaviate.rbac.models.MCPAction(*values)

Bases: str, _Action, Enum

CREATE = 'create_mcp'

READ = 'read_mcp'

UPDATE = 'update_mcp'

static values()

Return type:

List[str]

class weaviate.rbac.models.ReplicateAction(*values)

Bases: str, _Action, Enum

CREATE = 'create_replicate'

READ = 'read_replicate'

UPDATE = 'update_replicate'

DELETE = 'delete_replicate'

static values()

Return type:

List[str]

class weaviate.rbac.models._Permission(*, actions)

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.

Parameters:

actions (Set[ActionT])

actions: Set[ActionT]

abstractmethod _to_weaviate()

Return type:

List[WeaviatePermission]

_abc_impl = <_abc._abc_data object>

model_config = {}

Configuration for the model, should be a dictionary conforming to [ConfigDict][pydantic.config.ConfigDict].

class weaviate.rbac.models._Permission(*, actions)

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.

Parameters:

actions (Set[ActionT])

actions: Set[ActionT]

abstractmethod _to_weaviate()

Return type:

List[WeaviatePermission]

_abc_impl = <_abc._abc_data object>

model_config = {}

Configuration for the model, should be a dictionary conforming to [ConfigDict][pydantic.config.ConfigDict].

class weaviate.rbac.models._Permission(*, actions)

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.

Parameters:

actions (Set[ActionT])

actions: Set[ActionT]

abstractmethod _to_weaviate()

Return type:

List[WeaviatePermission]

_abc_impl = <_abc._abc_data object>

model_config = {}

Configuration for the model, should be a dictionary conforming to [ConfigDict][pydantic.config.ConfigDict].

class weaviate.rbac.models._Permission(*, actions)

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.

Parameters:

actions (Set[ActionT])

actions: Set[ActionT]

abstractmethod _to_weaviate()

Return type:

List[WeaviatePermission]

_abc_impl = <_abc._abc_data object>

model_config = {}

Configuration for the model, should be a dictionary conforming to [ConfigDict][pydantic.config.ConfigDict].

class weaviate.rbac.models._Permission(*, actions)

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.

Parameters:

actions (Set[ActionT])

actions: Set[ActionT]

abstractmethod _to_weaviate()

Return type:

List[WeaviatePermission]

_abc_impl = <_abc._abc_data object>

model_config = {}

Configuration for the model, should be a dictionary conforming to [ConfigDict][pydantic.config.ConfigDict].

class weaviate.rbac.models._Permission(*, actions)

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.

Parameters:

actions (Set[ActionT])

actions: Set[ActionT]

abstractmethod _to_weaviate()

Return type:

List[WeaviatePermission]

_abc_impl = <_abc._abc_data object>

model_config = {}

Configuration for the model, should be a dictionary conforming to [ConfigDict][pydantic.config.ConfigDict].

class weaviate.rbac.models._Permission(*, actions)

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.

Parameters:

actions (Set[ActionT])

actions: Set[ActionT]

abstractmethod _to_weaviate()

Return type:

List[WeaviatePermission]

_abc_impl = <_abc._abc_data object>

model_config = {}

Configuration for the model, should be a dictionary conforming to [ConfigDict][pydantic.config.ConfigDict].

class weaviate.rbac.models._Permission(*, actions)

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.

Parameters:

actions (Set[ActionT])

actions: Set[ActionT]

abstractmethod _to_weaviate()

Return type:

List[WeaviatePermission]

_abc_impl = <_abc._abc_data object>

model_config = {}

Configuration for the model, should be a dictionary conforming to [ConfigDict][pydantic.config.ConfigDict].

class weaviate.rbac.models._Permission(*, actions)

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.

Parameters:

actions (Set[ActionT])

actions: Set[ActionT]

abstractmethod _to_weaviate()

Return type:

List[WeaviatePermission]

_abc_impl = <_abc._abc_data object>

model_config = {}

Configuration for the model, should be a dictionary conforming to [ConfigDict][pydantic.config.ConfigDict].

class weaviate.rbac.models._Permission(*, actions)

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.

Parameters:

actions (Set[ActionT])

actions: Set[ActionT]

abstractmethod _to_weaviate()

Return type:

List[WeaviatePermission]

_abc_impl = <_abc._abc_data object>

model_config = {}

Configuration for the model, should be a dictionary conforming to [ConfigDict][pydantic.config.ConfigDict].

class weaviate.rbac.models._Permission(*, actions)

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.

Parameters:

actions (Set[ActionT])

actions: Set[ActionT]

abstractmethod _to_weaviate()

Return type:

List[WeaviatePermission]

_abc_impl = <_abc._abc_data object>

model_config = {}

Configuration for the model, should be a dictionary conforming to [ConfigDict][pydantic.config.ConfigDict].

class weaviate.rbac.models._Permission(*, actions)

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.

Parameters:

actions (Set[ActionT])

actions: Set[ActionT]

abstractmethod _to_weaviate()

Return type:

List[WeaviatePermission]

_abc_impl = <_abc._abc_data object>

model_config = {}

Configuration for the model, should be a dictionary conforming to [ConfigDict][pydantic.config.ConfigDict].

class weaviate.rbac.models._Permission(*, actions)

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.

Parameters:

actions (Set[ActionT])

actions: Set[ActionT]

abstractmethod _to_weaviate()

Return type:

List[WeaviatePermission]

_abc_impl = <_abc._abc_data object>

model_config = {}

Configuration for the model, should be a dictionary conforming to [ConfigDict][pydantic.config.ConfigDict].

class weaviate.rbac.models._CollectionsPermission(*, actions, collection)

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.

Parameters:

• actions (Set[CollectionsAction])

• collection (str)

collection: str

_to_weaviate()

Return type:

List[WeaviatePermission]

_abc_impl = <_abc._abc_data object>

model_config = {}

Configuration for the model, should be a dictionary conforming to [ConfigDict][pydantic.config.ConfigDict].

class weaviate.rbac.models._TenantsPermission(*, actions, collection, tenant)

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.

Parameters:

• actions (Set[TenantsAction])

• collection (str)

• tenant (str)

collection: str

tenant: str

_to_weaviate()

Return type:

List[WeaviatePermission]

_abc_impl = <_abc._abc_data object>

model_config = {}

Configuration for the model, should be a dictionary conforming to [ConfigDict][pydantic.config.ConfigDict].

class weaviate.rbac.models._NodesPermission(*, actions, verbosity, collection)

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.

Parameters:

• actions (Set[NodesAction])

• verbosity (Literal['minimal', 'verbose'])

• collection (str)

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

collection: str

_to_weaviate()

Return type:

List[WeaviatePermission]

_abc_impl = <_abc._abc_data object>

model_config = {}

Configuration for the model, should be a dictionary conforming to [ConfigDict][pydantic.config.ConfigDict].

class weaviate.rbac.models._ReplicatePermission(*, actions, collection, shard)

Bases: _Permission[ReplicateAction]

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.

Parameters:

• actions (Set[ReplicateAction])

• collection (str)

• shard (str)

collection: str

shard: str

_to_weaviate()

Return type:

List[WeaviatePermission]

_abc_impl = <_abc._abc_data object>

model_config = {}

Configuration for the model, should be a dictionary conforming to [ConfigDict][pydantic.config.ConfigDict].

class weaviate.rbac.models._RolesPermission(*, actions, role, scope=None)

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.

Parameters:

• actions (Set[RolesAction])

• role (str)

• scope (str | None)

role: str

scope: str | None

_to_weaviate()

Return type:

List[WeaviatePermission]

_abc_impl = <_abc._abc_data object>

model_config = {}

Configuration for the model, should be a dictionary conforming to [ConfigDict][pydantic.config.ConfigDict].

class weaviate.rbac.models._UsersPermission(*, actions, users)

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.

Parameters:

• actions (Set[UsersAction])

• users (str)

users: str

_to_weaviate()

Return type:

List[WeaviatePermission]

_abc_impl = <_abc._abc_data object>

model_config = {}

Configuration for the model, should be a dictionary conforming to [ConfigDict][pydantic.config.ConfigDict].

class weaviate.rbac.models._AliasPermission(*, actions, alias, collection)

Bases: _Permission[AliasAction]

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.

Parameters:

• actions (Set[AliasAction])

• alias (str)

• collection (str)

alias: str

collection: str

_to_weaviate()

Return type:

List[WeaviatePermission]

_abc_impl = <_abc._abc_data object>

model_config = {}

Configuration for the model, should be a dictionary conforming to [ConfigDict][pydantic.config.ConfigDict].

class weaviate.rbac.models._GroupsPermission(*, actions, group, group_type)

Bases: _Permission[GroupAction]

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.

Parameters:

• actions (Set[GroupAction])

• group (str)

• group_type (str)

group: str

group_type: str

_to_weaviate()

Return type:

List[WeaviatePermission]

_abc_impl = <_abc._abc_data object>

model_config = {}

Configuration for the model, should be a dictionary conforming to [ConfigDict][pydantic.config.ConfigDict].

class weaviate.rbac.models._BackupsPermission(*, actions, collection)

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.

Parameters:

• actions (Set[BackupsAction])

• collection (str)

collection: str

_to_weaviate()

Return type:

List[WeaviatePermission]

_abc_impl = <_abc._abc_data object>

model_config = {}

Configuration for the model, should be a dictionary conforming to [ConfigDict][pydantic.config.ConfigDict].

class weaviate.rbac.models._MCPPermission(*, actions)

Bases: _Permission[MCPAction]

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.

Parameters:

actions (Set[MCPAction])

_to_weaviate()

Return type:

List[WeaviatePermission]

_abc_impl = <_abc._abc_data object>

model_config = {}

Configuration for the model, should be a dictionary conforming to [ConfigDict][pydantic.config.ConfigDict].

class weaviate.rbac.models._ClusterPermission(*, actions)

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.

Parameters:

actions (Set[ClusterAction])

_to_weaviate()

Return type:

List[WeaviatePermission]

_abc_impl = <_abc._abc_data object>

model_config = {}

Configuration for the model, should be a dictionary conforming to [ConfigDict][pydantic.config.ConfigDict].

class weaviate.rbac.models._DataPermission(*, actions, collection, tenant)

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.

Parameters:

• actions (Set[DataAction])

• collection (str)

• tenant (str)

collection: str

tenant: str

_to_weaviate()

Return type:

List[WeaviatePermission]

_abc_impl = <_abc._abc_data object>

model_config = {}

Configuration for the model, should be a dictionary conforming to [ConfigDict][pydantic.config.ConfigDict].

class weaviate.rbac.models.CollectionsPermissionOutput(*, actions, collection)

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.

Parameters:

• actions (Set[CollectionsAction])

• collection (str)

_abc_impl = <_abc._abc_data object>

model_config = {}

Configuration for the model, should be a dictionary conforming to [ConfigDict][pydantic.config.ConfigDict].

class weaviate.rbac.models.DataPermissionOutput(*, actions, collection, tenant)

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.

Parameters:

• actions (Set[DataAction])

• collection (str)

• tenant (str)

_abc_impl = <_abc._abc_data object>

model_config = {}

Configuration for the model, should be a dictionary conforming to [ConfigDict][pydantic.config.ConfigDict].

class weaviate.rbac.models.ReplicatePermissionOutput(*, actions, collection, shard)

Bases: _ReplicatePermission

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.

Parameters:

• actions (Set[ReplicateAction])

• collection (str)

• shard (str)

_abc_impl = <_abc._abc_data object>

model_config = {}

Configuration for the model, should be a dictionary conforming to [ConfigDict][pydantic.config.ConfigDict].

class weaviate.rbac.models.RolesPermissionOutput(*, actions, role, scope=None)

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.

Parameters:

• actions (Set[RolesAction])

• role (str)

• scope (str | None)

_abc_impl = <_abc._abc_data object>

model_config = {}

Configuration for the model, should be a dictionary conforming to [ConfigDict][pydantic.config.ConfigDict].

class weaviate.rbac.models.UsersPermissionOutput(*, actions, users)

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.

Parameters:

• actions (Set[UsersAction])

• users (str)

_abc_impl = <_abc._abc_data object>

model_config = {}

Configuration for the model, should be a dictionary conforming to [ConfigDict][pydantic.config.ConfigDict].

class weaviate.rbac.models.GroupsPermissionOutput(*, actions, group, group_type)

Bases: _GroupsPermission

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.

Parameters:

• actions (Set[GroupAction])

• group (str)

• group_type (str)

_abc_impl = <_abc._abc_data object>

model_config = {}

Configuration for the model, should be a dictionary conforming to [ConfigDict][pydantic.config.ConfigDict].

class weaviate.rbac.models.AliasPermissionOutput(*, actions, alias, collection)

Bases: _AliasPermission

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.

Parameters:

• actions (Set[AliasAction])

• alias (str)

• collection (str)

_abc_impl = <_abc._abc_data object>

model_config = {}

Configuration for the model, should be a dictionary conforming to [ConfigDict][pydantic.config.ConfigDict].

class weaviate.rbac.models.ClusterPermissionOutput(*, actions)

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.

Parameters:

actions (Set[ClusterAction])

_abc_impl = <_abc._abc_data object>

model_config = {}

Configuration for the model, should be a dictionary conforming to [ConfigDict][pydantic.config.ConfigDict].

class weaviate.rbac.models.BackupsPermissionOutput(*, actions, collection)

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.

Parameters:

• actions (Set[BackupsAction])

• collection (str)

_abc_impl = <_abc._abc_data object>

model_config = {}

Configuration for the model, should be a dictionary conforming to [ConfigDict][pydantic.config.ConfigDict].

class weaviate.rbac.models.MCPPermissionOutput(*, actions)

Bases: _MCPPermission

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.

Parameters:

actions (Set[MCPAction])

_abc_impl = <_abc._abc_data object>

model_config = {}

Configuration for the model, should be a dictionary conforming to [ConfigDict][pydantic.config.ConfigDict].

class weaviate.rbac.models.NodesPermissionOutput(*, actions, verbosity, collection)

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.

Parameters:

• actions (Set[NodesAction])

• verbosity (Literal['minimal', 'verbose'])

• collection (str)

_abc_impl = <_abc._abc_data object>

model_config = {}

Configuration for the model, should be a dictionary conforming to [ConfigDict][pydantic.config.ConfigDict].

class weaviate.rbac.models.TenantsPermissionOutput(*, actions, collection, tenant)

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.

Parameters:

• actions (Set[TenantsAction])

• collection (str)

• tenant (str)

_abc_impl = <_abc._abc_data object>

model_config = {}

Configuration for the model, should be a dictionary conforming to [ConfigDict][pydantic.config.ConfigDict].

class weaviate.rbac.models.RoleBase(name: str)

Bases: object

Parameters:

name (str)

name: str

class weaviate.rbac.models.Role(name: str, alias_permissions: List[weaviate.rbac.models.AliasPermissionOutput], 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], mcp_permissions: List[weaviate.rbac.models.MCPPermissionOutput], nodes_permissions: List[weaviate.rbac.models.NodesPermissionOutput], tenants_permissions: List[weaviate.rbac.models.TenantsPermissionOutput], replicate_permissions: List[weaviate.rbac.models.ReplicatePermissionOutput], groups_permissions: List[weaviate.rbac.models.GroupsPermissionOutput])

Bases: RoleBase

Parameters:

• name (str)

• alias_permissions (List[AliasPermissionOutput])

• cluster_permissions (List[ClusterPermissionOutput])

• collections_permissions (List[CollectionsPermissionOutput])

• data_permissions (List[DataPermissionOutput])

• roles_permissions (List[RolesPermissionOutput])

• users_permissions (List[UsersPermissionOutput])

• backups_permissions (List[BackupsPermissionOutput])

• mcp_permissions (List[MCPPermissionOutput])

• nodes_permissions (List[NodesPermissionOutput])

• tenants_permissions (List[TenantsPermissionOutput])

• replicate_permissions (List[ReplicatePermissionOutput])

• groups_permissions (List[GroupsPermissionOutput])

alias_permissions: List[AliasPermissionOutput]

cluster_permissions: List[ClusterPermissionOutput]

collections_permissions: List[CollectionsPermissionOutput]

data_permissions: List[DataPermissionOutput]

roles_permissions: List[RolesPermissionOutput]

users_permissions: List[UsersPermissionOutput]

backups_permissions: List[BackupsPermissionOutput]

mcp_permissions: List[MCPPermissionOutput]

nodes_permissions: List[NodesPermissionOutput]

tenants_permissions: List[TenantsPermissionOutput]

replicate_permissions: List[ReplicatePermissionOutput]

groups_permissions: List[GroupsPermissionOutput]

property permissions: List[AliasPermissionOutput | ClusterPermissionOutput | CollectionsPermissionOutput | DataPermissionOutput | RolesPermissionOutput | UsersPermissionOutput | BackupsPermissionOutput | MCPPermissionOutput | NodesPermissionOutput | TenantsPermissionOutput | ReplicatePermissionOutput | GroupsPermissionOutput]

classmethod _from_weaviate_role(role)

Parameters:

role (WeaviateRole)

Return type:

Role

weaviate.rbac.models._join_permissions(permissions)

Parameters:

permissions (List[T])

Return type:

List[T]

class weaviate.rbac.models.Actions

Bases: object

Alias

alias of AliasAction

Data

alias of DataAction

Collections

alias of CollectionsAction

Roles

alias of RolesAction

Cluster

alias of ClusterAction

Nodes

alias of NodesAction

Backups

alias of BackupsAction

MCP

alias of MCPAction

Tenants

alias of TenantsAction

Users

alias of UsersAction

Replicate

alias of ReplicateAction

Groups

alias of GroupAction

class weaviate.rbac.models.GroupsPermissions

Bases: object

static oidc(*, group, read=False, assign_and_revoke=False)

Parameters:

• group (str | Sequence[str])

• read (bool)

• assign_and_revoke (bool)

Return type:

List[_Permission]

class weaviate.rbac.models.NodesPermissions

Bases: object

static verbose(*, collection, read=False)

Parameters:

• collection (str | Sequence[str])

• read (bool)

Return type:

List[_Permission]

static minimal(*, read=False)

Parameters:

read (bool)

Return type:

List[_Permission]

class weaviate.rbac.models.Permissions

Bases: object

Nodes

alias of NodesPermissions

Groups

alias of GroupsPermissions

static alias(*, alias, collection, create=False, read=False, update=False, delete=False)

Parameters:

• alias (str | Sequence[str])

• collection (str | Sequence[str])

• create (bool)

• read (bool)

• update (bool)

• delete (bool)

Return type:

List[_Permission]

static data(*, collection, tenant=None, create=False, read=False, update=False, delete=False)

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)

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)

Parameters:

• collection (str | Sequence[str])

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

• create (bool)

• read (bool)

• update (bool)

• delete (bool)

Return type:

List[_Permission]

static replicate(*, collection, shard=None, create=False, read=False, update=False, delete=False)

Parameters:

• collection (str | Sequence[str])

• shard (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)

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)

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)

Parameters:

• collection (str | Sequence[str])

• manage (bool)

Return type:

List[_Permission]

static mcp(*, create=False, read=False, update=False)

Parameters:

• create (bool)

• read (bool)

• update (bool)

Return type:

List[_Permission]

static cluster(*, read=False)

Parameters:

read (bool)

Return type:

List[_Permission]

weaviate.rbac.roles