Package io.weaviate.client.v1.rbac

Class Roles

java.lang.Object

io.weaviate.client.v1.rbac.Roles

public class Roles
extends Object

Constructor Summary

Constructors

Constructor	Description
Roles(HttpClient httpClient, Config config)

Method Summary

Modifier and Type	Method	Description
RoleAllGetter	allGetter()	Get all existing roles.
AssignedUsersGetter	assignedUsersGetter()	Deprecated.
RoleCreator	creator()	Create a new role.
RoleDeleter	deleter()	Delete a role.
RoleExists	exists()	Check if a role exists.
RoleGetter	getter()	Get role and its associated permissions.
PermissionAdder	permissionAdder()	Add permissions to an existing role.
PermissionChecker	permissionChecker()	Check if a role has a permission.
PermissionRemover	permissionRemover()	Remove permissions from a role.
UserAssignmentsGetter	userAssignmentsGetter()	Get role assignments.

Methods inherited from class java.lang.Object

clone, equals, finalize, getClass, hashCode, notify, notifyAll, toString, wait, wait, wait

Constructor Details

Roles

public Roles(HttpClient httpClient,
 Config config)

Method Details

creator

public RoleCreator creator()

Create a new role.

deleter

public RoleDeleter deleter()

Delete a role.

permissionAdder

public PermissionAdder permissionAdder()

Add permissions to an existing role. Note: This method is an upsert operation. If the permission already exists, it will be updated. If it does not exist, it will be created.

permissionRemover

public PermissionRemover permissionRemover()

Remove permissions from a role. Note: This method is a downsert operation. If the permission does not exist, it will be ignored. If these permissions are the only permissions of the role, the role will be deleted.

permissionChecker

public PermissionChecker permissionChecker()

Check if a role has a permission.

allGetter

public RoleAllGetter allGetter()

Get all existing roles.

getter

public RoleGetter getter()

Get role and its associated permissions.

assignedUsersGetter

@Deprecated
public AssignedUsersGetter assignedUsersGetter()

Deprecated.

Get users assigned to a role.

Deprecated - prefer userAssignmentsGetter()

userAssignmentsGetter

public UserAssignmentsGetter userAssignmentsGetter()

Get role assignments.

Note, that the result is not a list of unique users, but rather a list of all username+namespace combinations allowed for this role. In clusters with enabled OIDC authorization, users created dynamically (db_user) or configured in the environment (db_env_user) will appear twice: once as 'db_*' user and once as 'oidc' user.

exists

public RoleExists exists()

Check if a role exists.