Deploy keys and certificates to a module

Use this resource to deploy key manager certificates to a specific module keystore.

Request

To deploy a key or certificate, send a PUT request to the endpoint defined below.

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

The following table lists the parameters for this request.

Name Description Required Allowed values

Name	Description	Required	Allowed values
`keystoreFile`	Upload the keystore file containing the keys or certificates.	yes	Any attachment
`moduleName`	Enter the name of the module associated with the keystore.	yes	Any string
`owner`	Enter the name of the module owner.	yes	Any string
`alias`	Enter the alias of the keystore entry.	yes	Any string
`privateKeyPassword`	Enter the password for the private key.	yes	Any string
`propertyName`	Enter the name of the keystore property corresponding to the module.	yes	Any string

keystoreFile

Upload the keystore file containing the keys or certificates.

yes

Any attachment

moduleName

Enter the name of the module associated with the keystore.

yes

Any string

owner

Enter the name of the module owner.

yes

Any string

alias

Enter the alias of the keystore entry.

yes

Any string

privateKeyPassword

Enter the password for the private key.

yes

Any string

propertyName

Enter the name of the keystore property corresponding to the module.

yes

Any string

Different connectors use different property names. Refer to the following examples:

AS4 Keystore: AS4CPAKeyStoreContent
AS4 TrustStore: AS4CPATrustStoreContent
HTTP Connector Keystore: SSLKeyStore
Mail Connector: smime.keystore.data

Response

The response returns a JSON object confirming the deployment status.

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

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

Errors

This request might return one of the following error codes:

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.