Users, service accounts, and teams

This guide will explain the concepts of users, service accounts, and teams in Formant, and teach you how to create and configure each.

Users

A user is a member of your Formant organization. Users are configured with roles and access levels to set their visibility and control within the organization.

Add a user

Users can only be added to the organization by an Administrator. (The first account created in a Formant organization is an Administrator by default.)

  1. In Formant, in the upper-left corner, open the menu and click Settings.
  2. Click Users >> Add User.
  3. Enter the user’s name, email address, region, team (optional), and assign a role:
RolePermissions
ViewerCan view data from devices.
OperatorCan view data from, and teleoperate, devices.
AdministratorCan view data from, teleoperate, create, modify, and delete devices. Can create, modify, and delete users, tags, etc.

πŸ“˜

Multi-region user management (Enterprise plan feature)

When creating a new user, you may be prompted to choose their region: AMER, EMEA, or JAPAC. If you are not prompted to select a region, the default is AMER.

A user's region is a permanent attribute. You cannot change this attribute after the user has been created.

The user's metadata and Personally Identifiable Information (PII) will be hosted in servers according to the user's region. You can use this feature to bring your organization more in compliance with the EU's General Data Protection Regulation (GDPR) law.

If you need to change a user's region, you'll have to delete that user and re-create their account in the new region.

If you'd like to implement multi-region user management in your Formant organization, please reach out to our Customer Success team via the Intercom messenger in the bottom-right corner of this page, your Slack channel with us, or at [email protected].

The user will receive an email inviting them to your Formant organization. They must follow the link in the email to create their account within your organization.

Delete a user

Users can only be deleted from the organization by an Administrator. (The first account created in a Formant organization is an Administrator by default.)

  1. In Formant, in the upper-left corner, open the menu and click Settings.
  2. Click Users, and scroll to the user you want to delete from your organization.
  3. Click the trash can icon next to the user you want to delete, and then confirm the deletion by clicking OK.

🚧

Deleting a user is a permanent action. You can always re-add the user later, but metadata such as tags, role, and teams will not be saved.

Service accounts

Service accounts are used to grant access only to the Formant SDKs or API. They are useful in your apps, custom views, or to give to third parties, as they won't have access to the Formant web application. You can create a service account using the Formant web application, or using fctl.

Add a service account

  1. In Formant, in the upper-left corner, open the menu and click Settings.
  2. Click Users >> Add Service Account.
  3. Enter a name for the Service Account and click Create.
  4. Select a region, role, and team (optional).
  5. An email address and password will be created for this service account. Copy the credentials to a file safely. This will be the only time that these credentials are displayed.

🚧

This is the only time you will be able to copy the password for your service account. Copy the email and password for your service account to a secure file. You will need these credentials to authenticate your service account and access Formant.

Configure access levels

You can apply tags to users to set the devices, data, or topics to which a user will have access. While adding a user or viewing an existing user, click Show Advanced Settings to reveal the tags interface. Users will only have access to Formant entities with the tags associated with their account.

πŸ“˜

A user with no tags applied will have access to all entities within your organization.

Teams

A team is a collection of users with the same role and same access configuration. You can quickly configure roles and access for a large set of users by assigning them to a team.

Add a team

  1. In Formant, in the upper-left corner, open the menu and click Settings.
  2. Click Teams >> Add Team.
  3. Enter a name for your team and click Continue.
  4. Select the role for members of this team. Apply tags by clicking Show advanced options.
  5. Click the Select Users tab and select which users should be members of this team. Selected users will have the team's role and access configuration applied to their account.