Coldfusion Library

---

ColdFusion is a rapid development platform for building modern web applications. ColdFusion is designed to be expressive and powerful. The expressive characteristic allows you to perform programming tasks at a higher level than most other languages.

Get a Full Demo

Note: This library is meant to help you with a quick implementation of the LoginRadius platform and also to serve as a reference point for the LoginRadius API. Keep in mind that it is an open-source library, which means you are free to download and customize the library functions based on your specific application needs.

This document contains information and examples regarding the LoginRadius Coldfusion SDK.

Prerequisites:

• Download the SDK from Github.
• Copy the lrsdk component files to your project directory.

This guide will help you to set up and implement Loginradius in Coldfusion.

Pass the token returned in the User Registration login/registration response to the code below. You can use a javascript function in the login and social login onSuccess functions. Additional details on setting up and configuring your interface are available.

function redirect(token) {
    var form = document.createElement("form");
    form.method = "POST";
    form.action = "<YOUR_DOMAIN>"; //This is you callback page where token is retrieved.
    var _token = document.createElement("input");
    _token.type = "hidden";
    _token.name = "token";
    _token.value = token;
    form.appendChild(_token);
    document.body.appendChild(form);
    form.submit();
}

    var sl_options = {};
      sl_options.onSuccess = function(response) {
            redirect(response);          
      };
      sl_options.onError = function(errors) {
            redirect(errors);
      };
     LRObject.util.ready(function() {           
            LRObject.init('socialLogin', sl_options);       
      });

On your callback page, follow the instructions to implement LoginRadius SDK from the IMPLEMENTATION section below.

Create the LoginRadius Coldfusion component Object

<cfset SdkObject = createObject("component","lrsdk.authenticationapi").init(
       lr_api_key = "APIKEY",
       lr_api_secret = "APISECRET"
      )>

Call the function login by email to get user data based on the LoginRadius Access Token.

Try the following:

<cftry>
<cfset userProfileResult = SdkObject.getProfileByToken(token)>
 <cfset Uid ='#userProfileResult.Uid#'>
   <cfcatch type = "LoginRadiusException"> 
    <cfdump var = 'Error: #cfcatch.message#'>
 </cfcatch> 
</cftry>

Call the User Profile API in order to obtain the ID and UID of the user for use with the User Registration APIs.

With the LoginRadius access token, ID, and UID, we can now invoke any of the following functions to retrieve user data or call the User Registration APIs.

Use valid JSON where JSON is required. You can use the following library for handling JSON: https://github.com/bennadel/JsonSerializer.cfc

The Authentication (Auth) APIs allow changes to the account once some form of authentication has been performed. For this reason, they are considered to be user-facing client-side/front-end API calls.

These API calls can be generally be executed via a generated token.

List of APIs in this Section:

• Auth User Registration By Email
• Auth Login By Email
• Auth Login By Username
• Auth Add email
• Auth Forgot Password
• Auth Email Availability
• Auth UserName Availability
• Auth Read Profiles by Token
• Auth Privacy Policy Accept
• Auth Send Welcome Email
• Auth Social Identity
• Auth Validate Access token
• Auth Verify Email
• Auth Delete Account
• Auth Invalidate Access Token
• Security Questions By Access Token
• Security Questions By Email
• Security Questions By User Name
• Security Questions By Phone
• Auth Verify Email By OTP
• Auth Change Password
• Auth Link Social Identities
• Auth Resend Email Verification
• Auth Reset Password By Reset Token
• Auth Reset Password By OTP
• Auth Reset Password By Email
• Auth Reset Password By Phone
• Auth Reset Password By Username
• Auth Set or Change User Name
• Auth Update profile by Token
• Auth Update Security Question By Access Token
• Auth Delete Account With Email Confirmation
• Auth Remove email
• Auth Unlink Social Identities
• Validate Code
• Get Registration Data

If you have not already initialized the user object, do so now.

<cfset authenticationObject = createObject("component","lrsdk.authenticationapi").init(
       lr_api_key = "APIKEY",
       lr_api_secret = "APISECRET"
       lr_api_signing = 'true'
      )>

This API creates a user in the database as well as sends a verification email to the user.

Try the following:

/** 
 * @param payload This should have a valid JSON object with the userprofile data passed in.
 * @param verificationurl email verification url(OPTIONAL)
 * @param emailtemplate email template name (OPTIONAL)
 * @param options Prevent verification email (OPTIONAL) 
 * @return {"isPosted": "true"}
 */
Example:
 <cfset payload = "{'Email': [{'Type': 'Primary', 'Value': '[email protected]'}], 'Password': 'xxxxxx', 'FirstName' : 'firstname', 'LastName' : 'lastname'}">

<cftry> 
 <cfset response = authenticationObject.registerByEmail(payload, verificationurl, emailtemplate, options)> 
   <cfcatch type = "LoginRadiusException"> 
       <cfset message ='#cfcatch.message#'> 
   </cfcatch> 
</cftry>

This API retrieves a copy of the user data based on the Email.

Try the following:

/**
 * @param payload This should have a valid JSON object with the userprofile data passed in
 * @param verificationurl email verification url(OPTIONAL)
 * @param loginurl email verification url(OPTIONAL)
 * @param emailtemplate email template name (OPTIONAL)
 * @param grecaptcharesponse It is only required for locked accounts when logging in(OPTIONAL)
 * @return type object
 */
Example:
 <cfset payload = "{'Email': '[email protected]', 'Password': 'xxxxxx'}">

<cftry> 
 <cfset response = authenticationObject.loginByEmail(payload, verificationurl, loginurl, emailtemplate, grecaptcharesponse)> 
   <cfcatch type = "LoginRadiusException"> 
       <cfset message ='#cfcatch.message#'> 
   </cfcatch> 
</cftry> 

This API retrieves a copy of the user data based on the Username.

Try the following:

/**
 * @param payload This should have a valid JSON object with the userprofile data passed in
 * @param verificationurl email verification url(OPTIONAL)
 * @param loginurl email verification url(OPTIONAL)
 * @param emailtemplate email template name (OPTIONAL)
 * @param grecaptcharesponse It is only required for locked accounts when logging in(OPTIONAL)
 * @return type object
 */

Example:
 <cfset payload = "{'username': 'xxxxxxx', 'password': 'xxxxxx'}">

<cftry> 
 <cfset response = authenticationObject.loginByUsername(payload, verificationurl, loginurl, emailtemplate, grecaptcharesponse)> 
   <cfcatch type = "LoginRadiusException"> 
       <cfset message ='#cfcatch.message#'> 
   </cfcatch> 
</cftry> 

This API is used to add additional emails to a user's account.

Try the following:

 /**
    * @param accesstoken 
    * @param email  Email to be added to the user's account
    * @param type  String to identify the type of email
    * @param verificationUrl  Email verification url(OPTIONAL)
    * @param emailtemplate  Name of the email template(OPTIONAL)
    * @return {"isPosted": "true"}
  */
<cftry>
    <cfset response = authenticationObject.addEmail(accesstoken, email, type, verificationurl, emailtemplate)>
    <cfcatch type = "LoginRadiusException"> 
    <cfset message ='#cfcatch.message#'>
    </cfcatch> 
</cftry>

This API is used to send the reset password URL to a specified account.

Try the following:

 /**
   * @param $email
   * @param resetpasswordurl Url to which user should get re-directed to for resetting the password
   * @param emailtemplate Name of the email template (OPTIONAL)
   * @return {"isPosted": "true"}
   */
<cftry>
    <cfset response = authenticationObject.forgotPassword(email, resetpasswordurl, emailtemplate)>
    <cfcatch type = "LoginRadiusException"> 
    <cfset message ='#cfcatch.message#'>
    </cfcatch> 
</cftry>

This API is used to check if the email exists or not on your site.

Try the following:

 /**
   * @param email
   * @return {"IsExist": "true"}
   */
<cftry>
    <cfset response = authenticationObject.checkEmailExist(email)>
    <cfcatch type = "LoginRadiusException"> 
    <cfset message ='#cfcatch.message#'>
    </cfcatch> 
</cftry>

This API is used to check if the Username exists or not on your site.

Try the following:

 /**
   * @param username
   * @return {"IsExist": "true"}
   */
<cftry>
    <cfset response = authenticationObject.checkUsernameExist(username)>
    <cfcatch type = "LoginRadiusException"> 
    <cfset message ='#cfcatch.message#'>
    </cfcatch> 
</cftry>

This API retrieves a copy of the user data based on the access token.

Try the following:

 /**
   * @param accesstoken
   * @return type object
   */
<cftry>
    <cfset response = authenticationObject.getProfileByToken(accesstoken)>
    <cfcatch type = "LoginRadiusException"> 
    <cfset message ='#cfcatch.message#'>
    </cfcatch> 
</cftry>

This API is used to update the privacy policy stored in the user's profile by providing the access_token of the user accepting the privacy policy.

Try the following:

 /**
   * @param accesstoken
   * @return type object
   */
<cftry>
    <cfset response = authenticationObject.privacyPolicyAccept(accesstoken)>
    <cfcatch type = "LoginRadiusException"> 
    <cfset message ='#cfcatch.message#'>
    </cfcatch> 
</cftry>

This API will send a welcome email.

Try the following:

 /**
   * @param accesstoken
   * @param welcomeemailtemplate (OPTIONAL)
   * @return {"IsPosted": true}
   */
<cftry>
    <cfset response = authenticationObject.sendWelcomeEmail(accesstoken, welcomeemailtemplate)>
    <cfcatch type = "LoginRadiusException"> 
    <cfset message ='#cfcatch.message#'>
    </cfcatch> 
</cftry>

This API is called just before account linking API, and it prevents the raas profile of the second account from getting created.

Try the following:

 /**
   * @param accesstoken
   * @return type object
   */
<cftry>
    <cfset response = authenticationObject.getSocialIdentity(accesstoken)>
    <cfcatch type = "LoginRadiusException"> 
    <cfset message ='#cfcatch.message#'>
    </cfcatch> 
</cftry>

This API validates the access token if valid, then returns a response with its expiry otherwise error.

Try the following:

 /**
   * @param accesstoken
   * @return type object
   */
<cftry>
    <cfset response = authenticationObject.validateAccessToken(accesstoken)>
    <cfcatch type = "LoginRadiusException"> 
    <cfset message ='#cfcatch.message#'>
    </cfcatch> 
</cftry>

This API is used to verify the email of the user.

Try the following:

 /**
   * @param verificationtoken  Verification token received in the email.
   * @param url     Mention URL to log the main URL(Domain name) in Database.
   * @param welcomeemailtemplate    Email template for a welcome email. (OPTIONAL)
   * @return type object
   */

<cftry>
<cfset statusResult = SdkObject.verifyEmail(verificationtoken, url, welcomeemailtemplate)>
<cfcatch type = "LoginRadiusException"> 
<cfset message ='#cfcatch.message#'>
</cfcatch> 
</cftry>

