Skip to content

Provision certificates to IBM API Connect

Provision a certificate from Certificate Manager - SaaS to an IBM API Connect provider organization. Certificate Manager - SaaS installs the certificate in a keystore or on a consumer application, and can point a TLS client profile at the keystore for backend mutual TLS (mTLS).

Renewing certificates that a gateway already serves

IBM API Connect doesn't let Certificate Manager - SaaS change the keystore that a gateway's TLS server profile uses. To renew a certificate that a gateway serves for a hostname, provision to the installation that discovery created for that certificate, or enter the ID of the keystore that the TLS server profile already uses. Certificate Manager - SaaS then updates that keystore in place. If you leave Keystore ID empty, Certificate Manager - SaaS creates a new keystore, and the gateway keeps serving the old certificate until you assign the new keystore to its TLS server profile in IBM API Connect.

Before you begin

  • An IBM API Connect machine that you created and whose status is Verified.
  • The certificate to provision in the Certificate Manager - SaaS inventory, with its private key.
  • The System Administrator or PKI Administrator role, or the Resource Owner role and membership in the machine's owning team.
  • The IDs of the IBM API Connect objects you want to update: the keystore and TLS client profile, or the catalog, consumer organization, and consumer application.

To provision a certificate to IBM API Connect

  1. Sign in to Certificate Manager - SaaS.
  2. Click Installations > Machines.
  3. Click the more options button at the end of the machine's row, and then select Provision.
  4. In Search a certificate by name, expiration or fingerprint, enter part of the certificate's name, expiration date, or fingerprint, and then select the certificate from the results. Confirm that it's the right certificate by checking Subject DN, Validity, and Certificate SHA1 Fingerprint.

    The rest of the Provision a certificate dialog appears after you select a certificate.

  5. Under Certificate Information, for Certificate Home, choose where IBM API Connect stores the certificate:

    • Keystore: installs the certificate, its chain, and its private key in a keystore. This is the default.
    • Consumer Application: replaces the public certificate registered on a consumer application. The private key isn't sent.
  6. If you chose Keystore, in Keystore ID, enter the ID of an existing keystore to update. Leave it empty to create a new keystore. Later renewals update the same keystore.

  7. If you chose Consumer Application, enter these universally unique identifiers (UUIDs):

    • In Catalog ID, enter the UUID of the catalog in the provider organization.
    • In Consumer Organization ID, enter the UUID of the consumer organization.
    • In Application ID, enter the UUID of the consumer application whose public certificate you want to replace.
  8. Under Installation Endpoint, for Binding Type, choose how IBM API Connect uses the certificate:

    • Keystore Only: stores the certificate without connecting it to a TLS profile. This is the default.
    • API Gateway (SNI): renews a certificate that a gateway service serves for a hostname through Server Name Indication (SNI), by updating its keystore in place. Use it with an existing Keystore ID.
    • Backend mTLS: points a TLS client profile at the keystore, so outbound mTLS connections present the certificate.

    Note

    For the Consumer Application certificate home, keep Keystore Only. A consumer application certificate has no TLS profile to update.

  9. If you chose Backend mTLS, in TLS Client Profile ID, enter the UUID of the TLS client profile to update.

  10. (Optional) To save the installation without pushing the certificate now, disable Push certificate on save.
  11. Click Save. To save and then provision another certificate, click Save & New.

After you save, Certificate Manager - SaaS pushes the certificate to IBM API Connect:

  • Keystore: Certificate Manager - SaaS updates the certificate, chain, and private key in the keystore you specified, or saves them to a new keystore. For Backend mTLS, it then updates the TLS client profile to use the keystore. For API Gateway (SNI), the gateway serves the renewed certificate through its existing TLS server profile, with no gateway change.
  • Consumer Application: Certificate Manager - SaaS replaces the application's public certificate with the new certificate and its chain.

An installation appears on the machine's Installations tab. To provision on a schedule instead of right away, set up a machine provisioning schedule.