Description
===========

This role is the top level package of all auth categorised software and does not provide a special software product. This software is used for authorisation and authentication processes.

Requirements
============

Variables
----------

- development note: Define these variables in the defaults/main.yml file of your sub-role.

* auth_permitted_users
  * description:
    * This option contains a list of usernames that are allowed to access the system(s).
  * default: []
  * example: auth_permitted_users: ["user1", "user2"]

* auth_permitted_groups
  * description:
    * This option contains a list of groupnames that are allowed to access the system(s).
  * default: []
  * example: auth_permitted_users: ["group1", "group2"]

* auth_denied_users
  * description:
    * This option contains a list of usernames that are locked for the access to the system(s).
  * default: []
  * example: auth_permitted_users: ["user1", "user2"]

* auth_denied_groups
  * description:
    * This option contains a list of groupnames that are locked for the access to the system(s).
  * default: []
  * example: auth_permitted_users: ["user1", "user2"]
    
* auth_referrals
  * description:
    * This option contains a list of referrals. These are used when an uthentication service cannot find something in its local database to handle a request.
  * default: undefined  

Processes
=========

main
----

1. NOP

configure
---------

1. NOP

License
=======

BSD-3-Clauses

Contributors
============

- Martin Pietsch (martin.pietsch@tu-dresden.de)