This API is used to delete an account by passing it a delete token.

Try the following:

 /**
   * @param deletetoken
   * @return {"IsPosted": true}
   */
<cftry>
<cfset response = authenticationObject.deleteAccount(deletetoken)>
<cfcatch type = "LoginRadiusException"> 
<cfset message ='#cfcatch.message#'>
</cfcatch> 
</cftry>

This API call invalidates the active access_token or expires an access token's validity.

Try the following:

 /**
   * @param accesstoken
   * @return {"IsPosted": true}
   */
<cftry>
<cfset response = authenticationObject.invalidateAccessToken(accesstoken)>
<cfcatch type = "LoginRadiusException"> 
<cfset message ='#cfcatch.message#'>
</cfcatch> 
</cftry>

This API is used to retrieve the list of questions using the access token.

Try the following:

 /**
   * @param accesstoken
   * @return type object
   */
<cftry>
<cfset response = authenticationObject.securityQuestionByToken(accesstoken)>
<cfcatch type = "LoginRadiusException"> 
<cfset message ='#cfcatch.message#'>
</cfcatch> 
</cftry>

This API is used to retrieve the list of questions using email.

Try the following:

 /**
   * @param email
   * @return type object
   */
<cftry>
<cfset response = authenticationObject.securityQuestionByEmail(email)>
<cfcatch type = "LoginRadiusException"> 
<cfset message ='#cfcatch.message#'>
</cfcatch> 
</cftry>

This API is used to retrieve the list of questions using a username.

Try the following:

 /**
   * @param username
   * @return type object
   */
<cftry>
<cfset response = authenticationObject.securityQuestionByUsername(username)>
<cfcatch type = "LoginRadiusException"> 
<cfset message ='#cfcatch.message#'>
</cfcatch> 
</cftry>

This API is used to retrieve the list of questions using the phone.

Try the following:

 /**
   * @param phone
   * @return type object
   */
<cftry>
<cfset response = authenticationObject.securityQuestionByPhone(phone)>
<cfcatch type = "LoginRadiusException"> 
<cfset message ='#cfcatch.message#'>
</cfcatch> 
</cftry>

This API is used to verify the email of the user when the OTP Email verification flow is enabled.

Try the following:

 /**
   * @param payload
   * @param url Mention URL to log the main URL(Domain name) in Database.
   * @param welcomeemailtemplate (OPTIONAL)
   * @return type object
   */
Example:
  <cfset payload = "{'otp': 'xxxxxx', 'email': '[email protected]', 'SecurityAnswer': {'question':'answer'}, 'qq_captcha_ticket': 'xxxxx', 'qq_captcha_randstr': 'xxxxx', 'g-recaptcha-response': 'xxxxx'}">

<cftry>
<cfset response = authenticationObject.varifyEmailByOtp(payload, url, welcomeemailtemplate)>
<cfcatch type = "LoginRadiusException"> 
<cfset message ='#cfcatch.message#'>
</cfcatch> 
</cftry>

This API is used to change the password of the account based on the previous password.

Try the following:

 /**
   * @param accesstoken
   * @param oldpassword
   * @param newpassword
   * @return {"IsPosted": true}
   */
<cftry>
<cfset response = authenticationObject.changePassword(accesstoken, oldpassword, newpassword)>
<cfcatch type = "LoginRadiusException"> 
<cfset message = '#cfcatch.message#'>
</cfcatch> 
</cftry>

This API is used to link up a social provider account with the specified account based on the access token and the social provider's user access token.

Try the following:

 /**
   * @param accesstoken
   * @param candidatetoken
   * @return {"IsPosted": true}
   */
<cftry>
<cfset response = authenticationObject.accountLink(accesstoken, candidatetoken)>
<cfcatch type = "LoginRadiusException"> 
<cfset message ='#cfcatch.message#'>
</cfcatch> 
</cftry>

This API resends the verification email to the user.

Try the following:

 /**
   * @param email
   * @param verificationurl Site url where email will get verified (OPTIONAL)
   * @param emailtemplate  (OPTIONAL)
   * @return {"IsPosted": true}
   */
<cftry>
<cfset response = authenticationObject.resendEmailVerification(email, verificationurl, emailtemplate)>
<cfcatch type = "LoginRadiusException"> 
<cfset message ='#cfcatch.message#'>
</cfcatch> 
</cftry>

This API is used to set a new password for the specified account.

Try the following:

 /**
   * @param resettoken Reset token received in the email
   * @param password New password for the account
   * @param string welcomeemailtemplate (OPTIONAL)
   * @param string resetpasswordemailtemplate (OPTIONAL)
   * @return {"IsPosted": true}
   */
<cftry>
<cfset response = authenticationObject.resetPasswordByResetToken(resettoken, password, welcomeemailtemplate, resetpasswordemailtemplate)>
<cfcatch type = "LoginRadiusException"> 
<cfset message ='#cfcatch.message#'>
</cfcatch> 
</cftry>

This API is used to set a new password for the specified account.

Try the following:

 /**
   * @param email  User's Email ID
   * @param password  New password for the account
   * @param otp  One-time passcode sent on user's Email ID   
   * @param welcomeemailtemplate (OPTIONAL)
   * @param resetpasswordemailtemplate (OPTIONAL)
   * @return {"IsPosted": true}
   */
<cftry>
<cfset response = authenticationObject.resetPasswordByOTP(email, password, otp, welcomeemailtemplate, resetpasswordemailtemplate)>
<cfcatch type = "LoginRadiusException"> 
<cfset message ='#cfcatch.message#'>
</cfcatch> 
</cftry>

This API is used to reset the password for the specified account by a security question.

Try the following:

 /**
   * @param payload
   * @return {"IsPosted": true}
   */
Example:
  <cfset payload = "{'securityanswer': {'Question' : 'Answer'}, 'email': '[email protected]', 'password': 'xxxxxx', 'resetpasswordemailtemplate': ''}">

<cftry>
<cfset response = authenticationObject.resetPasswordByEmail(payload)>
<cfcatch type = "LoginRadiusException"> 
<cfset message ='#cfcatch.message#'>
</cfcatch> 
</cftry>

This API is used to reset the password for the specified account by a security question.

Try the following:

 /**
   * @param payload
   * @return {"IsPosted": true}
   */

Example:
  <cfset payload = "{'securityanswer': {'Question' : 'Answer'}, 'phone': 'xxxxxx', 'password': 'xxxxxx', 'resetpasswordemailtemplate': ''}">

<cftry>
<cfset response = authenticationObject.resetPasswordByPhone(payload)>
<cfcatch type = "LoginRadiusException"> 
<cfset message ='#cfcatch.message#'>
</cfcatch> 
</cftry>

This API is used to reset the password for the specified account by a security question.

Try the following:

 /**
   * @param payload
   * @return {"IsPosted": true}
   */
Example:
  <cfset payload = "{'securityanswer': {'Question' : 'Answer'}, 'username': 'xxxxxx', 'password': 'xxxxxx', 'resetpasswordemailtemplate': ''}">

<cftry>
<cfset response = authenticationObject.resetPasswordByUsername(payload)>
<cfcatch type = "LoginRadiusException"> 
<cfset message ='#cfcatch.message#'>
</cfcatch> 
</cftry>

This API is used to set or change UserName by the access token.

Try the following:

 /**
   * @param accesstoken
   * @param username
   * @return {"IsPosted": true}
   */
<cftry>
<cfset response = authenticationObject.changeUsername(accesstoken, username)>
<cfcatch type = "LoginRadiusException"> 
<cfset message ='#cfcatch.message#'>
</cfcatch> 
</cftry>

This API is used to update the user's profile by passing the access token.

Try the following:

 /**
   * @param accesstoken
   * @param payload This should have a valid JSON object with the user profile data passed in.
   * @param string verificationurl (OPTIONAL)
   * @param string emailtemplate (OPTIONAL)
   * @param string smstemplate (OPTIONAL)
   * @return userprofile object
   */
Example:
<cfset payload = "{'FirstName' : 'first name', 'LastName' : 'last name', 'Gender' : 'M', 'BirthDate' : 'MM-DD-YYYY' }">
 
<cftry> 
  <cfset userProfileResult = authenticationObject.updateProfileBytoken(accesstoken, payload, verificationurl, emailtemplate, smstemplate)> 
  <cfcatch type = "LoginRadiusException"> 
    <cfset message ='#cfcatch.message#'> 
  </cfcatch> 
</cftry>

This API is used to update security questions by the access token.

Try the following:

 /**
   * @param accesstoken
   * @param payload
   * @return type object
   */
Example:
<cfset payload = "{'securityquestionanswer' : {'question' : 'Answer'}}">
 
<cftry>
<cfset response = authenticationObject.updateSecurityQuestionByToken(accesstoken, payload)>
<cfcatch type = "LoginRadiusException"> 
<cfset message ='#cfcatch.message#'>
</cfcatch>
</cftry>

This API deletes a user account by passing the user's access token.

Try the following:

 /**
   * @param accesstoken
   * @param string deleteurl (OPTIONAL)
   * @param string emailtemplate (OPTIONAL)
   * @return {"IsDeleteRequestAccepted":true}
   */
<cftry>
<cfset response = authenticationObject.deleteAccountByEmailConfirmation(accesstoken, deleteurl, emailtemplate)>
<cfcatch type = "LoginRadiusException"> 
<cfset message ='#cfcatch.message#'>
</cfcatch> 
</cftry>

This API is used to remove additional emails from a user's account.

Try the following:

 /**
   * @param accesstoken
   * @param email string "[email protected]"
   * @return {"IsDeleted":true}
   */
<cftry>
<cfset response = authenticationObject.removeEmail(accesstoken, email)>
<cfcatch type = "LoginRadiusException"> 
<cfset message ='#cfcatch.message#'>
</cfcatch> 
</cftry>

This API is used to unlink up a social provider account with the specified account based on the access token and the social provider's user access token.

Try the following:

 /**
   * @param accesstoken
   * @param provider  Name of the provider
   * @param providerid  Unique ID of the linked account   
   * @return {"IsDeleted":true}
   */
<cftry>
<cfset response = authenticationObject.accountUnlink(accesstoken, provider, providerid)>
<cfcatch type = "LoginRadiusException"> 
<cfset message ='#cfcatch.message#'>
</cfcatch> 
</cftry>

This API allows you to validate code for a particular dropdown member.

Try the following:

 /**
   * @param params  
   * @return {"IsValid": true}
   */
Example:
params = "{'recordid': '', 'code': ''}"

<cftry>
<cfset response = authenticationObject.validateCode(params)>
<cfcatch type = "LoginRadiusException"> 
<cfset message ='#cfcatch.message#'>
</cfcatch> 
</cftry>

This API is used to retrieve dropdown data.

