- Created by Ann Base, last modified by Karolin Hemmingsson on Jan 10, 2020
You are viewing an old version of this page. View the current version.
Compare with Current View Page History
« Previous Version 12 Next »
This article describes how to connect Smart ID Digital Access component (Hybrid Access Gateway) to Nexus Personal Messaging that can either be installed on-premises or consumed as a service via Nexus GO Messaging. Personal Messaging is a web-based service for online authentication and signing using Smart ID Mobile App (Personal Mobile) or Nexus Personal Desktop with certificates.
For more information on the communication between Hybrid Access Gateway and Personal Messaging, see Architecture overview - Nexus Personal Messaging and Hybrid Access Gateway.
Prerequisites
The following prerequisites apply:
- Nexus Personal Messaging is installed on-premises or consumed as a service via Nexus GO Messaging.
- If Nexus GO Messaging is used, the access point must be protected by a public certificate, see Add certificates. When deploying a server certificate, its certificate chain up to the root shall also be added in CA certificates.
- If the Personal Mobile profile data was first created in Hybrid Access Gateway, that must first be migrated to Nexus Personal Messaging or Nexus GO Messaging. See Digital Access component news.
Step-by-step instructions
- Log in to the Hybrid Access Gateway administration interface with your admin user.
If you use Nexus GO Messaging, then you first need to request an API key from Nexus.
To request a Nexus GO Messaging API key:
Find your Nexus GO Messaging callback URL:
In the Hybrid Access Gateway administration interface, go to Manage System > Policy Services.
- Click Manage Global Policy Service Settings....
Copy Personal Messaging Callback URL, and replace <access-point-public-host> with your DNS name.
Default: Personal Messaging Callback URLhttps://<access-point-public-host>/https/api/rest/v3.0/personalmessaging
- Request an API key from Nexus by sending an email with the callback URL to Nexus support: support@nexusgroup.com.
When you have received a reply, you can go on to the following tasks.
To set up the connection to Personal Messaging:
- In the Hybrid Access Gateway administration interface, go to Manage system > Policy Services.
- Click Manage Global Policy Service Settings....
- Check Enable Provisioning.
Enter Provisioning Settings, that will apply to all policy services. Click the ?-sign for more information.
In Personal Messaging URL, enter a valid URL:
For Personal Messaging on-premises, enter the URL as it has been configured in Personal Messaging.
In this example, the default path is shown. If you have changed the path when you installed Personal Messaging, enter your configured path here. For more information, see Install Hermod:Example: Personal Messaging URL for Personal Messaging on-premiseshttps://<personalmessaging-public-host>/hermod/rest/command
For Nexus GO Messaging, enter the following URL:
Example: Personal Messaging URL for Nexus GO Messaginghttps://messagingservice.go.nexusgroup.com/command
In Image API URL, replace <access-point-public-host> with your DNS name.
- Enter an X API Key:
- For Personal Messaging on-premises, enter an API Key that has been generated in Personal Messaging. For more information on how to generate a key, see Add API user and callback URL in Hermod.
- For Nexus GO Messaging, enter the X API key as received by Nexus.
- If required, enter your own Attestation Key, which is used to sign provisioning responses.
There is a default Attestation Key stored, but it can be required to upload your own key, for example if you use the Smart ID Mobile SDK. - If you upgrade from version 5.12 or earlier of Hybrid Access Gateway, and already use Personal Mobile, you need to migrate these profiles to Nexus Personal Messaging (see Digital Access component news). Enter a Messaging Service Public URL. This is the URL that the existing Personal Mobile profiles will be redirected to at the very first call after the migration. After that, the Personal Mobile profile will memorize the new URL and use it for later calls.
For Personal Messaging on-premises, enter the URL as it has been configured in Personal Messaging.
In this example, the default path is shown. If you have changed the path when you installed Personal Messaging, enter your configured path here. For more information, see Install Hermod:Example: Messaging Service Public URL for Personal Messaging on-premiseshttps://<personalmessaging-public-host>/hermod/rest/ms
For Nexus GO Messaging:
Example: Messaging Service Public URL for Nexus GO Messaginghttps://messagingservice.go.nexusgroup.com/ms
This is supported from Smart ID Mobile App (Personal Mobile) version 3.10.
- For help on other input fields, click the ?-sign for more information.
The Personal Mobile app must be able to receive images during the authentication process. For this, a public available web resource as well as the Image API must be enabled.
To be able to receive images from the Distribution Service over the Access Point the corresponding web resource must be enabled:
- In the Hybrid Access Gateway administration interface, go to Manage Resource Access.
- Select the registered distribution-service web resource.
- Click Edit Resource Host.
- Check Enable resource.
- Click Save.
The Image API must be enabled:
- In the Hybrid Access Gateway administration interface, go to Manage System > Distribution Services.
- Select the registered Distribution Service.
- Check Enable Image API.
- Click Save.
To make Hybrid Access Gateway trust Personal Messaging, the Personal Messaging certificate authority (CA) must be added in Hybrid Access Gateway:
Locate the CA certificate files:
For on-premises installation of Personal Messaging, locate the SSL certificate that was used to set up Personal Messaging.
For Nexus GO Messaging, download the following CA certificate file:
Digicert intermediate CA: Digicert_SHA2_intermediate.cer
Add the CA in Hybrid Access Gateway by uploading the CA certificate files. See the section Add certificate authority in Add certificates.
This article is valid from Hybrid Access Gateway 5.13.1
Related information
- No labels