JOC API

/profile/key/store

POST

stores a new Public Key, a Certificate or Private key (ASCII format only)

Parameters in the POST body schema

Name	Type	Description	Example	Default
`keys`	required, object	object can contain the following fields: privateKey, string, optional publicKey, string, optional certificate, string, optional keyAlgorithm, string, required	{ "keys" : { "privateKey" : "-----BEGIN PGP PRIVATE KEY BLOCK-----\nVersion: BCPG v1.65\n\nlQO+BF6X8mMBCADJubBsqhEh8l/kY5Q3TwRn1ALceNVXJUnd9ERkD4/kox...", "keyAlgorithm" : "PGP" } }
`privateKey`	optional, string	Private Key (PGP, RSA, ECDSA)	"privateKey" : "-----BEGIN PGP PRIVATE KEY BLOCK-----\nVersion: BCPG v1.65\n\nlQO+BF6X8mMBCADJubBsqhEh8l/kY5Q3TwRn1ALceNVXJUnd9ERkD4/kox..."
`publicKey`	optional, string	Public Key (PGP, RSA, ECDSA)	"publicKey" : "-----BEGIN PGP PUBLIC KEY BLOCK-----\nVersion: BCPG v1.65\n\nmQENBF6X8mMBCADJubBsqhEh8l/kY5Q3TwRn1ALceNVXJUnd9ERkD4/kox..."
`certificate`	optional, string	X.509 Certificate (only for RSA/ECDSA Private Keys)	"certificate" : "-----BEGIN CERTIFICATE-----\nMIIF2DCCA8CgAwIBAgIJAMxQSEdXten9MA0GCSqGS..."
`keyAlgorithm`	required, string	key algorithm: PGP, RSA, ECDSA	"keyAlgorithm" : "RSA"	RSA
`auditLog`	optional, object	Object that contains `comment`, `timeSpent` and `ticketLink`.	{ "comment": "Operational requirement!", "timeSpent": 2 }
`comment`	optional, string	Field in `auditLog` to comment this action, e.g. the reason.
`timeSpent`	optional, integer	Field in `auditLog` to enter the time spent in minutes.
`ticketLink`	optional, string	Field in `auditLog` to enter a link to a corresponding ticket.

Request

Name

Description

Example

Type

Constraints

Default

Headers

X-Access-Token*

Request requires authentication!

550e8400-e29b-11d4-a716-446655440000

string

Body

application/json

model | example

{
    "title": "set key filter",
    "$schema": "http://json-schema.org/draft-04/schema#",
    "javaType": "com.sos.joc.model.publish.SetKeyFilter",
    "type": "object",
    "required": [
        "keys"
    ],
    "properties": {
        "keys": {
            "javaType": "com.sos.joc.model.sign.JocKeyPair",
            "type": "object",
            "required": [
                "keyAlgorithm"
            ],
            "properties": {
                "privateKey": {
                    "type": "string"
                },
                "publicKey": {
                    "type": "string"
                },
                "keyID": {
                    "type": "string"
                },
                "certificate": {
                    "type": "string"
                },
                "validUntil": {
                    "type": "string",
                    "format": "date-time"
                },
                "keyType": {
                    "type": "string"
                },
                "keyAlgorithm": {
                    "type": "string"
                }
            }
        },
        "auditLog": {
            "javaType": "com.sos.joc.model.audit.AuditParams",
            "type": "object",
            "properties": {
                "comment": {
                    "type": "string",
                    "pattern": "^[^<>]*$",
                    "maxLength": 255
                },
                "timeSpent": {
                    "type": "integer",
                    "minimum": 0
                },
                "ticketLink": {
                    "type": "string",
                    "pattern": "^[^<>]*$",
                    "maxLength": 255
                }
            }
        }
    }
}

{ "keys": { "privateKey": "-----BEGIN PGP PRIVATE KEY BLOCK-----\nVersion: BCPG v1.65\n\nlQO+BF6X8mMBCADJubBsqhEh8l/kY5Q3TwRn1ALceNVXJUnd9ERkD4/kox...", "keyAlgorithm": "PGP" } }

{
    "keys": {
        "privateKey": "-----BEGIN PGP PRIVATE KEY BLOCK-----\nVersion: BCPG v1.65\n\nlQO+BF6X8mMBCADJubBsqhEh8l/kY5Q3TwRn1ALceNVXJUnd9ERkD4/kox...",
        "keyAlgorithm": "PGP"
    }
}

Responses

