roboto.auth.scope

Module Contents

class roboto.auth.scope.ApiScope

Bases: str, enum.Enum

Scopes define the set of APIs a credential holder can access.

ApiEverythingElse = 'api.everything_else'

Holder has access to all other APIs not covered by other scopes.

A developer API token will likely want to include this scope, whereas an upload-only device token will likely want to omit it for principle of least privilege.

DatasetsCreate = 'datasets.create'

Holder can create new datasets.

FilesImport = 'files.import'

Holder can import existing files from an external object store into Roboto.

FilesUpload = 'files.upload'

Holder can upload new files to Roboto’s managed storage.

classmethod all()

Return type:

set[ApiScope]

classmethod minimal_uploader()

Return type:

set[ApiScope]