|
Purpose |
This operation is called to register a new managed object (certificate) at 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 POST method on the Key Manager REST interface (see [IF_KM]). |
||
|
Input |
Parameter |
Type |
Description |
|
authorization |
String |
ID token in the format: "Bearer: MII..." |
|
|
id |
String |
Object identifier of the management object to register |
|
|
value |
String |
Value of the management object to register |
|
|
objecttype |
String |
Object type of the management object to be registered Possible values: CERTIFICATE, CERTIFICATE_REQUEST, OPAQUE_OBJECT, PGP_KEY, PRIVATE_KEY, PUBLIC_KEY, SECRET_DATA, SPLIT_KEY, SYMMETRIC_KEY, X_USER, X_USER_GROUP |
|
|
attributes |
Attributes |
Attributes of the management object to be registered |
|
|
links |
Link[] |
Link between managed objects (refers to the linked object ID, a link type describes the object relationship) |
|
|
contentHint |
String |
Note on the content of the object |
|
|
Output |
Type |
Description |
|
|
|
200 |
Successful response {"id": "string", "value": "string", "objecttype": "string", "state": "string", "attributes": {"comment": "string", "name": ["string"]}, "dateattributes": { "activation": "srtring", "not-after": "string"}} |
|
|
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 43: Operation (POST) /objects
The 'Attributes' type has the following structure:
|
Component |
Type |
Description |
JSON definition |
|
comment |
String |
Comment |
{"comment":"[STRING]"} |
|
name |
String[] |
Attribute name |
{"name":"[STRING]"} |
|
activation |
String |
Date of activation |
{"activation":"[STRING]"} |
|
not-after |
String |
Date of revocation |
{"not-after":"[STRING]"} |
Table 44: Data type 'Attributes'
The 'Link' type has the following structure:
|
Component |
Type |
Description |
JSON definition |
|
id |
String |
Comment |
{"id":"[STRING]"} |
|
type |
String |
Attribute name |
{"type":"[STRING]"} |
Table 45: Data type 'Link'