roboto.auth.scope

Module Contents

ApiScope

class roboto.auth.scope.ApiScope#

Bases: roboto.compat.StrEnum

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

Attributes

ApiScope.ApiEverythingElse

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.

ApiScope.DatasetsCreate

DatasetsCreate = 'datasets.create' #

Holder can create new datasets.

ApiScope.FilesImport

FilesImport = 'files.import' #

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

ApiScope.FilesUpload

FilesUpload = 'files.upload' #

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

ApiScope.all()

classmethod all()#

Return type

set[ApiScope]

ApiScope.minimal_uploader()

classmethod minimal_uploader()#

Return type

set[ApiScope]