There are 2 steps in authenticating a Non-Trusted Device
from the Non-Trusted Device and wait for approval
from a Trusted Device.
Step 1: Making an Authentication Request
Same as how it works with , to authenticate a device, call the TrustedDeviceHelper.requestAuth function. This will automatically detect whether the current device is a Trusted Device or not.
TrustedDeviceHelper.requestAuth(this, "<EVENT NAME>", this, Callback.class, new Callback() {
@Override
public void onSuccess(JSONObject result) {
Toast.makeText(getApplicationContext(), result.toString(), Toast.LENGTH_SHORT).show();
}
@Override
public void onError(String error) {
Toast.makeText(getApplicationContext(), error, Toast.LENGTH_SHORT).show();
}
});
{
"ID": 1361, // Event ID
"CreatedAt": "2020-02-27T22:22:48.705212512Z",
"UpdatedAt": "2020-02-27T22:22:48.705212512Z",
"DeletedAt": null,
"client_user_id": "1014", // your client's User ID
"issuer": "afcabd98-745f-4b9e-98de-af968d9951d3", // your API Key
"event": "<EVENT NAME>",// requested event (LOGIN, or TRANSACTION, etc)
"ip": "192.168.232.2",
"location": "Unknown",
"timestamp": "1582842167",
"method": "TRUSTED_DEVICE", // auth method: TRUSTED_DEVICE (other choices are PIN / BIOMETRIC)
"new": false, // Is this a new pending event. More explanation below about Non-Trusted Device
"approved": true // Is this event approved.
// If authentication successful:
// Validate the oauth_token.access_token
"oauth_token": {
"access_token": "eyJhbGciOiJFUz...", // validate this access token
"id_token": "eyJhbGciOiJFUz...",
"refresh_token": "5:cYIfabtspE1cBeD7KP...",
"expires_in": 3600,
"token_type": "Bearer",
"auth_method": "TRUSTED_DEVICE"
}
}
Event Name
The EVENT_NAME should be filled by your app, according to what type of authentication event was requested. Example: LOGIN event, TRANSACTION event, UPDATE_PROFILE event, etc.
Callback Class
The Callback.class should be filled with the Activity to go to when the request is approved. For example, if this is a login request, then the Callback Activity can be your Dashboard class.
When an Authentication Event is requested TRUSTED_DEVICE, there are 2 possible cases:
Case 1: The current device is a Trusted Device
Case 2: The current device is NOT a Trusted Device
If the current device is not a Trusted Device, then it will create a pending event. This pending event will need to be approved by a Trusted Device. You should see a JSON result looking like:
{
...
"method": "TRUSTED_DEVICE",
// This is a pending event.
// It will turn to false once there's a Trusted Device
// responded to approve or reject this event
"new": true,
// Since it's a pending event, it's not yet approved.
"approved": false
}
The SDK will automatically show a prompt for the user to approve the event from a Trusted Device. The user then need to approve this request from their Trusted Device.
Step 2: How to approve a pending request from a Trusted Device
To check if there's a pending event for this user, you can call the getNewEvent method from a Trusted Device.
TrustedDeviceHelper.getNewEvent(this, this);
In the future, your app that is installed in a Trusted Device will receive a notification and this method is invoked when the notification is opened.
For now, you should tell your user to press a button and invoke this method when they try to login from a non-trusted device.
The SDK will open a prompt in the Trusted Device asking if the user want to approve or reject the authentication request
Receiving the result and check if the request was approved
In the non-trusted device where the user is trying to log in, you'll receive the result in the callback class that your specified.
Case 1: The request is approved
When the request is approved, the SDK will automatically redirect to your Callback Class. In the callback class, you should handle the response from Cotter
You'll receive a response in the form of a TrustedDeviceResponse object.
public class TrustedDeviceResponse {
public String response; // The response in the form of a string
public Event event; // The same response, but parsed in to an Event object
public boolean approved; // Whether or not the event was approved
public String error; // If there's any error, this will contain the error, otherwise null
}
{
"ID": 1364,
"CreatedAt": "2020-02-28T00:08:52.715136Z",
"UpdatedAt": "2020-02-28T00:08:56.917318Z",
"DeletedAt": null,
"client_user_id": "1014",
"issuer": "afcabd98-745f-4b9e-98de-af968d9951d3",
"event": "LOGIN",
"ip": "10.0.2.15",
"location": "",
"timestamp": "1582848531",
"method": "TRUSTED_DEVICE",
"new": false, // Should now be false because the Trusted Device already responded
"approved": true // In this case 1, this should be true. Otherwise your Callback class won't be open
// If authentication successful:
// Validate the oauth_token.access_token
"oauth_token": {
"access_token": "eyJhbGciOiJFUz...", // validate this access token
"id_token": "eyJhbGciOiJFUz...",
"refresh_token": "5:cYIfabtspE1cBeD7KP...",
"expires_in": 3600,
"token_type": "Bearer",
"auth_method": "TRUSTED_DEVICE"
}
}
When this authentication request is approved, you'll receive an access token in the String Response. Send this access token to your backend to validate it:
Case 2: The request is rejected
If the request is not approved for 1 minute, the prompt in the Non-Trusted Device will show an error message. The prompt will not show an error immediately when the Trusted Device denied the request, i.e. there is no difference between rejection and no response from the Trusted Device.
You will be automatically approved if the request is coming from a Trusted Device. This is covered in .
In the prompt in the user's Non-Trusted Device (right picture), you can to ask them to press a specific button in the Trusted Device to invoke the prompt on the left.
In this case, the will be called with an error message of Event is not approved.