Try the following:

 /**
   * @param type     // Type of the Datasource
   * @param parentid // Id of parent dropdown member (OPTIONAL)  
   * @param skip     // Skip number of records from start (OPTIONAL) 
   * @param limit    // Retrieve number of records at a time(max limit is 50) (OPTIONAL) 
   * @return type Object
   */
Example:
params = "{'recordid': '', 'code': ''}"

<cftry>
<cfset response = authenticationObject.authGetRegistrationData(type, parentid, skip, limit)>
<cfcatch type = "LoginRadiusException"> 
<cfset message ='#cfcatch.message#'>
</cfcatch> 
</cftry>

List of APIs in this Section:

• Passwordless Login By Email
• Passwordless Login By UserName
• Passwordless Login Verification
• Passwordless Login Phone Verification
• Passwordless Login By Phone

This API is used to send a Passwordless Login verification link to the provided Email ID.

Try the following:

 /**
   * @param email
   * @param passwordlesslogintemplate (OPTIONAL)
   * @param verificationurl (OPTIONAL)
   * @return {"IsPosted": true}
   */
<cftry>
<cfset response = authenticationObject.passwordLessLoginByEmail(email, passwordlesslogintemplate, verificationurl)>
<cfcatch type = "LoginRadiusException"> 
<cfset message ='#cfcatch.message#'>
</cfcatch> 
</cftry>

This API is used to send a Passwordless Login Verification Link to a user by providing their UserName.

Try the following:

 /**
   * @param username
   * @param passwordlesslogintemplate (OPTIONAL)
   * @param verificationurl (OPTIONAL)
   * @return {"IsPosted": true}
   */
<cftry>
<cfset response = authenticationObject.passwordLessLoginByUsername(username, passwordlesslogintemplate, verificationurl)>
<cfcatch type = "LoginRadiusException"> 
<cfset message ='#cfcatch.message#'>
</cfcatch> 
</cftry>

This API is used to verify the Passwordless Login verification link.

Try the following:

 /**
   * @param verificationtoken
   * @param welcomeemailtemplate (OPTIONAL)
   * @return userprofile object
   */
<cftry>
<cfset response = authenticationObject.passwordLessLoginVerification(verificationtoken, welcomeemailtemplate)>
<cfcatch type = "LoginRadiusException"> 
<cfset message ='#cfcatch.message#'>
</cfcatch> 
</cftry>

API can be used to send a One-time Passcode (OTP) provided that the account has a verified PhoneID.

Try the following:

 /**
   * @param phone
   * @param smstemplate (OPTIONAL)
   * @return type object
   */
<cftry>
<cfset response = authenticationObject.phoneSendOtp(phone, smstemplate)>
<cfcatch type = "LoginRadiusException"> 
<cfset message ='#cfcatch.message#'>
</cfcatch> 
</cftry>

This API verifies an account by OTP and allows the user to login.

Try the following:

 /**
   * @param payload
   * @param smstemplate (OPTIONAL)
   * @return type object
   */
Example:

  <cfset payload = "{'phone': 'xxxxxx', 'otp': 'xxxxxx', 'SecurityAnswer': {'question':'answer'}, 'qq_captcha_ticket': 'xxxxx', 'qq_captcha_response': 'xxxxx', 'g-recaptcha-response': 'xxxxx'}">

<cftry>
<cfset response = authenticationObject.phoneLoginUsingOtp(payload, smstemplate)>
<cfcatch type = "LoginRadiusException"> 
<cfset message ='#cfcatch.message#'>
</cfcatch> 
</cftry>

The LoginRadius Smart Login set of APIs that do not require a password to login and are designed to help you delegate the authentication process to a different device. This type of Authentication workflow, while not limited to, is common among Smart TV apps, Smart Phone Apps, and IoT devices.

List of APIs in this Section:

• Smart Login By Email
• Smart Login By Username
• Smart Login Ping
• Smart Login Verify Token

This API sends a Smart Login link to the user's Email Id.

Try the following:

 /**
   * @param email
   * @param clientguid
   * @param smartloginemailtemplate (OPTIONAL)
   * @param welcomeemailtemplate (OPTIONAL)
   * @param redirecturl (OPTIONAL)
   * @return {"IsPosted": true}
   */
<cftry>
<cfset response = authenticationObject.smartLoginByEmail(email, clientguid, smartloginemailtemplate, welcomeemailtemplate, redirecturl)>
<cfcatch type = "LoginRadiusException"> 
<cfset message ='#cfcatch.message#'>
</cfcatch> 
</cftry>

This API sends a Smart Login link to the user's Email Id.

Try the following:

 /**
   * @param username
   * @param clientguid
   * @param smartloginemailtemplate (OPTIONAL)
   * @param welcomeemailtemplate (OPTIONAL)
   * @param redirecturl (OPTIONAL)
   * @return {"IsPosted": true}
   */
<cftry>
<cfset response = authenticationObject.smartLoginByUsername(username, clientguid, smartloginemailtemplate, welcomeemailtemplate, redirecturl)>
<cfcatch type = "LoginRadiusException"> 
<cfset message ='#cfcatch.message#'>
</cfcatch> 
</cftry>

This API is used to check if the Smart Login link has been clicked or not.

Try the following:

 /**
   * @param clientguid
   * @return type object
   */
<cftry>
<cfset response = authenticationObject.smartLoginPing(clientguid)>
<cfcatch type = "LoginRadiusException"> 
<cfset message ='#cfcatch.message#'>
</cfcatch> 
</cftry>

This API verifies the provided token for Smart Login.

Try the following:

 /**
   * @param verificationtoken
   * @param welcomeemailtemplate
   * @return type object
   */
<cftry>
<cfset response = authenticationObject.smartLoginVerifyToken(verificationtoken, welcomeemailtemplate)>
<cfcatch type = "LoginRadiusException"> 
<cfset message ='#cfcatch.message#'>
</cfcatch> 
</cftry>

List of APIs in this Section:

• One Touch Login by Email Captcha
• One Touch Login by Phone Captcha
• One Touch OTP Verification

This API is used to send a link to a specified email for a frictionless login/registration.

Try the following:

 /**
  * @param payload
  * @param redirecturl (OPTIONAL)
  * @param onetouchloginemailtemplate (OPTIONAL)
  * @param welcomeemailtemplate (OPTIONAL)
  * @return {"isPosted" : true}
  */
Example:
  <cfset payload = "{'clientguid': 'xxxxx', 'email': '[email protected]', 'name': '', 'qq_captcha_ticket': 'xxxxx', 'qq_captcha_randstr': 'xxxxx', 'g-recaptcha-response': 'xxxxx'}">

<cftry>
<cfset response = authenticationObject.oneTouchLoginByEmail(payload, redirecturl, onetouchloginemailtemplate, welcomeemailtemplate)>
<cfcatch type = "LoginRadiusException"> 
<cfset message ='#cfcatch.message#'>
</cfcatch> 
</cftry>

This API is used to send a one-time password to a given phone number for a frictionless login/registration.

Try the following:

 /**
  * @param payload
  * @param smstemplate (OPTIONAL)
  * @return {"isPosted" : true}
  */
Example:
  <cfset payload = "{'phone': 'xxxxxxx', 'name': '', 'qq_captcha_ticket': 'xxxxx', 'qq_captcha_randstr': 'xxxxx', 'g-recaptcha-response': 'xxxxx'}">

<cftry>
<cfset response = authenticationObject.oneTouchLoginByPhone(payload, smstemplate)>
<cfcatch type = "LoginRadiusException"> 
<cfset message ='#cfcatch.message#'>
</cfcatch> 
</cftry>

This API is used to verify the otp for One Touch Login.

Try the following:

 /**
  * @param otp
  * @param phone
  * @param smstemplate (OPTIONAL)
  * @return type object
  */
<cftry>
<cfset response = authenticationObject.oneTouchOtpVerification(otp, phone, smstemplate)>
<cfcatch type = "LoginRadiusException"> 
<cfset message ='#cfcatch.message#'>
</cfcatch> 
</cftry>

This Multi-Factor Authentication [MFA] APIs are for managing Multi-Factor-Authentication (MFA). Note that this feature is not enabled by default. Contact our support team for more details.

List of APIs in this Section:

• MFA Email Login
• MFA User Name Login
• MFA Phone Login
• MFA Validate Access Token
• MFA Backup Code by Access Token
• MFA Reset Backup Code By Access Token
• MFA Validate Backup code
• MFA Validate OTP
• MFA Validate Google Auth Code
• MFA Update Phone Number
• MFA Update Phone Number By Token
• Update MFA by Access Token
• Update MFA Setting
• MFA Reset Google Authenticator by Token
• MFA Reset SMS Authenticator by Token
• MFA Re-Authenticate
• Validate MFA by Google Authenticator Code
• Validate MFA by Backup Code
• Validate MFA by OTP
• Validate MFA by Password

This API can be used to login by emailid on a Multi-factor authentication enabled LoginRadius site.

Try the following:

 /**
  * @param payload
  * @param loginurl (OPTIONAL)
  * @param verificationurl (OPTIONAL)
  * @param emailtemplate (OPTIONAL)
  * @param smstemplate2fa (OPTIONAL)
  * @return type Second Factor Authentication object
  */
Example:
  <cfset payload = "{'email': '[email protected]', 'password': 'xxxxxx'}">

<cftry>
<cfset response = mfaObject.mfaEmailLogin(payload, loginurl, verificationurl, emailtemplate, smstemplate2fa)>
<cfcatch type = "LoginRadiusException"> 
<cfset message ='#cfcatch.message#'>
</cfcatch> 
</cftry>

This API can be used to login by username on a Multi-factor authentication enabled LoginRadius site.

Try the following:

 /**
  * @param payload 
  * @param loginurl (OPTIONAL)
  * @param verificationurl (OPTIONAL)
  * @param emailtemplate (OPTIONAL)
  * @param smstemplate (OPTIONAL)
  * @param smstemplate2fa (OPTIONAL)
  * @return type Second Factor Authentication object
  */
Example:
  <cfset payload = "{'username': 'xxxxxx', 'password': 'xxxxxx'}">

<cftry>
<cfset response = mfaObject.mfaUserNameLogin(payload, loginurl, verificationurl, emailtemplate, smstemplate, smstemplate2fa)>
<cfcatch type = "LoginRadiusException"> 
<cfset message ='#cfcatch.message#'>
</cfcatch> 
</cftry>

This API is used to log in by phone on a Multi-factor authentication enabled LoginRadius site.

Try the following:

 /**
  * @param payload
  * @param loginurl (OPTIONAL)
  * @param verificationurl (OPTIONAL)
  * @param emailtemplate (OPTIONAL)
  * @param smstemplate (OPTIONAL)
  * @param smstemplate2fa (OPTIONAL)
  * @return type Second Factor Authentication object
  */
Example:
  <cfset payload = "{'phone': 'xxxxxx', 'password': 'xxxxxx'}">

