POST api/login/authenticate_external?username={username}&password={password}&terminal={terminal}&generate_qr={generate_qr}

Request Information

URI Parameters

NameDescriptionTypeAdditional information
username

string

Required

password

string

Required

terminal

string

Required

generate_qr

boolean

Required

Body Parameters

None.

Response Information

Resource Description

user_data_cmd
NameDescriptionTypeAdditional information
result

string

None.

message

string

None.

user_data

_user_data

None.

locator_data

_locator

None.

user_profile_data

_user_profile_data

None.

permisions

Collection of _user_permision

None.

token_data

_user_token

None.

Response Formats

application/json, text/json

Sample:
{
  "result": "sample string 1",
  "message": "sample string 2",
  "user_data": {
    "$id": "2",
    "id_user": "6a51c48d-40ac-474c-9152-0771aff3c99b",
    "user_name": "sample string 2",
    "first_name": "sample string 3",
    "last_name": "sample string 4",
    "active": true
  },
  "locator_data": {
    "$id": "3",
    "locator": "sample string 1",
    "expiration_date": "sample string 2"
  },
  "user_profile_data": {
    "$id": "4",
    "id_profile": "ed0b3ecb-deed-4ca2-a6f2-b8f5d0e2df9d",
    "profile_name": "sample string 2",
    "is_view_all_rooms": true
  },
  "permisions": [
    {
      "$id": "5",
      "id_function": "210454ba-0c2c-4f6f-9efc-461a9cdf761e",
      "function_mask": "sample string 2",
      "function_name": "sample string 3",
      "function_description": "sample string 4",
      "permision": true
    },
    {
      "$ref": "5"
    }
  ],
  "token_data": {
    "$id": "6",
    "token_id": "sample string 1",
    "date_from": "2026-09-06T06:23:07.9385848+02:00",
    "date_end": "2026-09-06T06:23:07.9385848+02:00"
  }
}