https://github.com/tcheeric/wutsi-login-bff
Wutsi BFF for login flow
https://github.com/tcheeric/wutsi-login-bff
Last synced: 11 days ago
JSON representation
Wutsi BFF for login flow
- Host: GitHub
- URL: https://github.com/tcheeric/wutsi-login-bff
- Owner: tcheeric
- Created: 2022-03-12T08:34:11.000Z (over 4 years ago)
- Default Branch: master
- Last Pushed: 2022-09-24T23:46:03.000Z (over 3 years ago)
- Last Synced: 2024-04-24T06:37:32.439Z (about 2 years ago)
- Language: Kotlin
- Homepage:
- Size: 260 KB
- Stars: 0
- Watchers: 1
- Forks: 0
- Open Issues: 0
-
Metadata Files:
- Readme: README.md
Awesome Lists containing this project
README
[](https://github.com/wutsi/wutsi-login-bff/actions/workflows/master.yml)
[](https://jdk.java.net/11/)
[](https://maven.apache.org/download.cgi)
# wutsi-login-bff
`wutsi-login-bff` provide the experience:
- Signing user
- Verifying the user's PIN
- Onboard new user
# Screens
## Login Screen
This is the endpoint for either signing in users or verifying their PIN.
**Endpoint:** `/`
#### Request Parameters
| Parameters | Default Value | Description |
|----------------------------|---------------|-------------------------------------------------------------------------------------------------------------------------------------------------------------|
| phone-number | | REQUIRED: Phone number of the user to authenticate in [E.164](https://en.wikipedia.org/wiki/E.164) format |
| screen-id | `page.login` | Screen identifier |
| icon | | Code of the icon to display in the title. See [Material Icons](https://github.com/flutter/flutter/blob/master/packages/flutter/lib/src/material/icons.dart) |
| title | | Main title |
| sub-title | | Sub Title |
| return-url | | URL where to redirect the user after completing the validation |
| return-to-route | `true` | Indicate if the return-url is a `Route` or `Command`. |
| auth | `true` | If `true`, a new authentication token will be created after validating the user PIN |
| dark-mode | `false` | If `true`, the login screen will be displayed in dark mode |
| hide-back-button | `false` | If `true`, the back button in the application bar will be hidden |
| hide-change-account-button | `false` | If `true`, the button to change account will be hidden. NOTE: This button available only in test environment or for super users |
## Onboard Screen
This is the endpoint onboard new user into the app.
**Endpoint:** `/onboard`