<cftry>
<cfset response = mfaObject.mfaPhoneLogin(payload, loginurl, verificationurl, emailtemplate, smstemplate, smstemplate2fa)>
<cfcatch type = "LoginRadiusException"> 
<cfset message ='#cfcatch.message#'>
</cfcatch> 
</cftry>

This API is used to configure the Multi-factor authentication after login by using the access_token when MFA is set as optional.

Try the following:

 /**
  * @param accesstoken = 'xxxxxxxx'
  * @param smstemplate2fa (OPTIONAL)
  * @return type Second Factor Authentication object
  */
<cftry>
<cfset response = mfaObject.mfaValidateToken(accesstoken, smstemplate2fa)>
<cfcatch type = "LoginRadiusException"> 
<cfset message ='#cfcatch.message#'>
</cfcatch> 
</cftry>

This API is used to get a set of backup codes via access token to allow the user login.

Try the following:

 /**
  * @param accesstoken
  * @return type Backup codes object
  */
<cftry>
<cfset response = mfaObject.mfaBackupCodeByToken(accesstoken)>
<cfcatch type = "LoginRadiusException"> 
<cfset message ='#cfcatch.message#'>
</cfcatch> 
</cftry>

API is used to reset the backup codes on a given account via the access token.

Try the following:

 /**
  * @param accesstoken
  * @return type Backup codes object
  */
<cftry>
<cfset response = mfaObject.mfaResetBackupCodeByToken(accesstoken)>
<cfcatch type = "LoginRadiusException"> 
<cfset message ='#cfcatch.message#'>
</cfcatch> 
</cftry>

This API is used to validate the backup code provided by the user, and if valid, we return an access token allowing the user to login.

Try the following:

 /**
  * @param secondfactorauthenticationtoken
  * @param backupcode  Backup Code for login
  * @return type object
  */
<cftry>
<cfset response = mfaObject.mfaValidateBackupCode(secondfactorauthenticationtoken, backupcode)>
<cfcatch type = "LoginRadiusException"> 
<cfset message ='#cfcatch.message#'>
</cfcatch> 
</cftry>

This API is used to login via Multi-factor authentication by passing the One Time Password received via SMS.

Try the following:

 /**
  * @param secondfactorauthenticationtoken
  * @param payload  
  * @param smstemplate2fa  (OPTIONAL)
  * @return type object
  */
<cftry>
<cfset response = mfaObject.mfaValidateOTP(secondfactorauthenticationtoken, payload, smstemplate2fa)>
<cfcatch type = "LoginRadiusException"> 
<cfset message ='#cfcatch.message#'>
</cfcatch> 
</cftry>

This API is used to login via Multi-factor-authentication by passing the google authenticator code.

Try the following:

 /**
  * @param secondfactorauthenticationtoken
  * @param googleauthenticatorcode
  * @param smstemplate2fa  (OPTIONAL)
  * @return type object
  */
<cftry>
<cfset response = mfaObject.mfaValidateGoogleAuthCode(secondfactorauthenticationtoken, googleauthenticatorcode, smstemplate2fa)>
<cfcatch type = "LoginRadiusException"> 
<cfset message ='#cfcatch.message#'>
</cfcatch> 
</cftry>

This API is used to update (if configured) the phone number by sending the verification OTP.

Try the following:

 /**
  * @param secondfactorauthenticationtoken  
  * @param phoneno2fa  
  * @param smstemplate2fa  (OPTIONAL)
  * @return type object
  */
<cftry>
<cfset response = mfaObject.mfaUpdatePhone(secondfactorauthenticationtoken, phoneno2fa, smstemplate2fa)>
<cfcatch type = "LoginRadiusException"> 
<cfset message ='#cfcatch.message#'>
</cfcatch> 
</cftry>

This API is used to update the Multi-factor authentication phone number by sending the verification OTP.

Try the following:

 /**
  * @param phoneno2fa = 'xxxxxxxxxx'   The Phone Number to be Updated.
  * @param accesstoken  
  * @param smstemplate2fa  (OPTIONAL)
  * @return type object
  */
<cftry>
<cfset response = mfaObject.mfaUpdatePhoneByToken(phoneno2fa, accesstoken, smstemplate2fa)>
<cfcatch type = "LoginRadiusException"> 
<cfset message ='#cfcatch.message#'>
</cfcatch> 
</cftry>

This API is used to Enable Multi-factor authentication by access token on user login.

Try the following:

 /**
  * @param googleauthenticatorcode
  * @param accesstoken  
  * @param smstemplate  (OPTIONAL)
  * @return type object
  */
<cftry>
<cfset response = mfaObject.updateMfaByGoogleAuthCode(googleauthenticatorcode, accesstoken, smstemplate)>
<cfcatch type = "LoginRadiusException"> 
<cfset message ='#cfcatch.message#'>
</cfcatch> 
</cftry>

This API is used to trigger the Multi-factor authentication settings after login for secure actions.

Try the following:

 /**
  * @param payload
  * @param accesstoken  
  * @return type object
  */
<cftry>
<cfset response = mfaObject.updateMfaByOtp(payload, accesstoken)>
<cfcatch type = "LoginRadiusException"> 
<cfset message ='#cfcatch.message#'>
</cfcatch> 
</cftry>

This API Resets the Google Authenticator configurations on a given account via the access token.

Try the following:

 /**
  * @param accesstoken  
  * @param googleauthenticator  pass boolean(true) to remove Google Authenticator
  * @return {"IsDeleted": true}
  */
<cftry>
<cfset response = mfaObject.mfaResetGoogleAuthenticatorByToken(accesstoken, googleauthenticator)>
<cfcatch type = "LoginRadiusException"> 
<cfset message ='#cfcatch.message#'>
</cfcatch> 
</cftry>

This API resets the SMS Authenticator configurations on a given account via the access token.

Try the following:

 /**
  * @param accesstoken  
  * @param otpauthenticator  pass boolean(true) to remove SMS Authenticator
  * @return {"IsDeleted": true}
  */
<cftry>
<cfset response = mfaObject.mfaResetSMSAuthenticatorByToken(accesstoken, otpauthenticator)>
<cfcatch type = "LoginRadiusException"> 
<cfset message ='#cfcatch.message#'>
</cfcatch> 
</cftry>

This API is used to trigger the Multi-Factor Authentication workflow for the provided access token.

Try the following:

 /**
  * @param accesstoken  
  * @param smstemplate2fa (OPTIONAL)
  * @return type object
  */
<cftry>
<cfset response = mfaObject.mfaReAuthenticate(accesstoken, smstemplate2fa)>
<cfcatch type = "LoginRadiusException"> 
<cfset message ='#cfcatch.message#'>
</cfcatch> 
</cftry>

This API is used to re-authenticate via Multi-factor-authentication by passing the google authenticator code.

Try the following:

 /**
  * @param accesstoken  
  * @param googleauthenticatorcode = 'xxxxxxxxxx'
  * @return type object
  */
<cftry>
<cfset response = mfaObject.validateMfaByGoogleAuthCode(accesstoken, googleauthenticatorcode)>
<cfcatch type = "LoginRadiusException"> 
<cfset message ='#cfcatch.message#'>
</cfcatch> 
</cftry>

This API is used to re-authenticate by a set of backup codes via an access token.

Try the following:

 /**
  * @param accesstoken  
  * @param backupcode = 'xxxxxxxxxx'
  * @return type object
  */
<cftry>
<cfset response = mfaObject.validateMfaByBackupCode(accesstoken, backupcode)>
<cfcatch type = "LoginRadiusException"> 
<cfset message ='#cfcatch.message#'>
</cfcatch> 
</cftry>

This API is used to re-authenticate via Multi-factor authentication by passing the One Time Password received via SMS.

Try the following:

 /**
  * @param accesstoken  
  * @param payload 
  * @param smstemplate2fa (OPTIONAL)
  * @return type object
  */
Example:
  <cfset payload = "{'otp': 'xxxxxx', 'SecurityAnswer': {'question': 'answer'}, 'qq_captcha_ticket': 'xxxxx', 'qq_captcha_randstr': 'xxxxx', 'g-recaptcha-response': 'xxxxx'}">

<cftry>
<cfset response = mfaObject.validateMfaByOtp(accesstoken, payload, smstemplate2fa)>
<cfcatch type = "LoginRadiusException"> 
<cfset message ='#cfcatch.message#'>
</cfcatch> 
</cftry>

This API is used to re-authenticate via Multi-factor-authentication by passing the password.

Try the following:

 /**
  * @param accesstoken  
  * @param payload
  * @param smstemplate2fa (OPTIONAL)
  * @return type object
  */

Example:
  <cfset payload = "{'Password': 'xxxxxx', 'SecurityAnswer': {'question': 'answer'}, 'qq_captcha_ticket': 'xxxxx', 'qq_captcha_randstr': 'xxxxx', 'g-recaptcha-response': 'xxxxx'}">

<cftry>
<cfset response = mfaObject.validateMfaByPassword(accesstoken, payload, smstemplate2fa)>
<cfcatch type = "LoginRadiusException"> 
<cfset message ='#cfcatch.message#'>
</cfcatch> 
</cftry>

Get a list of phone authentication APIs.

• Phone Login
• Phone Forgot Password By OTP
• Phone Resend OTP
• Phone Resend OTP By Token
• Phone User Registration by SMS
• Phone Number Availability
• Phone Number Update
• Phone Reset Password By OTP
• Phone Verify OTP
• Phone Verification OTP By Token
• Remove Phone ID by Access Token

If you have not already initialized the phone authentication object, do so now.

<cfset phoneObject = createObject("component","lrsdk.phoneauthenticationapi").init(
       lr_api_key = "APIKEY",
       lr_api_secret = "APISECRET"
      )>

This API retrieves a copy of the user data based on the Phone.

Try the following:

 /**
  * @param params json
  * @param loginurl  url from where user is going login(OPTIONAL)
  * @param smstemplate  sms template name(OPTIONAL)
  * @param grecaptcharesponse  It is only required for locked accounts when logging in(OPTIONAL) 
  * @return type userprofile object
  */
Example:
params = "{ 'phone' : 'xxxxxxxxx', 'password' : 'xxxxxxxxxxx' }"

<cftry>
<cfset response = phoneObject.loginByPhone(params, loginurl, smstemplate, grecaptcharesponse)>
<cfcatch type = "LoginRadiusException"> 
<cfset message ='#cfcatch.message#'>
</cfcatch> 
</cftry>

This API is used to send the OTP to reset the account password.

Try the following:

 /**
  *  @param phone = "xxxxxxxx" The Registered Phone Number
  *  @param smstemplate sms template name(OPTIONAL)
  *  @return type userprofile object
  */

<cftry>
<cfset response = phoneObject.phoneForgotPasswordByOtp(phone, smstemplate)>
<cfcatch type = "LoginRadiusException"> 
<cfset message ='#cfcatch.message#'>
</cfcatch> 
</cftry>

