Hyperion

adminRequired

Testing Env

https://{{host}}:8092

POST

/json-rpc/authorize/admin

WebsocketHTTP/S

Request Example

Shell

JavaScript

Java

Swift

curl --location -g --request POST 'https://localhost:8092/json-rpc/authorize/admin' \
--header 'Content-Type: application/json' \
--data-raw '{
    "command": "authorize",
    "subcommand": "adminRequired",
    "tan": 4711
}'

Response Example

{
    "command": "authorize-adminRequired",
    "info": {
        "adminRequired": true
    },
    "success": true,
    "tan": 4711
}

Request

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:

adminRequired

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

tokenRequired

newPasswordRequired