Service: Application Key

This API is officially released and maintained.

Service for managing application keys.

Table 1. Available methods
Method	Request	Response
List	ApplicationKeyListRequest	ApplicationKeyListResponse
Create	ApplicationKeyCreateRequest	ApplicationKeyCreateResponse
Update	ApplicationKeyUpdateRequest	google.protobuf.Empty
Delete	ApplicationKeyDeleteRequest	google.protobuf.Empty

List

List existing application keys for the authenticated account.

Request to list applicaion keys

Table 2. Available fields in blickfeld.secure.services.ApplicationKeyListRequest
Field	Type	Default	Unit
account_uuid	optional string	-	-
account_uuid	Optional uuid of the account for which to list the application keys. If not provided the uuid from the presented JWT token will be used.

Response for listing existing application keys.

Table 3. Available fields in blickfeld.secure.services.ApplicationKeyListResponse
Field	Type	Default	Unit
application_key	repeated ApplicationKeyEntry	-	-
application_key	Application key mapping from application-key-uuid (key) to application key details (value).

Table 4. Available fields in blickfeld.secure.services.ApplicationKeyListResponse.ApplicationKeyEntry
Field	Type	Default	Unit
key	string	-	-
value	config.ApplicationKey	-	-

Create an application key for the authenticated account.

Request to create an application key.

Table 5. Available fields in blickfeld.secure.services.ApplicationKeyCreateRequest
Field	Type	Default	Unit
account_uuid	optional string	-	-
account_uuid	Optional uuid of the account to which the application key is associated. If not provided the uuid from the presented JWT token will be used.
application_key	config.ApplicationKey	-	-
application_key	The application key to create. Minimum (optional) input is the value set in the `purpose` field. Everything else will be generated and added on the server side.
key	optional string	-	-
key	Optional key in plain text, in place of a generated one. Only for application keys with a username.

Response containing the plain-text key information of the generated application key.

The generated key in plain text will be returned only once.

Table 6. Available fields in blickfeld.secure.services.ApplicationKeyCreateResponse
Field	Type	Default	Unit
uuid	string	-	-
uuid	The uuid of the application key.
key	string	-	-
key	The generated key in plain text. This key has to be used whenever an application needs a token for authenticated access.

Update the access level, read-only flag, purpose and key of an application key with a username.

Request to update an application key with a username.

Table 7. Available fields in blickfeld.secure.services.ApplicationKeyUpdateRequest
Field	Type	Default	Unit
uuid	string	-	-
uuid	The uuid of the application key to update.
application_key	config.ApplicationKey	-	-
application_key	The new purpose, access level and read-only flag; an unset access level keeps the key’s. The remaining fields are ignored.
key	optional string	-	-
key	Optional new key in plain text. The key is kept when empty.

Delete an application key from the authenticated account.

Request to delete an application key.

Table 8. Available fields in blickfeld.secure.services.ApplicationKeyDeleteRequest
Field	Type	Default	Unit
uuid	optional string	-	-
uuid	The uuid of the application key to delete. Once the application key has been deleted all future authentication attempts with this application key will be blocked.