This API is used to resend a verification OTP to verify a user's Phone Number.

Try the following:

 /**
  *  @param phone = "xxxxxxxx" The Registered Phone Number
  *  @param smstemplate sms template name (OPTIONAL)
  *  @return type userprofile object
  */

<cftry>
<cfset response = phoneObject.phoneResendOtp(phone, smstemplate)>
<cfcatch type = "LoginRadiusException"> 
<cfset message ='#cfcatch.message#'>
</cfcatch> 
</cftry>

This API is used to resend a verification OTP to verify a user's Phone Number in cases in which an active token already exists.

Try the following:

 /**
  *  @param accesstoken
  *  @param phone = "xxxxxxxx" The Registered Phone Number
  *  @param smstemplate sms template name (OPTIONAL)
  *  @return type object
  */

<cftry>
<cfset response = phoneObject.phoneResendOtpByToken(accesstoken, phone, smstemplate)>
<cfcatch type = "LoginRadiusException"> 
<cfset message ='#cfcatch.message#'>
</cfcatch> 
</cftry>

This API registers the new users into your Cloud Directory and triggers the phone verification process.

Try the following:

/** 
 * @param payload This should have a valid JSON object with the userprofile data passed in.
 * @param verificationurl email verification url(OPTIONAL)
 * @param smstemplate sms template name (OPTIONAL)
 * @param options Prevent verification email (OPTIONAL) 
 * @return {"isPosted": "true"}
 */
Example:
 <cfset payload = '{"FirstName":"","LastName":"","BirthDate":"10-12-1985","Gender":"M","Password" : "*********","Email":[{"Type":"Primary","Value":"[email protected]"}],"PhoneId":"xxxxxxxxxxxx"}'>

<cftry> 
 <cfset response = phoneObject.registerByPhone(payload, verificationurl, smstemplate, options)> 
   <cfcatch type = "LoginRadiusException"> 
       <cfset message ='#cfcatch.message#'> 
   </cfcatch> 
</cftry>

This API is used to check the Phone Number exists or not on your site.

Try the following:

 /**
  *  @param phone = "xxxxxxxx" The Registered Phone Number
  *  @return {"IsExist": true}
  */

<cftry>
<cfset response = phoneObject.checkPhoneNumberAvailability(phone)>
<cfcatch type = "LoginRadiusException"> 
<cfset message ='#cfcatch.message#'>
</cfcatch> 
</cftry>

This API is used to update the login Phone Number of users.

Try the following:

 /**
  *  @param accesstoken
  *  @param phone = "xxxxxxxx" New Phone Number
  *  @param smstemplate sms template name (OPTIONAL)
  *  @return type object
  */

<cftry>
<cfset response = phoneObject.phoneNumberUpdate(accesstoken, phone, smstemplate)>
<cfcatch type = "LoginRadiusException"> 
<cfset message ='#cfcatch.message#'>
</cfcatch> 
</cftry>

This API is used to reset the password.

Try the following:

 /**
  * @param phone  The Registered Phone Number
  * @param otp  The Verification Code
  * @param password  New password
  * @param smstemplate  SMS Template Name (OPTIONAL)
  * @param resetpasswordemailtemplate  Reset Password Email Template (OPTIONAL)
  * @return {"IsPosted": true}
  */

<cftry>
<cfset response = phoneObject.phoneResetPasswordByOtp(phone, otp, password, smstemplate, resetpasswordemailtemplate)>
<cfcatch type = "LoginRadiusException"> 
<cfset message ='#cfcatch.message#'>
</cfcatch> 
</cftry>

This API is used to validate the verification code sent to verify a user's phone number.

Try the following:

 /**
  * @param phone  The Phone Number to be verify
  * @param otp  The Verification Code
  * @param smstemplate  SMS Template Name (OPTIONAL)
  * @return {"IsPosted": true}
  */

<cftry>
<cfset response = phoneObject.phoneVerificationByOtp(phone, otp, smstemplate)>
<cfcatch type = "LoginRadiusException"> 
<cfset message ='#cfcatch.message#'>
</cfcatch> 
</cftry>

This API is used to consume the verification code sent to verify a user's phone number. Use this call for front-end purposes in cases where the user is already logged in by passing the user's access token.

Try the following:

 /**
  * @param accesstoken
  * @param otp
  * @param smstemplate (OPTIONAL)
  * @return {"IsPosted": true}
  */

<cftry>
<cfset response = phoneObject.phoneVerificationOtpByToken(accesstoken, otp, smstemplate)>
<cfcatch type = "LoginRadiusException"> 
<cfset message ='#cfcatch.message#'>
</cfcatch> 
</cftry>

This API is used to delete the Phone ID on a user's account via the access token.

Try the following:

 /**
  * @param accesstoken
  * @return {"IsDeleted": true}
  */

<cftry>
<cfset response = phoneObject.removePhoneIdByAccessToken(accesstoken)>
<cfcatch type = "LoginRadiusException"> 
<cfset message ='#cfcatch.message#'>
</cfcatch> 
</cftry>

The Account Management APIs are used to manage a user's account. These calls require the API Key and API Secret and often the User's Account UID(Unified Identifier) to perform an operation.

For this reason, these APIs are considered to be for back-end purposes.

List of APIs in this Section:

• Account Create
• Get Email Verification Token
• Get Forgot Password Token
• Account Identities By Email
• Account Impersonation API
• Account Password
• Account Profiles By Email
• Account Profiles By UserName
• Account Profiles By Phone Id
• Account Profiles By Uid
• Account Set password
• Account Update
• Account Update Security Question
• Account Invalidate Verification Email
• Account Email Delete
• Account Delete
• MFA Backup Code By UID
• MFA Reset Backup Code By UID
• MFA Reset Google Authenticator By UID
• MFA Reset SMS Authenticator By UID
• Reset phone ID verification
• Generate SOTT Token
• Add Registration Data
• Get Registration Data
• Update Registration Data
• Delete Registration Data

If you have not already initialized the account object, do so now.

<cfset accountObject = createObject("component","lrsdk.accountapi").init(
       lr_api_key = "APIKEY",
       lr_api_secret = "APISECRET"
      )>

This API is used to create an account.

Try the following:

 /**
  * @param params  This should have a valid JSON object
  * @return userprofile object
  */

Example:
params = "{'Email': [{'Type': 'Primary', 'Value': '[email protected]'}], 'Password': 'xxxxxx',  'EmailVerified': true, 'FirstName' : 'firstname', 'LastName' : 'lastname'}"

<cftry> 
   <cfset createProfileResult = accountObject.accountCreate (params)> 
   <cfcatch type = "LoginRadiusException"> 
     <cfset message ='#cfcatch.message#'> 
    </cfcatch> 
 </cftry> 

This API Returns an Email Verification token.

Try the following:

 /**
  * @param email  = "[email protected]"
  * @return {"VerificationToken": "*****ae92c458c*****c76a9b29"}
  */

<cftry> 
   <cfset result = accountObject.getEmailVerificationToken (email)> 
   <cfcatch type = "LoginRadiusException"> 
     <cfset message ='#cfcatch.message#'> 
    </cfcatch> 
 </cftry> 

This API Returns a forgot password token.

Try the following:

 /**
  * @param email = "[email protected]"
  * @return {"ForgotToken": "7be0d7b06a********f98f46ca84083"}
  */

<cftry> 
   <cfset result = accountObject.getForgotPasswordToken (email)> 
   <cfcatch type = "LoginRadiusException"> 
     <cfset message ='#cfcatch.message#'> 
    </cfcatch> 
 </cftry> 

This API is used to retrieve all of the identities (UID and Profiles), associated with a specified email.

Try the following:

 /**
  * @param email = "[email protected]"
  * @return Identities Object
  */

<cftry> 
   <cfset result = accountObject.accountIdentitiesByEmail (email)> 
   <cfcatch type = "LoginRadiusException"> 
     <cfset message ='#cfcatch.message#'> 
    </cfcatch> 
 </cftry> 

The API is used to get LoginRadius access token based on UID.

Try the following:

 /**
  * @param uid = "xxxxxxx"
  * @return access token
  */

<cftry> 
   <cfset result = accountObject.accountImpersonationAPI (uid)> 
   <cfcatch type = "LoginRadiusException"> 
     <cfset message ='#cfcatch.message#'> 
    </cfcatch> 
 </cftry> 

This API is used to retrieve the hashed password of a specified account.

Try the following:

 /**
  * @param uid = "xxxxxxx"
  * @return {"PasswordHash": "xxxxxxx"}
  */

<cftry> 
   <cfset result = accountObject.getPassword (uid)> 
   <cfcatch type = "LoginRadiusException"> 
     <cfset message ='#cfcatch.message#'> 
    </cfcatch> 
 </cftry> 

This API is used to retrieve all of the profile data associated with the specified account by email.

Try the following:

 /**
  * @param email = '[email protected]'
  * @return userprofile Object
  */

<cftry> 
   <cfset result = accountObject.getProfileByEmail (email)> 
   <cfcatch type = "LoginRadiusException"> 
     <cfset message ='#cfcatch.message#'> 
    </cfcatch> 
 </cftry> 

This API is used to retrieve all of the profile data associated with the specified account by the user name.

Try the following:

 /**
  * @param username = 'xxxxxxxxx'
  * @return userprofile Object
  */

<cftry> 
   <cfset result = accountObject.getProfileByUsername (username)> 
   <cfcatch type = "LoginRadiusException"> 
     <cfset message ='#cfcatch.message#'> 
    </cfcatch> 
 </cftry> 

This API is used to retrieve all of the profile data associated with the account by phone number.

Try the following:

 /**
  * @param phone = 'xxxxxxxxx'
  * @return userprofile Object
  */

<cftry> 
   <cfset result = accountObject.getProfileByPhone (phone)> 
   <cfcatch type = "LoginRadiusException"> 
     <cfset message ='#cfcatch.message#'> 
    </cfcatch> 
 </cftry> 

This API is used to retrieve all of the profile data associated with the account by UID.

Try the following:

 /**
  * @param uid = 'xxxxxxxxx'
  * @return userprofile Object
  */

<cftry> 
   <cfset result = accountObject.getProfileByUid (uid)> 
   <cfcatch type = "LoginRadiusException"> 
     <cfset message ='#cfcatch.message#'> 
    </cfcatch> 
 </cftry> 

This API is used to set the password of an account.

Try the following:

 /**
  * @param uid = 'xxxxxxxxx'
  * @param password = 'xxxxxxxxx'
  * @return type Object
  */

<cftry> 
   <cfset result = accountObject.setPassword (uid, password)> 
   <cfcatch type = "LoginRadiusException"> 
     <cfset message ='#cfcatch.message#'> 
    </cfcatch> 
 </cftry> 

This API is used to update the information of the existing account.

