quilt3.admin Python API
quilt3.admin.types
ManagedRole(id: str, name: str, arn: str, typename__: Literal['ManagedRole']) -> None
UnmanagedRole(id: str, name: str, arn: str, typename__: Literal['UnmanagedRole']) -> None
User(name: str, email: str, date_joined: datetime.datetime, last_login: datetime.datetime, is_active: bool, is_admin: bool, is_sso_only: bool, is_service: bool, role: Optional[Annotated[Union[quilt3.admin.types.ManagedRole, quilt3.admin.types.UnmanagedRole], FieldInfo(annotation=NoneType, required=True, discriminator='typename__')]], extra_roles: List[Annotated[Union[quilt3.admin.types.ManagedRole, quilt3.admin.types.UnmanagedRole], FieldInfo(annotation=NoneType, required=True, discriminator='typename__')]]) -> None
SSOConfig(text: str, timestamp: datetime.datetime, uploader: quilt3.admin.types.User) -> None
TabulatorTable(name: str, config: str) -> None
quilt3.admin.roles
list() -> List[Union[quilt3.admin.types.ManagedRole, quilt3.admin.types.UnmanagedRole]]
Get a list of all roles in the registry.
quilt3.admin.users
get(name: str) -> Optional[quilt3.admin.types.User]
Get a specific user from the registry. Return None if the user does not exist.
Arguments
name: Username of user to get.
list() -> List[quilt3.admin.types.User]
Get a list of all users in the registry.
create(name: str, email: str, role: str, extra_roles: Optional[List[str]] = None) -> quilt3.admin.types.User
Create a new user in the registry.
Arguments
name: Username of user to create.
email: Email of user to create.
role: Active role of the user.
extra_roles: Additional roles to assign to the user.
delete(name: str) -> None
Delete user from the registry.
Arguments
name: Username of user to delete.
set_email(name: str, email: str) -> quilt3.admin.types.User
Set the email for a user.
Arguments
name: Username of user to update.
email: Email to set for the user.
set_admin(name: str, admin: bool) -> quilt3.admin.types.User
Set the admin status for a user.
Arguments
name: Username of user to update.
admin: Admin status to set for the user.
set_active(name: str, active: bool) -> quilt3.admin.types.User
Set the active status for a user.
Arguments
name: Username of user to update.
active: Active status to set for the user.
reset_password(name: str) -> None
Reset the password for a user.
Arguments
name: Username of user to update.
set_role(name: str, role: str, extra_roles: Optional[List[str]] = None, *, append: bool = False) -> quilt3.admin.types.User
Set the active and extra roles for a user.
Arguments
name: Username of user to update.
role: Role to be set as the active role.
extra_roles: Additional roles to assign to the user.
append: If True, append the extra roles to the existing roles. If False, replace the existing roles.
add_roles(name: str, roles: List[str]) -> quilt3.admin.types.User
Add roles to a user.
Arguments
name: Username of user to update.
roles: Roles to add to the user.
remove_roles(name: str, roles: List[str], fallback: Optional[str] = None) -> quilt3.admin.types.User
Remove roles from a user.
Arguments
name: Username of user to update.
roles: Roles to remove from the user.
fallback: If set, the role to assign to the user if the active role is removed.
quilt3.admin.sso_config
get() -> Optional[quilt3.admin.types.SSOConfig]
Get the current SSO configuration.
set(config: Optional[str]) -> Optional[quilt3.admin.types.SSOConfig]
Set the SSO configuration. Pass None to remove SSO configuration.
quilt3.admin.tabulator
list_tables(bucket_name: str) -> list[quilt3.admin.types.TabulatorTable]
List all tabulator tables in a bucket.
set_table(bucket_name: str, table_name: str, config: Optional[str]) -> None
Set the tabulator table configuration. Pass None to remove the table.
rename_table(bucket_name: str, table_name: str, new_table_name: str) -> None
Rename tabulator table.
get_open_query() -> bool
Get the open query status.
set_open_query(enabled: bool) -> None
Set the open query status.
Last updated