Auth#

class lumen.auth.Auth(*, name)#

An AuthPlugin is given the auth specfication and can apply arbitrary transforms to it.


Parameters#

name

type: str
default: 'Auth'
String identifier for this object.


Methods#

Auth.to_spec(context: Dict[str, Any] | None = None) Dict[str, Any]#

Exports the full specification to reconstruct this component.

Return type:

Resolved and instantiated Component object

Auth.transform(spec: Dict[str, Any]) Dict[str, Any]#

Types#

Auth type: None

An AuthPlugin is given the auth specfication and can apply arbitrary

YamlAuthMapperPlugin type: yaml

The YamlAuthMapperPlugin uses a Yaml file to map auth keys