HydrantID CA

Prerequisites

The prerequisites for configuring a HydrantID CA account in AppViewX as follows:
  1. To create a CA configuration the following values are required:
    • Base URL
    • API Key ID
    • API Key

    Once the organization (AppViewX) has subscribed for a HydrantID account, you will be provided with a Username, Password, and Login URL.

  2. The API Key ID and API Key should be of the following User Roles in HydrantId:
    • Account Auditor
    • Organization Admin
    • Organization Auditor
    • Requestor
  3. Users with role Account Admin in the HydrantID application can create the above roles. Only account admins can generate the API Key ID and API Key for the roles. Both values can be viewed for a limited time only. Ensure to note these values after the roles are added.

Configuring HydrantID CA

  1. Go to (Menu) > SIGN+ > ADMINISTRATION > Certificate Authority.
  2. From the displayed CA, select HydrantID.
    The HydrantID home page is displayed.
  3. Click the Configure Now button or +Add icon from the middle or top-right of the page respectively.
    The HydrantID CA details page is displayed.
  4. Update the following details in the General Information section as described in the table:
    Table 1. General Information - Field Description Table
    Fields Description
    *CA Account name A unique name to identify the CA setting.

    Permissible special characters are ‘.’, ‘-’,’_’. Names should not start with special characters.

    *Purpose/Usage Certificate Type for which CLM actions will be enabled.

    Server, Client and Code-signing are the supported types.
    Proxy Required Enable this field if the CA communication needs to happen via Proxy. The proxy details configured in general settings will be used for communication.
    Data Center (AppViewX's CA agent) Select the data center through which the CA communication needs to happen.
    *: Mandatory fields
  5. Update the following details in the CA Configuration section as described in the table. These fields are necessary for invoking the HydrantId APIs for Certificate Management.
    Table 2. CA Configuration - Field Description Table
    Fields Description
    *Base URL This URL will contain the hostname of the HydrantID CA instance and used for constructing the API requests. the default value is https://acm.hydrantid.com/api/v2
    *API Key ID Enter the API Key ID generated in the HydrantID application. Its is a unique value specific to the user created in hydrant and is used to authenticate the user.
    *API Key Enter the API Key generated in the HydrantID application. Its is a unique value specific to the user created in hydrant and used to authenticate and authorize requests.
    *: Mandatory fields
  6. Click Fetch hydrantID policies.
    A list of policies associated with the account are displayed. These are made available from HydrantID and are used for requesting different types of certificates.
    Note: Configuration can only be saved in AppViewX if the profiles are available.
  7. Update the following details in the Advanced Settings section as described in the table.
    Table 3. Advanced Settings - Field Description Table
    Fields Description
    Poll after CSR Submission A check box field when selected will fetch the certificated immediately after CSR Submission on enrollment, renew, and reissue of certificate with the retry count and retry frequency as described below.
    *Retry Count The number of times the polling will take place after CSR submission. Enter a value between 1 and 10.
    *Retry Frequency The duration of the polling. enter the value between 1 and 30seconds.
    *: Mandatory fields
  8. Click Save.
    The created HydrantID configuration settings will be added. A pop-up message is displayed as <CA_name> Settings Added.

Validating HydrantID CA

Once the HydrantID settings are added, validation needs to be done to check whether the connection between AppViewX and HydrantID is properly configured.
  1. Go to (Menu) > SIGN+ > ADMINISTRATION > Certificate Authority.
  2. From the displayed CA, select HydrantID.
    The HydrantID home page is displayed.
  3. In the Status column of the grid with the listed accounts, click Check to validate the CA setting that has been created.
    The CA communication will be validated and the Connection Status will be shown as either Success or Failure