Try the following:

 /**
  * @param uid = 'xxxxxxxxx'
  * @param payload  This should be a valid json data
  * @param nullsupport  Boolean, pass true if you wish to update any user profile field with a NULL value.
  * @return type Object
  */

Example:
<cfset payload = "{'FirstName' : 'first name', 'LastName' : 'last name', 'Gender' : 'M', 'BirthDate' : 'MM-DD-YYYY' }">

<cftry> 
   <cfset result = accountObject.accountUpdate (uid, payload, nullsupport)> 
   <cfcatch type = "LoginRadiusException"> 
     <cfset message ='#cfcatch.message#'> 
    </cfcatch> 
 </cftry> 

This API is used to update security questions configuration on an existing account.

Try the following:

 /**
  * @param uid = 'xxxxxxxxx'
  * @param payload  This should be a valid json data
  * @return type Object
  */
Example:
<cfset payload = "{'securityquestionanswer' : {'Question' : 'Answer'} }">

<cftry> 
   <cfset result = accountObject.updateSecurityQuestion (uid, payload)> 
   <cfcatch type = "LoginRadiusException"> 
     <cfset message ='#cfcatch.message#'> 
    </cfcatch> 
 </cftry> 

This API is used to invalidate the Email Verification status on an account.

Try the following:

 /**
  * @param uid = 'xxxxxxxxx'
  * @param verificationurl  (OPTIONAL)
  * @param emailtemplate  (OPTIONAL)
  * @return type Object
  */

<cftry> 
   <cfset result = accountObject.invalidateVerificationEmail (uid, verificationurl, emailtemplate)> 
   <cfcatch type = "LoginRadiusException"> 
     <cfset message ='#cfcatch.message#'> 
    </cfcatch> 
 </cftry> 

Use this API to Remove emails from a user account.

Try the following:

 /**
  * @param uid = 'xxxxxxxxx'
  * @param email = '[email protected]'
  * @return type Object
  */

<cftry> 
   <cfset result = accountObject.accountEmailDelete (uid, email)> 
   <cfcatch type = "LoginRadiusException"> 
     <cfset message ='#cfcatch.message#'> 
    </cfcatch> 
 </cftry> 

This API deletes the Users account and allows them to re-register for a new account.

Try the following:

 /**
  * @param uid = 'xxxxxxxxx'
  * @return {"IsDeleted": true}
  */

<cftry> 
   <cfset result = accountObject.accountDelete (uid)> 
   <cfcatch type = "LoginRadiusException"> 
     <cfset message ='#cfcatch.message#'> 
    </cfcatch> 
 </cftry> 

This API is used to get a set of backup codes to allow the user to login.

Try the following:

 /**
  * @param uid = 'xxxxxxxxx'
  * @return backup codes Object
  */

<cftry> 
   <cfset result = accountObject.mfaGetBackupCodeByUid(uid)> 
   <cfcatch type = "LoginRadiusException"> 
     <cfset message ='#cfcatch.message#'> 
    </cfcatch> 
 </cftry> 

This API is used to reset the backup codes on a given account via the UID.

Try the following:

 /**
  * @param uid = 'xxxxxxxxx'
  * @return backup codes Object
  */

<cftry> 
   <cfset result = accountObject.mfaResetBackupCodeByUid(uid)> 
   <cfcatch type = "LoginRadiusException"> 
     <cfset message ='#cfcatch.message#'> 
    </cfcatch> 
 </cftry> 

This API resets the Google Authenticator configurations on a given account via the UID.

Try the following:

 /**
  * @param uid = 'xxxxxxxxx'
  * @param googleauthenticator   // pass boolean(true) to remove Google Authenticator
  * @return {"IsDeleted": true}
  */

<cftry> 
   <cfset result = accountObject.mfaResetGoogleAuthenticatorByUid(uid, googleauthenticator)> 
   <cfcatch type = "LoginRadiusException"> 
     <cfset message ='#cfcatch.message#'> 
    </cfcatch> 
 </cftry> 

This API resets the Google Authenticator configurations on a given account via the UID.

Try the following:

 /**
  * @param uid = 'xxxxxxxxx'
  * @param otpauthenticator // pass boolean(true) to remove SMS Authenticator
  * @return {"IsDeleted": true}
  */

<cftry> 
   <cfset result = accountObject.mfaResetSMSAuthenticatorByUid(uid, otpauthenticator)> 
   <cfcatch type = "LoginRadiusException"> 
     <cfset message ='#cfcatch.message#'> 
    </cfcatch> 
 </cftry> 

This API allows you to reset the phone no verification of an end-users account.

Try the following:

 /**
  * @param uid = 'xxxxxxxxx'
  * @return {"IsPosted": true}
  */

<cftry> 
   <cfset result = accountObject.resetPhoneIdVerification(uid)> 
   <cfcatch type = "LoginRadiusException"> 
     <cfset message ='#cfcatch.message#'> 
    </cfcatch> 
 </cftry> 

This API allows you to generate SOTT with a given expiration time.

Try the following:

 /**
  * @param timedifference = '20' // The time difference you would like to pass, If you do not pass difference, then the default value is 10 minutes.
  * @return SOTT Token
  */

<cftry> 
   <cfset result = accountObject.generateSott(timedifference)> 
   <cfcatch type = "LoginRadiusException"> 
     <cfset message ='#cfcatch.message#'> 
    </cfcatch> 
 </cftry> 

This API allows you to fill data in the dropDownList, which you have created for user Registration.

Try the following:

 /**
  * @param params
  * @return {"IsPosted": true}
  */

Example:
params = "{'Data': [{'type': '', 'key': '', 'value': '', 'parentid': '', 'code': '', 'isactive': true}]}"

<cftry> 
   <cfset result = accountObject.addRegistrationData(params)> 
   <cfcatch type = "LoginRadiusException"> 
     <cfset message ='#cfcatch.message#'> 
    </cfcatch> 
 </cftry> 

This API is used to retrieve dropdown data.

Try the following:

 /**
  * @param type     // Type of the Datasource
  * @param parentid // Id of parent dropdown member (OPTIONAL)  
  * @param skip     // Skip number of records from start (OPTIONAL) 
  * @param limit    // Retrieve number of records at a time(max limit is 50) (OPTIONAL)
  * @return type Object
  */

<cftry> 
   <cfset result = accountObject.getRegistrationData(type, parentid, skip, limit)> 
   <cfcatch type = "LoginRadiusException"> 
     <cfset message ='#cfcatch.message#'> 
    </cfcatch> 
 </cftry> 

This API allows you to update members of dropDown.

Try the following:

 /**
  * @param recordid     // Dropdown items record id
  * @param params
  * @return type Object
  */

Example:
params = "{'type': '', 'key': '', 'value': '', 'parentid': '', 'code': '', 'isactive': true}"

<cftry> 
   <cfset result = accountObject.updateRegistrationData(recordid, params)> 
   <cfcatch type = "LoginRadiusException"> 
     <cfset message ='#cfcatch.message#'> 
    </cfcatch> 
 </cftry> 

This API allows you to delete a member from the dropDownList.

Try the following:

 /**
  * @param recordid     // Dropdown items record id
  * @return type Object
  */

<cftry> 
   <cfset result = accountObject.deleteRegistrationData(recordid)> 
   <cfcatch type = "LoginRadiusException"> 
     <cfset message ='#cfcatch.message#'> 
    </cfcatch> 
 </cftry> 

The Roles Management APIs allow for a quick and easy way to define roles and assign them to users.

List of APIs in this Section:

• Roles Create
• Get Context
• Roles List
• Get Roles By UID
• Add Permissions To Role
• Assign Roles By UID
• Upsert Context
• Delete Role
• Unassign Roles by UID
• Remove Permissions
• Delete Context
• Delete Role From Context
• Delete Permissions From Context

If you have not already initialized the role object, do so now.

<cfset roleObject = createObject("component","lrsdk.roleapi").init(
       lr_api_key = "APIKEY",
       lr_api_secret = "APISECRET"
      )>

This API creates a role with permissions.

Try the following:

 /**
  * @param payload     
  * @return type Object
  */
Example:
<cfset payload= '{"roles": [{"name": "role_name","permissions": {"permission_name1": true,"permission_name2": true,"permission_name3": true}}]}'>

<cftry> 
  <cfset result = roleObject.rolesCreate (payload)> 
  <cfcatch type = "LoginRadiusException"> 
    <cfset message ='#cfcatch.message#'> 
  </cfcatch> 
</cftry>

This API Gets the contexts that have been configured and the associated roles and permissions.

Try the following:

 /**
  * @param uid     
  * @return type Object
  */
<cftry> 
  <cfset result = roleObject.getContext (uid)> 
  <cfcatch type = "LoginRadiusException"> 
    <cfset message ='#cfcatch.message#'> 
  </cfcatch> 
</cftry>

This API retrieves the complete list of created roles with permissions of your app.

Try the following:

 /**
  * @return type Object
  */
<cftry> 
  <cfset result = roleObject.rolesList ()> 
  <cfcatch type = "LoginRadiusException"> 
    <cfset message ='#cfcatch.message#'> 
  </cfcatch> 
</cftry>

API is used to retrieve all the assigned roles of a particular User.

Try the following:

 /**
  * @param uid  
  * @return type Object
  */
<cftry> 
  <cfset result = roleObject.getRolesByUid (uid)> 
  <cfcatch type = "LoginRadiusException"> 
    <cfset message ='#cfcatch.message#'> 
  </cfcatch> 
</cftry>

This API is used to add permissions to a given role.

Try the following:

 /**
  * @param role  
  * @param payload
  * @return type Object
  */
Example:
<cfset payload= '{"permissions": [
    "permission_name1",
    "permission_name2"
  ]}'>

<cftry> 
  <cfset result = roleObject.addPermissionToRole (role, payload)> 
  <cfcatch type = "LoginRadiusException"> 
    <cfset message ='#cfcatch.message#'> 
  </cfcatch> 
</cftry>

This API is used to assign your desired roles to a given user.

Try the following:

 /**
  * @param uid  
  * @param payload
  * @return type Object
  */
Example:
<cfset payload= '{
  "roles": [
    "role_name"
  ]}'>

<cftry> 
  <cfset result = roleObject.assignRolesByUid (uid, payload)> 
  <cfcatch type = "LoginRadiusException"> 
    <cfset message ='#cfcatch.message#'> 
  </cfcatch> 
</cftry>

This API creates a Context with a set of Roles.

Try the following:

 /**
  * @param uid  
  * @param payload
  * @return type Object
  */
Example:
<cfset payload= '{
  "rolecontext": [{
      "context": "Home",
      "roles": ["admin","user"],
      "additionalpermissions": ["X","Y","Z"],
      "expiration": "07/15/2018 8:30:08 AM"
    }]}'>

