Skip to content
New issue

Have a question about this project? Sign up for a free GitHub account to open an issue and contact its maintainers and the community.

By clicking “Sign up for GitHub”, you agree to our terms of service and privacy statement. We’ll occasionally send you account related emails.

Already on GitHub? Sign in to your account

credentials-email #184

Merged
merged 2 commits into from
Dec 1, 2024
Merged
Show file tree
Hide file tree
Changes from 1 commit
Commits
File filter

Filter by extension

Filter by extension

Conversations
Failed to load comments.
Loading
Jump to
Jump to file
Failed to load files.
Loading
Diff view
Diff view
25 changes: 22 additions & 3 deletions docs/getting-started/creating-and-modifying-users.md
Original file line number Diff line number Diff line change
Expand Up @@ -12,8 +12,9 @@ To create more credentials to use and access your storage:
3. This is an optional step: Select a home directory for the credentials. By default, each credential only has access to its own home directory (`/home/<username>`). You can change the credentials' home directory to have multiple credentials access the same directory. The users are chrooted to this directory, meaning that this directory acts as an isolated storage for them. They will not have access to any parent or sibling directories.
4. Select the level of permissions accessible for the new user. By default, the user has read-only access to their home directory. For more information on the different permissions, see the table below.
5. Set an optional access expiration date for the credentials. If left blank, credentials access will never expire.
6. Choose a nickname for the credentials (optional). This shows up in the UI solely as a friendly user name.
7. Click **Add credentials**. The user will then be assigned a random password according to your organization's password policy (and username, if left empty).
6. Optionally, associate the credentials with an email address. This allows the user to reset their password on their own or authenticate using a Magic Code (One Time Passwords sent over email). When you associate the credentials with an email address, an email is sent to this address with a verification code. Request the verification code from the recipient in order to continue and associate the email address with the credentials.
7. Choose a nickname for the credentials (optional). This shows up in the UI solely as a friendly user name.
8. Click **Add credentials**. The user will then be assigned a random password according to your organization's password policy (and username, if left empty).


| Permissions | |
Expand All @@ -28,7 +29,7 @@ To create more credentials to use and access your storage:

### Editing user credentials

You may edit existing credentials by clicking the menu button (...) for the particular user you wish to edit and then selecting **Edit credentials** from the menu. You may change the username, home directory, user's permissions, and the nickname.
You may edit existing credentials by clicking the menu button (...) for the particular user you wish to edit and then selecting **Edit credentials** from the menu. You may change the username, home directory, user's permissions, email address, and the nickname.

### Setting user passwords

Expand Down Expand Up @@ -93,3 +94,21 @@ To add user-level inbound network rules, please complete the following steps:
5. Click **Add inbound rule**.

To edit, disable, or delete a rule, click the menu button (...) next to the rule and select the action you'd like to perform.


### <a name="email">Associating credentials with email addresses</a>

When creating or editing credentials, you have the option to associate the credentials with an email address. This allows web portal users to:

1. Initiate the "Forgot password" process to reset their password.
2. If enabled at the organization level, use the Magic Code authentication method (only available with the web portal).

:::tip
The username and the email address are not required to be the same. In fact, the same email address can be associated with multiple credentials.
:::

When adding or changing the associated email address, an email is sent to the address with a verification code. In order to complete the association process, you must enter in the verification code in the admin dashboard.

:::note
If you are the recipient of the verification email, make sure to provide the verification code to the person who added your email to SFTP To Go credentials. If you have any questions or concerns, you can also reach out to our support or safely ignore the email. Without the verification code, your email cannot be associated with SFTP To Go credentials.
:::
4 changes: 2 additions & 2 deletions docs/getting-started/dashboard.md
Original file line number Diff line number Diff line change
Expand Up @@ -6,8 +6,8 @@ sidebar_position: 10
Use the **Credentials** tab to:

1. Access your SFTP server information (host, usernames, and passwords).
2. Add or remove credentials.
3. Manage access options for credentials (home directories, permissions, public keys, inbound network rules, and rotate passwords).
2. Add, edit, seasrch or remove credentials.
motymichaely marked this conversation as resolved.
Show resolved Hide resolved
3. Manage access options for credentials (home directories, permissions, public keys, inbound network rules, passwords and email association).
motymichaely marked this conversation as resolved.
Show resolved Hide resolved

:::tip
We recommend rotating passwords every 90 days. The credentials list shows the password age for each credentials.
Expand Down
2 changes: 2 additions & 0 deletions docs/getting-started/organization-settings.md
Original file line number Diff line number Diff line change
Expand Up @@ -11,6 +11,8 @@ To manage your organization, security, billing, and team settings, click **Setti

SFTP To Go allows several authentication methods, which are ways to identify the client when they are logging into the server:

* Magic Code - Identification based on username and unique, six character long, one-time-use codes, sent to the email address associated with the username. This form of authentication is only supported by the web portal.
motymichaely marked this conversation as resolved.
Show resolved Hide resolved

* Password authentication - identification based on username and password. This authentication method can be used with both SFTP and FTPS protocols.

* Public key authentication - identification based on username and a cryptographic system that uses pairs of keys. To use it, add a public SSH key to each one of the credentials. This form of authentication is only supported by the SFTP protocol.
Expand Down
11 changes: 8 additions & 3 deletions docs/how-to-connect/connect-web-portal.md
Original file line number Diff line number Diff line change
Expand Up @@ -5,16 +5,21 @@ sidebar_position: 10
---
The web portal enables users with SFTP To Go credentials to manage files in their designated storage (i.e., their home directory) using a web browser over a secure HTTPS channel.

To access the web portal, first enable it in your organization's [settings tab](../getting-started/organization-settings#web-portal).
To access the web portal, first ensure it is enabled in your organization's [settings tab](../getting-started/organization-settings#web-portal).
Then, log in using your organization's portal login link, which can be found in the settings tab:

1. Enter a credentials username and password.
2. Click the "Log in" button.
1. Enter a credentials username
2. Enter a credentials password (or magic code if the credentials are associated with an email address and the [Magic Code](../getting-started/organization-settings#authentication-methods). authentication method is enabled)
motymichaely marked this conversation as resolved.
Show resolved Hide resolved
3. Click the "Log in" button.
motymichaely marked this conversation as resolved.
Show resolved Hide resolved

:::note
Alternatively, use a shortcut from your SFTP To Go dashboard to connect as any user on your credentials list. Click the menu button (...) and select "Open web portal".
:::

:::note
Credentials associated with email addresses can reset their passwords without contacting an administrator by initiating the "Forgot Password" flow.
motymichaely marked this conversation as resolved.
Show resolved Hide resolved
:::

## Organizing files and folders

### Navigation
Expand Down