requestToken - Hyperion

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 }'

{ "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

command

enum<string>

required

Main instruction field. For authentication, always set to 'authorize'.

Allowed value:

authorize

subcommand

enum<string>

required

Defines the specific authorization action, such as login, logout, etc.

Allowed value:

requestToken

Example:

requestToken

comment

string

required

Optional text (min 5 characters) to identify or annotate the token.

>= 5 characters

string

required

Unique identifier for a token (usually 5 characters).

>= 5 characters<= 5 characters

boolean

required

Boolean to accept or deny a token request.

Default:

true

tan

integer

optional

Transaction number for tracking requests and responses.

>= 0

Example:

4711

Examples

Responses

🟢200Success

application/json

Body

command

string

required

The command executed

subcommand

string

optional

The sub-command executed

success

boolean

required

Result, if the request excuted successfully

info

object

optional

Information requested

Additional properties

integer | number | string | boolean

optional

error

string

optional

Reason why a request did not execute successfully

errorData

array [object {1}]

optional

Detailed error explaination

description

string

optional

tan

integer

required

Request's transaction number