roles

Client API for role-based-access-control roles and assignments in Nexus.

qnexus.client.roles.assign_team(
resource_ref: BaseRef,
team: TeamRef,
role: Literal['Administrator', 'Contributor', 'Reader', 'Maintainer'] | Role,
) → None

Assign a role-based access control assignment to a team.

qnexus.client.roles.assign_user(
resource_ref: BaseRef,
user_email: EmailStr,
role: Literal['Administrator', 'Contributor', 'Reader', 'Maintainer'] | Role,
) → None

Assign a role-based access control assignment to a user.

qnexus.client.roles.assignments(
resource_ref: BaseRef,
) → DataframableList[RoleInfo]

Check the assignments on a particular resource.

qnexus.client.roles.get(
name: Literal['Administrator', 'Contributor', 'Reader', 'Maintainer'],
) → Role

Get a single Role by name.

qnexus.client.roles.get_all() → DataframableList[Role]

Get the definitions of possible role-based access control assignments.

class qnexus.roles.Role(
*,
id: UUID,
name: str,
description: str,
permissions: str,
type: Literal['role'] = 'role',
)

A role for use in RBAC assignments.

df() → DataFrame

Convert to a pandas DataFrame.

class qnexus.roles.RoleInfo(
*,
assignment_type: Literal['user', 'team', 'public'],
assignee: TeamRef | UserRef | None,
role: Role,
)

Information on a role assigned on a resource.

df() → DataFrame

Convert to a pandas DataFrame.