🔏
API Docs
  • Beam API Docs
  • Overview
    • About Beam
    • API Requirements
    • Roles and Permissions
  • Getting Started
    • Requesting an Account
    • Using RESTful Tools
    • Webhooks
  • The Basics
    • Entities
    • Best Practices
    • Testing Accounts
  • OAuth
    • Overview
    • How to Authorize Access
      • Step 1: Generate Authorization URL
      • Step 2: Handle Authorization Response
      • Step 3: Request an Access Token
      • Step 4: Call API Endpoints
      • Step 5: Refresh the Tokens
  • API Endpoints
    • Overview
    • Get User Devices
    • Toggle Door
    • Invite User (internal)
    • Get Toggle History
    • Get User Info
    • Get User Settings
Powered by GitBook
On this page
  1. Overview

Roles and Permissions

Since security is paramount, the Beam API employs somewhat strict account permissions for it’s users and developers. There are two main roles: Owner and User. An Owner of a Beam Controller has administrative privileges over that Controller, including:

  • Open and close any door on their account

  • View status of all doors on their account

  • Add, edit and remove doors

  • Add and remove users

  • View door history

  • Enable or disable 3rd-party integrations

A Beam Controller currently has only one owner but can have unlimited users. A user has more limited permissions and are restricted to the doors they have been invited:

  • Open and close invited door(s)

  • View status of invited door(s)

PreviousAPI RequirementsNextRequesting an Account

Last updated 4 years ago