Difference between revisions of "Hub Login Security"

From Hubitat Documentation
Jump to: navigation, search
Line 8: Line 8:
 
#<big>Select '''+Add User'''</big>[[File:Hub login security - Add User v2.png|none|thumb|600x600px|link=https://docs.hubitat.com/images/9/90/Hub_login_security_-_Add_User_v2.png |alt=Press "Add User"]]<big>'''NOTE:''' The username and password are both case sensitive.</big>[[File:Add new user v2.2.png|none|thumb|600x600px|link=https://docs.hubitat.com/images/f/f2/Add_new_user_v2.2.png |alt=Enter the User name and a password, then enter the password again in the "confirm password" field, and then enter an email address for password recovery]]
 
#<big>Select '''+Add User'''</big>[[File:Hub login security - Add User v2.png|none|thumb|600x600px|link=https://docs.hubitat.com/images/9/90/Hub_login_security_-_Add_User_v2.png |alt=Press "Add User"]]<big>'''NOTE:''' The username and password are both case sensitive.</big>[[File:Add new user v2.2.png|none|thumb|600x600px|link=https://docs.hubitat.com/images/f/f2/Add_new_user_v2.2.png |alt=Enter the User name and a password, then enter the password again in the "confirm password" field, and then enter an email address for password recovery]]
 
#<big>Once created, you may edit the user password or password recovery email by selecting the pencil icon.</big>[[File:Hub Login Security - Edit User v2.2.png|none|thumb|600x600px|link=https://docs.hubitat.com/images/f/f8/Hub_Login_Security_-_Edit_User_v2.2.png |alt=Once created, you may edit the user password or password recovery email by selecting the pencil icon to the right of the listed user name.]][[File:Edit User v2.2.png|none|thumb|600x600px|link=https://docs.hubitat.com/images/7/71/Edit_User_v2.2.png |alt=Press either the "Edit Recovery Email" button on the left, or the "Change Password" button below it as needed.]]
 
#<big>Once created, you may edit the user password or password recovery email by selecting the pencil icon.</big>[[File:Hub Login Security - Edit User v2.2.png|none|thumb|600x600px|link=https://docs.hubitat.com/images/f/f8/Hub_Login_Security_-_Edit_User_v2.2.png |alt=Once created, you may edit the user password or password recovery email by selecting the pencil icon to the right of the listed user name.]][[File:Edit User v2.2.png|none|thumb|600x600px|link=https://docs.hubitat.com/images/7/71/Edit_User_v2.2.png |alt=Press either the "Edit Recovery Email" button on the left, or the "Change Password" button below it as needed.]]
#To enable '''Hub Login Security''' and restrict login with a username and password, activate the ''Hub Login Security'' switch.[[File:Hub Login Security enabled v3.png|alt=Turn on the switch at the top of the Hub Security user list to enable Hub Security. This will immediately log you out of the hub and you will need to login again.|none|thumb|1344x1344px]]<big>You will be immediately required to login with the username and password you created.</big>
+
#To enable '''Hub Login Security''' and restrict login with a username and password, activate the ''Hub Login Security'' switch.[[File:Hub Login Security enabled v3.png|alt=Turn on the switch at the top of the Hub Login Security user list to enable Hub Login Security. This will immediately log you out of the hub and you will need to login again.|none|thumb|1344x1344px]]<big>You will be immediately required to login with the username and password you created.</big>
 
#*<big>'''NOTE''': Enforcing Hub Login Security may lock you out of your hub if you cannot remember the username and/or password you created. Ensure your recovery email is accessible and up to date.</big>[[File:Hub Security Logout v2.2.png|none|thumb|614x614px|link=https://docs.hubitat.com/images/3/37/Hub_Security_Logout_v2.2.png |alt=Sign in with your username and password.]]
 
#*<big>'''NOTE''': Enforcing Hub Login Security may lock you out of your hub if you cannot remember the username and/or password you created. Ensure your recovery email is accessible and up to date.</big>[[File:Hub Security Logout v2.2.png|none|thumb|614x614px|link=https://docs.hubitat.com/images/3/37/Hub_Security_Logout_v2.2.png |alt=Sign in with your username and password.]]
 
