Skip to content

Create an IBM API Connect machine

Create an IBM API Connect machine so Certificate Manager - SaaS can discover and provision the certificates that one IBM API Connect provider organization uses. Certificate Manager - SaaS connects to the IBM API Connect management endpoint through a VSatellite.

Before you begin

  • The System Administrator, PKI Administrator, or Resource Owner role. If you have the Resource Owner role, you must own or belong to at least one team.
  • An active VSatellite that can reach the IBM API Connect management (platform) endpoint.
  • IBM API Connect SaaS, or self-managed IBM API Connect version 10.0.x or later.
  • The universally unique identifier (UUID) of the provider organization that you want to connect. Each machine connects to one provider organization.
  • The client ID and client secret from the API Manager toolkit credentials.
  • Credentials for your deployment type:
    • SaaS: a platform REST API key.
    • Self-managed: the username and password of a provider organization user, and the user registry realm that the user belongs to, for example provider/default-idp-2.
  • An account with these permissions in the provider organization. The account doesn't need environment-wide administrator access.
    • For discovery, read access to keystores, TLS profiles, gateway services, catalogs, and consumer applications.
    • For provisioning, write access to keystores, TLS client profiles, and consumer applications.

To create an IBM API Connect machine

  1. Sign in to Certificate Manager - SaaS.
  2. Click Installations > Machines.
  3. Click New, and then select IBM API Connect.
  4. On the Properties step, in Name, enter a name for the machine.
  5. For Owning Team, choose the team that owns the machine. System Administrators and PKI Administrators can choose any team. Resource Owners can choose only a team they own or belong to.
  6. For VSatellite, choose a VSatellite that can reach the machine. A VSatellite that's the primary of a high availability group shows its number of active replicas, and Certificate Manager - SaaS can run the machine's operations on any healthy VSatellite in the group.

  7. For Authentication Method, choose how Certificate Manager - SaaS authenticates to IBM API Connect:

    • API Key (SaaS): uses a platform REST API key. This is the default.
    • Username and Password (Self-Managed): uses a provider organization user's username, password, and realm.
  8. In Management Endpoint Hostname, enter the hostname or IP address of the IBM API Connect management (platform) endpoint, without https:// or a path.

  9. (Optional) In Port, replace the default, 443, if the management endpoint listens on a different port.
  10. In Provider Organization ID, enter the UUID of the provider organization, not its name.
  11. In Client ID, enter the client ID from the API Manager toolkit credentials. The client ID is a UUID.
  12. In Client Secret, enter the client secret from the API Manager toolkit credentials.
  13. Enter the credentials for the authentication method you chose:

    • For API Key (SaaS), in API Key, enter the platform REST API key.
    • For Username and Password (Self-Managed), enter the provider organization user's Username and Password. In Realm, enter the user registry realm, for example provider/default-idp-2.

    Note

    Certificate Manager - SaaS encrypts the credentials you enter and doesn't display them again. On the machine's Properties tab, they appear masked. To keep a stored credential when you edit the machine, leave its masked value unchanged. Keep your own secure record of the credentials in case you need them again.

  14. Click Test Access. After the connection succeeds, click Continue. The Discovery step opens.

    Note

    A successful test confirms that Certificate Manager - SaaS can sign in to IBM API Connect and read the provider organization's keystores. If the test fails, check the credentials, the Provider Organization ID, and the account's read access to keystores.

  15. (Optional) To skip certificates that have already expired, enable Exclude Expired Certificates.

    Discovery finds the certificates that the provider organization uses for:

    • Gateway (SNI) hostnames: certificates in keystores that a TLS server profile uses and that a gateway service serves for a hostname through Server Name Indication (SNI).
    • Backend mutual TLS (mTLS): certificates in keystores that a TLS client profile uses for outbound connections.
    • Storage only: certificates in keystores that no TLS profile uses.
    • Consumer applications: the public certificates registered on consumer applications in each catalog.

    Discovery imports each certificate and its chain, but not its private key. A keystore certificate gets one installation for each gateway hostname and each TLS client profile that uses it.

  16. (Optional) To discover certificates on a schedule, enable Schedule. For Repeat every, choose Day, Week, or Month, and then in At, enter the time. For Week, select the days of the week. For Month, enter the days in Day of month. Times are in Coordinated Universal Time (UTC).

  17. Click Continue. The Provisioning step opens.
  18. (Optional) To provision certificates on a schedule, enable Schedule. For Repeat every, choose Day, Week, or Month, and then in At, enter the time. For Week, select the days of the week. For Month, enter the days in Day of month. Times are in Coordinated Universal Time (UTC).

    Scheduled provisioning pushes only certificates that are queued for deployment, such as renewed certificates, so renewals install during the window you choose.

  19. Click Finish.

What's next?

After you create the machine, provision a certificate to it. You can also run discovery on the machine at any time to track the certificates in your provider organization.