Compose Database-as-a-Service Help and Documentation

Everything you need to know about Compose, Hosted or Enterprise, is here in our help system. Whether you run one database for your businesses' sole application or six different databases to support an entire corporation, we've got the information you need.

Account Settings

The Compose UI allows you to view and manage your account settings, as well as the settings for other users on your account. If you are the person who set up the account initially, you are considered the Account Owner and have access to all account controls. All of the screens and settings you see in these help pages will be available to you.

The Account section of the UI breaks down into multiple sidebar items:

Account

The Accounts panel in the Compose UI.

Two-factor Authentication

This pane displays the status of two factor authentication for your user. To see the two-factor authentication status of other users on the account, look in the Users section of the sidebar. Click on the configure link to change the settings, or require your entire team to use two-factor authentication.

More details can be found on the Compose Security page.

User Info

These are your User details. If you change the email address, it will change the email address that you log in with. Likewise, changing the phone number will change the number that gets texts for two-factor authentication, if enabled.

Update Password

This updates the password you used to sign into the Compose App. It does not change any of the authentication settings on the deployment level.

Newsletter Settings

Enable or disable which Compose Newsletters you receive. The little blue check mark will appear next to your current subscriptions. Be sure to click on the Update Newsletter Settings to save your choices.

Account Settings

If you would like to rename your account, fill in the Account Name field.

Close Your Compose Account

You're welcome to keep your account open and not retain any billable databases if you like -- all you need to do is remove all deployments on the account and you will not be billed, but you'll keep your Compose account ready for your next deployment. If you would prefer to close the account entirely, please have a look over the steps on the Closing Your Account page to prevent possible data loss. When ready, click on the Close Account button.

API Tokens

Use this section to manage all API tokens that you provision for your account.

Managing API tokens on your account.

Accessing this panel requires re-entering your password, as the API key can be used to issue requests to our end-points that provision, de-provision, download backups, and other security sensitive tasks on your deployment. We also limit viewing an existing key to the time it is provisioned. Keep all API keys secure after provisioning and remember to remove them from any code put into repositories or source control management.

Creating an API Token

To create an API token, name it in the text field in the Create a new API token panel and click Create. The new token appears at the top of the list under You've created a new API token 'token-name'!. Copy the token from the text field and save it somewhere.

🚧

After you navigate away from this screen the token will no longer be available to view.

Deleting an API Token

If a token is no longer being used you can remove it by clicking Revoke next to the token name. That token can no longer be used to make requests to the API, so any applications or scripts that use it will need to be updated.

Activity

The Activity page allows you to see account activity by both the account owner and the other account users. The activity presented here is just account-level events, so logins (failed and successful), 2fa attempts (failed and successful), and deployment provisioning and de-provisioning will appear.

More information can be found on the Compose Security page.

Billing

The Billing panel contains all the settings for invoices and payments for your Compose account. The first page contains a summary of your latest invoice and the most recent payment. Detailed information about invoices is on the Invoices page, and information on payment schedules and settings is on the Payments page. For all information related to how your account charges are calculated and billed, see the Billing page.

Users, Teams, and Access

You can control access to your account using the Users, Teams and Access sections. You add others as Users in the Users section, form them into Teams in the Teams section, and then grant access to individual users and teams in the Access section.

Access is governed by Roles (Owner, Developer, Manager, and Billing Manager), which allow access to different parts of the UI, the ability to make and destroy deployments, or the ability to add other users and form teams.

For more details about user management and team management read the Compose Access Controls page, along with role definitions and permissions.

📘

NB: Granular Access Conrtol

The settings here apply to Compose Accounts. More granular control is available on the deployment level and at the database/data store level. The Deployment Access Control page contains details and links to deployment-specific documentation.

Notifications and Alerts

🚧

These features are only available if you have MongoDB Classic deployments.

Any alerts from your MongoDB Classic deployment will show up on the Alerts page. Notifications and settings regarding these alerts are managed on the Notifications page.

MongoDB Classic alerts and notifications settings.

Under Database Alerts, the slider sets the level of alerts that will be pushed to the Alerts page and/or forwarded to email, or pushed to PagerDuty. Under Alert contact settings, the toggles enable sending alerts to all users on the account, or the email addresses specified in the text field. If you enable pushing alerts to PagerDuty, then there is a field for your PagerDuty API key.

If you make any changes to this page, make sure you click Save alert settings to save the changes.


Still Need Help?

If this article didn't solve things, summon a human and get some help!

Updated about a year ago

Account Settings


Suggested Edits are limited on API Reference Pages

You can only suggest edits to Markdown body content, but not to the API spec.