Your initial EdgeIQ account will be set up for you by someone on the customer success team. At that point, you can continue to add users, customer accounts, and manage permissions of everyone using the system.
EdgeIQ accounts consist of Organizations and Users. Managing permissions for the various features of the system is done using Roles.
All instances of resources within the system must belong to an Org Account (Company), including users, devices, software updates, and so on. Your Org Account will also control the branding and visibility of different navigation features and widgets on the EdgeIQ Portal.
Organization Sub-accounts give you the ability to manage customer or business unit accounts. These act as sub-accounts for which you can manage users, devices, and so forth, and everything will be scoped to that Org Account. Org Accounts can be added to these companies in turn, in a hierarchical fashion, to describe any kind of relationship you need between your company, your customers, and so on.
All users, devices, and data produced by devices are always visible up the hierarchy, but not to sibling companies.
Company A + | | +-----+-----+ | | + + Company B Company C
Given the above hierarchy, Devices and data from devices in Company C will be visible to users in Company A. Users in Company B will not be able to see them, however, and vice versa.
Users are how individual access to the API and portal is managed. Users have usernames, use passwords to log into the portal, and have API tokens to use the API. For more information, see the Users API documentation. Users are associated with Org Accounts in a few ways.
Every user has an associated Org Account. This Org Account is the account that manages the user. The parent account for a user cannot be changed.
Every user also has a list of other accounts, referenced in company_ids. This is the list of Org Accounts that the user may manage. The user may, for instance, view and edit data from those accounts. Users are unable to see are modify an Organization Sub-account until it has been added to their Managed Accounts.
Users can be assigned to a Portal Branding Account. This can be changed after creating a user. This setting determines which Org Account's branding data will be used for visual styling and configuration when the user logs in to the portal.
Roles are used to assign user permission to perform the available functions in the system. There are a predefined set of roles, which are easy to assign to new users through the portal, or list and choose from using the API. For more information, see the User Types API documentation.
Updated about 1 year ago