Skip to main content

Teams

The nRF Cloud Teams feature lets you set up teams of users who can interact with the team's devices, with different access levels for individual users.

Your Team ID can be found on your Teams page on nRFCloud.com. This is your tenant ID in the response of a call to the FetchAccountInfo endpoint in the REST API. You need to know your Team ID to use the MQTT API.

Concepts

TermDefinition
UserA person with an account on the nRF Cloud portal. Each account is unique to a particular email. A person might create different accounts with different emails, but each account is considered a different user.
AccountThe configuration settings for an nRF Cloud user, such as their password, team associations, and team-specific permissions.
TeamContains a set of user accounts and a set of devices. A user can be a member of multiple teams, with different permissions for each team. A device cannot be a member of more than one team.
Team memberA user acting within a specific team. A team member has a role for a given team that is independent of their roles in other teams.
RoleA team member is assigned a role for a team, such as owner, admin, editor, or viewer.
Device groupA named set of devices. A team member can also be associated with a device group, which limits the devices they can access.
PermissionsA team member's assigned device groups and role, which defines what they can do with which devices.
API keyA unique identifier provided for a team member, allowing them to access the devices in that team using the nRF Cloud REST API, subject to their permissions for that team.

See also the Device groups page.

Roles

A team member has one role. If you are a member of multiple teams, you can have a different role for each team. When you are invited to a team, the invitation mail tells your role and the level of permissions you have.

The role defines what you can do within that team.

Owner

The following actions are only available to the team owner:

  • Remove any team members.
  • Invite users to a team by email address.
  • Cancel an invitation you created before the invitee accepts.
  • Modify team information, such as the name.
  • Delete a team.
    • All associated devices and user relationships are deleted, and any outstanding invitations are rejected.
  • Generate evaluation tokens.

Admin

In an admin role, you can perform all editor actions, as well as the following:

  • Remove any other team member (including yourself), except the owner.
  • Change any other team member's role (including yourself), except the owner.
  • Change a team member's assigned device groups.
  • Add, change, and delete device groups assigned to a device.
  • Update firmware on a device.

Editor

In an editor role, you can do the following:

  • View device information.
  • Regenerate your own nRF Cloud REST API key for a team you are on.
  • Generate a device certificate and use it to provision a device.
  • Add, remove, and perform actions on devices, such as:
    • Perform a scan with a Bluetooth gateway.
    • Rename a device.
    • Attach an image to the device as shown in the list of devices.
    • Interact with a device to change its characteristic values, such as enabling sensor output or changing the light pattern.
  • Add and remove SIM cards.
  • Add and remove Bluetooth gateways.

Viewer

In a viewer role, you can do the following:

  • View device information.
  • Regenerate your own nRF Cloud REST API key for a team you are on.

nRF Cloud REST API access by role

Each team member is provided an API key that grants them permissions to use the nRF Cloud REST API for devices in that team.

Device access using the nRF Cloud REST API is restricted by the API call and the team member's role:

nRF Cloud REST APIOwnerAdminEditorViewer
Account information
Account certificates
API usage information
Devices (all types):
> ListDevices request
> FetchDevice request
> All other requests in this section
Devices (Gateway)
Devices (Bluetooth LE)
Devices (IP/LTE)
Device firmware updates (FOTA)
Bulk operation status
Location Services
Messages:
> ListMessages
> SendDeviceMessage
Evaluation token:
Generate token
View token
Get REST API specification through /openapi.json endpoint

To interact with Teams, use the nRF Cloud portal.

For details on using Teams, see Working with Teams.