One-Tap Auth.

Gridy One-Tap authentication lets a User verify an authentication code from within their Gridy Authenticator app without having to manually submit an authentication code for verification each time they want to access your website or application. Offering a frictionless One-Tap authentication experience.

How it works

After a request for a new One-Tap Gridy authentication challenge has been accepted, the Gridy API client will start to poll the Status API endpoint every 3 secs*, waiting for a User to successfully complete your authentication challenge inside their Gridy Authenticator App. On successful completion of the authentication challenge, the API client will receive the updated challenge status inside the onVerified callback.

*poll frequency can be set in API request otherwise defaults to 3 seconds (3000ms)

API Client Support

At present the Gridy Java API client only supports polling the Status API endpoint. Server-Sent Events will be supported in the near future.

Polling

Java	Python	Dart	PHP	NodeJS

Server-Sent Events

Java	Python	Dart	PHP	NodeJS

One-Tap authentication is disabled by default for all API account types. Use the CLI to enable One-Tap authentication.

Enabling One-Tap authentication will require changes to your authentication code verification workflow and is currently only supported by the Gridy Java API client.

Usage

Enable One-Tap authentication

Auto Verify Gridy ID MFA challenges (default: false)

CLI

java -jar gridy-admin-cli.jar settings update --data '{ "autoverify": true/false }'

See the Sample code examples below:

Sample Code

Java

        apiInstance.challengeWithAutoVerify(
          new ChallengeRequest.Builder()
            .forUser( <USER EMAIL ADDRESS> )                          
            .challengeType ( <> ) 
            .enableAutoVerify( true )
            .enableQRcode( true )
            .withExpiry( Expiry.ThreeMins )
            .withStatus( Status.NEW )
            .withProfile( Profile.DEFAULT )
            .withIPAddress( <USER IP ADDRESS> )
            .withPollFreq(5000) 
            .build(), new AutoVerifyListener(){

                @Override
                public void onChallenge(ModelApiResponse mar) {
                //New Gridy ID challenge accepted 
                //Display Gridy ID Challenge QR code to User    
                }

                @Override
                public void onChallengeError(int i) {
                   //Error requesting new Gridy ID challenge
                   //See common error codes for list.   
                }   

                @Override
                public void onVerified(ModelApiResponse mar) {
                   //User has completed all authentication challenges successfully.

                }

                @Override
                public void onPending() {
                   //Waiting for User to complete Gridy ID authentication 
                   //challenge inside their Authenticator App   

                }

                @Override
                public void onExpired(ModelApiResponse mar) {
                //Gridy ID challenge Expired before being completed.

                }

                @Override
                public void onRejected(ModelApiResponse mar) {
                //Gridy ID challenge Rejected.
                //See common error codes for list.      

                }

                @Override
                public void onError(int i) {                                            
                    //Gridy ID challenge Error.
                                //See common error codes for list.                  
                }                                                               
            });