Details

openapi: 3.0.3 info: title: Plugins Management version: '0.0' servers: - url: https://banno.com tags: - name: Enable or Disable Plugins - name: Retrieve Plugins details paths: '/a/dashboard-cards/api/v0/institutions/{institutionId}/users/{userId}/plugincards': put: tags: [Enable or Disable Plugins] summary: Enable or disable plugins for a user. A maximum of 500 plugins can be updated in a single PUT request. parameters: - $ref: '#/components/parameters/institutionId' - $ref: '#/components/parameters/userId' requestBody: required: true content: application/json: schema: $ref: '#/components/schemas/PluginUpdateRequest' responses: '200': description: Plugins updated for user content: application/json: schema: $ref: '#/components/schemas/UserPutResponse' get: tags: [Retrieve Plugins details] summary: Retrieve plugins for a user security: - clientCredentials: - https://jackhenry.com/dashboard-cards/dashboard.read parameters: - $ref: '#/components/parameters/institutionId' - $ref: '#/components/parameters/userId' responses: '200': description: Plugins retrieved for user content: application/json: schema: $ref: '#/components/schemas/UserGetResponse' '/a/dashboard-cards/api/v0/institutions/{institutionId}/organizations/{organizationId}/plugincardclients': put: tags: [Enable or Disable Plugins] summary: Enable or disable plugins for an organization. A maximum of 500 plugins can be updated in a single PUT request. security: - clientCredentials: - https://jackhenry.com/dashboard-cards/dashboard.write parameters: - $ref: '#/components/parameters/institutionId' - $ref: '#/components/parameters/organizationId' requestBody: required: true content: application/json: schema: $ref: '#/components/schemas/OrgClientUpdateRequest' responses: '200': description: Plugins updated for organization content: application/json: schema: $ref: '#/components/schemas/OrganizationPutResponse' get: tags: [Retrieve Plugins details] summary: Retrieve plugins for an organization security: - clientCredentials: - https://jackhenry.com/dashboard-cards/dashboard.read parameters: - $ref: '#/components/parameters/institutionId' - $ref: '#/components/parameters/organizationId' responses: '200': description: Plugins retrieved for organization content: application/json: schema: $ref: '#/components/schemas/OrganizationGetResponse' '/a/dashboard-cards/api/v0/institutions/{institutionId}/organizations/{organizationId}/users/{userId}/plugincards': put: tags: [Enable or Disable Plugins] summary: Enable or disable plugins for an organization user. A maximum of 500 plugins can be updated in a single PUT request. security: - clientCredentials: - https://jackhenry.com/dashboard-cards/dashboard.write parameters: - $ref: '#/components/parameters/institutionId' - $ref: '#/components/parameters/organizationId' - $ref: '#/components/parameters/userId' requestBody: required: true content: application/json: schema: $ref: '#/components/schemas/PluginUpdateRequest' responses: '200': description: Plugins updated for organization user content: application/json: schema: $ref: '#/components/schemas/OrgUserPutResponse' get: tags: [Retrieve Plugins details] summary: Retrieve plugins for an organization user parameters: - $ref: '#/components/parameters/institutionId' - $ref: '#/components/parameters/organizationId' - $ref: '#/components/parameters/userId' responses: '200': description: Plugins retrieved for organization user content: application/json: schema: $ref: '#/components/schemas/OrgUserGetResponse' components: securitySchemes: clientCredentials: type: oauth2 description: OAuth2 using the client credentials flow flows: clientCredentials: tokenUrl: https://banno.com/a/oidc-provider/api/v0/token scopes: {} parameters: institutionId: in: path name: institutionId required: true schema: type: string format: uuid organizationId: in: path name: organizationId required: true schema: type: string format: uuid userId: in: path name: userId required: true schema: type: string format: uuid schemas: OrgClientUpdateRequest: type: object required: [clients] properties: clients: type: array items: type: object required: [cardClientId, enabled] properties: cardClientId: type: string format: uuid enabled: type: boolean PluginUpdateRequest: type: object required: [plugins] properties: plugins: type: array items: type: object required: [cardId, enabled] properties: cardId: type: string format: uuid enabled: type: boolean PluginPutResult: type: object required: [clientId, cardId, enabled, status] properties: clientId: type: string format: uuid actionClientId: type: string nullable: true format: uuid cardId: type: string format: uuid enabled: type: boolean status: type: string enum: [success, failed] PluginGetResult: type: object required: - clientId - clientName - cardId - cardName - enabled properties: clientId: type: string format: uuid clientName: type: string actionClientId: type: string nullable: true format: uuid actionClientName: type: string nullable: true cardId: type: string format: uuid cardName: type: string enabled: type: boolean OrgClientPutResult: type: object required: [cardClientId, enabled, status] properties: cardClientId: type: string format: uuid enabled: type: boolean status: type: string enum: [success, failed] OrgClientGetResult: type: object required: - cardClientId - cardClientName - enabled properties: cardClientId: type: string format: uuid cardClientName: type: string enabled: type: boolean UserPutResponse: type: object properties: userId: type: string format: uuid institutionId: type: string format: uuid plugins: type: array items: $ref: '#/components/schemas/PluginPutResult' OrganizationPutResponse: type: object properties: organizationId: type: string format: uuid institutionId: type: string format: uuid clients: type: array items: $ref: '#/components/schemas/OrgClientPutResult' OrgUserPutResponse: type: object properties: userId: type: string format: uuid organizationId: type: string format: uuid institutionId: type: string format: uuid plugins: type: array items: $ref: '#/components/schemas/PluginPutResult' UserGetResponse: type: object properties: userId: type: string format: uuid institutionId: type: string format: uuid plugins: type: array items: $ref: '#/components/schemas/PluginGetResult' OrganizationGetResponse: type: object properties: organizationId: type: string format: uuid institutionId: type: string format: uuid clients: type: array items: $ref: '#/components/schemas/OrgClientGetResult' OrgUserGetResponse: type: object properties: userId: type: string format: uuid organizationId: type: string format: uuid institutionId: type: string format: uuid plugins: type: array items: $ref: '#/components/schemas/PluginGetResult'