Details

openapi: 3.0.0 info: version: '0.0' title: User Alerts description: | An API for viewing and configuring alerts that are the result of system or user defined events. Alerts are currently delivered via the following channels push, email, and sms. servers: - url: 'https://{API_ENVIRONMENT}/a/consumer/api/v0' variables: API_ENVIRONMENT: default: digital.garden-fi.com description: FI specific hostname tags: - name: Alert Inbox description: | An inbox of recent alerts for a user (within the last 15 days). They can delete these from the list as well as mark them as read. - name: Alert Definition - name: User Alerts description: User related alerts that can be enabled/disabled and have configurable channels. - name: Account Alerts description: Account related alerts that can be enabled/disabled and have configurable channels. paths: '/users/{userId}/alert/definitions': get: tags: - Alert Definition summary: Get alert definitions supported by the institution. security: - OpenID_Connect: - 'https://api.banno.com/consumer/auth/user.alerts.readonly' - 'https://api.banno.com/consumer/auth/user.alerts.readwrite' parameters: - $ref: '#/components/parameters/userIdParam' responses: '200': description: OK content: application/json: schema: type: object required: - definitions properties: definitions: type: array items: $ref: '#/components/schemas/AlertDefinition' '/users/{userId}/alert/inbox': get: tags: - Alert Inbox summary: Get alerts for a user security: - OpenID_Connect: - 'https://api.banno.com/consumer/auth/user.alerts.readonly' - 'https://api.banno.com/consumer/auth/user.alerts.readwrite' parameters: - $ref: '#/components/parameters/userIdParam' responses: '200': description: OK content: application/json: schema: type: object properties: alerts: type: array items: $ref: '#/components/schemas/UserAlert' '404': description: Not found '/users/{userId}/alert/inbox/{alertId}': get: tags: - Alert Inbox summary: Get an alert security: - OpenID_Connect: - 'https://api.banno.com/consumer/auth/user.alerts.readonly' - 'https://api.banno.com/consumer/auth/user.alerts.readwrite' parameters: - $ref: '#/components/parameters/userIdParam' - $ref: '#/components/parameters/alertIdParam' responses: '200': description: OK content: application/json: schema: $ref: '#/components/schemas/UserAlert' '404': description: Alert not found delete: tags: - Alert Inbox summary: Delete an alert security: - OpenID_Connect: - 'https://api.banno.com/consumer/auth/user.alerts.readwrite' parameters: - $ref: '#/components/parameters/userIdParam' - $ref: '#/components/parameters/alertIdParam' responses: '204': description: deactivated successfully '/users/{userId}/alert/inbox/{alertId}/read': post: tags: - Alert Inbox summary: Report that an alert was read. security: - OpenID_Connect: - 'https://api.banno.com/consumer/auth/user.alerts.readwrite' parameters: - $ref: '#/components/parameters/userIdParam' - $ref: '#/components/parameters/alertIdParam' responses: '204': description: updated successfully '/users/{userId}/alert/config': get: tags: - User Alerts summary: Get user alert configuration security: - OpenID_Connect: - 'https://api.banno.com/consumer/auth/user.alerts.readonly' - 'https://api.banno.com/consumer/auth/user.alerts.readwrite' parameters: - $ref: '#/components/parameters/userIdParam' responses: '200': description: OK content: application/json: schema: type: object required: - alerts properties: alerts: type: array items: $ref: '#/components/schemas/AlertConfiguration' put: tags: - User Alerts summary: Update a user alert configuration security: - OpenID_Connect: - 'https://api.banno.com/consumer/auth/user.alerts.readwrite' parameters: - $ref: '#/components/parameters/userIdParam' requestBody: description: At least one channel must be selected content: application/json: schema: $ref: '#/components/schemas/ChannelsUpdate' responses: '204': description: updated successfully. '/users/{userId}/alert/config/accounts/{accountId}': get: tags: - Account Alerts summary: Get account alert configurations security: - OpenID_Connect: - 'https://api.banno.com/consumer/auth/user.alerts.readonly' - 'https://api.banno.com/consumer/auth/user.alerts.readwrite' parameters: - $ref: '#/components/parameters/userIdParam' - $ref: '#/components/parameters/accountIdParam' responses: '200': description: OK content: application/json: schema: type: object required: - alerts properties: alerts: type: array items: $ref: '#/components/schemas/AlertConfiguration' put: tags: - Account Alerts summary: Update an account alert configuration security: - OpenID_Connect: - 'https://api.banno.com/consumer/auth/user.alerts.readwrite' parameters: - $ref: '#/components/parameters/userIdParam' - $ref: '#/components/parameters/accountIdParam' requestBody: description: The alert is enabled if at least one channel is selected content: application/json: schema: $ref: '#/components/schemas/ChannelsUpdate' responses: '204': description: updated successfully components: securitySchemes: OpenID_Connect: type: openIdConnect description: OpenID Connect - Discovery endpoint will be institution specific openIdConnectUrl: >- https://digital.garden-fi.com/a/consumer/api/v0/oidc/.well-known/openid-configuration parameters: alertIdParam: in: path name: alertId required: true schema: $ref: '#/components/schemas/AlertId' userIdParam: in: path name: userId required: true schema: $ref: '#/components/schemas/UserId' accountIdParam: in: path name: accountId required: true schema: $ref: '#/components/schemas/AccountId' schemas: UserAlert: type: object required: - alertId - alertType - title - message - sentAt - expiresAt - read properties: alertId: $ref: '#/components/schemas/AlertId' alertType: $ref: '#/components/schemas/AlertType' title: type: string description: alert title message: type: string description: alert message body sentAt: type: string format: date-time description: when the alert was sent expiresAt: type: string format: date-time description: when the alert is set to auto delete read: type: boolean description: whether or not the user has read the alert data: $ref: '#/components/schemas/PushData' AlertDefinition: type: object required: - alertType - description properties: alertType: $ref: '#/components/schemas/AlertType' description: $ref: '#/components/schemas/AlertDescription' PushData: type: object description: | A custom map of data that is passed back to an app with a push notification. Can use up to 2048 bytes of data. properties: deepLink: $ref: '#/components/schemas/DeepLink' DeepLink: type: string format: uri description: | One of the following paths that represent a best effort intent relevant to the notification. - User: - /users/{userId} - Account: - /users/{userId}/accounts/{accountId} - Transaction: - /users/{userId}/accounts/{accountId}/transactions/{transactionId} - Transfer: - /users/{userId}/accounts/{accountId}/transfers/{transferId} AlertConfiguration: type: object description: The alert will send if at least one channel is enabled required: - alertType - overridable - enabled properties: alertType: $ref: '#/components/schemas/AlertType' overridable: type: object description: whether or not a channel is configurable required: - email - push - sms properties: email: type: boolean push: type: boolean sms: type: boolean enabled: type: object description: channels to send on required: - email - push - sms properties: email: type: boolean push: type: boolean sms: type: boolean ChannelsUpdate: type: object required: - alertType - enabled properties: alertType: $ref: '#/components/schemas/AlertType' enabled: type: object description: channels to send on properties: email: type: boolean push: type: boolean sms: type: boolean AlertId: type: string format: uuid description: alert uuid UserId: type: string format: uuid description: user uuid AccountId: type: string format: uuid description: account uuid AlertType: type: string description: unique alert type name example: user.email.changed AlertDescription: type: string description: a short description about the alert example: An alert that is sent when a user's email changes