#<big>When you are logged in, your user name will appear at the top of the sidebar.</big>[[File:Logged in Username v2.2.png|none|thumb|600x600px|link=https://docs.hubitat.com/images/4/43/Logged_in_Username_v2.2.png |alt=When you are logged in, you username will appear at the top-left of your hub user interface.]]
 
#<big>When you are logged in, your user name will appear at the top of the sidebar.</big>[[File:Logged in Username v2.2.png|none|thumb|600x600px|link=https://docs.hubitat.com/images/4/43/Logged_in_Username_v2.2.png |alt=When you are logged in, you username will appear at the top-left of your hub user interface.]]
 
#<big>Select the drop-down menu arrow to reveal the Log Out option.</big>[[File:HE User Logout v2.png|none|thumb|600x600px|link=https://docs.hubitat.com/images/8/84/HE_User_Logout_v2.png |alt=To the right of your username at the top left, there is a drop-down menu arrow. Press this to reveal a, "Log Out" option.]]
 
#<big>Select the drop-down menu arrow to reveal the Log Out option.</big>[[File:HE User Logout v2.png|none|thumb|600x600px|link=https://docs.hubitat.com/images/8/84/HE_User_Logout_v2.png |alt=To the right of your username at the top left, there is a drop-down menu arrow. Press this to reveal a, "Log Out" option.]]
#<big>To disable Hub Login Security, turn off the switch and login with your password.</big>[[File:Disable Hub Login Security v2.png|none|thumb|600x600px|link=https://docs.hubitat.com/images/e/e3/Disable_Hub_Login_Security_v2.png]]
+
#<big>To disable Hub Login Security, turn off the switch and login with your password.</big>[[File:Disable Hub Login Security v2.png|none|thumb|600x600px|link=https://docs.hubitat.com/images/e/e3/Disable_Hub_Login_Security_v2.png|alt=Turn off the switch at the top of the Hub Login Security user list to disable Hub Login Security, then enter your password in the field just below the Hub Login Security switch and press the "Login" button just below the password field.]]
 
#:
 
#:
  

Revision as of 21:31, 12 April 2021

Go to the top of the page

The Hub Login Security page is where you can create a user account to enforce password-protected access to your hub.

Note: This account is only to secure your local hub ui, it is not used to login to portal or the mobile app.

  1. To get started, go to Settings and select Hub Login Security.
    The settings page is where you will find the "Hub Login Security" card
  2. Select +Add User
    Press "Add User"
    NOTE: The username and password are both case sensitive.
    Enter the User name and a password, then enter the password again in the "confirm password" field, and then enter an email address for password recovery
  3. Once created, you may edit the user password or password recovery email by selecting the pencil icon.
    Once created, you may edit the user password or password recovery email by selecting the pencil icon to the right of the listed user name.
    Press either the "Edit Recovery Email" button on the left, or the "Change Password" button below it as needed.
  4. To enable Hub Login Security and restrict login with a username and password, activate the Hub Login Security switch.
    Turn on the switch at the top of the Hub Login Security user list to enable Hub Login Security. This will immediately log you out of the hub and you will need to login again.
    You will be immediately required to login with the username and password you created.
    • NOTE: Enforcing Hub Login Security may lock you out of your hub if you cannot remember the username and/or password you created. Ensure your recovery email is accessible and up to date.
      Sign in with your username and password.
  5. When you are logged in, your user name will appear at the top of the sidebar.
    When you are logged in, you username will appear at the top-left of your hub user interface.
  6. Select the drop-down menu arrow to reveal the Log Out option.
    To the right of your username at the top left, there is a drop-down menu arrow. Press this to reveal a, "Log Out" option.
  7. To disable Hub Login Security, turn off the switch and login with your password.
    Turn off the switch at the top of the Hub Login Security user list to disable Hub Login Security, then enter your password in the field just below the Hub Login Security switch and press the "Login" button just below the password field.