Skip to content
Closed
Show file tree
Hide file tree
Changes from all commits
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
55 changes: 50 additions & 5 deletions src/data/nav/platform.ts
Original file line number Diff line number Diff line change
Expand Up @@ -238,9 +238,46 @@ export default {
pages: [
{
name: 'Overview',
link: '/docs/account',
link: '/docs/platform/account',
index: true,
},
{
name: 'Dashboard',
pages: [
{
name: 'Dashboard overview',
link: '/docs/platform/account/dashboard',
},
{
name: 'Dashboard guide',
link: '/docs/platform/account/dashboard-guide',
},
{
name: 'Your account',
link: '/docs/platform/account/your-account',
},
{
name: 'Account settings',
link: '/docs/platform/account/account-settings',
},
{
name: 'Limits',
link: '/docs/platform/account/limits',
},
{
name: 'Usage',
link: '/docs/platform/account/usage',
},
{
name: 'My Settings',
link: '/docs/platform/account/my-settings',
},
{
name: 'My Access Tokens',
link: '/docs/platform/account/my-access-tokens',
},
],
},
{
name: 'User management',
link: '/docs/platform/account/users',
Expand Down Expand Up @@ -277,21 +314,29 @@ export default {
name: 'API keys',
link: '/docs/platform/account/app/api',
},
{
name: 'Integrations',
link: '/docs/platform/account/app/integrations',
},
{
name: 'Queues',
link: '/docs/platform/account/app/queues',
link: '/docs/platform/account/app/app-queues',
},
{
name: 'Notifications',
link: '/docs/platform/account/app/notifications',
link: '/docs/platform/account/app/app-notifications',
},
{
name: 'Dev console',
link: '/docs/platform/account/app/console',
link: '/docs/platform/account/app/dev-console',
},
{
name: 'CLI testing',
link: '/docs/platform/account/app/cli-testing',
},
{
name: 'Settings',
link: '/docs/platform/account/app/settings',
link: '/docs/platform/account/app/app-settings',
},
],
},
Expand Down
2 changes: 1 addition & 1 deletion src/pages/docs/channels/options/encryption.mdx
Original file line number Diff line number Diff line change
Expand Up @@ -32,7 +32,7 @@ Unencrypted communication with Ably is **disallowed** if any of the following co

* You attempt to use [Basic Authentication](/docs/auth/basic) and thus transmit a private API key over an unencrypted connection. You are only permitted to use unencrypted connections with [Token Authentication](/docs/auth/token) as tokens expire, limiting the impact of token interception.

* You have specified that TLS is required in your [app settings](/docs/platform/account/app/settings).
* You have specified that TLS is required in your [app settings](/docs/platform/account/app/app-settings).

* A client using an unencrypted connection attempts to attach to a channel that is configured to be used with [TLS only](/docs/channels#rules).

Expand Down
28 changes: 14 additions & 14 deletions src/pages/docs/platform/account/2fa.mdx
Original file line number Diff line number Diff line change
Expand Up @@ -13,13 +13,13 @@ Two-factor authentication (2FA) is an authentication process requiring users to
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.
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**.
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.

Expand All @@ -28,8 +28,8 @@ To enable 2FA for your own user login:
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.
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"/>
Expand All @@ -51,15 +51,15 @@ The account owner must already have 2FA enabled for their own login before they
To enforce 2FA for all users:

1. Log in to your [account](https://ably.com/accounts/any).
2. Select **Settings** from the account navigation dropdown.
3. Toggle **Require Two-Factor Authentication for all account users** under the **Authentication Settings** section.
4. **Save** the authentication settings.
2. Select Settings from the account navigation dropdown.
3. Toggle Require Two-Factor Authentication for all account users under the Authentication Settings section.
4. Save the authentication settings.

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

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

1. Log in to your [account](https://ably.com/accounts/any).
2. Select **Settings** from the account navigation dropdown.
3. Toggle **Require Two-Factor Authentication for all account users** under the **Authentication Settings** section.
4. **Save** the authentication settings.
2. Select Settings from the account navigation dropdown.
3. Toggle Require Two-Factor Authentication for all account users under the Authentication Settings section.
4. Save the authentication settings.
144 changes: 144 additions & 0 deletions src/pages/docs/platform/account/account-settings.mdx
Original file line number Diff line number Diff line change
@@ -0,0 +1,144 @@
---
title: Account settings
meta_description: "Configure your Ably account settings, preferences, and account-level options through the dashboard interface."
meta_keywords: "Ably account settings, account configuration, account preferences, account management"
redirect_from:
- /docs/account/account-settings
---

Configure your Ably account settings, preferences, and account-level options through the dashboard interface.

Account settings allow you to customize your Ably account behavior and configure account-wide preferences that affect your entire organization.

## Accessing account settings

To manage your account settings:

1. Click Account in the top navigation bar
2. Select Settings from the dropdown menu
3. You'll be taken to the account settings page

## Account configuration options

### Basic account information

Configure fundamental account details:

| Setting | Description |
| ------- | ----------- |
| Account name | Display name for your organization |
| Account description | Optional description of your account purpose |
| Time zone | Default time zone for timestamps and reports |
| Contact information | Primary contact details for the account |

### Account preferences

Customize account-wide behavior:

| Preference | Description |
| ---------- | ----------- |
| Default notification settings | Account-level notification preferences |
| Data retention policies | How long to retain various types of data |
| Regional preferences | Regional settings and compliance options |
| Display preferences | Default dashboard and interface settings |

### Security settings

Configure account-level security options:

| Security Option | Description |
| --------------- | ----------- |
| Two-factor authentication | Require 2FA for all account users |
| IP address restrictions | Limit access to specific IP ranges |
| Session timeout | Configure automatic logout timeouts |
| Login notifications | Email alerts for account access |

## Managing account settings

### Updating basic information

To modify account details:

1. Navigate to the account settings page
2. Locate the "Basic Information" section
3. Click Edit next to the setting you want to change
4. Update the information as needed
5. Click Save to apply changes

### Configuring preferences

To adjust account preferences:

1. Find the "Preferences" section in account settings
2. Review current settings and their impacts
3. Modify preferences according to your needs
4. Ensure changes align with your organization's requirements
5. Save your updated preferences

### Security configuration

To enhance account security:

1. Access the "Security" section of account settings
2. Review current security policies
3. Enable appropriate security features for your organization
4. Configure settings to match your security requirements
5. Test security settings to ensure they work as expected

## Account settings best practices

### Regular review

- Periodically review account settings to ensure they remain appropriate
- Update contact information when organizational changes occur
- Review security settings annually or when security requirements change

### Documentation

- Keep track of account setting changes and their rationale
- Document security policies and settings for compliance purposes
- Maintain records of who makes changes and when

### Team coordination

- Ensure account settings align with your team's workflow needs
- Communicate setting changes that may affect team members
- Consider the impact of account settings on all users

### Security considerations

- Enable two-factor authentication for enhanced security
- Regularly review and update IP restrictions as needed
- Monitor login notifications for unauthorized access attempts
- Keep security settings aligned with organizational policies

## Common account setting tasks

### Setting up notifications

Configure how your account receives important notifications:

1. Navigate to notification preferences
2. Choose which events trigger notifications
3. Select delivery methods (email, dashboard alerts)
4. Set notification frequency and timing

### Configuring data policies

Establish data handling preferences:

1. Review data retention options
2. Configure automatic data cleanup policies
3. Set compliance-related data handling preferences
4. Ensure policies meet regulatory requirements

### Managing regional settings

Configure regional compliance and preferences:

1. Select appropriate regional data handling
2. Configure compliance settings for your jurisdiction
3. Set regional display preferences
4. Ensure settings meet local requirements

Account settings provide the foundation for how your Ably account operates and integrates with your organization's policies and procedures.
20 changes: 10 additions & 10 deletions src/pages/docs/platform/account/app/api.mdx
Original file line number Diff line number Diff line change
Expand Up @@ -16,7 +16,7 @@ Before setting up multiple API keys with different permissions or sharing API ke

The following steps create a new API Key:

* Click **Create a new API key**.
* Click Create a new API key.
* Assign a friendly name.
* Give the new API key a descriptive name (e.g. chat app key) so it is easy to identify later.

Expand All @@ -28,14 +28,14 @@ To manage an API key: set [capabilities](/docs/auth/capabilities), define resour

| Capability | Description |
| ---------- | ----------- |
| **Publish** | Allow clients to publish messages to channels. |
| **Subscribe** | Allow clients to receive messages and presence state changes. |
| **History** | Allow clients to retrieve message and presence history. |
| **Presence** | Allow clients to register presence on a channel. |
| **Channel metadata** | Allow clients to query channel metadata. |
| **Push admin and push-subscribe** | Allow clients to manage and subscribe to push notifications. |
| **Statistics** | Allow clients to query usage statistics. |
| **Privileged headers** | Allow clients to set privileged headers, such as to skip channel rules. |
| Publish | Allow clients to publish messages to channels. |
| Subscribe | Allow clients to receive messages and presence state changes. |
| History | Allow clients to retrieve message and presence history. |
| Presence | Allow clients to register presence on a channel. |
| Channel metadata | Allow clients to query channel metadata. |
| Push admin and push-subscribe | Allow clients to manage and subscribe to push notifications. |
| Statistics | Allow clients to query usage statistics. |
| Privileged headers | Allow clients to set privileged headers, such as to skip channel rules. |

### Set resource restrictions

Expand Down Expand Up @@ -64,4 +64,4 @@ A single API key cannot support complex permission combinations, such as publish

### Change your API key settings

Click **Settings** on the required API key to change its settings. The same settings apply as when creating a new API key.
Click Settings on the required API key to change its settings. The same settings apply as when creating a new API key.
Loading