Configure an external application

Configure an external application to meet your institution's needs.

  1. Navigate to Settings > External applications.
  2. Select Create to set up a new, custom external application.
    Note: You can also select a previously created external application to edit.
  3. Enter the application Name.
    The Name text field is used for internal reference within People and the configured plug-in card.
  4. Under Client Type, choose a situation and follow the corresponding steps.
    Situation Steps
    A Banno API call is made from the server side. Select Confidential. This choice uses Client Secret.
    A Banno API call is made from the client side. Select Public. This choice uses Proof Key Code Exchange (PKCE).
    Note: For plug-in cards, we recommend making Banno API calls server side to avoid cross-domain issues.
  5. Under Client Secret, choose a situation and follow the corresponding steps.
    Situation Steps
    The plug-in cards are used. Clear User consent required. This action allows for the user to maintain a seamless sign on experience with third-party content.
    The API integrations are used. Select User consent required.. The user is directed to the Sign in with Banno screen.
  6. If you are using a plug-in card, enter a custom URI text in the Redirect URIs field to redirect users to a webpage within the plug-in card.
    Note: The following Additional/Custom config suggested values field is used internally by Banno to pass custom data into an SSO when necessary. Institutions are unable to edit the fields.
  7. Select Save.
  8. Select your external application from the External applications screen.
  9. Enter a brief description in the Description (optional) field.
  10. Select a link tag option in the Link Type drop-down field to determine where your application appears in the client apps.
  11. Enter a Link Title to provide a caption describing the Link Type.
  12. Enter a Link description for the Link Title.
    Note: The following Claims field is used internally by Banno for direct API integrations. Institutions are unable to select the fields.
  13. Select Save.
  14. Return to the External applications page and toggle Enable On for your external application.
Parent topic: External applications