Deploy key / certificate

This endpoint deploys the provided key manager certificates into corresponding module keystore.

Request

URL: /keys

Method: PUT

Authorization: required (user with role System Administrator)

PUT /ibis/rest/keys HTTP/1.1
Accept: multipart/form-data
Host: localhost:8080

Request Parameters

Name Description Required Allowed values

keystoreFile

keystore File

yes

Any attachment

moduleName

Keystore associated Module

yes

Any string

owner

Owner of module

yes

Any string

alias

Alias of keystore

yes

Any string

privateKeyPassword

Private key password

yes

Any string

propertyName

Keystore property name corresponding to module

yes

Any string

Each connector uses a different property name i.e.

  1. AS4 Keystore - AS4CPAKeyStoreContent

  2. AS4 TrustStore - AS4CPATrustStoreContent

  3. Http Connector keystore - SSLKeyStore

  4. Mail connector - smime.keystore.data

Response

HTTP/1.1 200 OK
Content-Tye: application/json

{
  "responsedata": "Created/updated successfully."
}

Errors

Authorization Failed (401)

Authorization with the given username and password failed. Please revisit both values and provide valid credentials.

<html>

    <head>
        <title>Status page</title>
    </head>

    <body style="font-family: sans-serif;">
        <p style="font-size: 1.2em;font-weight: bold;margin: 1em 0px;">Unauthorized</p>
        <p>The request requires user authentication</p>
        <p>You can get technical details <a
                href="http://www.w3.org/Protocols/rfc2616/rfc2616-sec10.html#sec10.4.2">here</a>.<br>
            Please continue your visit at our <a href="/">home page</a>.
        </p>
    </body>
</html>
Server Error (500)

Execution on the INUBIT server failed. Have a look into the response message, otherwise access to the INUBIT log is required to retrieve further information.

Service Unavailable (503)

In maintenance mode the INUBIT server endpoint will not respond to incoming requests but return this error response. Once the maintenance mode is switched off the endpoint will respond normally.