Skip to content
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

Make the login call-to-action clearer #124

Open
SateeshFW opened this issue Sep 6, 2024 · 1 comment
Open

Make the login call-to-action clearer #124

SateeshFW opened this issue Sep 6, 2024 · 1 comment
Labels
enhancement New feature or request jira

Comments

@SateeshFW
Copy link

SateeshFW commented Sep 6, 2024

GWA-CLI Issue

Priority: Medium/High

Issue Type: Feature

User Story

As an API Provider,
I want to successfully login through the gwa CLI using my IDIR credentials,
so that I can configure Gateway services.

Current Login Flow
The current flow of the gwa login command is unclear especially, the phrase "authentication handshake" has caused confusion, and users are often unsure of what actions they need to take. This results in delays and failed login attempts.

The prompt currently reads:

Please sign in at https://authz-apps-gov-bc-ca.test.api.gov.bc.ca/auth/realms/aps/device
Input the following code GOVJ-HSMF

Waiting for authentication handshake...

Proposed New Message Flow:
The message should be updated to something more user-friendly, like:

Please open the following URL in your browser to complete the login process:
https://authz-apps-gov-bc-ca.test.api.gov.bc.ca/auth/realms/aps/device

Enter the following code on the web page when prompted: GOVJ-HSMF

Once you have successfully logged in, return to this terminal to complete the authentication process.

Acceptance Criteria

  • The gwa login command should display clear and concise instructions for the login process.
  • Users should be instructed to open the provided URL in their browser.
  • Users should be instructed to input the provided code on the website.
  • Messaging should include guidance for users to return to the terminal after completing the login.
  • Ensure that the new messaging is tested and works for all supported platforms.
@SateeshFW SateeshFW added enhancement New feature or request jira labels Sep 6, 2024
@SateeshFW SateeshFW changed the title The gwa login command flow Refinement The gwa login command output Refinement Sep 6, 2024
@SateeshFW SateeshFW changed the title The gwa login command output Refinement Make the login call-to-action clearer Sep 6, 2024
@rustyjux
Copy link

rustyjux commented Sep 9, 2024

Another approach (alternative or in addition to changes to CLI output) would just be to add a few words about the need to complete the handshake in the Quick Start / Get Started instructions.

Also re: proposed updated wording, I have a few comments:

  • Enter the following code on the web page when prompted: GOVJ-HSMF - 'when prompted' seems unnecessary, you are immediately prompted (regardless of if you have done the user sign in already or not)
  • Once you have successfully logged in, return to this terminal to complete the authentication process. - 'return to this terminal.' should suffice - after you do the handshake/signin in browser the process is done.

Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment
Labels
enhancement New feature or request jira
Projects
None yet
Development

No branches or pull requests

3 participants