LogoLogo
HomeGitHub RepoBook Demo
dev
dev
  • About Quilt
  • Architecture
  • Mental Model
  • Metadata Management
  • Metadata Workflows
  • Quilt Platform (Catalog) User
    • About the Catalog
    • Bucket Browsing
    • Document Previews
    • Embeddable iFrames
    • Packaging Engine
    • Query
    • Quilt+ URIs
    • Qurator Omni
    • Search
    • Visualization & Dashboards
    • Advanced
      • Athena
      • Elasticsearch
      • Removing Stacks
  • Quilt Platform Administrator
    • Admin Settings UI
    • Catalog Configuration
    • Cross-Account Access
    • Enterprise Installs
    • quilt3.admin Python API
    • Advanced
      • Package Events
      • Private Endpoints
      • Restrict Access by Bucket Prefix
      • S3 Events via EventBridge
      • SSO Permissions Mapping
      • Tabulator
      • Troubleshooting
        • SSO Redirect Loop
    • Best Practices
      • GxP for Security & Compliance
      • Organizing S3 Buckets
  • Quilt Python SDK
    • Installation
    • Quick Start
    • Editing a Package
    • Uploading a Package
    • Installing a Package
    • Getting Data from a Package
    • Example: Git-like Operations
    • API Reference
      • quilt3
      • quilt3.Package
      • quilt3.Bucket
      • quilt3.hooks
      • Local Catalog
      • CLI, Environment
      • Known Limitations
      • Custom SSL Certificates
    • Advanced
      • Browsing Buckets
      • Filtering a Package
      • .quiltignore
      • Manipulating Manifests
      • Materialization
      • S3 Select
    • More
      • Changelog
      • Contributing
      • Frequently Asked Questions
      • Troubleshooting
  • Quilt Ecosystem Integrations
    • Benchling Packager
    • Event-Driven Packaging
    • Nextflow Plugin
Powered by GitBook
On this page
  • 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]]
  • quilt3.admin.users
  • get(name: str) -> Optional[quilt3.admin.types.User]
  • list() -> List[quilt3.admin.types.User]
  • create(name: str, email: str, role: str, extra_roles: Optional[List[str]] = None) -> quilt3.admin.types.User
  • delete(name: str) -> None
  • set_email(name: str, email: str) -> quilt3.admin.types.User
  • set_admin(name: str, admin: bool) -> quilt3.admin.types.User
  • set_active(name: str, active: bool) -> quilt3.admin.types.User
  • reset_password(name: str) -> None
  • set_role(name: str, role: str, extra_roles: Optional[List[str]] = None, *, append: bool = False) -> quilt3.admin.types.User
  • add_roles(name: str, roles: List[str]) -> quilt3.admin.types.User
  • remove_roles(name: str, roles: List[str], fallback: Optional[str] = None) -> quilt3.admin.types.User
  • quilt3.admin.sso_config
  • get() -> Optional[quilt3.admin.types.SSOConfig]
  • set(config: Optional[str]) -> Optional[quilt3.admin.types.SSOConfig]
  • quilt3.admin.tabulator
  • list_tables(bucket_name: str) -> list[quilt3.admin.types.TabulatorTable]
  • set_table(bucket_name: str, table_name: str, config: Optional[str]) -> None
  • rename_table(bucket_name: str, table_name: str, new_table_name: str) -> None
  • get_open_query() -> bool
  • set_open_query(enabled: bool) -> None

Was this helpful?

  1. Quilt Platform Administrator

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.

PreviousEnterprise InstallsNextAdvanced

Last updated 4 months ago

Was this helpful?