The operations listed are explained in more detail below with regard to their use, parameters and error cases.
|
Purpose |
This operation is called to query the objects of the PRIVATE_KEY type with the ACTIVE status present in the Key Manager. |
||
|
Interface |
Key Manager REST Interface (siehe [IF_KM]) |
||
|
Method of use |
The operation is called by a client software according to the specification as a GET method on the Key Manager REST interface (see [IF_KM]). |
||
|
Input |
Parameter |
Type |
Description |
|
authorization |
String |
ID token in the format: "Bearer: MII..." |
|
|
return |
Object |
Specifies the data fields to be returned with respect to found objects. If this parameter is omitted, all data fields will be returned |
|
|
id |
String |
Object identifier as query parameter for filtering the result |
|
|
state |
String |
Object status as query parameter to filter the result Possible values: PRE_ACTIVE, ACTIVE, DEACTIVATED, COMPROMISED, DESTROYED, DESTROYED_COMPROMISED |
|
|
objecttype |
String |
Objekttyp als Query-Parameter zur Filterung des Ergebnisses. Possible values: CERTIFICATE, CERTIFICATE_REQUEST, OPAQUE_OBJECT, PGP_KEY, PRIVATE_KEY, PUBLIC_KEY, SECRET_DATA, SPLIT_KEY, SYMMETRIC_KEY, X_USER, X_USER_GROUP |
|
|
attribute- params |
Object |
Attributes as query parameters to filter the result Usage: $AttributeName;$QueryExpression=$FilterValue [;$QueryExpression=$FilterValue] Example: name;contains=service&serialnumber; startsWith=1234&fresh=false |
|
|
|
objecttype |
String |
Type of the found object |
|
state |
String |
Status of the found object |
|
|
attributes |
Attributes |
Attributes of the found object |
|
|
dateattributes |
DateAttributes |
Validity period of the found object |
|
|
Error messages |
Type |
Reason |
|
|
400 |
Invalid request {"type": "string", "title": "string", "detail": "string", "instance": "string", "status": "string", "additionalData": {}} |
||
|
401 |
Unauthorized access to the resource {"type": "string", "title": "string", "detail": "string", "instance": "string", "status": "string", "additionalData": {}} |
||
|
403 |
Access to the resource forbidden {"type": "string", "title": "string", "detail": "string", "instance": "string", "status": "string", "additionalData": {}} |
||
|
500 |
Internal server error {"type": "string", "title": "string", "detail": "string", "instance": "string", "status": "string", "additionalData": {}} |
||
Table 39: Operation /private-keys
The 'Attributes' type has the following structure:
|
Component |
Type |
Description |
JSON definition |
|
comment |
String |
Comment |
{"comment":"[STRING]"} |
|
name |
String |
Attribute name |
{"name":"[STRING]"} |
Table 40: Data type 'Attributes'
The 'DateAttributes' type has the following structure:
|
Component |
Type |
Description |
JSON definition |
|
activation |
String |
Date of activation |
{"activation":"[STRING]"} |
|
not-after |
String |
Date of revocation |
{"not-after":"[STRING]"} |
Table 41: Data type 'DateAttributes'