-
Notifications
You must be signed in to change notification settings - Fork 80
Readme auth #2378
New issue
Have a question about this project? Sign up for a free GitHub account to open an issue and contact its maintainers and the community.
By clicking “Sign up for GitHub”, you agree to our terms of service and privacy statement. We’ll occasionally send you account related emails.
Already on GitHub? Sign in to your account
base: master
Are you sure you want to change the base?
Readme auth #2378
Conversation
update readme of auth gh-0
empty space to check push gh-0
There was a problem hiding this comment.
Choose a reason for hiding this comment
The reason will be displayed to describe this comment to others. Learn more.
Pull request overview
This PR enhances the authentication service README by adding documentation for AWS Cognito OAuth integration and Redis datasource configuration. The changes provide developers with setup instructions and code examples for implementing these authentication features.
Key changes:
- Added AWS Cognito OAuth authentication setup instructions with required environment variables
- Added Redis datasource configuration example with comprehensive environment variable handling
- Added npm installation commands for required connectors
💡 Add Copilot custom instructions for smarter, more guided reviews. Learn how to get started.
| - Use `/verify-otp` to enter otp or code from authenticator app. | ||
| for using Google Authenticator user needs to pass client id in the payload which is optional in case for OTP | ||
|
|
||
| - **Oauth- using Cognito** - |
Copilot
AI
Dec 5, 2025
There was a problem hiding this comment.
Choose a reason for hiding this comment
The reason will be displayed to describe this comment to others. Learn more.
Inconsistent capitalization: 'Oauth' should be 'OAuth' to match the naming convention used elsewhere in the document (see line 160).
| - **Oauth- using Cognito** - | |
| - **OAuth- using Cognito** - |
|
|
||
| COGNITO_AUTH_CALLBACK_URL refers to the API endpoint /auth/cognito-auth-redirect provided by authentication service | ||
| - we are using the loopback4-authentication package inside the backend service. we have setup the User, AuthClient UserCredential Models and the api /auth/cognito and /auth/cognito-auth-redirect via authentication service. You only need to bind the providers as stated in [loopback4-authentication](https://github.com/sourcefuse/loopback4-authentication) | ||
| - on redirecting back to the application with the code generated by the call back api , application can use that code to sent to /auth/token api to get the token for your application. |
Copilot
AI
Dec 5, 2025
There was a problem hiding this comment.
Choose a reason for hiding this comment
The reason will be displayed to describe this comment to others. Learn more.
Grammatical error: 'sent' should be 'send' (infinitive form after 'to').
| - on redirecting back to the application with the code generated by the call back api , application can use that code to sent to /auth/token api to get the token for your application. | |
| - on redirecting back to the application with the code generated by the call back api , application can use that code to send to /auth/token api to get the token for your application. |
|
|
||
| COGNITO_AUTH_CALLBACK_URL refers to the API endpoint /auth/cognito-auth-redirect provided by authentication service | ||
| - we are using the loopback4-authentication package inside the backend service. we have setup the User, AuthClient UserCredential Models and the api /auth/cognito and /auth/cognito-auth-redirect via authentication service. You only need to bind the providers as stated in [loopback4-authentication](https://github.com/sourcefuse/loopback4-authentication) | ||
| - on redirecting back to the application with the code generated by the call back api , application can use that code to sent to /auth/token api to get the token for your application. |
Copilot
AI
Dec 5, 2025
There was a problem hiding this comment.
Choose a reason for hiding this comment
The reason will be displayed to describe this comment to others. Learn more.
Spacing error: Extra space before comma after 'api'.
| - on redirecting back to the application with the code generated by the call back api , application can use that code to sent to /auth/token api to get the token for your application. | |
| - on redirecting back to the application with the code generated by the call back api, application can use that code to sent to /auth/token api to get the token for your application. |
| redis datasource - | ||
| run - ```npm install loopback-connector-kv-redis --save``` | ||
| ```typescript | ||
| for redis, datasource example is as below |
Copilot
AI
Dec 5, 2025
There was a problem hiding this comment.
Choose a reason for hiding this comment
The reason will be displayed to describe this comment to others. Learn more.
Inconsistent capitalization: 'redis' should be 'Redis' to match proper noun convention.
| redis datasource - | |
| run - ```npm install loopback-connector-kv-redis --save``` | |
| ```typescript | |
| for redis, datasource example is as below | |
| Redis datasource - | |
| run - ```npm install loopback-connector-kv-redis --save``` | |
| ```typescript | |
| For Redis, datasource example is as below |
| redis datasource - | ||
| run - ```npm install loopback-connector-kv-redis --save``` | ||
| ```typescript | ||
| for redis, datasource example is as below |
Copilot
AI
Dec 5, 2025
There was a problem hiding this comment.
Choose a reason for hiding this comment
The reason will be displayed to describe this comment to others. Learn more.
Inconsistent capitalization and style: Should be formatted as a proper sentence, e.g., 'For Redis, the datasource example is as follows:'
| for redis, datasource example is as below | |
| For Redis, the datasource example is as follows: |
update paragraphs gh-0
update few points gh-0
add docs in readme gh-o
add first user sql gh-0
add docs gh-0
|
|
@Tyagi-Sunny PR title |



Description
Please include a summary of the change and which issue is fixed. Please also include relevant motivation and context. List any dependencies that are required for this change.
Fixes # (issue)
Type of change
Please delete options that are not relevant.
How Has This Been Tested?
Please describe the tests that you ran to verify your changes. Provide instructions so we can reproduce. Please also list any relevant details for your test configuration
Checklist: