Confirm a User's Logged-in Status or Provide a Registration or Login Form

This article is about implementing SSO for Emplifi Ratings & Reviews widgets. For implementing SSO for the Emplifi platform, see Single Sign-on (SSO).

Fill out the userDataFn to confirm a user's logged-in status or provide a registration or login form:

Steps:

1. Familiarize yourself with the function reference for this step, which covers the userDataFn and ssoRegDone functions.

2. Inside the userDataFn function, add code to check the user's logged-in status.

3. If the user is not logged in, provide a registration or login form.
   Email Address Verification
   When a user registers with your site during the content submission process, you should call ssoRegDone only after the user's email address is verified to your satisfaction. Emplifi understands this call as your authorization to submit the content. If you only want to allow confirmed email addresses, wait to call the ssoRegDone function until after the user confirms their email address.

4. When the user is logged in, generate the userDataToken, which is a JWT token you'll need to compute on the server side using your site's authKey. The authKey is available in your site's settings area.
   For details on the contents of the userDataToken, see the function reference for ssoRegDone.

5. From the PDP, make a callback to the ssoRegDone function with the userDataToken.

   This callback can be in the userDataFn function, but it's not required to be there. You just have to call ssoRegDone whenever you're done logging in the user. It's asynchronous, so you can handle this in whatever way you need.

   The callback looks like this:

   CODE

   TurnToCmd('ssoRegDone', { context: contextObj, userDataToken: userToken });

After you finish this step, the userDataFn function might be structured something like this:

var turnToConfig = {
    ...
    sso: {
        userDataFn: function(contextObj){
          // Check the user's logged-in status.
          // YOUR CODE HERE

          // If the user is not logged in, provide a registration or login form.
          // If the user is logged in, generate the userDataToken.
          // YOUR CODE HERE
          // Assign the token to use it in the ssoRegDone callback.
          var userToken = // YOUR CODE HERE

          // Make a callback to the Emplifi ssoRegDone function with the userDataToken.
          TurnToCmd('ssoRegDone', { context: contextObj, userDataToken: userToken });
        },
    }
}

Examples and functions reference

userDataToken generation example

Here is an example implementation of a server-side call to retrieve user data and generate the JWT userDataToken. The key used in the example is aaa-aaa. In a real implementation, it would be your site's authKey. This example is in PHP, but you are free to use Java or C# or whatever backend language your site uses on the server side.

use \Firebase\JWT\JWT;

namespace EmplifiSSO;

class User {
        // fields for holding user information from your site
        public $username;
        public $password;
        public $firstName;
        public $lastName;
        public $nickName;
        public $emailAddress;
        public $userAuthToken;

        public function isLoggedIn() {
        return (isset($this->username) && isset($this->password));
        }

        /**
        * For illustrative purposes user details are passed in from a controller. In a live    
        *  environment these will be stored by your system.
        */
        public function setUserDetails($data) {
            $this->firstName = $data['firstName'];
            $this->lastName = $data['lastName'];
            $this->nickName = $data['nickName'];
            $this->emailAddress = $data['email'];
            $this->userAuthToken = $data['userAuthToken'];
        }

        /**
        * Use username/password to authenticate user and retrieve personal data.
        *  In this example, any username and password are accepted, but in a live example
        *  you should implement authentication logic.
        */
        public function logUserIn($username, $password, $userInfo) {
            $this->username = $username;
            $this->password = $password;
            $this->setUserDetails($userInfo);
            return $this->buildUserToken('aaa-aaa');
        }

        /**
         * User token is an encrypted set of user details that will be used by Emplifi's system to 
         *  identify who is logged in. $siteAuthKey comes from site settings
         *  and is different for each site.
         */
        public function buildUserToken($siteAuthKey) {
            // build an array with the required user fields
            $userData = array (
                "fn" => $this->firstName,
                "ln" => $this->lastName,
                "nn" => $this->nickName,
                "e" => $this->emailAddress,
                "ua" => $this->userAuthToken,
                "iss" => "Emplifi",        // issuer should always be Emplifi
                "exp" => time() + 86400   // current Unix timestamp (in seconds), plus 24 hrs in secs
            );

            return JWT::encode($userData, $siteAuthKey, 'HS256');
        }
}

USERDATAFN(CONTEXTOBJ) function

This function is called by Emplifi Ratings & Reviews code to request information about the current user. The operation is handled asynchronously, so this function does not have a return value. When SSO verification or login completes, your code should make a callback to the ssoRegDone function.

SSOREGDONE function

When logged-in status is verified or login completes, this function is called by your code to resume the user's in-progress action (such as submitting a review). The function is provided for your use via the TurnToCmd object.