# Usage¶

The ood_auth_map scripts are all designed to take a URL-encoded authenticated username and map it to a local system username. In all cases the included scripts follow the given format:

bin/ood_auth_map.<TYPE> [OPTIONS] <REMOTE_USER>


Where TYPE can be either regex or mapfile.

A successful mapping will return the local username to STDOUT:

$bin/ood_auth_map.mapfile http%3A%2F%2Fcilogon.org%2FserverA%2Fusers%2F50191 jnicklas$


An unsuccessful mapping will return an empty string to STDOUT:

$bin/ood_auth_map.regex -r '^(\w+)@osc.edu$' jnicklas@gmail.com

\$


Note

The authenticated username can be specified as a URL-encoded string to avoid having to escape special characters in the shell.

For any of the provided scripts you can display a quick reference of the capabilities offered by that script with:

bin/ood_auth_map.<TYPE> --help


Provided Scripts