YamlAuthMapperPlugin type: yaml#
- class lumen.auth.YamlAuthMapperPlugin(*, yaml_file, name)#
The YamlAuthMapperPlugin uses a Yaml file to map auth keys allowing more concise declarations for individual dashboards, e.g. the following yaml specification:
- group:
- admins:
- users:
- email:
will expand this auth spec:
- auth:
- group:
admins
to this expanded spec:
Parameters#
yaml_file
type: str | pathlib.Path
default: None
Methods#
- YamlAuthMapperPlugin.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
- YamlAuthMapperPlugin.transform(spec: Dict[str, Any]) Dict[str, Any]#