Service: Account

This API is officially released and maintained.

This service supports the complete lifecycle of accounts which are managed by the current Qb2 device.

Table 1. Available methods
Method	Request	Response
List	google.protobuf.Empty	AccountListResponse
Create	AccountCreateRequest	AccountCreateResponse
Reset	AccountResetRequest	AccountResetResponse
Delete	AccountDeleteRequest	google.protobuf.Empty
Get	AccountGetRequest	AccountGetResponse
Store	AccountStoreRequest	google.protobuf.Empty

List

List registered accounts.

Response

Response for list of accounts

Table 2. Available fields in blickfeld.secure.services.AccountListResponse
Field	Type	Default	Unit
account	repeated AccountEntry	-	-
account	Accounts mapping from account-uuid (key) to account details (value).

Account Entry

Table 3. Available fields in blickfeld.secure.services.AccountListResponse.AccountEntry
Field	Type	Default	Unit
key	string	-	-
value	config.Account	-	-

Create

Create a new account.

Request

Request to create a new user

Table 4. Available fields in blickfeld.secure.services.AccountCreateRequest
Field	Type	Default	Unit
account	config.Account	-	-
account	the account to create

Response

Response after account has been created.

The generated activation password in plain text will be returned only once.

Table 5. Available fields in blickfeld.secure.services.AccountCreateResponse
Field	Type	Default	Unit
activation_password	string	-	-
activation_password	the activation password in plain text
uuid	string	-	-
uuid	the uuid of the account

Reset

Reset account by setting the state to WAITING_FOR_ACTIVATION & generating a new activation password.

Request

Request to reset an existing account

Table 6. Available fields in blickfeld.secure.services.AccountResetRequest
Field	Type	Default	Unit
uuid	string	-	-
uuid	the uuid of the account to reset

Response

Response after account has been reset.

The generated activation password in plain text will be returned only once.

Table 7. Available fields in blickfeld.secure.services.AccountResetResponse
Field	Type	Default	Unit
activation_password	string	-	-
activation_password	the activation password in plain text

Delete

Delete an Account.

Request

Request to delete an Account

Table 8. Available fields in blickfeld.secure.services.AccountDeleteRequest
Field	Type	Default	Unit
uuid	optional string	-	-
uuid	Optional uuid of the account to delete. If left empty the uuid from the presented JWT token will be used.

Get

Get Account information.

Request

Request to query account details

Table 9. Available fields in blickfeld.secure.services.AccountGetRequest
Field	Type	Default	Unit
uuid	optional string	-	-
uuid	Optional uuid of the account to get. If left empty the uuid from the presented JWT token will be used.

Response

Response for the currently authenticated account.

Table 10. Available fields in blickfeld.secure.services.AccountGetResponse
Field	Type	Default	Unit
account	config.Account	-	-
account	The account details
uuid	string	-	-
uuid	The uuid of the account

Store

Store updated account data.

During account activation this method can be accessed using a JWT token with access level LEVEL_PUBLIC. It will fail with UNAUTHENTICATED if no JWT token is presented.

Request

Store updated account details.

Table 11. Available fields in blickfeld.secure.services.AccountStoreRequest
Field	Type	Default	Unit
uuid	optional string	-	-
uuid	Optional uuid of the account to store. If not provided the uuid from the presented JWT token will be used.
account	optional config.Account	-	-
account	Optional account data to store.
password_update	optional PasswordUpdate	-	-
password_update	Optional password update for the account to store.

Password Update

Password update message

Table 12. Available fields in blickfeld.secure.services.AccountStoreRequest.PasswordUpdate
Field	Type	Default	Unit
current	string	-	-
current	the current password
new	string	-	-
new	the new password