Service: Authentication

This API is officially released and maintained.

Service for authentication to the Qb2 device.

Table 1. Available methods
Method Request Response

Login

AuthenticationLoginRequest

AuthenticationLoginResponse

Login

User-Accounts managed by Qb2 have to use the Login method with an existing account in order to receive a JWT Token for access to priviliged parts of the device API.

The factory user has the username "admin". The password is printed on the device label.

Request

Request for authentication

Table 2. Available fields in blickfeld.secure.services.AuthenticationLoginRequest
Field Type Default Unit

user

User

-

-

Authenticate with user credentials

application

Application

-

-

Authenticate with application key credentials

User

User credentials

Table 3. Available fields in blickfeld.secure.services.AuthenticationLoginRequest.User
Field Type Default Unit

name

optional string

-

-

the username (can be left out in case of default factory state)

password

string

-

-

the password of the user in plain text

Application

Application Key credentials

Table 4. Available fields in blickfeld.secure.services.AuthenticationLoginRequest.Application
Field Type Default Unit

key

string

-

-

the key in plain text

http_digest

string

-

-

the key as md5 checksum

Response

Response containing the issued JWT token.

Table 5. Available fields in blickfeld.secure.services.AuthenticationLoginResponse
Field Type Default Unit

token

string

-

-

The JWT token which needs to be sent with the key "token" in the metadata of a gRPC call. The token is bound to a Service: Session.