<cftry> 
  <cfset result = roleObject.upsertContext (uid, payload)> 
  <cfcatch type = "LoginRadiusException"> 
    <cfset message ='#cfcatch.message#'> 
  </cfcatch> 
</cftry>

This API is used to delete a role.

Try the following:

 /**
  * @param role  
  * @return type Object
  */

<cftry> 
  <cfset result = roleObject.deleteRole (role)> 
  <cfcatch type = "LoginRadiusException"> 
    <cfset message ='#cfcatch.message#'> 
  </cfcatch> 
</cftry>

This API is used to the unassign role from a user.

Try the following:

 /**
  * @param uid  
  * @param payload
  * @return type Object
  */
Example:
<cfset payload= '{"roles": ["role_name"]}'>

<cftry> 
  <cfset result = roleObject.unassignRolesByUid (uid, payload)> 
  <cfcatch type = "LoginRadiusException"> 
    <cfset message ='#cfcatch.message#'> 
  </cfcatch> 
</cftry>

API is used to remove permissions from a role.

Try the following:

 /**
  * @param rolename  
  * @param payload
  * @return type Object
  */
Example:
<cfset payload= '{"permissions": ["permission_name1"]}'>

<cftry> 
  <cfset result = roleObject.removePermission (rolename, payload)> 
  <cfcatch type = "LoginRadiusException"> 
    <cfset message ='#cfcatch.message#'> 
  </cfcatch> 
</cftry>

This API Deletes the specified Role Context.

Try the following:

 /**
  * @param uid 
  * @param rolecontextname  
  * @return type Object
  */
<cftry> 
  <cfset result = roleObject.deleteContext (uid, rolecontextname)> 
  <cfcatch type = "LoginRadiusException"> 
    <cfset message ='#cfcatch.message#'> 
  </cfcatch> 
</cftry>

This API Deletes the specified Role from a Context.

Try the following:

 /**
  * @param uid 
  * @param rolecontextname  
  * @param payload
  * @return type Object
  */
Example:
<cfset payload= '{"roles": ["admin"]}'>

<cftry> 
  <cfset result = roleObject.deleteRoleFromContext (uid, rolecontextname, payload)> 
  <cfcatch type = "LoginRadiusException"> 
    <cfset message ='#cfcatch.message#'> 
  </cfcatch> 
</cftry>

This API Deletes Additional Permissions from Context.

Try the following:

 /**
  * @param uid 
  * @param rolecontextname  
  * @param payload
  * @return type Object
  */
Example:
<cfset payload= '{"additionalpermissions": ["X"]}'>

<cftry> 
  <cfset result = roleObject.deletePermissionFromContext (uid, rolecontextname, payload)> 
  <cfcatch type = "LoginRadiusException"> 
    <cfset message ='#cfcatch.message#'> 
  </cfcatch> 
</cftry>

This API is used to manage a custom object for the user and relies on the User Entity object. If you are unsure of your Object ID, you can reach out to the support team for details on this. If you haven't already initialized the User Registration Custom Object API, do so now.

List of APIs in this Section:

• Create Custom Object By UID
• Create Custom Object By Token
• Custom Object By ObjectRecordId And UID
• Custom Object By ObjectRecordId and Token
• Custom Object By Token
• Custom Object By UID
• Custom Object Update By UID
• Custom Object Update By Token
• Custom Object Update By ObjectRecordId and UID
• Custom Object Update By ObjectRecordId and Token
• Custom Object Delete By ObjectRecordId and UID
• Custom Object Delete By ObjectRecordId and Token

If you have not already initialized the custom object, do so now.

<cfset customObject = createObject("component","lrsdk.customobjectapi").init(
       lr_api_key = "APIKEY",
       lr_api_secret = "APISECRET",
       lr_api_signing = "true/false"
      )>

This API is used to write information in JSON format to the custom object for the specified account.

Try the following:

 /**
  * @param uid     
  * @param objectname     
  * @param payload     
  * @return type Object
  */

Example:
payload = "{'customdata1': 'Store my customdata1 value', 'customdata2': 'Store my customdata2 value'}"

<cftry> 
  <cfset result = customObject.createCustomObjectByUid (uid, objectname, payload)> 
  <cfcatch type = "LoginRadiusException"> 
    <cfset message ='#cfcatch.message#'> 
  </cfcatch> 
</cftry>

This API is used to write information in JSON format to the custom object for the specified account.

Try the following:

 /**
  * @param accesstoken     
  * @param objectname     
  * @param payload     
  * @return type Object
  */
Example:
payload = "{'customdata1': 'Store my customdata1 value', 'customdata2': 'Store my customdata2 value'}"

<cftry> 
  <cfset result = customObject.createCustomObjectByToken (accesstoken, objectname, payload)> 
  <cfcatch type = "LoginRadiusException"> 
    <cfset message ='#cfcatch.message#'> 
  </cfcatch> 
</cftry>

This API is used to retrieve the Custom Object data for the specified account.

Try the following:

 /**
  * @param uid     
  * @param objectrecordid     
  * @param objectname     
  * @return type Object
  */
<cftry> 
  <cfset result = customObject.customObjectByObjectRecordIdAndUid (uid, objectrecordid, objectname)> 
  <cfcatch type = "LoginRadiusException"> 
    <cfset message ='#cfcatch.message#'> 
  </cfcatch> 
</cftry>

This API is used to retrieve the Custom Object data for the specified account.

Try the following:

 /**
  * @param accesstoken     
  * @param objectrecordid     
  * @param objectname     
  * @return type Object
  */
<cftry> 
  <cfset result = customObject.customObjectByObjectRecordIdAndToken (accesstoken, objectrecordid, objectname)> 
  <cfcatch type = "LoginRadiusException"> 
    <cfset message ='#cfcatch.message#'> 
  </cfcatch> 
</cftry>

This API is used to retrieve all the custom objects by UID.

Try the following:

 /**
  * @param uid     
  * @param objectname     
  * @return type Object
  */
<cftry> 
  <cfset result = customObject.getCustomObjectByUid (uid, objectname)> 
  <cfcatch type = "LoginRadiusException"> 
    <cfset message ='#cfcatch.message#'> 
  </cfcatch> 
</cftry>

This API is used to retrieve all the custom objects by the access token.

Try the following:

 /**
  * @param accesstoken     
  * @param objectname     
  * @return type Object
  */
<cftry> 
  <cfset result = customObject.getCustomObjectByToken (accesstoken, objectname)> 
  <cfcatch type = "LoginRadiusException"> 
    <cfset message ='#cfcatch.message#'> 
  </cfcatch> 
</cftry>

This API is used to update the specified custom object data.

Try the following:

 /**
  * @param uid     
  * @param objectrecordid     
  * @param objectname     
  * @param updatetype     
  * @param payload     
  * @return type Object
  */
Example:
payload = "{'field1': 'Store my field1 value', 'field2': 'Store my field2 value'}"

<cftry> 
  <cfset result = customObject.updateCustomObjectByUid (uid, objectrecordid, objectname, updatetype, payload)> 
  <cfcatch type = "LoginRadiusException"> 
    <cfset message ='#cfcatch.message#'> 
  </cfcatch> 
</cftry>

This API is used to update the specified custom object data.

Try the following:

 /**
  * @param accesstoken     
  * @param objectrecordid     
  * @param objectname     
  * @param updatetype     
  * @param payload     
  * @return type Object
  */
Example:
payload = "{'field1': 'Store my field1 value', 'field2': 'Store my field2 value'}"

<cftry> 
  <cfset result = customObject.updateCustomObjectByToken (accesstoken, objectrecordid, objectname, updatetype, payload)> 
  <cfcatch type = "LoginRadiusException"> 
    <cfset message ='#cfcatch.message#'> 
  </cfcatch> 
</cftry>

This API is used to remove the specified Custom Object data.

Try the following:

 /**
  * @param uid     
  * @param objectrecordid     
  * @param objectname     
  * @param payload     
  * @return type Object
  */
<cftry> 
  <cfset result = customObject.deleteCustomObjectByUid (uid, objectrecordid, objectname, payload)> 
  <cfcatch type = "LoginRadiusException"> 
    <cfset message ='#cfcatch.message#'> 
  </cfcatch> 
</cftry>

This API is used to remove the specified Custom Object data.

Try the following:

 /**
  * @param accesstoken     
  * @param objectrecordid     
  * @param objectname     
  * @param payload     
  * @return type Object
  */
<cftry> 
  <cfset result = customObject.deleteCustomObjectByToken (accesstoken, objectrecordid, objectname, payload)> 
  <cfcatch type = "LoginRadiusException"> 
    <cfset message ='#cfcatch.message#'> 
  </cfcatch> 
</cftry>

Get a list of the configuration selected in the LoginRadius user account.

List of APIs in this Section:

• Get Configurations
• Get Server Time

If you have not already initialized the config object, do so now.

<cfset configObject = createObject("component","lrsdk.configurationapi").init(
       lr_api_key = "APIKEY",
       lr_api_secret = "APISECRET"
      )>

Try the following:

 /**
   * @Return object of configurations.
   */
<cftry> 
  <cfset result = configObject.getConfigurations()> 
  <cfcatch type = "LoginRadiusException"> 
    <cfset message ='#cfcatch.message#'> 
  </cfcatch> 
</cftry>

This API allows you to query your LoginRadius account for basic server information and server time information, which is useful when generating a SOTT token.

Try the following:

 /**
  * @param timedifference The time difference you would like to pass, If you do not pass difference, then the default value is 10 minutes.
  * @return type object
  */

<cftry> 
   <cfset result = configObject.getServerTime(timedifference)> 
   <cfcatch type = "LoginRadiusException"> 
     <cfset message ='#cfcatch.message#'> 
    </cfcatch> 
 </cftry> 

WebHooks allow you to build or set up integrations that subscribe to certain events on LoginRadius.

List of APIs in this Section:

• WebHook Subscribe
• Webhook Test
• Webhook Subscribed URLs
• WebHook Unsubscribe

If you have not already initialized the webhook object, do so now.

<cfset webHookObject = createObject("component","lrsdk.webhookapi").init(
       lr_api_key = "APIKEY",
       lr_api_secret = "APISECRET"
      )>

API can be used to configure a WebHook on your LoginRadius site.

Try the following:

 /**
  * @param targeturl 
  * @param event 
  * @return {"IsPosted": true}
  */

<cftry> 
  <cfset result = webHookObject.webHookSubscribe(targeturl, event)> 
  <cfcatch type = "LoginRadiusException"> 
    <cfset message ='#cfcatch.message#'> 
  </cfcatch> 
</cftry>

This API can be used to test a subscribed WebHook.

Try the following:

 /**
  * @return {"IsAllowed": true}
  */

<cftry> 
   <cfset result = webHookObject.webHookTest()> 
   <cfcatch type = "LoginRadiusException"> 
     <cfset message ='#cfcatch.message#'> 
    </cfcatch> 
 </cftry> 

This API is used to fetch all the subscribed URLs for a particular event.

