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, scope: ScopeFilterEnum = ScopeFilterEnum.USER, ) → None[source]¶

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

Examples

>>> import qnexus as qnx
>>> team = qnx.teams.get(name="team-unobtainium")
>>> qnx.roles.assign_team(project_ref, team=team, role="Contributor")

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

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

Examples

>>> import qnexus as qnx
>>> qnx.roles.assign_user(
...     project_ref,
...     user_email="colleague@example.com",
...     role="Reader",
... )

qnexus.client.roles.assignments( resource_ref: BaseRef, scope: ScopeFilterEnum = ScopeFilterEnum.USER, ) → DataframableList[RoleInfo][source]¶

Check the assignments on a particular resource.

Examples

>>> import qnexus as qnx
>>> assignments = qnx.roles.assignments(project_ref)
>>> assignments.df()

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

Get a single Role by name.

Examples

>>> import qnexus as qnx
>>> reader_role = qnx.roles.get("Maintainer")

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

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

Examples

>>> import qnexus as qnx
>>> roles = qnx.roles.get_all()
>>> roles.df()

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

A role for use in RBAC assignments.

df() → DataFrame[source]¶: Convert to a pandas DataFrame.

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

Information on a role assigned on a resource.

df() → DataFrame[source]¶: Convert to a pandas DataFrame.