Code	Description	Body
200	Confirm store successfully	application/json model \| example { "title": "ok answer", "$schema": "http://json-schema.org/draft-04/schema#", "javaType": "com.sos.joc.model.common.Ok", "type": "object", "required": [ "deliveryDate", "ok" ], "properties": { "deliveryDate": { "description": "Value is UTC timestamp in ISO 8601 YYYY-MM-DDThh:mm:ss.sZ or empty", "type": "string", "format": "date-time" }, "surveyDate": { "description": "Value is UTC timestamp in ISO 8601 YYYY-MM-DDThh:mm:ss.sZ or empty", "type": "string", "format": "date-time" }, "ok": { "type": "boolean" } } } { "deliveryDate": "2020-05-05T21:13:35Z", "ok": true } { "deliveryDate": "2020-05-05T21:13:35Z", "ok": true }
401	Unauthorized!	application/json model \| example { "title": "authentication", "$schema": "http://json-schema.org/draft-04/schema#", "type": "object", "required": [ "isAuthenticated" ], "properties": { "user": { "type": "string" }, "accessToken": { "type": "string" }, "message": { "type": "string" }, "role": { "type": "string" }, "isAuthenticated": { "type": "boolean" }, "isPermitted": { "type": "boolean", "default": false }, "sessionTimeout": { "type": "integer", "default": 1800 }, "enableTouch": { "type": "boolean", "default": true } } } { "user": "root", "message": "Oops!", "isAuthenticated": false, "isPermitted": false } { "user": "root", "message": "Oops!", "isAuthenticated": false, "isPermitted": false }
403	Forbidden! The user doesn't have sufficient permissions for 'store'	application/json model \| example { "title": "authentication", "$schema": "http://json-schema.org/draft-04/schema#", "type": "object", "required": [ "isAuthenticated" ], "properties": { "user": { "type": "string" }, "accessToken": { "type": "string" }, "message": { "type": "string" }, "role": { "type": "string" }, "isAuthenticated": { "type": "boolean" }, "isPermitted": { "type": "boolean", "default": false }, "sessionTimeout": { "type": "integer", "default": 1800 }, "enableTouch": { "type": "boolean", "default": true } } } { "user": "root", "message": "You don't have sufficient permissions for ...", "role": "all", "isAuthenticated": true, "isPermitted": false } { "user": "root", "message": "You don't have sufficient permissions for ...", "role": "all", "isAuthenticated": true, "isPermitted": false }
420	'store' failed!	application/json model \| example { "title": "error object with delivery date", "$schema": "http://json-schema.org/draft-04/schema#", "javaType": "com.sos.joc.model.common.Err420", "type": "object", "required": [ "deliveryDate", "error" ], "properties": { "deliveryDate": { "description": "Value is UTC timestamp in ISO 8601 YYYY-MM-DDThh:mm:ss.sZ or empty", "type": "string", "format": "date-time" }, "surveyDate": { "description": "Value is UTC timestamp in ISO 8601 YYYY-MM-DDThh:mm:ss.sZ or empty", "type": "string", "format": "date-time" }, "error": { "javaType": "com.sos.joc.model.common.Err", "type": "object", "required": [ "code", "message" ], "properties": { "code": { "type": "string" }, "message": { "type": "string" } } } } } { "deliveryDate": "2016-05-05T21:13:35Z", "surveyDate": "2016-05-05T21:13:33Z", "error": { "code": "JOC-420", "message": "store failed!" } } { "deliveryDate": "2016-05-05T21:13:35Z", "surveyDate": "2016-05-05T21:13:33Z", "error": { "code": "JOC-420", "message": "store failed!" } }
440	Login Timeout! The client's session has expired and must log in again.	application/json model \| example { "title": "authentication", "$schema": "http://json-schema.org/draft-04/schema#", "type": "object", "required": [ "isAuthenticated" ], "properties": { "user": { "type": "string" }, "accessToken": { "type": "string" }, "message": { "type": "string" }, "role": { "type": "string" }, "isAuthenticated": { "type": "boolean" }, "isPermitted": { "type": "boolean", "default": false }, "sessionTimeout": { "type": "integer", "default": 1800 }, "enableTouch": { "type": "boolean", "default": true } } } { "user": "root", "message": "Session has expired. Please log in again", "role": "all", "isAuthenticated": false, "isPermitted": false } { "user": "root", "message": "Session has expired. Please log in again", "role": "all", "isAuthenticated": false, "isPermitted": false }