Jack Henry & Associates Plugin Bridge API

Bridge handshake and lifecycle.

Documentation

Specifications

Other Resources

OpenAPI Specification

jack-henry-plugin-bridge-api-openapi.yml Raw ↑
openapi: 3.0.3
info:
  title: Banno Admin Abilities Plugin Bridge API
  description: 'Back-office administration surface used by the Banno staff console

    itself. Lets institutions look up abilities/feature flags, manage

    consumer/business users, configure plugin management, manage

    segments and ads, run reports, drive RDC, ACH, wires, Zelle, and

    high-risk actions, and administer OAuth/OpenID clients.


    Resource groups (documented at

    https://banno.github.io/open-api-docs/admin-api/api-reference/v0/):

    Abilities, Accounts, ACH, Alerts, Consumers, Contact Info,

    Documents, Forms, High-Risk Actions, History, Institution Offline

    Status, Marketing/Ads, Messages, OAuth and OpenID Connect, Plugin

    Management, Remote Deposit Capture, Reports, Routing Numbers,

    Segments, Transfer Settings, Wire Transfers, and Zelle.

    '
  version: v0
  contact:
    name: Jack Henry Developer Support
    url: https://jackhenry.dev/support/
  license:
    name: Proprietary
servers:
- url: https://api.banno.com
  description: Banno production
security:
- openIdConnect: []
tags:
- name: Plugin Bridge
  description: Bridge handshake and lifecycle.
paths:
  /plugins/api/v0/plugins/{pluginId}/bridge/token:
    post:
      summary: Exchange Bridge Token
      operationId: exchangeBridgeToken
      tags:
      - Plugin Bridge
      description: 'Exchanges the parent-window handshake nonce for a short-lived

        bridge token used by the @jack-henry/banno-plugin-framework-bridge

        library to call host-side functions.

        '
      parameters:
      - name: pluginId
        in: path
        required: true
        schema:
          type: string
          format: uuid
      requestBody:
        required: true
        content:
          application/json:
            schema:
              type: object
              required:
              - nonce
              properties:
                nonce:
                  type: string
      responses:
        '200':
          description: Bridge token.
          content:
            application/json:
              schema:
                type: object
                properties:
                  token:
                    type: string
                  expiresIn:
                    type: integer
                    description: Seconds
components:
  securitySchemes:
    openIdConnect:
      type: openIdConnect
      openIdConnectUrl: https://api.banno.com/a/oidc/.well-known/openid-configuration