Butlr · OAuth Scopes

Butlr OAuth Scopes

OAuth 2.0 searched

Butlr publishes 12 OAuth 2.0 scopes. Scopes are the fine-grained permissions an application requests at authorization time to act against the Butlr API on a user’s behalf.

This index is generated from the provider’s OpenAPI security definitions (and, where available, its documented scope reference) and refreshes on every APIs.io network build. Browse every provider’s scopes at scopes.apis.io.

CompanySensorsOccupancyPeople SensingSmart BuildingsSpatial IntelligenceIoTGraphQLWebhooksReal Estate

Scopes: 12 Flows: Method: searched

Scopes (12)

Scope	Description	Flows
read:spaces	Read access to spaces (sites/buildings/floors).
write:spaces	Create and update spaces.
delete:spaces	Delete spaces.
read:rooms	Read access to rooms.
write:rooms	Create and update rooms.
delete:rooms	Delete rooms.
read:sensors	Read access to sensors.
write:sensors	Create and update sensors.
delete:sensors	Delete sensors.
read:hives	Read access to hives (sensor gateways/hubs).
write:hives	Create and update hives.
delete:hives	Delete hives.

📄 Provider scope reference: https://docs.butlr.io/getting-started/mint-client-credentials

Source

OAuth Scopes

generated: '2026-07-18'
method: searched
source: https://docs.butlr.io/getting-started/mint-client-credentials
docs: https://docs.butlr.io/getting-started/mint-client-credentials
audience: https://butlrauth/
identity_provider: Auth0
schemes:
- name: OAuth2 Client Credentials
  flow: clientCredentials
  audience: https://butlrauth/
scopes:
- {scope: 'read:spaces',   description: Read access to spaces (sites/buildings/floors).}
- {scope: 'write:spaces',  description: Create and update spaces.}
- {scope: 'delete:spaces', description: Delete spaces.}
- {scope: 'read:rooms',    description: Read access to rooms.}
- {scope: 'write:rooms',   description: Create and update rooms.}
- {scope: 'delete:rooms',  description: Delete rooms.}
- {scope: 'read:sensors',  description: Read access to sensors.}
- {scope: 'write:sensors', description: Create and update sensors.}
- {scope: 'delete:sensors',description: Delete sensors.}
- {scope: 'read:hives',    description: Read access to hives (sensor gateways/hubs).}
- {scope: 'write:hives',   description: Create and update hives.}
- {scope: 'delete:hives',  description: Delete hives.}
notes: >-
  Scopes are granted to Auth0 M2M clients created for the Butlr API audience
  (https://butlrauth/). The documented default scope set covers the spaces,
  rooms, sensors, and hives resource families with read/write/delete access.
  The official MCP server is provisioned with read-only scopes only. Derived
  from the client-credential minting docs (no OpenAPI oauth2 flow declaration
  is published, so the derive-oauth-scopes.py baseline was not applicable).