Service: Application Key
This API is not yet officially released nor maintained. |
Service for managing application keys.
Method | Request | Response |
---|---|---|
List
List existing application keys for the authenticated account.
Request
Request to list applicaion keys
Field | Type | Default | Unit |
---|---|---|---|
account_uuid |
optional string |
- |
- |
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
Response for listing existing application keys.
Field | Type | Default | Unit |
---|---|---|---|
application_key |
repeated ApplicationKeyEntry |
- |
- |
Application key mapping from application-key-uuid (key) to application key details (value). |
Create
Create an application key for the authenticated account.
Request
Request to create an application key.
Field | Type | Default | Unit |
---|---|---|---|
account_uuid |
optional string |
- |
- |
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 |
- |
- |
|
The application key to create. Minimum (optional) input is the value set in the |
Response
Response containing the plain-text key information of the generated application key.
The generated key in plain text will be returned only once. |
Field | Type | Default | Unit |
---|---|---|---|
key |
string |
- |
- |
The generated key in plain text. This key has to be used whenever an application needs a token for authenticated access. |
Delete
Delete an application key from the authenticated account.
Request
Request to delete an application key.
Field | Type | Default | Unit |
---|---|---|---|
uuid |
string |
- |
- |
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. |