SSO Widget

Embed the SSO Widget

The SSO widget can be embedded onto your site using an iFrame. It alllows users to create credentials and to log into their customer credit account. The widget can be used along different customer journeys.

Below is an example of how to add the widget to your website:

1<iframe src="https://id.newdaytechnology.com/<brand>/<endpoint>?token=<token>&redirect_uri=<redirect_uri>&sessionId=<sessionId>&context=<context>&user_name=<user_name>"></iframe>

The widget accepts the following parameters in the iFrame source url:

When the user successfully creates credentials or logs in, the widget posts serialized data back to the redirect_uri provided in the query string. The data returned by the widget must be deserialized before usage.

1var payload = JsonConvert.DeserializeObject<Object>(formData["payload"])

Create Credentials

A user can create credentials during a purchase checkout journey or in any other scenario (hereby referred as a non-checkout journey). The context parameter specified in the iFrame query string defines whether the user is either in one or the other journey types. By default, the user is in a purchase checkout journey unless nocheckout is specified.

There are differences in the user experience between the two journey types:

• Purchase checkout journey:
  Page titles are displayed;
  If the user tries to create an account with a username that is already taken, an alert message will be displayed, with a link to be redirected to the log in page;
  
• Non-checkout journey:
  Page titles are not displayed;
  If the user tries to create an account with a username that is already taken, an alert message will be displayed but no link to be redirected to the log in page will be provided;
  

Copy and paste the below code into your website where you want to display the create credentials journey.

1<iframe src="https://id.newdaytechnology.com/<brand>/credentials?sessionId=<sessionId>&redirect_uri=<redirect_uri>&token=<token>"></iframe>

Successful response

When credentials are successfully created, the widget posts back the following data to the redirect_uri provided in the query string:

1{
2 "data": {
3 "idToken": "{{id_token}}"
4 },
5 "isSuccessful": true,
6 "message": null,
7 "errorMessages": {
8   "status": null,
9   "errors": []
10  }
11}

Unsuccessful response - Token expired

The widget does not handle errors related to invalid tokens. Instead, it posts back the below data and redirect the user to the redirect_uri present in the query string. A refreshed token can be retrieved from the Refresh Token endpoint. The widget can then be re-called by passing the new token in the URL parameters.

1{
2   "status": 401,
3   "errorMessage": "Token expired"
4}}

Log in

Copy and paste the code below code into your website where you want the log in journey to be displayed.

1  <iframe src="https://id.newdaytechnology.com/<brand>/login?sessionId=<sessionId>&redirect_uri=<redirect_uri>"></iframe>

Successful response

When a user successfully logs in, the widget posts the below data back to the redirect_uri provided in the query string:

1{
2  "hashedUserId": "{{hashed_user_id}}",
3   "identityToken": “",
4   "expiresIn": 600,
5   "tokenType": "Bearer",
6   "refreshToken": "{{refresh_token}}",
7   "correlationId": "string",
8   "isAccountLocked": false,
9   "remainingAttempts": null,
10   "success": true
11}

Unsuccessful response - Account locked

Users can attempt to log in with incorrect credentials up to 5 times before their account is locked. The widget does not handle this scenario. Instead, it can optionally post back the below data and redirect the user to the redirect_uri provided in the query string:

1{
2   "status": 403,
3   "errorMessage": "User account locked."
4}

Customisation

The following elements can be configured by NewDay to match your site:

The below elements are not currently configurable:

• Titles copy (e.g. Username, Passcode etc)
• Hint copy (‘This is your username you use to log in’)
• Prompt copy within the input fields (‘enter your username)
• Error messages based on API responses (e.g. Unauthorised user)
• Help copy (‘Do you already have NewPay?’)
• Retrieval copy (‘Trouble logging in?’)