docassemble has a built-in username and password system. Users can click “Log in” in the upper-right-hand corner to log in, and if they do not have a username and password on the system, they can register.
End users who are not logged in will lose their session information if they close their web browser. If they register and log in, however, they can fill out part of an interview, close the web browser, log back in again, and pick up where they left off.
When a user registers in the docassemble system, their default “privilege” is that of “user,” which has the lowest privileges. There are seven privileges defined by default in docassemble:
The “cron” user privilege is used exclusively by the code that runs scheduled tasks.
When docassemble is first installed, it creates a user with “admin” privileges with the following login information:
- Email: [email protected]
- Password: password
Users can log in with Facebook, Google, Twitter, or Microsoft Azure.
This requires obtaining API keys with those companies. See the
documentation for the
oauth configuration directive for details.
Users can also log in with their mobile phone by receiving a
verification code via SMS. See the documentation for the
phone login and
twilio configuration directives for details.
Users who log in with an e-mail address and password have the additional option of using two-factor authentication.
When a user is logged in, the user’s information is made available to
docassemble interviews through the
All registered users can edit their “Profile” from the user menu. The fields available include:
- First name
- Last name
Users with privileges of
developer can also edit other
- Country Code (must be an official country code like
- First subdivision (e.g., state)
- Second subdivision (e.g., county)
- Third subdivision (e.g., municipality)
- Organization (e.g., company, non-profit organization)
Administrators can go to the “User List” from the menu. From here, administrators can edit the profiles of each user in the system. Users can be deactivated, so that they can no longer log in. Deactivated accounts can be reactivated. The privileges of each user can be edited. For example, a user with privileges of “user” can be given the privileges of “developer” or “admin.”
Administrators can go to the “Privileges List” by clicking “Edit Privileges” on the User List page. From here, administrators can add new privilege types, or delete privilege types that were already created.
Administrators can add users by clicking “Add a user” on the User List page. The user’s first name, last name, e-mail, password, and user role(s) must be set.
Administrators can invite people to register by clicking “Invite a
user” on the User List page. docassemble will send an e-mail
with a link that the person can click on to register. If
allow registration is set to
False, this is the only way that
users can register on the site.
The administrator can select the role that the user will be assigned when he or she registers.
You have been invited to join MyDocassemble.
To register for an account, please click on the link below.
Interviews can behave differently depending on whether the user is logged in, or the role of the logged-in user.
There are three functions that facilitate this:
Falsedepending on whether the user is logged in.
user_info()- if the user is logged in, this returns information from the user’s profile
Falsedepending on whether the user has given privileges.
Here is an example of an interview that requires the user to be logged in:
Note that the use of the
initial modifier is very important here.
It ensures that the interview will check to make sure the user is
logged in every time in the interview is processed. If the code was
mandatory, the user could log in, then log out, and still use
the interview, because once a
block runs to completion, it is thereafter ignored.
Here is an example of
code that directs users to different
endpoints depending on their roles:
The following interview excerpt uses information about the logged-in user in an interview question:
code screens out a user by e-mail address:
If you use actions in your interview, docassemble will run those
actions before it processes the
questions in your interview. However, if you have a screening process
in your interview, such as those illustrated in the previous section,
you might not want these actions to be able to bypass that
This could be a problem if, for example, you use
interview_url_action() to provide URLs to users in order to access
an interview. Anyone in possession of such a URL could access the
interview with it, bypassing any screening process you established.
Consider the last example from the previous section. To ensure that
actions are only processed after the screening process is complete,
you would change the first
code block to:
This explicitly indicates to docassemble the point in the
interview processing when you want the actions to be processed. If
your screening process prevents
process_action() from running, the
action will be ignored.
If you do not include a call to
process_action() within a
block in your interview, docassemble will automatically run
process_action() immediately. (The
will run after
modules blocks, but before