admin category
This category of logs contains all the business requests concerning the Administration module (Admin).
setup action 
The setup action means that the Admin configuration is checked. It generates an "info" severity log if it is configured properly, or an "err" severity log in the event of an error.
The log fields for this action are as follows:
|
Field |
Description |
Type |
Mandatory/Optional |
|---|---|---|---|
|
tenant_id |
Tenant identifier. Example: 025f02fe-bee2-444b-bf76-b5ead30327c0 |
String in uuid v4 format | Mandatory |
| enabled | Specify if the Admin module is enabled. | Boolean | Mandatory |
| errors |
If the Admin module cannot be enabled due to an incorrect configuration, this JSON object contains an error list with an error code and a message:
Example: [ { code: 2002010, message: 'Module: Admin not enabled for tenantId bc337abd-0d4f-43f9-aaf6-54ef7268d2e5. Reason: Validation failed. Reasons are: [Wrong type error: <tenant>/admin/authentication property must be array]' } ] |
Object |
Mandatory if enabled is set to true
|
create_key action
The create_key action means that a key has been created in the database. This is the case whenever a client needs a new key.
This action generates an "info" severity log if the key is created, or an "err" severity log in the event of an error.
The log fields for this action are as follows:
|
Field |
Description |
Type |
Mandatory/Optional |
|---|---|---|---|
|
tenant_id |
Tenant identifier. Example: 025f02fe-bee2-444b-bf76-b5ead30327c0 |
String in uuid v4 format | Mandatory |
| key_id |
Identifier of the created key. Example: a25b5603-ed4e-41e0-bdd7-b157e4846ed8 |
String in uuid v4 format | Mandatory |
| display_name | Name of the key | String | Mandatory if "info" severity |
| algorithm | Algorithm used to create the key | Object | Mandatory if "info" severity |
| name | Name of the algorithm used. Example : AES-GCM |
String | Mandatory if "info" severity |
| parameters.length | Length of a symmetric key algorithm Example: 256 |
Integer | Mandatory if "info" severity |
| parameters.modulus_length | Length of an asymmetric key algorithm Example: 2048 |
Integer | Mandatory if "info" severity |
| parameters.hash |
Hash of the asymmetric key Example: SHA-256 |
String | Mandatory if "info" severity |
| usages |
Key usage Example: [‘encrypt’, ‘wrapKey’] |
String array | Mandatory if "info" severity |
| module |
Module for which the key was created Example : kas |
String | Mandatory if "info" severity |
| created_at | Date the key was created | String | Mandatory if "info" severity |
| updated_at | Date the key was last updated | String | Mandatory if "info" severity |
| error |
JSON object containing an error code and a message indicating why the public key could not be created. Example: [ error: { code: 2006002, message: "Validation failed. Reasons are: [Wrong type error: /display_name property must be string]"
|
Object | Mandatory if "err" severity |
get_keys action
The get_key action means that a list of keys has been retrieved from the database.
This action generates an "info" severity log if the list of keys is retrieved, or an "err" severity log in the event of an error.
The log fields for this action are as follows:
|
Field |
Description |
Type |
Mandatory/Optional |
|---|---|---|---|
|
keys: Array containing the list of keys. It is mandatory but can be empty. |
|||
|
tenant_id |
Tenant identifier Example: 025f02fe-bee2-444b-bf76-b5ead30327c0 |
String in uuid v4 format | Mandatory |
| key_id |
Identifier of the key Example: a25b5603-ed4e-41e0-bdd7-b157e4846ed8 |
String in uuid v4 format | Mandatory |
| display_name | Name of the key | String | Mandatory if "info" severity |
| algorithm | Algorithm used to create the key | Object | Mandatory if "info" severity |
| algorithm.name | Name of the algorithm used. Example : AES-GCM |
String | Mandatory if "info" severity |
| algorithm.parameters.length |
Length of the symmetric key algorithm Example: 256 |
Integer | Mandatory if "info" severity |
| algorithm.parameters.modulus_length | Length of the asymmetric key algorithm Example: 2048 |
Integer | Mandatory if "info" severity |
| algorithm.parameters.hash |
Hash of the asymmetric key Example: SHA-256 |
String | Mandatory if "info" severity |
| usages |
Key usage Example: [‘encrypt’, ‘wrapKey’] |
String array | Mandatory if "info" severity |
| created_at | Date the key was created | String | Mandatory if "info" severity |
| updated_at | Date the key was updated | String | Mandatory if "info" severity |
| module |
Module for which the key was created Example : kas |
String | Mandatory if "info" severity |
| error |
JSON object containing an error code and a message indicating why the public key could not be retrieved. Example: [ error: { code: 2006002, message: "Validation failed. Reasons are: [Wrong type error: /display_name property must be string]"
|
Object | Mandatory if "err" severity |
get_key action
The get_key action means that a key has been retrieved from the database.
This action generates an "info" severity log if the key is retrieved, or an "err" severity log in the event of an error.
The log fields for this action are as follows:
|
Field |
Description |
Type |
Mandatory/Optional |
|---|---|---|---|
|
tenant_id |
Tenant identifier Example: 025f02fe-bee2-444b-bf76-b5ead30327c0 |
String in uuid v4 format | Mandatory |
| key_id |
Identifier of the created key Example: a25b5603-ed4e-41e0-bdd7-b157e4846ed8 |
String in uuid v4 format | Mandatory |
| display_name | Name of the key | String | Mandatory if "info" severity |
| algorithm | Algorithm used to create the key | Object | Mandatory if "info" severity |
| algorithm.name | Name of the algorithm used Example : AES-GCM |
String | Mandatory if "info" severity |
| algorithm.parameters.length | Length of athe symmetric key algorithm Example: 256 |
Integer | Mandatory if "info" severity |
| algorithm.parameters.modulus_length | Length of thean asymmetric key algorithm Example: 2048 |
Integer | Mandatory if "info" severity |
| algorithm.parameters.hash |
Hash of the asymmetric key Example: SHA-256 |
String | Mandatory if "info" severity |
| usages |
Key usage Example: [‘encrypt’, ‘wrapKey’] |
String array | Mandatory if "info" severity |
| created_at | Key creation date | String | Mandatory if "info" severity |
| updated_at | Date the key was last updated | String | Mandatory if "info" severity |
| module |
Module for which the key was created Example : kas |
String | Mandatory if "info" severity |
| error |
JSON object containing an error code and a message indicating why the public key could not be retrievedcreated. Example: [ error: { code: 2006002, message: "Validation failed. Reasons are: [Wrong type error: /display_name property must be string]"
|
Object | Mandatory if "err" severity |
update_key action
The update_key action means that a key has been updated in the database.
This action generates an "info" severity log if the key is updated, or an "err" severity log in the event of an error.
The log fields for this action are as follows:
|
Field |
Description |
Type |
Mandatory/Optional |
|---|---|---|---|
|
tenant_id |
Tenant identifier Example: 025f02fe-bee2-444b-bf76-b5ead30327c0 |
String in uuid v4 format | Mandatory |
| key_id |
Identifier of the updated key Example: a25b5603-ed4e-41e0-bdd7-b157e4846ed8 |
String in uuid v4 format | Mandatory |
| updated_properties | Properties updated | Object | Mandatory if "info" severity. Must contain at least one updated property |
| updated_properties.display_name | Name of the new display name of the key | String | Mandatory if the status is not updated |
| updated_propertie.status | New status Example: compromised | String | Mandatory if the display name is not updated |
| updated_at | Date the key was updated | String | Mandatory if "info" severity |
| module |
Module for which the key was created Example : kas |
String | Mandatory if "info" severity |
| error |
JSON object containing an error code and a message indicating why the public key could not be updated. Example: [ error: { code: 2006002, message: "Validation failed. Reasons are: [Wrong type error: /display_name property must be string]"
|
Object | Mandatory if "err" severity |