SigningHub Integration
SigningHub is one of the major in-house products of Ascertia used for document signing. ADSS Web RA facilitates to generate certificates and these certificates can be used later for document signing purposes within SigningHub, once these certificates are auto provisioned to SigningHub application.
How it Works?
- You can integrate SigningHub application with ADSS Web RA, by configuring a connector and setup that connector under your service plan and that service plan can be assigned to an enterprise account at registration time. Select a default certificate profile for SigningHub, if you want to generate a default certificate at registration time and push this to SigningHub application. These certificates will be auto provisioned in SigningHub which later can be used for document signing purposes.
- By default, the Create button will appear allowing you to create a new integration account for the first time. This can be done from Dashboard or by navigating to SigningHub Integration App option from left panel (i.e. application name that was used while creating app under SigningHub). You need to create a Virtual ID as a prerequisite if it's not yet been created. Once your Virtual ID account successfully created, you can create an integrated application for SigningHub. A certificate request with a Pending status will appear under Certificate Requests list, and once it is reviewed by Admin RAO then it will be shown as Reviewed status. You can view your request details. Same certificate request will also be shown under Issued Certificate list.
- If you have already created an integrated application for SigningHub under ADSS Web RA, then you can create a certificate request using icon on top right. Provide all required information and your certificate request will appear with a Pending status under Certificate Requests list, and once it is reviewed by Admin RAO then it will be shown as Reviewed status.
- A certificate request once created, will appear in Draft state (if it's not completed), click on icon and select Edit to complete a certificate request. Provide all required information and generate certificate request using same steps as mentioned above.
|
One Time password (OTP) can be set as an authentication at the time of request submission for certificate issuance and revocation, based on certificate criticality. See details in External Services > Connectors> SMS Gateway. |
Configure SigningHub Integration
- First create an integrated application under SigningHub application.
- A SigningHub connector must be configured under External Services > Connectors, by selecting SigningHub as a provider. Provide API URL and SigningHub App name (configured in SigningHub Application).
- Configure a new service plan or use an already configured service plan, to setup SigningHub Connector under Profile Settings. New users and their certificates will be auto provisioned to SigningHub instance that is configured under selected connector.
- Select a default certificate profile for SigningHub under Service Plan > Profile Settings, if you want to generate a default certificate at registration time and push this to SigningHub application.
Create Certificate Requests
If you have already created an integration app account, then follow the steps to create a certificate request.
- You can create a certificate request, using icon on top right.
- Select Certificate Type and click CREATE to generate a certificate request.
- Provide all the required information, as required by RA (Registration Authority) to complete vetting process.
- Select validity period (if allowed by Admin RAO) for the certificate validity. Click on GENERATE to complete a certificate request.
- Email notification will be sent to RA (Registration Authority) for request approval.
|
1) Once an integration App account created, a certificate will also be generated with an Approved status if no approval required by RA (Registration Authority). |
All the certificate requests related to the user will be listed here. See the following table for the column headers description:
Field |
Description |
Request No |
This column displays the unique auto generated request number against each certificate request. Click on it to view the details of the certificate request. |
Request Type |
This column displays the name of your integration app (that is configured under SigningHub) against each certificate. |
Certificate Purpose |
This column displays the purpose/ type of each requested certificate, i.e. Document Signing etc. |
Status |
This column displays the current status of each certificate request, i.e. Approved, Declined, or Pending. It also shows the date on which the request status was put up. Declined: A certificate request that has been turned down by RA (Registration Authority). The declined requests imply that the certificates issuance has been refused against them. Pending: A certificate request that has not been processed by RA (Registration Authority) as yet. The pending requests imply that the RA (Registration Authority) need to review the vetting details and take appropriate actions (i.e. Approve or Decline) against them. Draft: A certificate request that has been created but not processed by user yet. The draft requests imply that the user needs to fill the vetting details and take appropriate actions (i.e. Create, Submit) against them. |
|
1) Certificate will be generated on approval of request. An email and on screen notification will be received to user on approval. |
View Issued Certificates
Once a certificate is approved, it will be shown under [SigningHub_Integration_App] > Issued Certificates list with Issued status. See following table for the each column header details.
Field |
Description |
Request No |
This column displays the unique auto generated request number against each certificate request. Click on it to view the details of the certificate request. |
Common Name |
This column displays the common name of each certificate. |
Certificate Purpose |
This column displays the purpose of each requested certificate, i.e. Document Signing etc. |
Capacity Name |
This column displays the name of certification profile that is used to generate that intended certificate. |
Status |
This column displays the current status of each certificate, i.e. Issued, Revoked, or Expired. Revoked: A certificate that has been revoked/ cancelled by RA (Registration Authority). The revoked certificates cannot be used by the users. Expired: A certificate that has been expired as per its configured time period. The expired certificates cannot be used by the users till they are renewed. Pending Revocation: A certificate request for revocation has been sent to RA (Registration Authority). |
Expiry Date |
This column displays the date of each certificate on which they will expire. |
|
Certificate Revocation Requests
- Click [SigningHub_Integration_App] > Revocation Requests from the left menu.
- Search the certificate for which revocation is required and click adjacent to it from the main grid and select Revoke.
- A confirmation message will appear. Click YES.
- Provide the information required by RA (Registration Authority) for revocation process.
- Click Revoke.
- Request will be submitted to RA (Registration Authority) for revoke certificate.
- Email Notification will be sent to RA (Registration Authority) for revocation approval request.
- Certificate will be revoked on approval of request. You will receive an email and on screen notification.
- Request status will be changed to Approved and certificate with status Revoked will be available in [SigningHub_Integration_App] > Issued Certificates list.
|
Certificate status under Issued Certificates list will remain as Pending Revocation until request approved by enterprise RAO. |
Settings
- Click [SigningHub_Integration_App] > Settings from the left menu. You will be shown SigningHub Integration App account settings.
- Click on Remove [SigningHub_Integration_App] ID Account link.
- A confirmation message will appear. Click Yes to remove your configured SigningHub Integration account.
- Count for all Provisioned Certificates will appear, and on click Provisioned Certificates Count it redirects you to Issued Certificates list.
|
1) Once you deleted your [SigningHub_Integration_App] account, all its associated requests and certificates will be removed permanently. |
Access Control Information
There are certain rules that will be followed while managing or viewing certificates requests list and it's related information. These rules are based on the user's type which includes Enterprise RAOs, Admin RAOs or Administrators.
Roles |
Allowed Features |
Enterprise RAO |
|
Admin RAO |
|
Administrators |
|