user:add

hereditas user:add

add an authorized user to the box

Description

Whitelist email addresses to allow users to authenticate and access your Hereditas box. If you configure Auth0 to enable social logins (e.g. Google, Facebook and/or Microsoft accounts), users won’t need to set up a new account or password, and they can authenticate with their existing social account as long as the email address matches what you’ve whitelisted.

When you whitelist an email address, you can choose between the “user” role (the default) and the “owner” one. Someone with the “owner” role can access the data in this Hereditas box at any time (provided they have the “user passphrase” too), and when they authenticate, they reset any timer that might have been started by another person with the “user” role.

After running this command, you will need to synchronize the changes on Auth0 with hereditas auth0:sync (it’s not necessary to re-build or re-deploy the box).

Example usage

hereditas user:add \
   --email "[email protected]"

Flags

Flag Type Required Default Value Description
-e
--email
string none email address of the user to whitelist
-r
--role
"user", "owner" "user" role: user or owner