Devices

openapi: 3.0.0 info: version: "1.0.0" title: User Devices tags: - name: Device Operations servers: - url: 'https://{API_ENVIRONMENT}/a/consumer/api/v0' variables: API_ENVIRONMENT: default: digital.garden-fi.com description: FI specific hostname paths: "/users/{userId}/devices": parameters: - $ref: '#/components/parameters/UserId' get: tags: - Device Operations description: | This endpoint supports being used with an Access Token from the Admin API with "Manage security settings" permission for the Associated User. Lists of devices of the given user security: - OpenID_Connect: - 'https://api.banno.com/consumer/auth/devices.readwrite' - 'https://api.banno.com/consumer/auth/devices.readonly' parameters: - $ref: '#/components/parameters/UserId' - in: query name: onlyActive description: | Indicates if the response should only include active and authorised devices (those with an authorised active session). If true, only active devices are sent back in the response. If false, then all devices registered for this user are returned. By default it is set to true. required: false schema: type: boolean responses: "200": description: The user's device registrations content: application/json: schema: $ref: "#/components/schemas/deviceRegistrationArray" "400": description: | No JWT found, or else another kind of bad data denoted by the error message content: application/json: schema: nullable: true type: string delete: tags: - Device Operations description: | This endpoint supports being used with an Access Token from the Admin API with "Manage security settings" permission for the Associated User. Deactivates all devices for a user security: - OpenID_Connect: - 'https://api.banno.com/consumer/auth/devices.readwrite' responses: "204": description: Deactivated all of the user's device registrations "400": description: | No JWT found, or else another kind of bad data denoted by the error message content: application/json: schema: nullable: true type: string "/users/{userId}/devices/{deviceRegistrationId}": delete: tags: - Device Operations description: | This endpoint supports being used with an Access Token from the Admin API with "Manage security settings" permission for the Associated User. Deactivates the user's device given by the registration Id. parameters: - $ref: '#/components/parameters/UserId' - $ref: '#/components/parameters/DeviceRegistrationId' security: - OpenID_Connect: - 'https://api.banno.com/consumer/auth/devices.readwrite' responses: "204": description: | The deactivation was successful, if there was a device. "400": description: | No JWT found, or else another kind of bad data denoted by the error message content: application/json: schema: nullable: true type: string ## ## COMPONENTS> ## 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: UserId: in: path name: userId description: | Identifier of the user that owns the resource denoted by the URI. This `userId` is defined by Banno upon creating a user account. required: true schema: type: string format: uuid DeviceRegistrationId: in: path name: deviceRegistrationId description: | An Id for the registration of this device within the Jack Henry Digital. This registration Id is created by Jack Henry, and so has no extrinsic relation with any Id of the device itself (such as the IMEI). required: true schema: type: string format: uuid schemas: deviceRegistrationArray: type: object required: - registrations properties: registrations: type: array items: $ref: "#/components/schemas/DeviceRegistration" DeviceRegistration: type: object description: | A device registration repcords the details of a physical device with a user and institution. User sessions, within Jack Henry Digital, are associated to a device registration. Note that, a same physical device can be part of several different device registrations, for instance if a shared laptop is used by several people, or if a person uses Jack Henry Digital with more than one bank or credit union. required: - jwtDeviceRegistrationId - institutionId - deviceId - deviceInfo - createdAt - updatedAt - lastSeenAt properties: jwtDeviceRegistrationId: type: string format: uuid description: id for the device registration institutionId: type: string format: uuid description: | Identifier, within Jack Henry Digital, of the bank or credit union with which the user is using the application. deviceId: type: string description: device Id deviceInfo: $ref: "#/components/schemas/DeviceInfo" createdAt: type: string format: date-time description: | The time at which this device was registered in Jack Henry Digital. It usually indicates the first time the user logs into the mobile or web application from this device. updatedAt: type: string format: date-time description: last time information about this device has changed lastSeenAt: type: string format: date-time description: last time this device has been seen (not necessarily updated) deletedAt: type: string format: date-time description: | If present, it indicates the time when this device was deactivated (session closed). If absent, this device registration is still active. DeviceInfo: type: object description: | Some basic information about the device. This information is stored in the session JWTs used for authentication of consumer users, , and may be included in the history and activity events generated by the actions issued from that device. properties: model: type: string description: device model example: 'SM-S727VL' brand: type: string description: device brand example: 'Samsung' os: type: string description: device os name example: 'Android' osVersion: type: string description: device os version example: '10' appVersion: type: string description: version of the Banno mobile application example: '2.6.338' browser: type: string description: browser name example: 'Chrome' browserVersion: type: string description: browser version example: '66.0.3359.158' browserEngine: type: string description: name of the web engine used from the browser in this device. example: 'WebKit' browserEngineVersion: type: string description: browser engine version example: '537.36'