Hyperion
  1. Authorization
Hyperion
  • JSON-RPC API Introduction
  • JSON-API Commands Overview
  • Connect to Hyperion
  • Components & Priorities
  • Hyperion API
    • Authorization
      • API Authentication - Introduction
      • createToken
        POST
      • renameToken
        POST
      • deleteToken
        POST
      • getTokenlist
        POST
      • tokenRequired
        POST
      • adminRequired
        POST
      • newPasswordRequired
        POST
      • requestToken
        POST
      • newPassword
        POST
      • answerRequest
        POST
      • getPendingTokenRequests
        POST
      • login
        POST
      • logout
        POST
    • Information
      • getSystemInformation
      • getSubscriptionInformation
      • getServerInformation
      • getImageSnapshot
      • getLedsSnapshot
    • Controls
      • Input Controls
        • setColor
        • setEffect
        • setImage
        • clear
        • clearAll
        • selectSource
      • Output Controls
        • adjustColors
        • setLedMapping
        • setVideomode
      • Subscription Controls
        • liveImageStream
        • liveLedColorStream
      • Operational Controls
        • setComponentState
        • setInstanceState
        • switchInstance
        • setSystemState
        • setSubscriptions
    • Configuration
      • createInstance
      • deleteInstance
      • renameInstance
      • getConfiguration
      • updateConfiguration
      • restoreConfiguration
      • getSchemas
  1. Authorization

API Authentication - Introduction

Hyperion has an authorization system allowing users to login via password, and
applications to login with tokens. The user can configure how strong or weak the Hyperion API should be protected from the Configuration -> Network Services screens on the Web UI.

Token System#

Tokens are a simple way to authenticate an App for API access. They can be created in
the UI on the Configuration -> Network Services panel (the panel appears when API Authentication options is checked). Your application can also request a Token via the API.

Authentication Workflow#

Recommended workflow for your application to authenticate:
1
Request a token
Execute a requestToken call annotating it with a meaningful comment which identifies the token's requestor, e.g. an application name or device) and a short randomly created id (numbers/letters).
The comment and id fields are presented to the user for decision making.
2
Wait for the response
The user needs to accept or deny the token request via Hyperion's Web UI.
3
On success
The call will return a UUID token.
Save the token somewhere for further use. The token does not expire.
Be aware that a user can revoke the token any time. It will continue to work for currently connected sessions.
4
On error
No token created as either the user denied the request or it timed out (180s)
Modified at 2025-05-20 21:01:00
Previous
Components & Priorities
Next
createToken
Built with