ArangoDB v3.5 reached End of Life (EOL) and is no longer supported.

This documentation is outdated. Please see the most recent version here: Latest Docs

My Account

You can access information related to your account via the User Toolbar. The toolbar is in the top right corner in the Oasis dashboard and accessible from every view. There are three elements:

  • Bell icon: Notifications (Invites)
  • Question mark icon: Help
  • User icon: My Account

Oasis My Account

Overview

How to view my account

  1. Hover or click the user icon of the User Toolbar in the top right corner.
  2. Click on Overview in the My account section.
  3. The Overview displays your name, email address, company and when the account was created.

How to edit the profile of my account

  1. Hover or click the user icon in the User Toolbar in the top right corner.
  2. Click on Overview in the My account section.
  3. Click the Edit button.
  4. Change your personal information and click on Save.

Oasis My Account Info

Organizations

How to view my organizations

  1. Hover or click the user icon of the User Toolbar in the top right corner.
  2. Click on My organizations in the My account section.
  3. Your organizations are listed in a table. Click on the organization name or the eye icon in the Actions column to jump to the organization overview.

How to create a new organization

  1. Hover or click the user icon of the User Toolbar in the top right corner.
  2. Click on My organizations in the My account section.
  3. Click on the New organization button.
  4. Enter a name and and a description for the new organization and click the Create button.

The free to try tier is limited to a single organization.

How to delete an organization

Removing an organization implies the deletion of projects and deployments. This operation cannot be undone and all deployment data will be lost. Please proceed with caution.

  1. Hover or click the user icon of the User Toolbar in the top right corner.
  2. Click on My organizations in the My account section.
  3. Click on the trash can icon in the Actions column.
  4. Enter Delete! to confirm and click on Yes.

If you are no longer a member of any organization, then a new organization is created for you when you log in again.

Oasis New Organization

Invites

Invitations are requests to join organizations. You can accept or reject pending invites.

How to create invites

See Users and Groups: How to add a new member to the organization

How to respond to my invites

I am already member of an organization

  1. The bell icon in the top right corner will display a badge with the number of pending notifications.
  2. Click the icon to get to the the Invites tab of the My account view. You can also hover the user icon and click on My organization invites to get there.
  3. On this page you can accept or reject pending invitation, as well as see past invites that you accepted or rejected.

I am not a member of an organization yet

  1. Once invited, you will receive an email with a link asking to join your ArangoDB Oasis organization.
  2. After the confirmation link is clicked, you will be asked to log in or to create a new account.
  3. To sign up for a new account, click the Sign up for free button or the Sign up link in the header navigation.
  4. After successfully signing up, you will receive a verification email.
  5. Clicking the confirmation link takes you back to the ArangoDB Oasis site.
  6. After successfully logging in, you can accept or reject the invite to join your organization.
  7. After accepting the invite, you become a member of your organization and will be granted access to the organization and its related projects and deployments.

Oasis Organization Invite Email

API Keys

API keys are authentication tokens intended to be used for scripting. They allow a script to authenticate on behalf of a user.

An API key consists of a key and a secret. You need both to complete authentication.

How to view my API keys

  1. Hover or click the user icon of the User Toolbar in the top right corner.
  2. Click on My API keys in the My account section.
  3. Information about the API keys are listed in the My API keys section.

Oasis My API keys

How to create a new API key

  1. Hover or click the user icon of the User Toolbar in the top right corner.
  2. Click on My API keys in the My account section.
  3. Click the New API key button.
  4. Optionally limit the API key to a specific organization.
  5. Optionally specify after how many hours the API key should expire into the Time to live field.
  6. Optionally limit the API key to read-only APIs
  7. Click on the Create button.
  8. Copy the API key ID and Secret, then click the Close button.

The secret is only shown once at creation time. You have to store it in a safe place.

Oasis New API key

Oasis API key Secret

How to revoke or delete an API key

  1. Hover or click the user icon of the User Toolbar in the top right corner.
  2. Click on My API keys in the My account section.
  3. Click on an icon in the Actions column:
    • Counter-clockwise arrow icon: Revoke API key
    • Trash can icon: Delete API key
  4. Click the Yes button to confirm.