Skip to main content

API Provider Setup Instructions

note

The Technical-User HSM Setup Password has a limited lifetime of 7 days from first usage. It is necessary to retrieve a permanent secret before the setup password expires.

IMPORTANT: In ECO-CC the lifetime is limited to 7 days from the date of issuance.

If you don’t accomplish to setup your application and connect to the HSM cluster within that time you have to contact Securosys through the Support Portal to renew the HSM Setup Password.

Securosys Support Portal

You have received an e-mail with your login user to the Securosys Support Portal. Please follow the instructions How to activate a new support portal account, and change your password on first access under your profile Personal Preferences – Security.

Download Primus API Provider

Retrieve the Primus API provider selected on your CloudHSM Service Order Form or Cloud Console for the respective API:

caution

Ensure you have the CloudHSM Service Credentials, obtained during the Activation Process - CloudHSM Service Credentials for in-person purchase, or Activation Process - Download the CloudHSM Service Credentials for online purchase, readily available to configure the API Providers.

caution

Remember to retrieve the permanent secret within the lifespan of the HSM Setup Password.

Initiate the CloudHSM User Account

Use the setup password to initiate your account, establish a first connection, and obtain the user secret for permanent integration. Follow the steps tailored to your chosen Primus API Provider.

tip

The network parameters (IP address / URLs) are provided as part of the onboarding process, either received alongside with the Welcome Support Ticket for in-person purchase or included in the Welcome email for online purchase. You can also find them listed on CloudHSM Connectivity Details page.

Rest API

Follow the Quickstart guide in the Rest-API section to set up your initial connection. It provides step-by-step instructions for configuring connections in both on-premises and CloudHSM environments.

Next, create your first key and sign a payload using this Tutorial to explore the library further.

Java Cryptography Extension

Follow the guidelines provided in the Java Cryptography Extension Quickstart section to set up your initial connection. The Quickstart section offers step-by-step instructions for configuring connections in both on-premises and CloudHSM environments, making the process straightforward.

Continue with the Java Cryptography Extension Tutorial to learn more about the library.

Microsoft CNG

Follow the guidelines provided in the Microsoft CNG Quickstart section to set up your initial connection. The Quickstart section offers step-by-step instructions for configuring connections in both on-premises and CloudHSM environments, making the process straightforward.

Continue with the Microsoft CNG Tutorial to learn more about the library.

PKCS#11 (Cryptoki)

Follow the guidelines provided in the PKCS#11 (Cryptoki) Quickstart section to set up your initial connection. The section offers step-by-step instructions for configuring connections in both on-premises and CloudHSM environments, making the process straightforward.

Continue with the PKCS#11 (Cryptoki) Tutorial to learn more about the library.