ZTPKI CA

To use the ZTPKI CA driver, you must generate API keys (HAWK IDs) in the ZTPKI portal to authenticate Trust Protection Foundation. The API uses Hawk authentication, which combines a public ID with a private secret (Key).

Best Practices and Account Limits

  • Recommended Role: While any user with organization access can create API keys, we recommend using a Service Requestor account. This is a non-login account managed by Organization Admins or higher.

  • Key Limits: You can generate up to 10 API keys per Service Requestor account. There is no limit to the number of Service Requestor accounts you can create in your organization.

  • Notifications: Skip adding a distribution list to the Service Requestor account. Since you are using Trust Protection Foundation for certificate management, relying on ZTPKI for expiry emails will create redundant alerts (extra noise).

Generating API Credentials in ZTPKI

  1. Log in to the ZTPKI CA web portal.

  2. Create an API key.

  3. Click Users.

  4. Select the user to add a key for.

  1. In API Keys, click Add API Key.

  2. In API Key Details, copy the ID and Key.

    NOTE: The ID remains visible in the portal, but the Key is only displayed once. If you forget to copy the Key, simply roll (replace) the key to generate a new one. Since the key is brand new, rolling it will not disrupt any services. For more information on rolling and managing keys in ZTPKI, refer to Manage API keys.

  3. Click Close.

Configuring Trust Protection Foundation

Once your keys are generated, add them to Trust Protection Foundation so they can be linked to your CA Template Object.

  1. In Trust Protection Foundation, create a Username Credential. For instructions, refer to Creating user name or password credentials.

  2. Paste the copied ID into the User Name field.

  3. Paste the copied Key into the Password field.

  4. Save the credential. You will link this credential to the API Credential field when configuring your ZTPKI CA Template Object.

The following topics include the steps required to set up the ZTPKI CA.

TIP  To browse topics in this section, use the menu on the left side of this page.