This repository has been archived on 2024-05-31. You can view files and clone it, but cannot push or open issues or pull requests.
authentik/docs/expressions/index.md
Jens L 73116b9d1a
policies/expression: migrate to raw python instead of jinja2 (#49)
* policies/expression: migrate to raw python instead of jinja2

* lib/expression: create base evaluator, custom subclass for policies

* core: rewrite propertymappings to use python

* providers/saml: update to new PropertyMappings

* sources/ldap: update to new PropertyMappings

* docs: update docs for new propertymappings

* root: remove jinja2

* root: re-add jinja to lock file as its implicitly required
2020-06-05 12:00:27 +02:00

1.5 KiB

Expressions

Expressions allow you to write custom Logic using Python code.

Expressions are used in different places throughout passbook, and can do different things.

!!! info These functions/objects are available wherever expressions are used. For more specific information, see Expression Policies and Property Mappings

Global objects

  • pb_logger: structlog BoundLogger. (ref)
  • requests: requests Session object. (ref)

Generally available functions

regex_match(value: Any, regex: str) -> bool

Check if value matches Regular Expression regex.

Example:

return regex_match(request.user.username, '.*admin.*')

regex_replace(value: Any, regex: str, repl: str) -> str

Replace anything matching regex within value with repl and return it.

Example:

user_email_local = regex_replace(request.user.email, '(.+)@.+', '')

pb_is_group_member(user: User, **group_filters) -> bool

Check if user is member of a group matching **group_filters.

Example:

return pb_is_group_member(request.user, name="test_group")

pb_user_by(**filters) -> Optional[User]

Fetch a user matching **filters. Returns None if no user was found.

Example:

other_user = pb_user_by(username="other_user")