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

requestToken

Testing Env
https://{{host}}:8092
Testing Env
https://{{host}}:8092
POST
/json-rpc/authorize/token/approve
Request Request Example
Shell
JavaScript
Java
Swift
curl --location -g --request POST 'https://localhost:8092/json-rpc/authorize/token/approve' \
--header 'Content-Type: application/json' \
--data-raw '{
    "command": "authorize",
    "subcommand": "requestToken",
    "comment": "OpenHab2 Binding",
    "id": "WD6nT",
    "accept": true,
    "tan": 4711
}'
Response Response Example
Success
{
    "command": "authorize-requestToken",
    "info": {
        "comment": "OpenHab2 Binding",
        "id": "WD6nT",
        "token": "83675c61-141e-460c-8a92-c4da55b61e0d"
    },
    "success": true,
    "tan": 4711
}

Request

Authorization
Provide your bearer token in the
Authorization
header when making requests to protected resources.
Example:
Authorization: Bearer ********************
Body Params application/json

Examples

Responses

🟢200Success
application/json
Body

Modified at 2025-05-18 08:34:51
Previous
newPasswordRequired
Next
newPassword
Built with