External applications
In order to display web content directly in the dashboard and create features specific to your institution, an external application will first need to be configured and then integrated with a plugin card). This will allow your institution to configure additional integrations with third-party services and other Jack Henry products, generate API keys to access the Banno API, and enable plugin item connections.
Configure an external application
- Settings
- External applications
Create sets up a new, custom external application, or you can select a previously created external application to edit. The following fields for a new external application will need to be completed:
- Name
- This customizable text field is used for internal reference within Banno People and the configured plugin card.
- Client ID
- This field auto-generates with an ID when a new external application or SSO is configured. The Client ID is used for authentication purposes, and institutions are unable to edit this field.
- Client secret
- This field auto-generates with a secret when a new external application or SSO is configured. The Client secret is used in addition to the client ID when a user connects with the SSO or plugin card. Third party integrations will require the client ID and secret.
- User consent required
- For plugin cards, uncheck User consent required so the user maintains a seamless sign on experience with third-party content.
For API integrations, you want this box checked so the user is directed to the Sign in with Banno screen.
- Redirect URIs
- Redirect URLs are a property of an external application. They serve as an allow list for the OIDC client for URL redirects (callbacks). The customizable URI text field links to the responsive web page that loads within the plugin card and displays to the end user. Although multiple URIs can be added, the plugin card framework only utilizes the first URI listed.
For third party integrations, the third party will likely give you a redirect URI, or several, to place here.
- Additional/custom config suggested values
- If needed, Banno sets and uses these fields internally for passing custom data into an SSO when needed. Institutions are unable to edit the fields.
- Save
- This saves the external application field information.
- Delete
- This button permanently deletes the external application.
After you Save the information, you will need to go back into the external application one more time and complete the following fields. This will need to be done so that you can utilize the external application.
- Description (optional)
- This customizable text field provides a brief description of the external application. It’s used for internal reference within Banno People and the configured plugin card.
- Link type
- The link type determines where the external application shows in the client apps. For plugin cards, select PluginCard.
- Link title
- This customizable text field provides a short caption describing the link type. It’s used for internal reference within Banno People and the configured plugin card.
- Link description (optional)
- This customizable text field provides a brief description of the link title. It’s used for internal reference within Banno People and the configured plugin card.
- Claims
- Claims allow extra data to be sent along with the API responses for third parties to consume. These claims are data such as what type of user a user is (retail or business), their iPay Subscriber ID, and various other data about a user and their accounts. Some of these should be enabled with caution, as they are restricted and contain sensitive info. The list of claims and whether they are public or restricted is on (https://jackhenry.dev/open-api-docs/authentication-framework/overview/openidconnectoauth/](our developer site).
- Enabled
- Confirm this field is enabled. We recommend always leaving the external application enabled.
Finally, you will need to Save the newest information.
When you’re creating a plugin card and configuring its settings, you will see the external application listed as a dropdown integration option within the External application field.
For more information on configuring an external application, please visit JackHenry.Dev.
An example for a plugin card is also on the JackHenry.Dev Plugin Card example page.
Edit or delete an external application
- Settings
- External applications
Your institution can edit or delete an external application by selecting the specific one. Delete will permanently remove the external application and need to be reconfigured if you need it again.