diff options
| author | Christian Grothoff <christian@grothoff.org> | 2024-03-05 22:47:11 +0100 |
|---|---|---|
| committer | Christian Grothoff <christian@grothoff.org> | 2024-03-05 22:47:16 +0100 |
| commit | 05edb08e886c55dd9200a42e52e1bcb7007d13f4 (patch) | |
| tree | aea77a5ab35cae0122751c33a99d31332cc7f510 /manpages | |
| parent | 5fe272750cf8986c9cab004d508da13b623112e2 (diff) | |
| download | docs-05edb08e886c55dd9200a42e52e1bcb7007d13f4.tar.gz docs-05edb08e886c55dd9200a42e52e1bcb7007d13f4.tar.bz2 docs-05edb08e886c55dd9200a42e52e1bcb7007d13f4.zip | |
document new ADDRESS_RESTRICTIONS regex option
Diffstat (limited to 'manpages')
| -rw-r--r-- | manpages/challenger.conf.5.rst | 2 |
1 files changed, 2 insertions, 0 deletions
diff --git a/manpages/challenger.conf.5.rst b/manpages/challenger.conf.5.rst index a46b8461..66c46e80 100644 --- a/manpages/challenger.conf.5.rst +++ b/manpages/challenger.conf.5.rst @@ -71,6 +71,8 @@ AUTH_COMMAND ADDRESS_TYPE Type of the address that is being collected, returned as part of the ``address_type`` in the ``/info`` endpoint. Examples include ``email`` or ``phone``. +ADDRESS_RESTRICTIONS + JSON object with a map of keys (names of the fields of the address to be entered by the user) to objects with a "regex" (string) containing an extended Posix regular expression for allowed address field values, and a "hint"/"hint_i18n" giving a human-readable explanation to display if the value entered by the user does not match the regex. Keys that are not mapped to such an object have no restriction on the value provided by the user. Examples would be '{"email":{"hint":"valid e-mail address required","regex":"^[a-zA-Z0-9_.+-]+@[a-zA-Z0-9-]+\.[a-zA-Z0-9-.]+$"}' or '{"zip":{"hint":"numeric zip code required","regex":"^[0-9]+$"}'. SEE ALSO |