Skip to content

docs(account): update settings pages for new dashboard UX (DX-1074) #3344

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.

Sign up for GitHub

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

Open
matt423 wants to merge 3 commits into
base: main
Choose a base branch
from
Open

docs(account): update settings pages for new dashboard UX (DX-1074) #3344

Show file tree
Hide file tree
Changes from all commits
Commits
Show all changes
3 commits
Select commit Hold shift + click to select a range
723d509
docs(account): update 2FA flow for new security settings UX
matt423 Apr 16, 2026
d49809d
docs(account): update user management URLs and SSO disconnect flow
matt423 Apr 16, 2026
1ac0517
docs(account): restructure overview for new personal settings layout
matt423 Apr 16, 2026
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
Binary file modified src/images/content/screenshots/dash/account.png
View file
Open in desktop
Loading
Sorry, something went wrong. Reload?
Sorry, we cannot display this file.
Sorry, this file is invalid so it cannot be displayed.
35 changes: 14 additions & 21 deletions src/pages/docs/platform/account/2fa.mdx
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -6,39 +6,32 @@ redirect_from:
- /docs/account/2fa
---

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.
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.

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

To enable 2FA for your own user login:

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

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

To disable 2FA for your own user login:

1. Log in to your [account](https://ably.com/accounts/any).
2. Select **My Settings** from the account navigation dropdown.
3. Click the **Disable Two-Factor Authentication** button.
* Re-enter your password as prompted.

### Change phone number <a id="phone"/>
1. Log in to your [account](https://ably.com/accounts/any) and go to [Security settings](https://ably.com/users/settings/security).
2. Click **Disable** on the **Two-factor authentication** card.
3. Enter your password in the dialog to confirm.

Disable and re-enable 2FA in order to update your phone number.
### SMS 2FA <a id="sms"/>

### SMS and TOTP 2FA <a id="sms"/>

Disable and re-enable 2FA in order to switch between SMS 2FA and TOTP (time-based one-time password) 2FA.
<Aside data-type='note'>
SMS-based 2FA is deprecated. Users who previously enabled SMS 2FA remain supported, but new setups use TOTP.
</Aside>

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

Expand Down
16 changes: 7 additions & 9 deletions src/pages/docs/platform/account/index.mdx
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -8,9 +8,9 @@ redirect_from:

Manage all aspects of your account, from Two-factor authentication ([2FA](/docs/platform/account/2fa)) and billing to user management and personal preferences.

Begin by [logging](https://ably.com/login) in to Ably through your browser. Once you're logged in, you have access to the Ably dashboard, where you can click on the Account navigation dropdown to access the account settings:
Begin by [logging](https://ably.com/login) in to Ably through your browser. Once you're logged in, click the user avatar in the top-right of the Ably dashboard to access your profile settings, access tokens, and sidebar preferences:

![Ably Account Settings](../../../../images/content/screenshots/dash/account.png)
![Ably user menu](../../../../images/content/screenshots/dash/account.png)

### Settings

Expand Down Expand Up @@ -52,15 +52,13 @@ Manage the [users](/docs/platform/account/users) associated with your account:
* Multiple roles can be assigned to a single user.
* Remove, or change user roles within an Ably account.

### My Settings
### Personal settings
Copy link
Copy Markdown
Contributor

@AndyTWF AndyTWF Apr 17, 2026

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

Given the image at the top of the page, this page sorta no longer makes sense.

The old image used to show all the account options on the old dashboard, but those options are left-nav.

So I think we need to consider the structure of this page (do we split user + account?)

Copy link
Copy Markdown
Member Author

@matt423 matt423 Apr 17, 2026

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

I see there's some cross over with Marks open PR. I'll see what's worth picking from there into here


Control personal account settings:
Control your personal account settings, organized into three sections:

* View and edit name, email, and password.
* Enable two-factor authentication (2FA) for added security.
* Connect and manage login providers (Google, GitHub).
* Customize Ably email preferences (product updates, news, educational emails)
* Set up notifications for account usage.
* [Profile](https://ably.com/users/settings/profile): view and edit your name and email address, or delete your profile.
* [Security](https://ably.com/users/settings/security): manage your password, [two-factor authentication (2FA)](/docs/platform/account/2fa), and connected login providers (Google, GitHub).
* [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.

### Access tokens

Expand Down
29 changes: 16 additions & 13 deletions src/pages/docs/platform/account/users.mdx
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -80,10 +80,10 @@ The following steps remove a user from your account. You must be an account owne
The following steps delete your profile or remove yourself from an Ably account:

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

<Aside data-type='important'>
**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.
Expand All @@ -103,14 +103,14 @@ You will not be able to delete your account until the 1st of the month following
</Aside>

5. [Disconnect SSO provider](#sso) if you use SSO to log in.
6. Go to your [My Settings](https://ably.com/users/edit) page.
7. Scroll to Want to delete your profile?
6. Go to your [Profile settings](https://ably.com/users/settings/profile) page.
7. Scroll to the **Delete profile** section.

<Aside data-type='note'>
If you are using an SSO login you'll see a Contact us link instead of a Start button. You'll need to [disconnect your SSO provider](#sso) first.
If you are using an SSO login you'll see a Contact us link instead of a Delete profile button. You'll need to [disconnect your SSO provider](#sso) first.
</Aside>

8. Click Start to proceed with permanently closing your account.
8. Click **Delete profile** to proceed with permanently closing your account.
9. On the proceeding Close Your Ably Account page, review the accounts for closure.
10. Click Close Account to permanently deactivate your account.

Expand All @@ -119,9 +119,12 @@ If you are using an SSO login you'll see a Contact us link instead of a Start bu
If you use SSO (Single Sign-On) to log in to your Ably account, you must first set a password and disconnect your SSO provider before closing your account. The self-service account closure process requires a password to authenticate the closure request. The following steps set a password and disconnect your SSO provider:

1. Log in to your [account](https://ably.com/accounts/any) using your current SSO method (Google or GitHub).
2. Navigate to Account then [My Settings.](https://ably.com/users/edit)
3. In the Password section, click Change your password.
4. Click Update my personal settings to save the changes.
5. Scroll to the Login provider section.
6. Click remove connection next to the SSO provider/s you want to disconnect.
7. After completing these steps, return to the instructions above to [close your account](#close).
2. Go to [Security settings](https://ably.com/users/settings/security).
3. In the **Password** card, click **Create password** and enter a new password in the dialog.
4. Scroll to the **Login provider** card.
5. Click **Disconnect** next to the SSO provider you want to disconnect and confirm in the dialog.
6. After completing these steps, return to the instructions above to [close your account](#close).

<Aside data-type='note'>
You cannot disconnect your last remaining SSO provider unless a password is set on your account.
</Aside>
Loading