This guide will walk you through the basic units of permissions and access levels in Formant: users, roles, and teams.

Users

A user is a single person in your Formant organization, identified by an email address. When you add a new user to your organization, a signup email will be sent to the email address you specify, allowing that person to join your organization and set a password.

Once you've added someone as a user in your Formant organization, you can control their permissions and access levels through roles.

Roles

A role is a set of permissions designed for a given use case or user persona for your organization. For example, you might want a set of users to have teleoperation permissions, but only over a certain type of device; or you might want customers to only be able to see certain device views.

You can create a role and then apply it to existing users, or you can specify a user's role when you add them to your organization.

Default roles

Formant offers a set of default roles:

Role	Permissions
Viewer	Can view data from devices.
Operator	Can view data from, and teleoperate, devices.
Administrator	Can view data from, teleoperate, create, modify, and delete devices. Can create, modify, and delete users, tags, etc.

📘
The first account created in a Formant organization is an Administrator by default.

In addition to the default roles, you can create custom roles with permissions and access levels according to your needs.

Teams

A team is a set of users with the same role. You can quickly assign the same role to many users in your organization by creating a team and adding users to it. You can then set the access level of that team.

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 the Formant command-line tool, fctl.

👋
If you notice an issue with this page or need help, please reach out to us! Use the 'Did this page help you?' buttons below, or get in contact with our Customer Success team via the Intercom messenger in the bottom-right corner of this page, or at [email protected].