ArangoDB v3.13 is under development and not released yet. This documentation is not final and potentially incomplete.

My Account in ArangoGraph

How to manage your user account, your organizations, and your API keys in ArangoGraph

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

  • Question mark icon: Help
  • User icon: My Account

ArangoGraph My Account

Overview

How to view my account

  1. Hover over or click the user icon of the User Toolbar in the top right corner.
  2. Click 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 over or click the user icon in the User Toolbar in the top right corner.
  2. Click Overview in the My account section.
  3. Click the Edit button.
  4. Change your personal information and Save.

ArangoGraph My Account Info

Organizations

How to view my organizations

  1. Hover over or click the user icon of the User Toolbar in the top right corner.
  2. Click My organizations in the My account section.
  3. Your organizations are listed in a table. Click 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 over or click the user icon of the User Toolbar in the top right corner.
  2. Click My organizations in the My account section.
  3. Click 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 over or click the user icon of the User Toolbar in the top right corner.
  2. Click My organizations in the My account section.
  3. Click the recycle bin icon in the Actions column.
  4. Enter Delete! to confirm and click Yes.
If you are no longer a member of any organization, then a new organization is created for you when you log in again.

ArangoGraph 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 not a member of an organization yet

  1. Once invited, you will receive an email asking to join your ArangoGraph organization.
    ArangoGraph Organization Invite Email
  2. Click the View my organization invite link in the email. You will be asked to log in or to create a new account.
  3. To sign up for a new account, click the Start Free button or the Sign up link in the header navigation.
    ArangoGraph Homepage
  4. After successfully signing up, you will receive a verification email.
  5. Click the Verify my email address link in the email. It takes you back to the ArangoGraph Insights Platform site.
    ArangoGraph Organization Invite Email Verify
  6. After successfully logging in, you can accept or reject the invite to join your organization.
    ArangoGraph Organization Invite
  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.

I am already a member of an organization

  1. Once invited, you will receive an email asking to join your ArangoGraph organization, as well as a notification in the ArangoGraph dashboard.
  2. Click the View my organization invites link in the email, or hover over the user icon in the top right corner of the dashboard and click My organization invites.
    ArangoGraph Organization Invite Notification
  3. On the Invites tab of the My account view, you can accept or reject pending invitations, as well as see past invitations that you accepted or rejected. Click the button with a checkmark icon to join the organization.
    ArangoGraph Organization Invites Accept

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 over or click the user icon of the User Toolbar in the top right corner.
  2. Click My API keys in the My account section.
  3. Information about the API keys are listed in the My API keys section.

ArangoGraph My API keys

How to create a new API key

  1. Hover over or click the user icon of the User Toolbar in the top right corner.
  2. Click 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 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.

ArangoGraph New API key

ArangoGraph API key Secret

How to revoke or delete an API key

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