Although there is no specific convention about where to put the authentication Liquid pages, we chose to put them within the **app/views/pages/auth** folder in the following examples.
Each authentication action is triggered by posting a form with specific hidden HTML inputs describing the action and its parameters.
## Sign up
This action creates a new user and automatically signs her/him in. The sign up form has to contain 3 fields: the id attribute (usually email), the password and its confirmation.
**Form parameters**
| Name | Description |
| auth_action | **sign_up** |
| auth_content_type | the slug of your "users" content type with one password type field |
| auth_id_field | name of your field used to identify the user. |
| auth_password_field | name of your password type field |
| auth_callback | path to the page once the user has been authenticated with success. |
| auth_entry[] | HTML form attributes of the user model. Require the value of [auth_id_field], [auth_password_field] and [auth_password_field]_confirmation. Example: auth_entry[email], auth_entry[password] and auth_entry[password_confirmation] |
| auth_email_handle | the handle of the Locomotive page used as the email template |
| auth_disable_email | don't send the welcome email if it sets to '1' or 'true'. |
| auth_email_smtp_namespace | name of the site metafields namespace used to store your SMTP settings. Default: smtp |
| auth_email_smtp_address_alias | name of the address property in the site metafields namespace. Default: address |
| auth_email_smtp_port_alias | name of the port property in the site metafields namespace. Default: port |
| auth_email_smtp_user_name_alias | name of the user_name property in the site metafields namespace. Default: user_name |
| auth_email_smtp_password_alias | name of the user_name property in the site metafields namespace. Default: password |
**Global liquid variables**
| Name | Description |
| auth_entry | the content entry only if the form is invalid. This liquid drop includes all the validation errors. |
| auth_invalid_entry | not null if the form is invalid. |
**Example**
## Sign in
If an "user" is found based on the auth_id and auth\_password values, then the authenticated user will be available as a global liquid variable in all the further requests. The name of the variable is made from the slug of the content type: ```{{ current_<singular version of the content type's slug> }}```.
If the liquid variable is null, it means there is no authenticated user.
If no user has been found, the page specified by the action attribute of the form will be rendered.
**Form parameters**
| Name | Description |
| auth_action | **sign_in** |
| auth_content_type | the slug of your "users" content type with one password type field |
| auth_id_field | name of your field used to identify the user. |
| auth_password_field | name of your password type field |
| auth_callback | path to the page once the user has been authenticated with success. |
| auth_id | id typed by the user |
| auth_password | password typed by the user |
**Global liquid variables**
| Name | Description |
| auth_wrong_credentials | Wrong id and/or password. Empty if the form has not been submitted yet. |
**Example**
## Sign out
Remove the current authenticated user from the current session. Once submitted, the user is redirected to the path defined in the action attribute of the sign out form.
**Form parameters**
| Name | Description |
| auth_action | **sign_out** |
| auth_content_type | the slug of your "users" content type |
**Global liquid variables**
| Name | Description |
| auth_signed_out | True once the user has been signed out |
**Example**
## Forgot password
Send instructions about how to reset a forgotten password.
**Form parameters**
| Name | Description |
| auth_action | **forgot_password** |
| auth_content_type | the slug of your "users" content type |
| auth_id_field | name of your field used to identify the user. |
| auth_password_field | name of your password type field |
| auth_id | id typed by the user |
| auth_reset_password_url | the **absolute** url of the reset password page. This url will be inserted in the email. |
| auth_email_handle | the handle of the Locomotive page used as the email template |
| auth_email_smtp_namespace | name of the site metafields namespace used to store your SMTP settings. Default: smtp |
| auth_email_smtp_address_alias | name of the address property in the site metafields namespace. Default: address |
| auth_email_smtp_port_alias | name of the port property in the site metafields namespace. Default: port |
| auth_email_smtp_user_name_alias | name of the user_name property in the site metafields namespace. Default: user_name |
| auth_email_smtp_password_alias | name of the user_name property in the site metafields namespace. Default: password |
**Global liquid variables**
| Name | Description |
| auth\_reset\_<auth_password_field>\_instructions_sent | True if the email has been successfully sent |
| auth\_wrong\_<auth_id_field> | True if no user was found |
**Example**
## Reset password
When the user clicks on the link in the email sent by the previous action, she/he is redirected to the reset password page where she/he will enter a new password.
The link is protected by a token only valid for **2 hours**.
**Form parameters**
| Name | Description |
| auth_action | **reset_password** |
| auth_content_type | the slug of your "users" content type |
| auth_password_field | name of your password type field |
| auth_password | password typed by the user |
| auth_reset_token | `{{ params.auth_reset_token }}` |
| auth_callback | path to the page once the password has been updated with success |
**Global liquid variables**
| Name | Description |
| auth_invalid_token | True if the token is invalid or has expired |
| auth_<auth_password_field>_too_short | True if the password length is less than 6 characters |
**Example**