Certificate Manager
Introduced in SwaggerHub On-Premise 1.19.2.
Use the Certificate Manager in the Admin Center to store and manage SSL/TLS certificates used by SwaggerHub On-Premise: the certificate for HTTPS access, and trusted certificates for LDAP connections. You can also view details for each certificate, such as the expiration date, common name (CN), issuer, and so on.
Certificate requirements
Before uploading any certificates, see the requirements for SSL certificates, load balancer trusted certificates and trusted LDAPS certificates.
Upload a certificate
In the Certificate Manager, click Import Certificate.
Browse for the Certificate File (typically a PEM file).
If this certificate is for the SwaggerHub server itself (for HTTPS access), specify the Private Key. The private key must be in the PKCS #8 format and not encrypted. Paste the key value exactly as it was generated, including the
BEGIN PRIVATE KEY
andEND PRIVATE KEY
lines.Specify a Friendly Name and an optional Description for this certificate.
Click Import.
In the Admin Center, go to the Settings page, apply this certificate via the corresponding option in SSL settings or LDAP settings.
Click Save Changes and Restart. Wait a few minutes for the system to restart completely.
View certificate information
The Certificate Manager displays certificate information in the following columns. You can sort and filter by any columns.
Note
If a certificate file contains multiple certificates (for example, intermediate and root), the displayed information is for the first certificate only.
Column | Description |
---|---|
Friendly Name | A unique display name for this certificate. |
Common Name | The CN field of the certificate. This is typically a domain name ( |
Private Key | Indicates whether a private key was provided along with the certificate. A private key is required for the SwaggerHub server certificate. Note: This flag is based on whether a key was specified in the Private Key field on the certificate import screen. It does not indicate keys included in the certificate files. |
Used By | Indicates how the certificate is used. SSL indicates the SwaggerHub server certificate and trusted certificates used in the option. LDAP indicates trusted certificates for LDAP connections. |
Expires In | Shows how many days are left until the certificate expires. Certificates that expire within the next 30 days are highlighted in red. |
Expand the rows in the table to view other details, including the certificate Issuer, SAN, and Description.
Download a certificate
Click next to the needed certificate in the list.
Replace a certificate
You can replace a certificate, for example, if it is about to expire.
Upload the new certificate to the Certificate Manager.
In the Admin Center, go to the Settings page and apply the new certificate via the corresponding option in SSL settings or LDAP settings.
Click Save Changes and Restart for the certificate change to take effect.
Delete the old certificate from the Certificate Manager.
Delete a certificate
Before deleting a certificate, make sure that:
It is not used (the Used By column is empty).
You have a backup copy of any important certificates and their private keys.
To delete a certificate, click next to this certificate in the Certificate Manager.