API reference

class Action(resource: str, operation: str)

class ActionRef(**data)

model_config: ClassVar[ConfigDict] = {}

Configuration for the model, should be a dictionary conforming to [ConfigDict][pydantic.config.ConfigDict].

class ActionSpec(action, can, is_object_action, formats=None, async_formats=None)

class LoginResponse(**data)

model_config: ClassVar[ConfigDict] = {}

Configuration for the model, should be a dictionary conforming to [ConfigDict][pydantic.config.ConfigDict].

class OkResponse(**data)

model_config: ClassVar[ConfigDict] = {}

Configuration for the model, should be a dictionary conforming to [ConfigDict][pydantic.config.ConfigDict].

class DownloadResponse(**data)

model_config: ClassVar[ConfigDict] = {}

Configuration for the model, should be a dictionary conforming to [ConfigDict][pydantic.config.ConfigDict].

class LocalStorage(root, base_url='/_files')

class S3Storage(bucket, region=None, endpoint_url=None, client_factory=<function client>)

client_factory(**kwargs)

Create a low-level service client by name using the default session.

See boto3.session.Session.client().

class UploadRequest(**data)

model_config: ClassVar[ConfigDict] = {}

Configuration for the model, should be a dictionary conforming to [ConfigDict][pydantic.config.ConfigDict].

class UploadResponse(**data)

model_config: ClassVar[ConfigDict] = {}

Configuration for the model, should be a dictionary conforming to [ConfigDict][pydantic.config.ConfigDict].

class FilterValuesRequest(**data)

model_config: ClassVar[ConfigDict] = {}

Configuration for the model, should be a dictionary conforming to [ConfigDict][pydantic.config.ConfigDict].

class FilterOperator(*values)

class EagerLoad(attr, strategy=EagerStrategy.SELECTIN, children=())

class EagerStrategy(*values)

class OrderKey(field, direction, expr)

exception InvalidCursorError

class CoordinateSchema(**data)

model_config: ClassVar[ConfigDict] = {'from_attributes': True}

Configuration for the model, should be a dictionary conforming to [ConfigDict][pydantic.config.ConfigDict].

class ClientCredentials(**data)

model_config: ClassVar[ConfigDict] = {'frozen': True}

Configuration for the model, should be a dictionary conforming to [ConfigDict][pydantic.config.ConfigDict].

exception OAuthConfigError

class ProviderConfig(**data)

model_config: ClassVar[ConfigDict] = {'extra': 'ignore', 'frozen': True}

Configuration for the model, should be a dictionary conforming to [ConfigDict][pydantic.config.ConfigDict].

class AuthorizationState(**data)

model_config: ClassVar[ConfigDict] = {'frozen': True}

Configuration for the model, should be a dictionary conforming to [ConfigDict][pydantic.config.ConfigDict].

exception OAuthError

class TokenResponse(**data)

model_config: ClassVar[ConfigDict] = {'extra': 'ignore', 'frozen': True}

Configuration for the model, should be a dictionary conforming to [ConfigDict][pydantic.config.ConfigDict].

class OidcIdentity(**data)

model_config: ClassVar[ConfigDict] = {'extra': 'ignore', 'frozen': True}

Configuration for the model, should be a dictionary conforming to [ConfigDict][pydantic.config.ConfigDict].

class Provider(client, verifier=None, app_only=False, app_scopes=())

class ActionPermissions(object_scoped, collection_scoped)

class Condition(field, op, value, negated=False)

class Decision(permit, allow, deny, raw)

class FilterResult(always_allow, always_deny, conjunctions)

exception OpaError

class ResourceRef(type, id=None, attributes=<factory>)

class RoleBinding(role, scope=None)

exception ScopeError

class Subject(type, id, user=None)

class VerdictIndices(objects, collection)

class VerdictRange(view, actions_start)

class Bool(name, operators=(FilterOperator.EQ,), kind='bool')

class Enum(name, enum_class, operators=(FilterOperator.EQ, FilterOperator.IN), kind='enum')

class LiteralField(name, type, operators=(FilterOperator.EQ, FilterOperator.GT, FilterOperator.GTE, FilterOperator.LT, FilterOperator.LTE), kind='literal')

class Ref(name, target, operators=(FilterOperator.EQ, FilterOperator.IN), kind='ref')

class ResourceEntry(resource, model, pk, default_rep_serializer, default_rep_class, fields=(), search_columns=(), opa_rep_class=None, object_actions=(), collection_actions=())

class ResourceRegistry(entries)

class Result(**data)

model_config: ClassVar[ConfigDict] = {}

Configuration for the model, should be a dictionary conforming to [ConfigDict][pydantic.config.ConfigDict].

class RowFilterFactory(*args, **kwargs)

class ValuesPage(**data)

model_config: ClassVar[ConfigDict] = {}

Configuration for the model, should be a dictionary conforming to [ConfigDict][pydantic.config.ConfigDict].