Skip to main content

Documentation Index

Fetch the complete documentation index at: https://docs.futurex.com/llms.txt

Use this file to discover all available pages before exploring further.

CryptoHub supports both administration and key management access through the JSON API. You must create an application partition and its associated identity to enable authentication and communication through a JSON web request. The application partition specifies the administrative, key management permissions, and key access for the application identity.

​
Create an application partition

Perform the following steps to create an application partition:
1
Log in to the CryptoHub web dashboard under dual control with your Administrator users.
2
Select the gear icon in the upper-right corner of the page and go to Administration > User Management > Partitions.
3
Select [ Add ] and configure the following settings:
  • Basic Info
    • Role Name: Enter Zoho.
    • Login Count Requirement: Select Normal.
    • HSM Partition: Select Enabled.
    • Role Type: Select Principal.
  • Service Permissions: Select Zoho.
  • Permissions: Select the following permissions:
    • Crypto:Decrypt
    • Crypto:Encrypt
  • Advanced Info:
    • External Name (none)
    • REST API Login: Select Enabled.
    • Excrypt API Login: Select Disabled
    • KMIP API Login: Select Disabled.
4
Select [ Deploy ].

​
Create an application identity

Perform the following steps to create an application identity:
1
Log in to the CryptoHub web dashboard under dual control with your Administrator users.
2
Select the gear icon in the upper-right corner of the page and go to Administration > User Management > Applications.
3
Select [ Add ] and configure the following settings:
  • Basic Info
    • Login Name: Enter KeyManagerAPI.
    • Common Name: Enter KeyManagerAPI.
    • HSM Application: Enabled.
    • Locked: Disabled.
  • Partitions: Enter KeyManagerAPI.
  • Authentication: Select API Key.
4
Select [ Deploy ].
Your browser prompts you to download a text file api-key-KeyManagerAPI.txt containing the API key, which you can use for Web API authentication.