Skip to content

Commit dbc5794

Browse files
authored
Merge pull request #3344 from ably/DX-1074-setting-pages-updates
docs(account): update settings pages for new dashboard UX (DX-1074)
2 parents 34005a9 + 33c4d18 commit dbc5794

4 files changed

Lines changed: 41 additions & 31 deletions

File tree

18.9 KB
Loading

src/pages/docs/platform/account/2fa.mdx

Lines changed: 16 additions & 21 deletions
Original file line numberDiff line numberDiff line change
@@ -6,39 +6,34 @@ redirect_from:
66
- /docs/account/2fa
77
---
88

9-
Two-factor authentication (2FA) is an authentication process requiring users to utilize two different forms of verification. 2FA for your Ably account requires your password and a security token sent to your mobile phone.
9+
Two-factor authentication (2FA) is an authentication process requiring users to utilize two different forms of verification. 2FA for your Ably account requires your password and a time-based one-time password (TOTP) from an authenticator app.
1010

1111
Access your [security settings](https://ably.com/users/settings/security) to configure two-factor authentication for your Ably account.
1212

1313
## Enable 2FA <a id="enable"/>
1414

1515
To enable 2FA for your own user login:
1616

17-
1. Log in to your account and select [Profile Settings](https://ably.com/users/edit) in your account.
18-
2. Toggle **Enable Two-Factor Authentication** under the **Two-factor authentication** section.
19-
* Re-enter your password as prompted.
20-
3. Select your **Country**.
21-
4. Enter your **Phone number**
22-
5. Click **Next** to receive an SMS with a security token.
23-
6. Enter the security token and click **Verify security code**.
24-
7. Scan the QR code into an authenticator app such as Authy, or Google Authenticator.
25-
8. Store your recovery codes in a safe location.
17+
1. Log in to your [account](https://ably.com/accounts/any) and go to [Security](https://ably.com/users/settings/security).
18+
2. Click **Enable** on the **Two-factor authentication** card.
19+
3. Enter your password in the dialog to confirm.
20+
4. Scan the QR code into an authenticator app such as Google Authenticator or 1Password.
21+
5. Enter the generated code to verify.
22+
6. Store your recovery codes in a safe location.
2623

2724
### Disable 2FA <a id="disable"/>
2825

2926
To disable 2FA for your own user login:
3027

31-
1. Log in to your account and select [Profile Settings](https://ably.com/users/edit) in your account.
32-
2. Click the **Disable Two-Factor Authentication** button.
33-
* Re-enter your password as prompted.
28+
1. Log in to your [account](https://ably.com/accounts/any) and go to [Security](https://ably.com/users/settings/security).
29+
2. Click **Disable** on the **Two-factor authentication** card.
30+
3. Enter your password in the dialog to confirm.
3431

35-
### Change phone number <a id="phone"/>
32+
### SMS 2FA <a id="sms"/>
3633

37-
Disable and re-enable 2FA in order to update your phone number.
38-
39-
### SMS and TOTP 2FA <a id="sms"/>
40-
41-
Disable and re-enable 2FA in order to switch between SMS 2FA and TOTP (time-based one-time password) 2FA.
34+
<Aside data-type='note'>
35+
SMS-based 2FA is deprecated. Users who previously enabled SMS 2FA remain supported, but new setups use TOTP.
36+
</Aside>
4237

4338
## Enforce 2FA for all users <a id="enforce"/>
4439

@@ -50,14 +45,14 @@ The account owner must already have 2FA enabled for their own login before they
5045

5146
To enforce 2FA for all users:
5247

53-
1. Log in to your account and select [Profile Settings](https://ably.com/users/edit) in your account.
48+
1. Log in to your [account](https://ably.com/accounts/any) and go to the account [Security](https://ably.com/accounts/any/security) page.
5449
2. Toggle **Require Two-Factor Authentication for all account users** under the **Authentication Settings** section.
5550
3. **Save** the authentication settings.
5651

5752
### Remove 2FA requirement of all users <a id="remove"/>
5853

5954
To remove the requirement for all users to authenticate with 2FA:
6055

61-
1. Log in to your account and select [Profile Settings](https://ably.com/users/edit) in your account.
56+
1. Log in to your [account](https://ably.com/accounts/any) and go to the account [Security](https://ably.com/accounts/any/security) page.
6257
2. Toggle **Require Two-Factor Authentication for all account users** under the **Authentication Settings** section.
6358
3. **Save** the authentication settings.

src/pages/docs/platform/account/index.mdx

Lines changed: 12 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -31,3 +31,15 @@ View detailed [reports](https://ably.com/accounts/any/apps/any/reports) about yo
3131
## Team <a id="team"/>
3232

3333
[Manage the users](https://ably.com/accounts/any/account_users) that have access to your account. The account owner role has full permissions to manage the account, including adding and removing users, and managing their [roles](/docs/platform/account/team).
34+
35+
## Profile settings <a id="personal"/>
36+
37+
Click the user avatar in the top-right of the Ably dashboard to access your profile settings:
38+
39+
![Ably user menu](../../../../images/content/screenshots/dash/account.png)
40+
41+
Your profile settings are organized into three sections:
42+
43+
* [Profile](https://ably.com/users/settings/profile): view and edit your name and email address, or delete your profile.
44+
* [Security](https://ably.com/users/settings/security): manage your password, [two-factor authentication (2FA)](/docs/platform/account/2fa), and connected login providers (Google, GitHub).
45+
* [Emails and notifications](https://ably.com/users/settings/emails_and_notifications): customize Ably email preferences (product updates, news, educational emails) and set up notifications for account usage.

src/pages/docs/platform/account/team.mdx

Lines changed: 13 additions & 10 deletions
Original file line numberDiff line numberDiff line change
@@ -77,10 +77,10 @@ You must be an account owner or admin to remove users:
7777
## Delete your profile or leave an account <a id="leave"/>
7878

7979
1. Log in to your [account](https://ably.com/accounts/any).
80-
2. Go to [My Settings](https://ably.com/users/edit).
80+
2. Go to [Profile settings](https://ably.com/users/settings/profile).
8181
3. [Disconnect SSO provider](#sso) if you use SSO to log in.
82-
4. Scroll to "Want to delete your profile?"
83-
5. Click "Start" to remove yourself from this account.
82+
4. Scroll to the **Delete profile** section.
83+
5. Click **Delete profile** to remove yourself from this account.
8484

8585
<Aside data-type='important'>
8686
Account owners: Deleting your profile will delete the entire account and all data. You must first [transfer ownership](https://faqs.ably.com/can-i-change-my-ably-account-owner) to another user before deleting your profile.
@@ -110,10 +110,13 @@ If you use an SSO login you'll see a "Contact us" link instead of a "Start" butt
110110

111111
If you use SSO to log in, you must set a password and disconnect your SSO provider before closing your account:
112112

113-
1. Log in to your [account](https://ably.com/accounts/any).
114-
2. Navigate to Account then [My Settings](https://ably.com/users/edit).
115-
3. In the Password section, click "Change your password".
116-
4. Click "Update my personal settings" to save the changes.
117-
5. Scroll to the Login provider section.
118-
6. Click "remove connection" next to the SSO provider you want to disconnect.
119-
7. Return to the instructions above to [close your account](#close).
113+
1. Log in to your [account](https://ably.com/accounts/any) using your current SSO method.
114+
2. Go to [Security](https://ably.com/users/settings/security).
115+
3. In the **Password** card, click **Create password** and enter a new password in the dialog.
116+
4. Scroll to the **Login provider** card.
117+
5. Click **Disconnect** next to the SSO provider you want to disconnect and confirm in the dialog.
118+
6. Return to the instructions above to [close your account](#close).
119+
120+
<Aside data-type='note'>
121+
You cannot disconnect your last remaining SSO provider unless a password is set on your account.
122+
</Aside>

0 commit comments

Comments
 (0)