Skip to main content
Each connected Entity has at least one owner, usually the who onboarded it. Owners can share access to their Entities by assigning permissions directly to other Applications or to a Collective of them. Permissions can be assigned to any Application, uniquely identified by an .

​
Collectives

Permissions can also be assigned to a Collective of Applications, identified by a . Applications automatically inherit all permissions assigned to a Collective when they are or become a member of it.

​
Types of permissions

Each Entity supports four types of permissions that can be assigned to an Application:
  • Viewer – Can access Readings, settings, and previously triggered Commands.
  • Contributor – Can trigger Commands.
  • Administer – Can manage certain settings.
  • Owner – Can manage permissions and all settings.

​
What you’ll need

  • A valid access (bearer) token
  • An Entity of any type that your Application owns
  • The ID of a Collective or another Application ()

​
Let’s try it out

Our endpoints refer to a principalId as a common name for both Application and Collectives IDs. We currently updating the naming of these properties.
1

Understand who can access your Entity (optional)

You may want to List all permissions for an Entity, to understand who can access it.To do so, you must specify the of an Entity you own.
Response (Body)
{
  "data": [
    {
      "entityId": "3c90c3cc-[...]-8dd25736052a",
      "principalId": "b8a4d7e5-[...]-572a00302df9",
      "permissionLevels": [
        "Viewer"
      ],
    }
  ], ...
}
You’ll find an array of for each you’ve shared access with.
2

Share access with someone else

To share access with someone else, Add permissions for them on your Entity.Specify the of an Entity you own, and set the to the Application you’re sharing access with. Lastly, set the you are assigning to them.You may need to make multiple requests to assign multiple permission levels.
Request (Example)
{
  "principalId": "b8a4d7e5-[...]-572a00302df9",
  "permissionLevel": "Administer"
}