Try the following:

 /**
  * @param event 
  * @return type object
  */

<cftry> 
   <cfset result = webHookObject.getWebHookSubscribedUrl( event )> 
   <cfcatch type = "LoginRadiusException"> 
     <cfset message ='#cfcatch.message#'> 
    </cfcatch> 
 </cftry> 

This API can be used to unsubscribe a WebHook configured on your LoginRadius site.

Try the following:

 /**
  * @param targeturl 
  * @param event 
  * @return {"IsDeleted": true}
  */

<cftry> 
   <cfset result = webHookObject.webHookUnsubscribe( targeturl, event )> 
   <cfcatch type = "LoginRadiusException"> 
     <cfset message ='#cfcatch.message#'> 
    </cfcatch> 
 </cftry> 

This API is used to manage a custom object for the user and relies on the User Entity object. If you are unsure of your Object ID, you can reach out to the support team for details on this. If you haven't already initialized the User Registration Custom Object API, do so now.

List of APIs in this Section:

• Access Token
• Validate Access Token
• Invalidate Access Token
• User Profile
• Trackable Status Posting
• Post Message API
• Get Trackable Status Stats
• Trackable Status Fetching
• Shorten URL
• Get Active Session Details
• Album
• Audio
• Check In
• Company
• Contact
• Event
• Following
• Group
• Like
• Mention
• Page
• Photo
• Post
• Status Fetching
• Status Posting
• Video

If you have not already initialized the social object, do so now.

<cfset socialObject = createObject("component","lrsdk.socialloginapi").init(
       lr_api_key = "APIKEY",
       lr_api_secret = "APISECRET"
      )>

This API Is used to translate the Request Token returned during authentication into an Access Token.

Try the following:

 /**
  * @param access_token     
  * @return access token
  */
<cftry> 
  <cfset result = socialObject.loginradiusExchangeAccessToken( access_token )> 
  <cfcatch type = "LoginRadiusException"> 
    <cfset message ='#cfcatch.message#'> 
  </cfcatch> 
</cftry>

This API validates access token.

Try the following:

 /**
  * @param access_token     
  * @return access token
  */
<cftry> 
  <cfset result = socialObject.loginradiusTokenValidate( access_token )> 
  <cfcatch type = "LoginRadiusException"> 
    <cfset message ='#cfcatch.message#'> 
  </cfcatch> 
</cftry>

This API invalidates the access token.

Try the following:

 /**
  * @param access_token     
  * @return {"isPosted": true}
  */
<cftry> 
  <cfset result = socialObject.loginradiusTokenInvalidate( access_token )> 
  <cfcatch type = "LoginRadiusException"> 
    <cfset message ='#cfcatch.message#'> 
  </cfcatch> 
</cftry>

Get user profile by the access token.

Try the following:

 /**
 * @param access_token
 * @Return object of userProfile.
 */
<cftry> 
  <cfset result = socialObject.loginradiusGetUserProfiledata( access_token )> 
  <cfcatch type = "LoginRadiusException"> 
    <cfset message ='#cfcatch.message#'> 
  </cfcatch> 
</cftry>

The Trackable Status API is used to update the status on the user's wall and return a Post ID value.

Try the following:

 /**
 * @param access_token
 * @param status
 * @param title
 * @param url
 * @param imageurl
 * @param caption
 * @param description
 * @Return object
 */
<cftry> 
  <cfset result = socialObject.loginradiusTrackableStatusPosting( access_token, status, title, url, imageurl, caption, description )> 
  <cfcatch type = "LoginRadiusException"> 
    <cfset message ='#cfcatch.message#'> 
  </cfcatch> 
</cftry>

The Message API is used to post messages to the user's contacts.

Try the following:

 /**
 * @param access_token
 * @param to
 * @param subject
 * @param message
 * @Return object
 */
<cftry> 
  <cfset result = socialObject.loginradiusSendMessagePost( access_token, to, subject, message )> 
  <cfcatch type = "LoginRadiusException"> 
    <cfset message ='#cfcatch.message#'> 
  </cfcatch> 
</cftry>

The Trackable Status API is used to update the status on the user's wall and return a Post ID value.

Try the following:

 /**
 * @param access_token
 * @param status
 * @param title
 * @param url
 * @param imageurl
 * @param caption
 * @param description
 * @Return object
 */
<cftry> 
  <cfset result = socialObject.loginradiusGetTrackableStatusStats( access_token, status, title, url, imageurl, caption, description )> 
  <cfcatch type = "LoginRadiusException"> 
    <cfset message ='#cfcatch.message#'> 
  </cfcatch> 
</cftry>

This API is used to retrieve a tracked post based on the passed in post ID value.

Try the following:

 /**
 * @param postid
 * @Return object
 */
<cftry> 
  <cfset result = socialObject.loginradiusTrackableStatusFetching( postid )> 
  <cfcatch type = "LoginRadiusException"> 
    <cfset message ='#cfcatch.message#'> 
  </cfcatch> 
</cftry>

The Shorten URL API is used to convert your URLs to the LoginRadius short URL - ish.re

Try the following:

 /**
 * @param url
 * @Return object
 */
<cftry> 
  <cfset result = socialObject.loginradiusShortenUrl( url )> 
  <cfcatch type = "LoginRadiusException"> 
    <cfset message ='#cfcatch.message#'> 
  </cfcatch> 
</cftry>

This API is used to get all active sessions by Access Token.

Try the following:

 /**
 * @param access_token
 * @Return object
 */
<cftry> 
  <cfset result = socialObject.loginradiusGetActiveSessionDetail( access_token )> 
  <cfcatch type = "LoginRadiusException"> 
    <cfset message ='#cfcatch.message#'> 
  </cfcatch> 
</cftry>

Fetch the user's photo albums.

Try the following:

<cftry>
<cfset photoAlbumsResult = socialObject.loginradiusGetPhotoAlbums(access_token)>
	<cfcatch type = "LoginRadiusException"> 
         <cfdump var = 'Error: #cfcatch.message#'>
  </cfcatch> 
</cftry>

Fetch the user's checked in data.

Try the following:

<cftry>
<cfset getAudioResult = socialObject.loginradiusGetAudio(access_token)>
	<cfcatch type = "LoginRadiusException"> 
      <cfdump var = 'Error: #cfcatch.message#'>
  </cfcatch> 
</cftry>

The Check-In API is used to get check Ins data from the user's social account.

Try the following:

<cftry>
<cfset getAudioResult = socialObject.loginradiusGetCheckins(access_token)>
	<cfcatch type = "LoginRadiusException"> 
      <cfdump var = 'Error: #cfcatch.message#'>
  </cfcatch> 
</cftry>

Fetch the user's followed companies.

Try the following:

<cftry>
<cfset followedCompaniesResult = socialObject.loginradiusGetFollowedCompanies(access_token)>
	<cfcatch type = "LoginRadiusException"> 
       <cfdump var = 'Error: #cfcatch.message#'>
  </cfcatch> 
</cftry>

Fetch the user's friends/contacts/followers.

Try the following:

<cftry>
<cfset getContactsResult = socialObject.loginradiusGetContacts(access_token)>
	<cfcatch type = "LoginRadiusException"> 
       <cfdump var = 'Error: #cfcatch.message#'>
  </cfcatch> 
</cftry>

Fetch the user's event data.

Try the following:

<cftry>
<cfset getEventsResult = socialObject.loginradiusGetEvents(access_token)>
	<cfcatch type = "LoginRadiusException"> 
      <cfdump var = 'Error: #cfcatch.message#'>
  </cfcatch> 

</cftry>

Fetch the user's following data.

Try the following:

<cftry>
<cfset getFollowingResult = socialObject.loginradiusGetFollowing(access_token)>
	<cfcatch type = "LoginRadiusException"> 
      <cfdump var = 'Error: #cfcatch.message#'>
  </cfcatch> 
</cftry>

Fetch the user's groups.

Try the following:

<cftry>
<cfset getGroupsResult = socialObject.loginradiusGetGroups (access_token)>
	<cfcatch type = "LoginRadiusException"> 
     <cfdump var = 'Error: #cfcatch.message#'>
  </cfcatch> 
</cftry>

Fetch the user's likes data.

Try the following:

<cftry>
<cfset getLikesResult = socialObject.loginradiusGetLikes (access_token)>
	<cfcatch type = "LoginRadiusException"> 
     <cfdump var = 'Error: #cfcatch.message#'>
  </cfcatch> 
</cftry>

Fetch the user's mentions.

Try the following:

<cftry>
<cfset getMentionsResult = socialObject.loginradiusGetMentions(access_token)>
	<cfcatch type = "LoginRadiusException"> 
     <cfdump var = 'Error: #cfcatch.message#'>
  </cfcatch> 
</cftry>

Fetch a specified page data.

Try the following:

<cftry>
<cfset userProfileResult = socialObject.loginradiusGetPages (access_token, pageName)>
	<cfcatch type = "LoginRadiusException"> 
     <cfdump var = 'Error: #cfcatch.message#'>
  </cfcatch> 
</cftry>

Fetch the user's photos from a specific album.

Try the following:

<cftry>
<cfset photoResult = socialObject.loginradiusGetPhotos(access_token, albumId)>
	<cfcatch type = "LoginRadiusException"> 
	  <cfdump var = 'Error: #cfcatch.message#'>
  </cfcatch> 
</cftry>

Fetch the user's posts.

Try the following:

<cftry>
<cfset getPostsResult = socialObject.loginradiusGetPosts (access_token)>
	<cfcatch type = "LoginRadiusException"> 
    <cfdump var = 'Error: #cfcatch.message#'>
  </cfcatch> 
</cftry>

Fetch the user's status updates.

Try the following:

<cftry>
<cfset getStatusResult = socialObject.loginradiusStatusFetching (access_token)>
	<cfcatch type = "LoginRadiusException"> 
     <cfdump var = 'Error: #cfcatch.message#'>
  </cfcatch> 
</cftry>

The Status API is used to update the status on the user's wall.

Try the following:

<cftry>
<cfset userProfileResult = socialObject.loginradiusStatusPosting (access_token, title, url, imageurl, status, caption, description)>
	<cfcatch type = "LoginRadiusException"> 
     <cfdump var = 'Error: #cfcatch.message#'>
  </cfcatch> 
</cftry>

• title is the title of the message (Optional)
• url is the web link of the status message (Optional)
• imageurl is the image URL of the status message (Optional)
• status is the status message text (Required)
• caption is the caption of the status message (Optional)
• description is the description of the status message (Optional)

Fetch the user's video files.

Try the following:

<cftry>
<cfset getVideoResult = socialObject.loginradiusGetVideo(access_token)>
	<cfcatch type = "LoginRadiusException"> 
     <cfdump var = 'Error: #cfcatch.message#'>
  </cfcatch> 
</cftry>

You can get a copy of the demo project from Github