X-API Keys
Last updated
Last updated
PlaceOS can generate API Keys for authenticated access.
The API keys can be used for:
Accessing the
Using the
Administrator access to your PlaceOS Backoffice
Login to PlaceOS Backoffice
Navigate to the Admin Tab
Select API Keys
Select the domain the API Key will belong to
Any existing API Keys will be shown in the list
Click Add API Key
Enter the required information:
Name: Suitable name for the API Key
Description: What the key will be used for (useful for other administrators)
Scopes: Select from available scopes (see available scopes below)
User: The user in which the API Key will emulate
Permissions: Permission level assigned to the API Key (see permission details below)
Click Save
The new API Key will be shown once after it is saved, you will not be able to view it again
Available Scopes for API Keys are:
public
A special scope that can access all routes (supports read and write modifiers)
api_keys
ldap_authentication
saml_authentication
o_auth_authentication
o_auth_applications
brokers
cluster
domains
drivers
settings
modules
systems
control
.read
: module class types, function list of a module, module state lookup
.write
: control websocket, API execute request
edges
metadata
repositories
scope.read
scope.write
API Keys are typically passed in the header of the request, however can be used in the following ways
HTTP Header: X-API-Key: <token>
URL param: ?api-key=<token>
A HTTP Cookie: api-key=<token>
Navigate to the API Key Page in Backoffice located in the Admin Tab.
X-API Keys can be used for unattended panel authentication, scopes are required for these applications to function. The table below outlines common applications that require API Keys and the associated scopes.
Booking Panel
users.read
systems.read
control
zones.read
(optional)
`metadata.read` (optional)
Map Kiosk
public.read
guests
A special scope for guests that provides
Click the trash icon to remove the key.