Customer Identity public repo for Node.js V2 SDK, based on LoginRadius V2 APIs.
LoginRadius Node.js Customer Registration wrapper provides access to LoginRadius Identity Management Platform API.
LoginRadius is an Identity Management Platform that simplifies user registration while securing data. LoginRadius Platform simplifies and secures your user registration process, increases conversion with Social Login that combines 30 major social platforms, and offers a full solution with Traditional User Registration. You can gather a wealth of user profile data from Social Login or Traditional User Registration.
LoginRadius centralizes it all in one place, making it easy to manage and access. Easily integrate LoginRadius with all of your third-party applications, like MailChimp, Google Analytics, Livefyre and many more, making it easy to utilize the data you are capturing.
LoginRadius helps businesses boost user engagement on their web/mobile platform, manage online identities, utilize social media for marketing, capture accurate consumer data, and get unique social insight into their customer base.
Please visit here for more information.
$ npm install loginradius-sdk
Disclaimer
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.
LoginRadius Combined Node SDK features a combined SDK set to encompass Social Login, User Registration, and Custom Object.
This document contains information and examples regarding the LoginRadius Node.js SDK. It provides guidance for working with social authentication, user profile data, and sending messages with a variety of social networks such as Facebook, Google, Twitter, Yahoo, LinkedIn, and more. You can get the SDK from here
Note: The latest version(11.1.0) of Node js SDK works with LoginRadius V2 APIs.
Installation
run npm install loginradius-sdk
Configuration
Create var config in project
var config = {
apiDomain: 'api.loginradius.com',
apiKey: '{{ Your API KEY }}',
apiSecret: '{{ Your API Secret }}',
siteName: '{{ Your Sitename }}',
apiRequestSigning: false,
originIp:"{{ Client Ip }}",
proxy:{
host:'',
port:'',
user:'',
password:''
}
}
Replace the placeholders in the config object with your LoginRadius credentials apikey, apisecret, sitename. These can be obtained from here
Pass the proxy configurations if you want to set Http Server Proxy Configuration through your NodeJs SDK. Host and port are required to set Http Server Proxy configuration (username and password are optional).
LoginRadius allows you to add X-Origin-IP in your headers and it determines the IP address of the client's request,this can also be useful to overcome analytics discrepancies where the analytics depend on header data.
originIp:"{{ Client Ip }}"
The originIp will be added in var config
Require the loginradius-sdk package and pass the config object
var lrv2 = require('loginradius-sdk')(config);
List of APIs in this Section:
- PUT : Auth Update Profile by Token
- PUT : Auth Unlock Account by Access Token
- PUT : Auth Verify Email By OTP
- PUT : Auth Reset Password by Security Answer and Email
- PUT : Auth Reset Password by Security Answer and Phone
- PUT : Auth Reset Password by Security Answer and UserName
- PUT : Auth Reset Password by Reset Token
- PUT : Auth Reset Password by OTP
- PUT : Auth Reset Password by OTP and UserName
- PUT : Auth Change Password
- PUT : Auth Set or Change UserName
- PUT : Auth Resend Email Verification
- POST : Auth Add Email
- POST : Auth Login by Email
- POST : Auth Login by Username
- POST : Auth Forgot Password
- POST : Auth Link Social Identities
- POST : Auth Link Social Identities By Ping
- POST : Auth User Registration by Email
- POST : Auth User Registration By Captcha
- GET : Get Security Questions By Email
- GET : Get Security Questions By UserName
- GET : Get Security Questions By Phone
- GET : Get Security Questions By Access Token
- GET : Auth Validate Access token
- GET : Access Token Invalidate
- GET : Access Token Info
- GET : Auth Read all Profiles by Token
- GET : Auth Send Welcome Email
- GET : Auth Delete Account
- GET : Get Profile By Ping
- GET : Auth Check Email Availability
- GET : Auth Verify Email
- GET : Auth Check UserName Availability
- GET : Auth Privacy Policy Accept
- GET : Auth Privacy Policy History By Access Token
- DELETE : Auth Delete Account with Email Confirmation
- DELETE : Auth Remove Email
- DELETE : Auth Unlink Social Identities
var accessToken = "<accessToken>"; //Required
var userProfileUpdateModel ={
"firstName" : "<firstName>",
"lastName" : "<lastName>"
}; //Required
var emailTemplate = "<emailTemplate>"; //Optional
var fields = null; //Optional
var nullSupport = true; //Optional
var smsTemplate = "<smsTemplate>"; //Optional
var verificationUrl = "<verificationUrl>"; //Optional
lrv2.authenticationApi.updateProfileByAccessToken(accessToken, userProfileUpdateModel, emailTemplate, fields, nullSupport, smsTemplate, verificationUrl).then((response) => {
console.log(response);
}).catch((error) => {
console.log(error);
});
var accessToken = "<accessToken>"; //Required
var unlockProfileModel ={
"g-recaptcha-response" : "<g-recaptcha-response>"
}; //Required
lrv2.authenticationApi.unlockAccountByToken(accessToken, unlockProfileModel).then((response) => {
console.log(response);
}).catch((error) => {
console.log(error);
});
var emailVerificationByOtpModel ={
"email" : "<email>",
"otp" : "<otp>"
}; //Required
var fields = null; //Optional
var url = "<url>"; //Optional
var welcomeEmailTemplate = "<welcomeEmailTemplate>"; //Optional
lrv2.authenticationApi.verifyEmailByOTP(emailVerificationByOtpModel, fields, url, welcomeEmailTemplate).then((response) => {
console.log(response);
}).catch((error) => {
console.log(error);
});
var resetPasswordBySecurityAnswerAndEmailModel ={
"email" : "<email>",
"password" : "<password>",
"securityAnswer" : {"QuestionID":"Answer"}
}; //Required
lrv2.authenticationApi.resetPasswordBySecurityAnswerAndEmail(resetPasswordBySecurityAnswerAndEmailModel).then((response) => {
console.log(response);
}).catch((error) => {
console.log(error);
});
var resetPasswordBySecurityAnswerAndPhoneModel ={
"password" : "<password>",
"phone" : "<phone>",
"securityAnswer" : {"QuestionID":"Answer"}
}; //Required
lrv2.authenticationApi.resetPasswordBySecurityAnswerAndPhone(resetPasswordBySecurityAnswerAndPhoneModel).then((response) => {
console.log(response);
}).catch((error) => {
console.log(error);
});
var resetPasswordBySecurityAnswerAndUserNameModel ={
"password" : "<password>",
"securityAnswer" : {"QuestionID":"Answer"},
"userName" : "<userName>"
}; //Required
lrv2.authenticationApi.resetPasswordBySecurityAnswerAndUserName(resetPasswordBySecurityAnswerAndUserNameModel).then((response) => {
console.log(response);
}).catch((error) => {
console.log(error);
});
var resetPasswordByResetTokenModel ={
"password" : "<password>",
"resetToken" : "<resetToken>"
}; //Required
lrv2.authenticationApi.resetPasswordByResetToken(resetPasswordByResetTokenModel).then((response) => {
console.log(response);
}).catch((error) => {
console.log(error);
});
var resetPasswordByEmailAndOtpModel ={
"email" : "<email>",
"otp" : "<otp>",
"password" : "<password>"
}; //Required
lrv2.authenticationApi.resetPasswordByEmailOTP(resetPasswordByEmailAndOtpModel).then((response) => {
console.log(response);
}).catch((error) => {
console.log(error);
});
var resetPasswordByUserNameModel ={
"otp" : "<otp>",
"password" : "<password>",
"userName" : "<userName>"
}; //Required
lrv2.authenticationApi.resetPasswordByOTPAndUserName(resetPasswordByUserNameModel).then((response) => {
console.log(response);
}).catch((error) => {
console.log(error);
});
var accessToken = "<accessToken>"; //Required
var newPassword = "<newPassword>"; //Required
var oldPassword = "<oldPassword>"; //Required
lrv2.authenticationApi.changePassword(accessToken, newPassword, oldPassword).then((response) => {
console.log(response);
}).catch((error) => {
console.log(error);
});
var accessToken = "<accessToken>"; //Required
var username = "<username>"; //Required
lrv2.authenticationApi.setOrChangeUserName(accessToken, username).then((response) => {
console.log(response);
}).catch((error) => {
console.log(error);
});
var email = "<email>"; //Required
var emailTemplate = "<emailTemplate>"; //Optional
var verificationUrl = "<verificationUrl>"; //Optional
lrv2.authenticationApi.authResendEmailVerification(email, emailTemplate, verificationUrl).then((response) => {
console.log(response);
}).catch((error) => {
console.log(error);
});
var accessToken = "<accessToken>"; //Required
var email = "<email>"; //Required
var type = "<type>"; //Required
var emailTemplate = "<emailTemplate>"; //Optional
var verificationUrl = "<verificationUrl>"; //Optional
lrv2.authenticationApi.addEmail(accessToken, email, type, emailTemplate, verificationUrl).then((response) => {
console.log(response);
}).catch((error) => {
console.log(error);
});
var emailAuthenticationModel ={
"email" : "<email>",
"password" : "<password>"
}; //Required
var emailTemplate = "<emailTemplate>"; //Optional
var fields = null; //Optional
var loginUrl = "<loginUrl>"; //Optional
var verificationUrl = "<verificationUrl>"; //Optional
lrv2.authenticationApi.loginByEmail(emailAuthenticationModel, emailTemplate, fields, loginUrl, verificationUrl).then((response) => {
console.log(response);
}).catch((error) => {
console.log(error);
});
var userNameAuthenticationModel ={
"password" : "<password>",
"username" : "<username>"
}; //Required
var emailTemplate = "<emailTemplate>"; //Optional
var fields = null; //Optional
var loginUrl = "<loginUrl>"; //Optional
var verificationUrl = "<verificationUrl>"; //Optional
lrv2.authenticationApi.loginByUserName(userNameAuthenticationModel, emailTemplate, fields, loginUrl, verificationUrl).then((response) => {
console.log(response);
}).catch((error) => {
console.log(error);
});
var email = "<email>"; //Required
var resetPasswordUrl = "<resetPasswordUrl>"; //Required
var emailTemplate = "<emailTemplate>"; //Optional
lrv2.authenticationApi.forgotPassword(email, resetPasswordUrl, emailTemplate).then((response) => {
console.log(response);
}).catch((error) => {
console.log(error);
});
var accessToken = "<accessToken>"; //Required
var candidateToken = "<candidateToken>"; //Required
lrv2.authenticationApi.linkSocialIdentities(accessToken, candidateToken).then((response) => {
console.log(response);
}).catch((error) => {
console.log(error);
});
var accessToken = "<accessToken>"; //Required
var clientGuid = "<clientGuid>"; //Required
lrv2.authenticationApi.linkSocialIdentitiesByPing(accessToken, clientGuid).then((response) => {
console.log(response);
}).catch((error) => {
console.log(error);
});
var authUserRegistrationModel ={
"email" : [ {
"type" : "<type>" ,
"value" : "<value>"
} ] ,
"firstName" : "<firstName>",
"lastName" : "<lastName>",
"password" : "<password>"
}; //Required
var sott = "<sott>"; //Required
var emailTemplate = "<emailTemplate>"; //Optional
var fields = null; //Optional
var options = "<options>"; //Optional
var verificationUrl = "<verificationUrl>"; //Optional
var welcomeEmailTemplate = "<welcomeEmailTemplate>"; //Optional
lrv2.authenticationApi.userRegistrationByEmail(authUserRegistrationModel, sott, emailTemplate, fields, options, verificationUrl, welcomeEmailTemplate).then((response) => {
console.log(response);
}).catch((error) => {
console.log(error);
});
var authUserRegistrationModelWithCaptcha ={
"email" : [ {
"type" : "<type>" ,
"value" : "<value>"
} ] ,
"firstName" : "<firstName>",
"g-recaptcha-response" : "<g-recaptcha-response>",
"lastName" : "<lastName>",
"password" : "<password>"
}; //Required
var emailTemplate = "<emailTemplate>"; //Optional
var fields = null; //Optional
var options = "<options>"; //Optional
var smsTemplate = "<smsTemplate>"; //Optional
var verificationUrl = "<verificationUrl>"; //Optional
var welcomeEmailTemplate = "<welcomeEmailTemplate>"; //Optional
lrv2.authenticationApi.userRegistrationByCaptcha(authUserRegistrationModelWithCaptcha, emailTemplate, fields, options, smsTemplate, verificationUrl, welcomeEmailTemplate).then((response) => {
console.log(response);
}).catch((error) => {
console.log(error);
});
var email = "<email>"; //Required
lrv2.authenticationApi.getSecurityQuestionsByEmail(email).then((response) => {
console.log(response);
}).catch((error) => {
console.log(error);
});
var userName = "<userName>"; //Required
lrv2.authenticationApi.getSecurityQuestionsByUserName(userName).then((response) => {
console.log(response);
}).catch((error) => {
console.log(error);
});
var phone = "<phone>"; //Required
lrv2.authenticationApi.getSecurityQuestionsByPhone(phone).then((response) => {
console.log(response);
}).catch((error) => {
console.log(error);
});
var accessToken = "<accessToken>"; //Required
lrv2.authenticationApi.getSecurityQuestionsByAccessToken(accessToken).then((response) => {
console.log(response);
}).catch((error) => {
console.log(error);
});
var accessToken = "<accessToken>"; //Required
lrv2.authenticationApi.authValidateAccessToken(accessToken).then((response) => {
console.log(response);
}).catch((error) => {
console.log(error);
});
var accessToken = "<accessToken>"; //Required
var preventRefresh = true; //Optional
lrv2.authenticationApi.authInValidateAccessToken(accessToken, preventRefresh).then((response) => {
console.log(response);
}).catch((error) => {
console.log(error);
});
var accessToken = "<accessToken>"; //Required
lrv2.authenticationApi.getAccessTokenInfo(accessToken).then((response) => {
console.log(response);
}).catch((error) => {
console.log(error);
});
var accessToken = "<accessToken>"; //Required
var fields = null; //Optional
lrv2.authenticationApi.getProfileByAccessToken(accessToken, fields).then((response) => {
console.log(response);
}).catch((error) => {
console.log(error);
});
var accessToken = "<accessToken>"; //Required
var welcomeEmailTemplate = "<welcomeEmailTemplate>"; //Optional
lrv2.authenticationApi.sendWelcomeEmail(accessToken, welcomeEmailTemplate).then((response) => {
console.log(response);
}).catch((error) => {
console.log(error);
});
var deletetoken = "<deletetoken>"; //Required
lrv2.authenticationApi.deleteAccountByDeleteToken(deletetoken).then((response) => {
console.log(response);
}).catch((error) => {
console.log(error);
});
var clientGuid = "<clientGuid>"; //Required
var emailTemplate = "<emailTemplate>"; //Optional
var fields = null; //Optional
var verificationUrl = "<verificationUrl>"; //Optional
var welcomeEmailTemplate = "<welcomeEmailTemplate>"; //Optional
lrv2.authenticationApi.getProfileByPing(clientGuid, emailTemplate, fields, verificationUrl, welcomeEmailTemplate).then((response) => {
console.log(response);
}).catch((error) => {
console.log(error);
});
var email = "<email>"; //Required
lrv2.authenticationApi.checkEmailAvailability(email).then((response) => {
console.log(response);
}).catch((error) => {
console.log(error);
});
var verificationToken = "<verificationToken>"; //Required
var fields = null; //Optional
var url = "<url>"; //Optional
var welcomeEmailTemplate = "<welcomeEmailTemplate>"; //Optional
lrv2.authenticationApi.verifyEmail(verificationToken, fields, url, welcomeEmailTemplate).then((response) => {
console.log(response);
}).catch((error) => {
console.log(error);
});
var username = "<username>"; //Required
lrv2.authenticationApi.checkUserNameAvailability(username).then((response) => {
console.log(response);
}).catch((error) => {
console.log(error);
});
var accessToken = "<accessToken>"; //Required
var fields = null; //Optional
lrv2.authenticationApi.acceptPrivacyPolicy(accessToken, fields).then((response) => {
console.log(response);
}).catch((error) => {
console.log(error);
});
var accessToken = "<accessToken>"; //Required
lrv2.authenticationApi.getPrivacyPolicyHistoryByAccessToken(accessToken).then((response) => {
console.log(response);
}).catch((error) => {
console.log(error);
});
var accessToken = "<accessToken>"; //Required
var deleteUrl = "<deleteUrl>"; //Optional
var emailTemplate = "<emailTemplate>"; //Optional
lrv2.authenticationApi.deleteAccountWithEmailConfirmation(accessToken, deleteUrl, emailTemplate).then((response) => {
console.log(response);
}).catch((error) => {
console.log(error);
});
var accessToken = "<accessToken>"; //Required
var email = "<email>"; //Required
lrv2.authenticationApi.removeEmail(accessToken, email).then((response) => {
console.log(response);
}).catch((error) => {
console.log(error);
});
var accessToken = "<accessToken>"; //Required
var provider = "<provider>"; //Required
var providerId = "<providerId>"; //Required
lrv2.authenticationApi.unlinkSocialIdentities(accessToken, provider, providerId).then((response) => {
console.log(response);
}).catch((error) => {
console.log(error);
});
List of APIs in this Section:
- PUT : Account Update
- PUT : Update Phone ID by UID
- PUT : Account Set Password
- PUT : Account Invalidate Verification Email
- PUT : Reset phone ID verification
- PUT : Upsert Email
- PUT : Update UID
- POST : Account Create
- POST : Forgot Password token
- POST : Email Verification token
- GET : Get Privacy Policy History By Uid
- GET : Account Profiles by Email
- GET : Account Profiles by Username
- GET : Account Profile by Phone ID
- GET : Account Profiles by UID
- GET : Account Password
- GET : Access Token based on UID or User impersonation API
- GET : Refresh Access Token by Refresh Token
- GET : Revoke Refresh Token
- GET : Account Identities by Email
- DELETE : Account Delete
- DELETE : Account Remove Email
- DELETE : Delete User Profiles By Email
var accountUserProfileUpdateModel ={
"firstName" : "<firstName>",
"lastName" : "<lastName>"
}; //Required
var uid = "<uid>"; //Required
var fields = null; //Optional
var nullSupport = true; //Optional
lrv2.accountApi.updateAccountByUid(accountUserProfileUpdateModel, uid, fields, nullSupport).then((response) => {
console.log(response);
}).catch((error) => {
console.log(error);
});
var phone = "<phone>"; //Required
var uid = "<uid>"; //Required
var fields = null; //Optional
lrv2.accountApi.updatePhoneIDByUid(phone, uid, fields).then((response) => {
console.log(response);
}).catch((error) => {
console.log(error);
});
var password = "<password>"; //Required
var uid = "<uid>"; //Required
lrv2.accountApi.setAccountPasswordByUid(password, uid).then((response) => {
console.log(response);
}).catch((error) => {
console.log(error);
});
var uid = "<uid>"; //Required
var emailTemplate = "<emailTemplate>"; //Optional
var verificationUrl = "<verificationUrl>"; //Optional
lrv2.accountApi.invalidateAccountEmailVerification(uid, emailTemplate, verificationUrl).then((response) => {
console.log(response);
}).catch((error) => {
console.log(error);
});
var uid = "<uid>"; //Required
var smsTemplate = "<smsTemplate>"; //Optional
lrv2.accountApi.resetPhoneIDVerificationByUid(uid, smsTemplate).then((response) => {
console.log(response);
}).catch((error) => {
console.log(error);
});
var upsertEmailModel ={
"email" : [ {
"type" : "<type>" ,
"value" : "<value>"
} ]
}; //Required
var uid = "<uid>"; //Required
var fields = null; //Optional
lrv2.accountApi.upsertEmail(upsertEmailModel, uid, fields).then((response) => {
console.log(response);
}).catch((error) => {
console.log(error);
});
var updateUidModel ={
"newUid" : "<newUid>"
}; //Required
var uid = "<uid>"; //Required
lrv2.accountApi.accountUpdateUid(updateUidModel, uid).then((response) => {
console.log(response);
}).catch((error) => {
console.log(error);
});
In order to use this API, you need to format a JSON request body with all of the mandatory fields [More Info](https://www.loginradius.com/docs/api/v2/customer-identity-api/account/account-create)
var accountCreateModel ={
"email" : [ {
"type" : "<type>" ,
"value" : "<value>"
} ] ,
"firstName" : "<firstName>",
"lastName" : "<lastName>",
"password" : "<password>"
}; //Required
var fields = null; //Optional
lrv2.accountApi.createAccount(accountCreateModel, fields).then((response) => {
console.log(response);
}).catch((error) => {
console.log(error);
});
var email = "<email>"; //Required
var emailTemplate = "<emailTemplate>"; //Optional
var resetPasswordUrl = "<resetPasswordUrl>"; //Optional
var sendEmail = true; //Optional
lrv2.accountApi.getForgotPasswordToken(email, emailTemplate, resetPasswordUrl, sendEmail).then((response) => {
console.log(response);
}).catch((error) => {
console.log(error);
});
var email = "<email>"; //Required
lrv2.accountApi.getEmailVerificationToken(email).then((response) => {
console.log(response);
}).catch((error) => {
console.log(error);
});
var uid = "<uid>"; //Required
lrv2.accountApi.getPrivacyPolicyHistoryByUid(uid).then((response) => {
console.log(response);
}).catch((error) => {
console.log(error);
});
var email = "<email>"; //Required
var fields = null; //Optional
lrv2.accountApi.getAccountProfileByEmail(email, fields).then((response) => {
console.log(response);
}).catch((error) => {
console.log(error);
});
var userName = "<userName>"; //Required
var fields = null; //Optional
lrv2.accountApi.getAccountProfileByUserName(userName, fields).then((response) => {
console.log(response);
}).catch((error) => {
console.log(error);
});
var phone = "<phone>"; //Required
var fields = null; //Optional
lrv2.accountApi.getAccountProfileByPhone(phone, fields).then((response) => {
console.log(response);
}).catch((error) => {
console.log(error);
});
var uid = "<uid>"; //Required
var fields = null; //Optional
lrv2.accountApi.getAccountProfileByUid(uid, fields).then((response) => {
console.log(response);
}).catch((error) => {
console.log(error);
});
var uid = "<uid>"; //Required
lrv2.accountApi.getAccountPasswordHashByUid(uid).then((response) => {
console.log(response);
}).catch((error) => {
console.log(error);
});
var uid = "<uid>"; //Required
lrv2.accountApi.getAccessTokenByUid(uid).then((response) => {
console.log(response);
}).catch((error) => {
console.log(error);
});
var refreshToken = "<refreshToken>"; //Required
lrv2.accountApi.refreshAccessTokenByRefreshToken(refreshToken).then((response) => {
console.log(response);
}).catch((error) => {
console.log(error);
});
var refreshToken = "<refreshToken>"; //Required
lrv2.accountApi.revokeRefreshToken(refreshToken).then((response) => {
console.log(response);
}).catch((error) => {
console.log(error);
});
var email = "<email>"; //Required
var fields = null; //Optional
lrv2.accountApi.getAccountIdentitiesByEmail(email, fields).then((response) => {
console.log(response);
}).catch((error) => {
console.log(error);
});
var uid = "<uid>"; //Required
lrv2.accountApi.deleteAccountByUid(uid).then((response) => {
console.log(response);
}).catch((error) => {
console.log(error);
});
var email = "<email>"; //Required
var uid = "<uid>"; //Required
var fields = null; //Optional
lrv2.accountApi.removeEmail(email, uid, fields).then((response) => {
console.log(response);
}).catch((error) => {
console.log(error);
});
var email = "<email>"; //Required
lrv2.accountApi.accountDeleteByEmail(email).then((response) => {
console.log(response);
}).catch((error) => {
console.log(error);
});
List of APIs in this Section:
- POST : Post Message API
- POST : Status Posting
- POST : Trackable Status Posting
- GET : Access Token
- GET : Refresh Token
- GET : Token Validate
- GET : Access Token Invalidate
- GET : Get Active Session Details
- GET : Get Active Session By Account Id
- GET : Get Active Session By Profile Id
- GET : Album
- GET : Get Albums with cursor
- GET : Audio
- GET : Get Audio With Cursor
- GET : Check In
- GET : Get CheckIns With Cursor
- GET : Contact
- GET : Event
- GET : Get Events With Cursor
- GET : Following
- GET : Get Followings With Cursor
- GET : Group
- GET : Get Groups With Cursor
- GET : Like
- GET : Get Likes With Cursor
- GET : Mention
- GET : Page
- GET : Photo
- GET : Get Post
- GET : Get Trackable Status Stats
- GET : Trackable Status Fetching
- GET : User Profile
- GET : Refresh User Profile
- GET : Video
Supported Providers: Twitter, LinkedIn
The Message API is used to post messages to the user?s contacts. This is one of the APIs that makes up the LoginRadius Friend Invite System. After using the Contact API, you can send messages to the retrieved contacts. This API requires setting permissions in your LoginRadius Dashboard.
GET & POST Message API work the same way except the API method is different [More Info](https://www.loginradius.com/docs/api/v2/customer-identity-api/social-login/advanced-social-api/post-message-api)
var accessToken = "<accessToken>"; //Required
var message = "<message>"; //Required
var subject = "<subject>"; //Required
var to = "<to>"; //Required
lrv2.socialApi.postMessage(accessToken, message, subject, to).then((response) => {
console.log(response);
}).catch((error) => {
console.log(error);
});
Supported Providers: Facebook, Twitter, LinkedIn [More Info](https://www.loginradius.com/docs/api/v2/customer-identity-api/social-login/advanced-social-api/status-posting/)
var accessToken = "<accessToken>"; //Required
var caption = "<caption>"; //Required
var description = "<description>"; //Required
var imageurl = "<imageurl>"; //Required
var status = "<status>"; //Required
var title = "<title>"; //Required
var url = "<url>"; //Required
var shorturl = "<shorturl>"; //Optional
lrv2.socialApi.statusPosting(accessToken, caption, description, imageurl, status, title, url, shorturl).then((response) => {
console.log(response);
}).catch((error) => {
console.log(error);
});
The Trackable Status API is used to update the status on the user's wall and return an Post ID value. It is commonly referred to as Permission based sharing or Push notifications.
POST Input Parameter Format: application/x-www-form-urlencoded [More Info](https://www.loginradius.com/docs/api/v2/customer-identity-api/social-login/advanced-social-api/trackable-status-posting/)
var accessToken = "<accessToken>"; //Required
var statusModel ={
"caption" : "<caption>",
"description" : "<description>",
"imageurl" : "<imageurl>",
"status" : "<status>",
"title" : "<title>",
"url" : "<url>"
}; //Required
lrv2.socialApi.trackableStatusPosting(accessToken, statusModel).then((response) => {
console.log(response);
}).catch((error) => {
console.log(error);
});
var token = "<token>"; //Required
lrv2.socialApi.exchangeAccessToken(token).then((response) => {
console.log(response);
}).catch((error) => {
console.log(error);
});
Supported Providers : Facebook,Yahoo,Google,Twitter, Linkedin.
Contact LoginRadius support team to enable this API. [More Info](https://www.loginradius.com/docs/api/v2/customer-identity-api/refresh-token/refresh-token)
var accessToken = "<accessToken>"; //Required
var expiresIn = 0; //Optional
var isWeb = true; //Optional
lrv2.socialApi.refreshAccessToken(accessToken, expiresIn, isWeb).then((response) => {
console.log(response);
}).catch((error) => {
console.log(error);
});
var accessToken = "<accessToken>"; //Required
lrv2.socialApi.validateAccessToken(accessToken).then((response) => {
console.log(response);
}).catch((error) => {
console.log(error);
});
var accessToken = "<accessToken>"; //Required
lrv2.socialApi.inValidateAccessToken(accessToken).then((response) => {
console.log(response);
}).catch((error) => {
console.log(error);
});
var token = "<token>"; //Required
lrv2.socialApi.getActiveSession(token).then((response) => {
console.log(response);
}).catch((error) => {
console.log(error);
});
var accountId = "<accountId>"; //Required
lrv2.socialApi.getActiveSessionByAccountID(accountId).then((response) => {
console.log(response);
}).catch((error) => {
console.log(error);
});
var profileId = "<profileId>"; //Required
lrv2.socialApi.getActiveSessionByProfileID(profileId).then((response) => {
console.log(response);
}).catch((error) => {
console.log(error);
});
This API returns the photo albums associated with the passed in access tokens Social Profile. [More Info](https://www.loginradius.com/docs/api/v2/customer-identity-api/social-login/advanced-social-api/album/)
var accessToken = "<accessToken>"; //Required
lrv2.socialApi.getAlbums(accessToken).then((response) => {
console.log(response);
}).catch((error) => {
console.log(error);
});
This API returns the photo albums associated with the passed in access tokens Social Profile. [More Info](https://www.loginradius.com/docs/api/v2/customer-identity-api/social-login/advanced-social-api/album/)
var accessToken = "<accessToken>"; //Required
var nextCursor = "<nextCursor>"; //Required
lrv2.socialApi.getAlbumsWithCursor(accessToken, nextCursor).then((response) => {
console.log(response);
}).catch((error) => {
console.log(error);
});
Supported Providers: Live, Vkontakte [More Info](https://www.loginradius.com/docs/api/v2/customer-identity-api/social-login/advanced-social-api/audio)
var accessToken = "<accessToken>"; //Required
lrv2.socialApi.getAudios(accessToken).then((response) => {
console.log(response);
}).catch((error) => {
console.log(error);
});
Supported Providers: Live, Vkontakte [More Info](https://www.loginradius.com/docs/api/v2/customer-identity-api/social-login/advanced-social-api/audio)
var accessToken = "<accessToken>"; //Required
var nextCursor = "<nextCursor>"; //Required
lrv2.socialApi.getAudiosWithCursor(accessToken, nextCursor).then((response) => {
console.log(response);
}).catch((error) => {
console.log(error);
});
Supported Providers: Facebook, Foursquare, Vkontakte [More Info](https://www.loginradius.com/docs/api/v2/customer-identity-api/social-login/advanced-social-api/check-in)
var accessToken = "<accessToken>"; //Required
lrv2.socialApi.getCheckIns(accessToken).then((response) => {
console.log(response);
}).catch((error) => {
console.log(error);
});
Supported Providers: Facebook, Foursquare, Vkontakte [More Info](https://www.loginradius.com/docs/api/v2/customer-identity-api/social-login/advanced-social-api/check-in)
var accessToken = "<accessToken>"; //Required
var nextCursor = "<nextCursor>"; //Required
lrv2.socialApi.getCheckInsWithCursor(accessToken, nextCursor).then((response) => {
console.log(response);
}).catch((error) => {
console.log(error);
});
Note: Facebook restricts access to the list of friends that is returned. When using the Contacts API with Facebook you will only receive friends that have accepted some permissions with your app.
Supported Providers: Facebook, Foursquare, Google, LinkedIn, Live, Twitter, Vkontakte, Yahoo [More Info](https://www.loginradius.com/docs/api/v2/customer-identity-api/social-login/advanced-social-api/contact)
var accessToken = "<accessToken>"; //Required
var nextCursor = "<nextCursor>"; //Optional
lrv2.socialApi.getContacts(accessToken, nextCursor).then((response) => {
console.log(response);
}).catch((error) => {
console.log(error);
});
Supported Providers: Facebook, Live [More Info](https://www.loginradius.com/docs/api/v2/customer-identity-api/social-login/advanced-social-api/event)
var accessToken = "<accessToken>"; //Required
lrv2.socialApi.getEvents(accessToken).then((response) => {
console.log(response);
}).catch((error) => {
console.log(error);
});
Supported Providers: Facebook, Live [More Info](https://www.loginradius.com/docs/api/v2/customer-identity-api/social-login/advanced-social-api/event)
var accessToken = "<accessToken>"; //Required
var nextCursor = "<nextCursor>"; //Required
lrv2.socialApi.getEventsWithCursor(accessToken, nextCursor).then((response) => {
console.log(response);
}).catch((error) => {
console.log(error);
});
Supported Providers: Twitter [More Info](https://www.loginradius.com/docs/api/v2/customer-identity-api/social-login/advanced-social-api/following)
var accessToken = "<accessToken>"; //Required
lrv2.socialApi.getFollowings(accessToken).then((response) => {
console.log(response);
}).catch((error) => {
console.log(error);
});
Supported Providers: Twitter [More Info](https://www.loginradius.com/docs/api/v2/customer-identity-api/social-login/advanced-social-api/following)
var accessToken = "<accessToken>"; //Required
var nextCursor = "<nextCursor>"; //Required
lrv2.socialApi.getFollowingsWithCursor(accessToken, nextCursor).then((response) => {
console.log(response);
}).catch((error) => {
console.log(error);
});
Supported Providers: Facebook, Vkontakte [More Info](https://www.loginradius.com/docs/api/v2/customer-identity-api/social-login/advanced-social-api/group)
var accessToken = "<accessToken>"; //Required
lrv2.socialApi.getGroups(accessToken).then((response) => {
console.log(response);
}).catch((error) => {
console.log(error);
});
Supported Providers: Facebook, Vkontakte [More Info](https://www.loginradius.com/docs/api/v2/customer-identity-api/social-login/advanced-social-api/group)
var accessToken = "<accessToken>"; //Required
var nextCursor = "<nextCursor>"; //Required
lrv2.socialApi.getGroupsWithCursor(accessToken, nextCursor).then((response) => {
console.log(response);
}).catch((error) => {
console.log(error);
});
Supported Providers: Facebook [More Info](https://www.loginradius.com/docs/api/v2/customer-identity-api/social-login/advanced-social-api/like)
var accessToken = "<accessToken>"; //Required
lrv2.socialApi.getLikes(accessToken).then((response) => {
console.log(response);
}).catch((error) => {
console.log(error);
});
Supported Providers: Facebook [More Info](https://www.loginradius.com/docs/api/v2/customer-identity-api/social-login/advanced-social-api/like)
var accessToken = "<accessToken>"; //Required
var nextCursor = "<nextCursor>"; //Required
lrv2.socialApi.getLikesWithCursor(accessToken, nextCursor).then((response) => {
console.log(response);
}).catch((error) => {
console.log(error);
});
Supported Providers: Twitter [More Info](https://www.loginradius.com/docs/api/v2/customer-identity-api/social-login/advanced-social-api/mention)
var accessToken = "<accessToken>"; //Required
lrv2.socialApi.getMentions(accessToken).then((response) => {
console.log(response);
}).catch((error) => {
console.log(error);
});
Supported Providers: Facebook, LinkedIn [More Info](https://www.loginradius.com/docs/api/v2/customer-identity-api/social-login/advanced-social-api/page)
var accessToken = "<accessToken>"; //Required
var pageName = "<pageName>"; //Required
lrv2.socialApi.getPage(accessToken, pageName).then((response) => {
console.log(response);
}).catch((error) => {
console.log(error);
});
Supported Providers: Facebook, Foursquare, Google, Live, Vkontakte [More Info](https://www.loginradius.com/docs/api/v2/customer-identity-api/social-login/advanced-social-api/photo)
var accessToken = "<accessToken>"; //Required
var albumId = "<albumId>"; //Required
lrv2.socialApi.getPhotos(accessToken, albumId).then((response) => {
console.log(response);
}).catch((error) => {
console.log(error);
});
Supported Providers: Facebook [More Info](https://www.loginradius.com/docs/api/v2/customer-identity-api/social-login/advanced-social-api/post)
var accessToken = "<accessToken>"; //Required
lrv2.socialApi.getPosts(accessToken).then((response) => {
console.log(response);
}).catch((error) => {
console.log(error);
});
The Trackable Status API is used to update the status on the user's wall and return an Post ID value. It is commonly referred to as Permission based sharing or Push notifications. [More Info](https://www.loginradius.com/docs/api/v2/customer-identity-api/social-login/advanced-social-api/get-trackable-status-stats/)
var accessToken = "<accessToken>"; //Required
var caption = "<caption>"; //Required
var description = "<description>"; //Required
var imageurl = "<imageurl>"; //Required
var status = "<status>"; //Required
var title = "<title>"; //Required
var url = "<url>"; //Required
lrv2.socialApi.getTrackableStatusStats(accessToken, caption, description, imageurl, status, title, url).then((response) => {
console.log(response);
}).catch((error) => {
console.log(error);
});
This API is used to retrieve a tracked post based on the passed in post ID value. This API requires setting permissions in your LoginRadius Dashboard.
Note: To utilize this API you need to find the ID for the post you want to track, which might require using Trackable Status Posting API first. [More Info](https://www.loginradius.com/docs/api/v2/customer-identity-api/social-login/advanced-social-api/trackable-status-fetching/)
var postId = "<postId>"; //Required
lrv2.socialApi.trackableStatusFetching(postId).then((response) => {
console.log(response);
}).catch((error) => {
console.log(error);
});
Supported Providers: All [More Info](https://www.loginradius.com/docs/api/v2/customer-identity-api/social-login/user-profile)
var accessToken = "<accessToken>"; //Required
var fields = null; //Optional
lrv2.socialApi.getSocialUserProfile(accessToken, fields).then((response) => {
console.log(response);
}).catch((error) => {
console.log(error);
});
var accessToken = "<accessToken>"; //Required
var fields = null; //Optional
lrv2.socialApi.getRefreshedSocialUserProfile(accessToken, fields).then((response) => {
console.log(response);
}).catch((error) => {
console.log(error);
});
Supported Providers: Facebook, Google, Live, Vkontakte [More Info](https://www.loginradius.com/docs/api/v2/customer-identity-api/social-login/advanced-social-api/video)
var accessToken = "<accessToken>"; //Required
var nextCursor = "<nextCursor>"; //Required
lrv2.socialApi.getVideos(accessToken, nextCursor).then((response) => {
console.log(response);
}).catch((error) => {
console.log(error);
});
List of APIs in this Section:
- PUT : Custom Object Update by Access Token
- PUT : Custom Object Update by UID
- POST : Create Custom Object by Token
- POST : Create Custom Object by UID
- GET : Custom Object by Token
- GET : Custom Object by ObjectRecordId and Token
- GET : Custom Object By UID
- GET : Custom Object by ObjectRecordId and UID
- DELETE : Custom Object Delete by Record Id And Token
- DELETE : Account Delete Custom Object by ObjectRecordId
var accessToken = "<accessToken>"; //Required
var objectName = "<objectName>"; //Required
var objectRecordId = "<objectRecordId>"; //Required
var object = { "customdata1": "Store my customdata1 value" }; //Required
var updateType = "<updateType>"; //Optional
lrv2.customObjectApi.updateCustomObjectByToken(accessToken, objectName, objectRecordId, object, updateType).then((response) => {
console.log(response);
}).catch((error) => {
console.log(error);
});
var objectName = "<objectName>"; //Required
var objectRecordId = "<objectRecordId>"; //Required
var object = { "customdata1": "Store my customdata1 value" }; //Required
var uid = "<uid>"; //Required
var updateType = "<updateType>"; //Optional
lrv2.customObjectApi.updateCustomObjectByUid(objectName, objectRecordId, object, uid, updateType).then((response) => {
console.log(response);
}).catch((error) => {
console.log(error);
});
var accessToken = "<accessToken>"; //Required
var objectName = "<objectName>"; //Required
var object = { "customdata1": "Store my customdata1 value" }; //Required
lrv2.customObjectApi.createCustomObjectByToken(accessToken, objectName, object).then((response) => {
console.log(response);
}).catch((error) => {
console.log(error);
});
var objectName = "<objectName>"; //Required
var object = { "customdata1": "Store my customdata1 value" }; //Required
var uid = "<uid>"; //Required
lrv2.customObjectApi.createCustomObjectByUid(objectName, object, uid).then((response) => {
console.log(response);
}).catch((error) => {
console.log(error);
});
var accessToken = "<accessToken>"; //Required
var objectName = "<objectName>"; //Required
lrv2.customObjectApi.getCustomObjectByToken(accessToken, objectName).then((response) => {
console.log(response);
}).catch((error) => {
console.log(error);
});
var accessToken = "<accessToken>"; //Required
var objectName = "<objectName>"; //Required
var objectRecordId = "<objectRecordId>"; //Required
lrv2.customObjectApi.getCustomObjectByRecordIDAndToken(accessToken, objectName, objectRecordId).then((response) => {
console.log(response);
}).catch((error) => {
console.log(error);
});
var objectName = "<objectName>"; //Required
var uid = "<uid>"; //Required
lrv2.customObjectApi.getCustomObjectByUid(objectName, uid).then((response) => {
console.log(response);
}).catch((error) => {
console.log(error);
});
var objectName = "<objectName>"; //Required
var objectRecordId = "<objectRecordId>"; //Required
var uid = "<uid>"; //Required
lrv2.customObjectApi.getCustomObjectByRecordID(objectName, objectRecordId, uid).then((response) => {
console.log(response);
}).catch((error) => {
console.log(error);
});
var accessToken = "<accessToken>"; //Required
var objectName = "<objectName>"; //Required
var objectRecordId = "<objectRecordId>"; //Required
lrv2.customObjectApi.deleteCustomObjectByToken(accessToken, objectName, objectRecordId).then((response) => {
console.log(response);
}).catch((error) => {
console.log(error);
});
var objectName = "<objectName>"; //Required
var objectRecordId = "<objectRecordId>"; //Required
var uid = "<uid>"; //Required
lrv2.customObjectApi.deleteCustomObjectByRecordID(objectName, objectRecordId, uid).then((response) => {
console.log(response);
}).catch((error) => {
console.log(error);
});
List of APIs in this Section:
- PUT : Phone Reset Password by OTP
- PUT : Phone Verification OTP
- PUT : Phone Verification OTP by Token
- PUT : Phone Number Update
- POST : Phone Login
- POST : Phone Forgot Password by OTP
- POST : Phone Resend Verification OTP
- POST : Phone Resend Verification OTP By Token
- POST : Phone User Registration by SMS
- GET : Phone Number Availability
- DELETE : Remove Phone ID by Access Token
var resetPasswordByOTPModel ={
"otp" : "<otp>",
"password" : "<password>",
"phone" : "<phone>"
}; //Required
lrv2.phoneAuthenticationApi.resetPasswordByPhoneOTP(resetPasswordByOTPModel).then((response) => {
console.log(response);
}).catch((error) => {
console.log(error);
});
var otp = "<otp>"; //Required
var phone = "<phone>"; //Required
var fields = null; //Optional
var smsTemplate = "<smsTemplate>"; //Optional
lrv2.phoneAuthenticationApi.phoneVerificationByOTP(otp, phone, fields, smsTemplate).then((response) => {
console.log(response);
}).catch((error) => {
console.log(error);
});
var accessToken = "<accessToken>"; //Required
var otp = "<otp>"; //Required
var smsTemplate = "<smsTemplate>"; //Optional
lrv2.phoneAuthenticationApi.phoneVerificationOTPByAccessToken(accessToken, otp, smsTemplate).then((response) => {
console.log(response);
}).catch((error) => {
console.log(error);
});
var accessToken = "<accessToken>"; //Required
var phone = "<phone>"; //Required
var smsTemplate = "<smsTemplate>"; //Optional
lrv2.phoneAuthenticationApi.updatePhoneNumber(accessToken, phone, smsTemplate).then((response) => {
console.log(response);
}).catch((error) => {
console.log(error);
});
var phoneAuthenticationModel ={
"password" : "<password>",
"phone" : "<phone>"
}; //Required
var fields = null; //Optional
var loginUrl = "<loginUrl>"; //Optional
var smsTemplate = "<smsTemplate>"; //Optional
lrv2.phoneAuthenticationApi.loginByPhone(phoneAuthenticationModel, fields, loginUrl, smsTemplate).then((response) => {
console.log(response);
}).catch((error) => {
console.log(error);
});
var phone = "<phone>"; //Required
var smsTemplate = "<smsTemplate>"; //Optional
lrv2.phoneAuthenticationApi.forgotPasswordByPhoneOTP(phone, smsTemplate).then((response) => {
console.log(response);
}).catch((error) => {
console.log(error);
});
var phone = "<phone>"; //Required
var smsTemplate = "<smsTemplate>"; //Optional
lrv2.phoneAuthenticationApi.phoneResendVerificationOTP(phone, smsTemplate).then((response) => {
console.log(response);
}).catch((error) => {
console.log(error);
});
var accessToken = "<accessToken>"; //Required
var phone = "<phone>"; //Required
var smsTemplate = "<smsTemplate>"; //Optional
lrv2.phoneAuthenticationApi.phoneResendVerificationOTPByToken(accessToken, phone, smsTemplate).then((response) => {
console.log(response);
}).catch((error) => {
console.log(error);
});
var authUserRegistrationModel ={
"firstName" : "<firstName>",
"lastName" : "<lastName>",
"password" : "<password>",
"phoneId" : "<phoneId>"
}; //Required
var sott = "<sott>"; //Required
var fields = null; //Optional
var options = "<options>"; //Optional
var smsTemplate = "<smsTemplate>"; //Optional
var verificationUrl = "<verificationUrl>"; //Optional
var welcomeEmailTemplate = "<welcomeEmailTemplate>"; //Optional
lrv2.phoneAuthenticationApi.userRegistrationByPhone(authUserRegistrationModel, sott, fields, options, smsTemplate, verificationUrl, welcomeEmailTemplate).then((response) => {
console.log(response);
}).catch((error) => {
console.log(error);
});
var phone = "<phone>"; //Required
lrv2.phoneAuthenticationApi.checkPhoneNumberAvailability(phone).then((response) => {
console.log(response);
}).catch((error) => {
console.log(error);
});
var accessToken = "<accessToken>"; //Required
lrv2.phoneAuthenticationApi.removePhoneIDByAccessToken(accessToken).then((response) => {
console.log(response);
}).catch((error) => {
console.log(error);
});
List of APIs in this Section:
- PUT : Update MFA Setting
- PUT : Update MFA by Access Token
- PUT : MFA Update Phone Number by Token
- PUT : MFA Validate OTP
- PUT : MFA Validate Google Auth Code
- PUT : MFA Validate Backup code
- PUT : MFA Update Phone Number
- POST : MFA Email Login
- POST : MFA UserName Login
- POST : MFA Phone Login
- GET : MFA Validate Access Token
- GET : MFA Backup Code by Access Token
- GET : Reset Backup Code by Access Token
- GET : MFA Resend Otp
- GET : MFA Backup Code by UID
- GET : MFA Reset Backup Code by UID
- DELETE : MFA Reset Google Authenticator by Token
- DELETE : MFA Reset SMS Authenticator by Token
- DELETE : MFA Reset SMS Authenticator By UID
- DELETE : MFA Reset Google Authenticator By UID
var accessToken = "<accessToken>"; //Required
var multiFactorAuthModelWithLockout ={
"otp" : "<otp>"
}; //Required
var fields = null; //Optional
lrv2.multiFactorAuthenticationApi.mfaUpdateSetting(accessToken, multiFactorAuthModelWithLockout, fields).then((response) => {
console.log(response);
}).catch((error) => {
console.log(error);
});
var accessToken = "<accessToken>"; //Required
var multiFactorAuthModelByGoogleAuthenticatorCode ={
"googleAuthenticatorCode" : "<googleAuthenticatorCode>"
}; //Required
var fields = null; //Optional
var smsTemplate = "<smsTemplate>"; //Optional
lrv2.multiFactorAuthenticationApi.mfaUpdateByAccessToken(accessToken, multiFactorAuthModelByGoogleAuthenticatorCode, fields, smsTemplate).then((response) => {
console.log(response);
}).catch((error) => {
console.log(error);
});
var accessToken = "<accessToken>"; //Required
var phoneNo2FA = "<phoneNo2FA>"; //Required
var smsTemplate2FA = "<smsTemplate2FA>"; //Optional
lrv2.multiFactorAuthenticationApi.mfaUpdatePhoneNumberByToken(accessToken, phoneNo2FA, smsTemplate2FA).then((response) => {
console.log(response);
}).catch((error) => {
console.log(error);
});
var multiFactorAuthModelWithLockout ={
"otp" : "<otp>"
}; //Required
var secondFactorAuthenticationToken = "<secondFactorAuthenticationToken>"; //Required
var fields = null; //Optional
var smsTemplate2FA = "<smsTemplate2FA>"; //Optional
lrv2.multiFactorAuthenticationApi.mfaValidateOTPByPhone(multiFactorAuthModelWithLockout, secondFactorAuthenticationToken, fields, smsTemplate2FA).then((response) => {
console.log(response);
}).catch((error) => {
console.log(error);
});
var googleAuthenticatorCode = "<googleAuthenticatorCode>"; //Required
var secondFactorAuthenticationToken = "<secondFactorAuthenticationToken>"; //Required
var fields = null; //Optional
var smsTemplate2FA = "<smsTemplate2FA>"; //Optional
lrv2.multiFactorAuthenticationApi.mfaValidateGoogleAuthCode(googleAuthenticatorCode, secondFactorAuthenticationToken, fields, smsTemplate2FA).then((response) => {
console.log(response);
}).catch((error) => {
console.log(error);
});
var multiFactorAuthModelByBackupCode ={
"backupCode" : "<backupCode>"
}; //Required
var secondFactorAuthenticationToken = "<secondFactorAuthenticationToken>"; //Required
var fields = null; //Optional
lrv2.multiFactorAuthenticationApi.mfaValidateBackupCode(multiFactorAuthModelByBackupCode, secondFactorAuthenticationToken, fields).then((response) => {
console.log(response);
}).catch((error) => {
console.log(error);
});
var phoneNo2FA = "<phoneNo2FA>"; //Required
var secondFactorAuthenticationToken = "<secondFactorAuthenticationToken>"; //Required
var smsTemplate2FA = "<smsTemplate2FA>"; //Optional
lrv2.multiFactorAuthenticationApi.mfaUpdatePhoneNumber(phoneNo2FA, secondFactorAuthenticationToken, smsTemplate2FA).then((response) => {
console.log(response);
}).catch((error) => {
console.log(error);
});
var email = "<email>"; //Required
var password = "<password>"; //Required
var emailTemplate = "<emailTemplate>"; //Optional
var fields = null; //Optional
var loginUrl = "<loginUrl>"; //Optional
var smsTemplate = "<smsTemplate>"; //Optional
var smsTemplate2FA = "<smsTemplate2FA>"; //Optional
var verificationUrl = "<verificationUrl>"; //Optional
lrv2.multiFactorAuthenticationApi.mfaLoginByEmail(email, password, emailTemplate, fields, loginUrl, smsTemplate, smsTemplate2FA, verificationUrl).then((response) => {
console.log(response);
}).catch((error) => {
console.log(error);
});
var password = "<password>"; //Required
var username = "<username>"; //Required
var emailTemplate = "<emailTemplate>"; //Optional
var fields = null; //Optional
var loginUrl = "<loginUrl>"; //Optional
var smsTemplate = "<smsTemplate>"; //Optional
var smsTemplate2FA = "<smsTemplate2FA>"; //Optional
var verificationUrl = "<verificationUrl>"; //Optional
lrv2.multiFactorAuthenticationApi.mfaLoginByUserName(password, username, emailTemplate, fields, loginUrl, smsTemplate, smsTemplate2FA, verificationUrl).then((response) => {
console.log(response);
}).catch((error) => {
console.log(error);
});
var password = "<password>"; //Required
var phone = "<phone>"; //Required
var emailTemplate = "<emailTemplate>"; //Optional
var fields = null; //Optional
var loginUrl = "<loginUrl>"; //Optional
var smsTemplate = "<smsTemplate>"; //Optional
var smsTemplate2FA = "<smsTemplate2FA>"; //Optional
var verificationUrl = "<verificationUrl>"; //Optional
lrv2.multiFactorAuthenticationApi.mfaLoginByPhone(password, phone, emailTemplate, fields, loginUrl, smsTemplate, smsTemplate2FA, verificationUrl).then((response) => {
console.log(response);
}).catch((error) => {
console.log(error);
});
var accessToken = "<accessToken>"; //Required
var smsTemplate2FA = "<smsTemplate2FA>"; //Optional
lrv2.multiFactorAuthenticationApi.mfaConfigureByAccessToken(accessToken, smsTemplate2FA).then((response) => {
console.log(response);
}).catch((error) => {
console.log(error);
});
var accessToken = "<accessToken>"; //Required
lrv2.multiFactorAuthenticationApi.mfaBackupCodeByAccessToken(accessToken).then((response) => {
console.log(response);
}).catch((error) => {
console.log(error);
});
var accessToken = "<accessToken>"; //Required
lrv2.multiFactorAuthenticationApi.mfaResetBackupCodeByAccessToken(accessToken).then((response) => {
console.log(response);
}).catch((error) => {
console.log(error);
});
var secondFactorAuthenticationToken = "<secondFactorAuthenticationToken>"; //Required
var smsTemplate2FA = "<smsTemplate2FA>"; //Optional
lrv2.multiFactorAuthenticationApi.mfaResendOTP(secondFactorAuthenticationToken, smsTemplate2FA).then((response) => {
console.log(response);
}).catch((error) => {
console.log(error);
});
var uid = "<uid>"; //Required
lrv2.multiFactorAuthenticationApi.mfaBackupCodeByUid(uid).then((response) => {
console.log(response);
}).catch((error) => {
console.log(error);
});
var uid = "<uid>"; //Required
lrv2.multiFactorAuthenticationApi.mfaResetBackupCodeByUid(uid).then((response) => {
console.log(response);
}).catch((error) => {
console.log(error);
});
var accessToken = "<accessToken>"; //Required
var googleauthenticator = true; //Required
lrv2.multiFactorAuthenticationApi.mfaResetGoogleAuthByToken(accessToken, googleauthenticator).then((response) => {
console.log(response);
}).catch((error) => {
console.log(error);
});
var accessToken = "<accessToken>"; //Required
var otpauthenticator = true; //Required
lrv2.multiFactorAuthenticationApi.mfaResetSMSAuthByToken(accessToken, otpauthenticator).then((response) => {
console.log(response);
}).catch((error) => {
console.log(error);
});
var otpauthenticator = true; //Required
var uid = "<uid>"; //Required
lrv2.multiFactorAuthenticationApi.mfaResetSMSAuthenticatorByUid(otpauthenticator, uid).then((response) => {
console.log(response);
}).catch((error) => {
console.log(error);
});
var googleauthenticator = true; //Required
var uid = "<uid>"; //Required
lrv2.multiFactorAuthenticationApi.mfaResetGoogleAuthenticatorByUid(googleauthenticator, uid).then((response) => {
console.log(response);
}).catch((error) => {
console.log(error);
});
List of APIs in this Section:
- PUT : Reset PIN By ResetToken
- PUT : Reset PIN By SecurityAnswer And Email
- PUT : Reset PIN By SecurityAnswer And Username
- PUT : Reset PIN By SecurityAnswer And Phone
- PUT : Change PIN By Token
- PUT : Reset PIN by Phone and OTP
- PUT : Reset PIN by Email and OTP
- PUT : Reset PIN by Username and OTP
- POST : PIN Login
- POST : Forgot PIN By Email
- POST : Forgot PIN By UserName
- POST : Forgot PIN By Phone
- POST : Set PIN By PinAuthToken
- GET : Invalidate PIN Session Token
var resetPINByResetToken ={
"pin" : "<pin>",
"resetToken" : "<resetToken>"
}; //Required
lrv2.pinAuthenticationApi.resetPINByResetToken(resetPINByResetToken).then((response) => {
console.log(response);
}).catch((error) => {
console.log(error);
});
var resetPINBySecurityQuestionAnswerAndEmailModel ={
"email" : "<email>",
"pin" : "<pin>",
"securityAnswer" : {"QuestionID":"Answer"}
}; //Required
lrv2.pinAuthenticationApi.resetPINByEmailAndSecurityAnswer(resetPINBySecurityQuestionAnswerAndEmailModel).then((response) => {
console.log(response);
}).catch((error) => {
console.log(error);
});
var resetPINBySecurityQuestionAnswerAndUsernameModel ={
"pin" : "<pin>",
"securityAnswer" : {"QuestionID":"Answer"},
"username" : "<username>"
}; //Required
lrv2.pinAuthenticationApi.resetPINByUsernameAndSecurityAnswer(resetPINBySecurityQuestionAnswerAndUsernameModel).then((response) => {
console.log(response);
}).catch((error) => {
console.log(error);
});
var resetPINBySecurityQuestionAnswerAndPhoneModel ={
"phone" : "<phone>",
"pin" : "<pin>",
"securityAnswer" : {"QuestionID":"Answer"}
}; //Required
lrv2.pinAuthenticationApi.resetPINByPhoneAndSecurityAnswer(resetPINBySecurityQuestionAnswerAndPhoneModel).then((response) => {
console.log(response);
}).catch((error) => {
console.log(error);
});
var accessToken = "<accessToken>"; //Required
var changePINModel ={
"newPIN" : "<newPIN>",
"oldPIN" : "<oldPIN>"
}; //Required
lrv2.pinAuthenticationApi.changePINByAccessToken(accessToken, changePINModel).then((response) => {
console.log(response);
}).catch((error) => {
console.log(error);
});
var resetPINByPhoneAndOTPModel ={
"otp" : "<otp>",
"phone" : "<phone>",
"pin" : "<pin>"
}; //Required
lrv2.pinAuthenticationApi.resetPINByPhoneAndOtp(resetPINByPhoneAndOTPModel).then((response) => {
console.log(response);
}).catch((error) => {
console.log(error);
});
var resetPINByEmailAndOtpModel ={
"email" : "<email>",
"otp" : "<otp>",
"pin" : "<pin>"
}; //Required
lrv2.pinAuthenticationApi.resetPINByEmailAndOtp(resetPINByEmailAndOtpModel).then((response) => {
console.log(response);
}).catch((error) => {
console.log(error);
});
var resetPINByUsernameAndOtpModel ={
"otp" : "<otp>",
"pin" : "<pin>",
"username" : "<username>"
}; //Required
lrv2.pinAuthenticationApi.resetPINByUsernameAndOtp(resetPINByUsernameAndOtpModel).then((response) => {
console.log(response);
}).catch((error) => {
console.log(error);
});
var loginByPINModel ={
"pin" : "<pin>"
}; //Required
var sessionToken = "<sessionToken>"; //Required
lrv2.pinAuthenticationApi.pinLogin(loginByPINModel, sessionToken).then((response) => {
console.log(response);
}).catch((error) => {
console.log(error);
});
var forgotPINLinkByEmailModel ={
"email" : "<email>"
}; //Required
var emailTemplate = "<emailTemplate>"; //Optional
var resetPINUrl = "<resetPINUrl>"; //Optional
lrv2.pinAuthenticationApi.sendForgotPINEmailByEmail(forgotPINLinkByEmailModel, emailTemplate, resetPINUrl).then((response) => {
console.log(response);
}).catch((error) => {
console.log(error);
});
var forgotPINLinkByUserNameModel ={
"userName" : "<userName>"
}; //Required
var emailTemplate = "<emailTemplate>"; //Optional
var resetPINUrl = "<resetPINUrl>"; //Optional
lrv2.pinAuthenticationApi.sendForgotPINEmailByUsername(forgotPINLinkByUserNameModel, emailTemplate, resetPINUrl).then((response) => {
console.log(response);
}).catch((error) => {
console.log(error);
});
var forgotPINOtpByPhoneModel ={
"phone" : "<phone>"
}; //Required
var smsTemplate = "<smsTemplate>"; //Optional
lrv2.pinAuthenticationApi.sendForgotPINSMSByPhone(forgotPINOtpByPhoneModel, smsTemplate).then((response) => {
console.log(response);
}).catch((error) => {
console.log(error);
});
var pinRequiredModel ={
"pin" : "<pin>"
}; //Required
var pinAuthToken = "<pinAuthToken>"; //Required
lrv2.pinAuthenticationApi.setPINByPinAuthToken(pinRequiredModel, pinAuthToken).then((response) => {
console.log(response);
}).catch((error) => {
console.log(error);
});
var sessionToken = "<sessionToken>"; //Required
lrv2.pinAuthenticationApi.inValidatePinSessionToken(sessionToken).then((response) => {
console.log(response);
}).catch((error) => {
console.log(error);
});
List of APIs in this Section:
- PUT : Validate MFA by OTP
- PUT : Validate MFA by Backup Code
- PUT : Validate MFA by Google Authenticator Code
- PUT : Validate MFA by Password
- PUT : MFA Re-authentication by PIN
- POST : Verify Multifactor OTP Authentication
- POST : Verify Multifactor Password Authentication
- POST : Verify Multifactor PIN Authentication
- GET : Multi Factor Re-Authenticate
var accessToken = "<accessToken>"; //Required
var reauthByOtpModel ={
"otp" : "<otp>"
}; //Required
lrv2.reAuthenticationApi.mfaReAuthenticateByOTP(accessToken, reauthByOtpModel).then((response) => {
console.log(response);
}).catch((error) => {
console.log(error);
});
var accessToken = "<accessToken>"; //Required
var reauthByBackupCodeModel ={
"backupCode" : "<backupCode>"
}; //Required
lrv2.reAuthenticationApi.mfaReAuthenticateByBackupCode(accessToken, reauthByBackupCodeModel).then((response) => {
console.log(response);
}).catch((error) => {
console.log(error);
});
var accessToken = "<accessToken>"; //Required
var reauthByGoogleAuthenticatorCodeModel ={
"googleAuthenticatorCode" : "<googleAuthenticatorCode>"
}; //Required
lrv2.reAuthenticationApi.mfaReAuthenticateByGoogleAuth(accessToken, reauthByGoogleAuthenticatorCodeModel).then((response) => {
console.log(response);
}).catch((error) => {
console.log(error);
});
var accessToken = "<accessToken>"; //Required
var passwordEventBasedAuthModelWithLockout ={
"password" : "<password>"
}; //Required
var smsTemplate2FA = "<smsTemplate2FA>"; //Optional
lrv2.reAuthenticationApi.mfaReAuthenticateByPassword(accessToken, passwordEventBasedAuthModelWithLockout, smsTemplate2FA).then((response) => {
console.log(response);
}).catch((error) => {
console.log(error);
});
var accessToken = "<accessToken>"; //Required
var pinAuthEventBasedAuthModelWithLockout ={
"pin" : "<pin>"
}; //Required
var smsTemplate2FA = "<smsTemplate2FA>"; //Optional
lrv2.reAuthenticationApi.verifyPINAuthentication(accessToken, pinAuthEventBasedAuthModelWithLockout, smsTemplate2FA).then((response) => {
console.log(response);
}).catch((error) => {
console.log(error);
});
var eventBasedMultiFactorToken ={
"secondFactorValidationToken" : "<secondFactorValidationToken>"
}; //Required
var uid = "<uid>"; //Required
lrv2.reAuthenticationApi.verifyMultiFactorOtpReauthentication(eventBasedMultiFactorToken, uid).then((response) => {
console.log(response);
}).catch((error) => {
console.log(error);
});
var eventBasedMultiFactorToken ={
"secondFactorValidationToken" : "<secondFactorValidationToken>"
}; //Required
var uid = "<uid>"; //Required
lrv2.reAuthenticationApi.verifyMultiFactorPasswordReauthentication(eventBasedMultiFactorToken, uid).then((response) => {
console.log(response);
}).catch((error) => {
console.log(error);
});
var eventBasedMultiFactorToken ={
"secondFactorValidationToken" : "<secondFactorValidationToken>"
}; //Required
var uid = "<uid>"; //Required
lrv2.reAuthenticationApi.verifyMultiFactorPINReauthentication(eventBasedMultiFactorToken, uid).then((response) => {
console.log(response);
}).catch((error) => {
console.log(error);
});
var accessToken = "<accessToken>"; //Required
var smsTemplate2FA = "<smsTemplate2FA>"; //Optional
lrv2.reAuthenticationApi.mfaReAuthenticate(accessToken, smsTemplate2FA).then((response) => {
console.log(response);
}).catch((error) => {
console.log(error);
});
List of APIs in this Section:
- PUT : Update Consent By Access Token
- POST : Consent By ConsentToken
- POST : Post Consent By Access Token
- GET : Get Consent Logs By Uid
- GET : Get Consent Log by Access Token
- GET : Get Verify Consent By Access Token
var accessToken = "<accessToken>"; //Required
var consentUpdateModel ={
"consents" : [ {
"consentOptionId" : "<consentOptionId>" ,
"isAccepted" : true
} ]
}; //Required
lrv2.consentManagementApi.updateConsentProfileByAccessToken(accessToken, consentUpdateModel).then((response) => {
console.log(response);
}).catch((error) => {
console.log(error);
});
var consentToken = "<consentToken>"; //Required
var consentSubmitModel ={
"data" : [ {
"consentOptionId" : "<consentOptionId>" ,
"isAccepted" : true
} ] ,
"events" : [ {
"event" : "<event>" ,
"isCustom" : true
} ]
}; //Required
lrv2.consentManagementApi.submitConsentByConsentToken(consentToken, consentSubmitModel).then((response) => {
console.log(response);
}).catch((error) => {
console.log(error);
});
var accessToken = "<accessToken>"; //Required
var consentSubmitModel ={
"data" : [ {
"consentOptionId" : "<consentOptionId>" ,
"isAccepted" : true
} ] ,
"events" : [ {
"event" : "<event>" ,
"isCustom" : true
} ]
}; //Required
lrv2.consentManagementApi.submitConsentByAccessToken(accessToken, consentSubmitModel).then((response) => {
console.log(response);
}).catch((error) => {
console.log(error);
});
var uid = "<uid>"; //Required
lrv2.consentManagementApi.getConsentLogsByUid(uid).then((response) => {
console.log(response);
}).catch((error) => {
console.log(error);
});
var accessToken = "<accessToken>"; //Required
lrv2.consentManagementApi.getConsentLogs(accessToken).then((response) => {
console.log(response);
}).catch((error) => {
console.log(error);
});
var accessToken = "<accessToken>"; //Required
var event = "<event>"; //Required
var isCustom = true; //Required
lrv2.consentManagementApi.verifyConsentByAccessToken(accessToken, event, isCustom).then((response) => {
console.log(response);
}).catch((error) => {
console.log(error);
});
List of APIs in this Section:
- GET : Smart Login Verify Token
- GET : Smart Login By Email
- GET : Smart Login By Username
- GET : Smart Login Ping
var verificationToken = "<verificationToken>"; //Required
var welcomeEmailTemplate = "<welcomeEmailTemplate>"; //Optional
lrv2.smartLoginApi.smartLoginTokenVerification(verificationToken, welcomeEmailTemplate).then((response) => {
console.log(response);
}).catch((error) => {
console.log(error);
});
var clientGuid = "<clientGuid>"; //Required
var email = "<email>"; //Required
var redirectUrl = "<redirectUrl>"; //Optional
var smartLoginEmailTemplate = "<smartLoginEmailTemplate>"; //Optional
var welcomeEmailTemplate = "<welcomeEmailTemplate>"; //Optional
lrv2.smartLoginApi.smartLoginByEmail(clientGuid, email, redirectUrl, smartLoginEmailTemplate, welcomeEmailTemplate).then((response) => {
console.log(response);
}).catch((error) => {
console.log(error);
});
var clientGuid = "<clientGuid>"; //Required
var username = "<username>"; //Required
var redirectUrl = "<redirectUrl>"; //Optional
var smartLoginEmailTemplate = "<smartLoginEmailTemplate>"; //Optional
var welcomeEmailTemplate = "<welcomeEmailTemplate>"; //Optional
lrv2.smartLoginApi.smartLoginByUserName(clientGuid, username, redirectUrl, smartLoginEmailTemplate, welcomeEmailTemplate).then((response) => {
console.log(response);
}).catch((error) => {
console.log(error);
});
var clientGuid = "<clientGuid>"; //Required
var fields = null; //Optional
lrv2.smartLoginApi.smartLoginPing(clientGuid, fields).then((response) => {
console.log(response);
}).catch((error) => {
console.log(error);
});
List of APIs in this Section:
- PUT : One Touch OTP Verification
- POST : One Touch Login by Email
- POST : One Touch Login by Phone
- GET : One Touch Email Verification
- GET : One Touch Login Ping
var otp = "<otp>"; //Required
var phone = "<phone>"; //Required
var fields = null; //Optional
var smsTemplate = "<smsTemplate>"; //Optional
lrv2.oneTouchLoginApi.oneTouchLoginOTPVerification(otp, phone, fields, smsTemplate).then((response) => {
console.log(response);
}).catch((error) => {
console.log(error);
});
var oneTouchLoginByEmailModel ={
"clientguid" : "<clientguid>",
"email" : "<email>",
"g-recaptcha-response" : "<g-recaptcha-response>"
}; //Required
var oneTouchLoginEmailTemplate = "<oneTouchLoginEmailTemplate>"; //Optional
var redirecturl = "<redirecturl>"; //Optional
var welcomeemailtemplate = "<welcomeemailtemplate>"; //Optional
lrv2.oneTouchLoginApi.oneTouchLoginByEmail(oneTouchLoginByEmailModel, oneTouchLoginEmailTemplate, redirecturl, welcomeemailtemplate).then((response) => {
console.log(response);
}).catch((error) => {
console.log(error);
});
var oneTouchLoginByPhoneModel ={
"g-recaptcha-response" : "<g-recaptcha-response>",
"phone" : "<phone>"
}; //Required
var smsTemplate = "<smsTemplate>"; //Optional
lrv2.oneTouchLoginApi.oneTouchLoginByPhone(oneTouchLoginByPhoneModel, smsTemplate).then((response) => {
console.log(response);
}).catch((error) => {
console.log(error);
});
var verificationToken = "<verificationToken>"; //Required
var welcomeEmailTemplate = "<welcomeEmailTemplate>"; //Optional
lrv2.oneTouchLoginApi.oneTouchEmailVerification(verificationToken, welcomeEmailTemplate).then((response) => {
console.log(response);
}).catch((error) => {
console.log(error);
});
var clientGuid = "<clientGuid>"; //Required
var fields = null; //Optional
lrv2.oneTouchLoginApi.oneTouchLoginPing(clientGuid, fields).then((response) => {
console.log(response);
}).catch((error) => {
console.log(error);
});
List of APIs in this Section:
- PUT : Passwordless Login Phone Verification
- POST : Passwordless Login Verification By Email And OTP
- POST : Passwordless Login Verification By User Name And OTP
- GET : Passwordless Login by Phone
- GET : Passwordless Login By Email
- GET : Passwordless Login By UserName
- GET : Passwordless Login Verification
var passwordLessLoginOtpModel ={
"otp" : "<otp>",
"phone" : "<phone>"
}; //Required
var fields = null; //Optional
var smsTemplate = "<smsTemplate>"; //Optional
lrv2.passwordLessLoginApi.passwordlessLoginPhoneVerification(passwordLessLoginOtpModel, fields, smsTemplate).then((response) => {
console.log(response);
}).catch((error) => {
console.log(error);
});
var passwordLessLoginByEmailAndOtpModel ={
"email": "<email>",
"otp": "<otp>",
"welcomeemailtemplate": "<welcome_email_template>"
}; //Required
var fields = null; //Optional
lrv2.passwordLessLoginApi.passwordlessLoginVerificationByEmailAndOTP(passwordLessLoginByEmailAndOtpModel, fields).then((response) => {
console.log(response);
}).catch((error) => {
console.log(error);
});
var passwordLessLoginByUserNameAndOtpModel ={
"username": "<User name>",
"otp": "<otp>",
"welcomeemailtemplate": "<welcome_email_template>"
}; //Required
var fields = null; //Optional
lrv2.passwordLessLoginApi.passwordlessLoginVerificationByUserNameAndOTP(passwordLessLoginByUserNameAndOtpModel, fields).then((response) => {
console.log(response);
}).catch((error) => {
console.log(error);
});
var phone = "<phone>"; //Required
var smsTemplate = "<smsTemplate>"; //Optional
lrv2.passwordLessLoginApi.passwordlessLoginByPhone(phone, smsTemplate).then((response) => {
console.log(response);
}).catch((error) => {
console.log(error);
});
var email = "<email>"; //Required
var passwordLessLoginTemplate = "<passwordLessLoginTemplate>"; //Optional
var verificationUrl = "<verificationUrl>"; //Optional
lrv2.passwordLessLoginApi.passwordlessLoginByEmail(email, passwordLessLoginTemplate, verificationUrl).then((response) => {
console.log(response);
}).catch((error) => {
console.log(error);
});
var username = "<username>"; //Required
var passwordLessLoginTemplate = "<passwordLessLoginTemplate>"; //Optional
var verificationUrl = "<verificationUrl>"; //Optional
lrv2.passwordLessLoginApi.passwordlessLoginByUserName(username, passwordLessLoginTemplate, verificationUrl).then((response) => {
console.log(response);
}).catch((error) => {
console.log(error);
});
var verificationToken = "<verificationToken>"; //Required
var fields = null; //Optional
var welcomeEmailTemplate = "<welcomeEmailTemplate>"; //Optional
lrv2.passwordLessLoginApi.passwordlessLoginVerification(verificationToken, fields, welcomeEmailTemplate).then((response) => {
console.log(response);
}).catch((error) => {
console.log(error);
});
List of APIs in this Section:
- GET : Get Server Time
- GET : Get Configurations
var timeDifference = 0; //Optional
lrv2.configurationApi.getServerInfo(timeDifference).then((response) => {
console.log(response);
}).catch((error) => {
console.log(error);
});
lrv2.configurationApi.getConfigurations().then((response) => {
console.log(response);
}).catch((error) => {
console.log(error);
});
List of APIs in this Section:
- PUT : Assign Roles by UID
- PUT : Upsert Context
- PUT : Add Permissions to Role
- POST : Roles Create
- GET : Roles by UID
- GET : Get Context with Roles and Permissions
- GET : Role Context profile
- GET : Roles List
- DELETE : Unassign Roles by UID
- DELETE : Delete Role Context
- DELETE : Delete Role from Context
- DELETE : Delete Additional Permission from Context
- DELETE : Account Delete Role
- DELETE : Remove Permissions
var accountRolesModel ={
"roles" : [ "roles" ]
}; //Required
var uid = "<uid>"; //Required
lrv2.roleApi.assignRolesByUid(accountRolesModel, uid).then((response) => {
console.log(response);
}).catch((error) => {
console.log(error);
});
var accountRoleContextModel ={
"roleContext" : [ {
"additionalPermissions" : ["<additionalPermissions>" ] ,
"context" : "<context>" ,
"expiration" : "<expiration>" ,
"roles" : ["<roles>" ]
} ]
}; //Required
var uid = "<uid>"; //Required
lrv2.roleApi.updateRoleContextByUid(accountRoleContextModel, uid).then((response) => {
console.log(response);
}).catch((error) => {
console.log(error);
});
var permissionsModel ={
"permissions" : [ "permissions" ]
}; //Required
var role = "<role>"; //Required
lrv2.roleApi.addRolePermissions(permissionsModel, role).then((response) => {
console.log(response);
}).catch((error) => {
console.log(error);
});
var rolesModel ={
"roles" : [ {
"name" : "<name>" ,
"permissions" : {"Permission_name":true}
} ]
}; //Required
lrv2.roleApi.createRoles(rolesModel).then((response) => {
console.log(response);
}).catch((error) => {
console.log(error);
});
var uid = "<uid>"; //Required
lrv2.roleApi.getRolesByUid(uid).then((response) => {
console.log(response);
}).catch((error) => {
console.log(error);
});
var uid = "<uid>"; //Required
lrv2.roleApi.getRoleContextByUid(uid).then((response) => {
console.log(response);
}).catch((error) => {
console.log(error);
});
var contextName = "<contextName>"; //Required
lrv2.roleApi.getRoleContextByContextName(contextName).then((response) => {
console.log(response);
}).catch((error) => {
console.log(error);
});
lrv2.roleApi.getRolesList().then((response) => {
console.log(response);
}).catch((error) => {
console.log(error);
});
var accountRolesModel ={
"roles" : [ "roles" ]
}; //Required
var uid = "<uid>"; //Required
lrv2.roleApi.unassignRolesByUid(accountRolesModel, uid).then((response) => {
console.log(response);
}).catch((error) => {
console.log(error);
});
var contextName = "<contextName>"; //Required
var uid = "<uid>"; //Required
lrv2.roleApi.deleteRoleContextByUid(contextName, uid).then((response) => {
console.log(response);
}).catch((error) => {
console.log(error);
});
var contextName = "<contextName>"; //Required
var roleContextRemoveRoleModel ={
"roles" : [ "roles" ]
}; //Required
var uid = "<uid>"; //Required
lrv2.roleApi.deleteRolesFromRoleContextByUid(contextName, roleContextRemoveRoleModel, uid).then((response) => {
console.log(response);
}).catch((error) => {
console.log(error);
});
var contextName = "<contextName>"; //Required
var roleContextAdditionalPermissionRemoveRoleModel ={
"additionalPermissions" : [ "additionalPermissions" ]
}; //Required
var uid = "<uid>"; //Required
lrv2.roleApi.deleteAdditionalPermissionFromRoleContextByUid(contextName, roleContextAdditionalPermissionRemoveRoleModel, uid).then((response) => {
console.log(response);
}).catch((error) => {
console.log(error);
});
var role = "<role>"; //Required
lrv2.roleApi.deleteRole(role).then((response) => {
console.log(response);
}).catch((error) => {
console.log(error);
});
var permissionsModel ={
"permissions" : [ "permissions" ]
}; //Required
var role = "<role>"; //Required
lrv2.roleApi.removeRolePermissions(permissionsModel, role).then((response) => {
console.log(response);
}).catch((error) => {
console.log(error);
});
List of APIs in this Section:
- PUT : Update Registration Data
- POST : Validate secret code
- POST : Add Registration Data
- GET : Auth Get Registration Data Server
- GET : Get Registration Data
- DELETE : Delete Registration Data
- DELETE : Delete All Records by Datasource
var registrationDataUpdateModel ={
"isActive" : true,
"key" : "<key>",
"type" : "<type>",
"value" : "<value>"
}; //Required
var recordId = "<recordId>"; //Required
lrv2.customRegistrationDataApi.updateRegistrationData(registrationDataUpdateModel, recordId).then((response) => {
console.log(response);
}).catch((error) => {
console.log(error);
});
var code = "<code>"; //Required
var recordId = "<recordId>"; //Required
lrv2.customRegistrationDataApi.validateRegistrationDataCode(code, recordId).then((response) => {
console.log(response);
}).catch((error) => {
console.log(error);
});
var registrationDataCreateModelList ={
"data" : [ {
"code" : "<code>" ,
"isActive" : true ,
"key" : "<key>" ,
"parentId" : "<parentId>" ,
"type" : "<type>" ,
"value" : "<value>"
} ]
}; //Required
lrv2.customRegistrationDataApi.addRegistrationData(registrationDataCreateModelList).then((response) => {
console.log(response);
}).catch((error) => {
console.log(error);
});
var type = "<type>"; //Required
var limit = 0; //Optional
var parentId = "<parentId>"; //Optional
var skip = 0; //Optional
lrv2.customRegistrationDataApi.authGetRegistrationData(type, limit, parentId, skip).then((response) => {
console.log(response);
}).catch((error) => {
console.log(error);
});
var type = "<type>"; //Required
var limit = 0; //Optional
var parentId = "<parentId>"; //Optional
var skip = 0; //Optional
lrv2.customRegistrationDataApi.getRegistrationData(type, limit, parentId, skip).then((response) => {
console.log(response);
}).catch((error) => {
console.log(error);
});
var recordId = "<recordId>"; //Required
lrv2.customRegistrationDataApi.deleteRegistrationData(recordId).then((response) => {
console.log(response);
}).catch((error) => {
console.log(error);
});
var type = "<type>"; //Required
lrv2.customRegistrationDataApi.deleteAllRecordsByDataSource(type).then((response) => {
console.log(response);
}).catch((error) => {
console.log(error);
});
List of APIs in this Section:
- POST : Risk Based Authentication Login by Email
- POST : Risk Based Authentication Login by Username
- POST : Risk Based Authentication Phone Login
var emailAuthenticationModel ={
"email" : "<email>",
"password" : "<password>"
}; //Required
var emailTemplate = "<emailTemplate>"; //Optional
var fields = null; //Optional
var loginUrl = "<loginUrl>"; //Optional
var passwordDelegation = true; //Optional
var passwordDelegationApp = "<passwordDelegationApp>"; //Optional
var rbaBrowserEmailTemplate = "<rbaBrowserEmailTemplate>"; //Optional
var rbaBrowserSmsTemplate = "<rbaBrowserSmsTemplate>"; //Optional
var rbaCityEmailTemplate = "<rbaCityEmailTemplate>"; //Optional
var rbaCitySmsTemplate = "<rbaCitySmsTemplate>"; //Optional
var rbaCountryEmailTemplate = "<rbaCountryEmailTemplate>"; //Optional
var rbaCountrySmsTemplate = "<rbaCountrySmsTemplate>"; //Optional
var rbaIpEmailTemplate = "<rbaIpEmailTemplate>"; //Optional
var rbaIpSmsTemplate = "<rbaIpSmsTemplate>"; //Optional
var rbaOneclickEmailTemplate = "<rbaOneclickEmailTemplate>"; //Optional
var rbaOTPSmsTemplate = "<rbaOTPSmsTemplate>"; //Optional
var smsTemplate = "<smsTemplate>"; //Optional
var verificationUrl = "<verificationUrl>"; //Optional
lrv2.riskBasedAuthenticationApi.rbaLoginByEmail(emailAuthenticationModel, emailTemplate, fields, loginUrl, passwordDelegation, passwordDelegationApp, rbaBrowserEmailTemplate, rbaBrowserSmsTemplate, rbaCityEmailTemplate, rbaCitySmsTemplate, rbaCountryEmailTemplate, rbaCountrySmsTemplate, rbaIpEmailTemplate, rbaIpSmsTemplate, rbaOneclickEmailTemplate, rbaOTPSmsTemplate, smsTemplate, verificationUrl).then((response) => {
console.log(response);
}).catch((error) => {
console.log(error);
});
var userNameAuthenticationModel ={
"password" : "<password>",
"username" : "<username>"
}; //Required
var emailTemplate = "<emailTemplate>"; //Optional
var fields = null; //Optional
var loginUrl = "<loginUrl>"; //Optional
var passwordDelegation = true; //Optional
var passwordDelegationApp = "<passwordDelegationApp>"; //Optional
var rbaBrowserEmailTemplate = "<rbaBrowserEmailTemplate>"; //Optional
var rbaBrowserSmsTemplate = "<rbaBrowserSmsTemplate>"; //Optional
var rbaCityEmailTemplate = "<rbaCityEmailTemplate>"; //Optional
var rbaCitySmsTemplate = "<rbaCitySmsTemplate>"; //Optional
var rbaCountryEmailTemplate = "<rbaCountryEmailTemplate>"; //Optional
var rbaCountrySmsTemplate = "<rbaCountrySmsTemplate>"; //Optional
var rbaIpEmailTemplate = "<rbaIpEmailTemplate>"; //Optional
var rbaIpSmsTemplate = "<rbaIpSmsTemplate>"; //Optional
var rbaOneclickEmailTemplate = "<rbaOneclickEmailTemplate>"; //Optional
var rbaOTPSmsTemplate = "<rbaOTPSmsTemplate>"; //Optional
var smsTemplate = "<smsTemplate>"; //Optional
var verificationUrl = "<verificationUrl>"; //Optional
lrv2.riskBasedAuthenticationApi.rbaLoginByUserName(userNameAuthenticationModel, emailTemplate, fields, loginUrl, passwordDelegation, passwordDelegationApp, rbaBrowserEmailTemplate, rbaBrowserSmsTemplate, rbaCityEmailTemplate, rbaCitySmsTemplate, rbaCountryEmailTemplate, rbaCountrySmsTemplate, rbaIpEmailTemplate, rbaIpSmsTemplate, rbaOneclickEmailTemplate, rbaOTPSmsTemplate, smsTemplate, verificationUrl).then((response) => {
console.log(response);
}).catch((error) => {
console.log(error);
});
var phoneAuthenticationModel ={
"password" : "<password>",
"phone" : "<phone>"
}; //Required
var emailTemplate = "<emailTemplate>"; //Optional
var fields = null; //Optional
var loginUrl = "<loginUrl>"; //Optional
var passwordDelegation = true; //Optional
var passwordDelegationApp = "<passwordDelegationApp>"; //Optional
var rbaBrowserEmailTemplate = "<rbaBrowserEmailTemplate>"; //Optional
var rbaBrowserSmsTemplate = "<rbaBrowserSmsTemplate>"; //Optional
var rbaCityEmailTemplate = "<rbaCityEmailTemplate>"; //Optional
var rbaCitySmsTemplate = "<rbaCitySmsTemplate>"; //Optional
var rbaCountryEmailTemplate = "<rbaCountryEmailTemplate>"; //Optional
var rbaCountrySmsTemplate = "<rbaCountrySmsTemplate>"; //Optional
var rbaIpEmailTemplate = "<rbaIpEmailTemplate>"; //Optional
var rbaIpSmsTemplate = "<rbaIpSmsTemplate>"; //Optional
var rbaOneclickEmailTemplate = "<rbaOneclickEmailTemplate>"; //Optional
var rbaOTPSmsTemplate = "<rbaOTPSmsTemplate>"; //Optional
var smsTemplate = "<smsTemplate>"; //Optional
var verificationUrl = "<verificationUrl>"; //Optional
lrv2.riskBasedAuthenticationApi.rbaLoginByPhone(phoneAuthenticationModel, emailTemplate, fields, loginUrl, passwordDelegation, passwordDelegationApp, rbaBrowserEmailTemplate, rbaBrowserSmsTemplate, rbaCityEmailTemplate, rbaCitySmsTemplate, rbaCountryEmailTemplate, rbaCountrySmsTemplate, rbaIpEmailTemplate, rbaIpSmsTemplate, rbaOneclickEmailTemplate, rbaOTPSmsTemplate, smsTemplate, verificationUrl).then((response) => {
console.log(response);
}).catch((error) => {
console.log(error);
});
List of APIs in this Section:
- GET : Generate SOTT
var timeDifference = 0; //Optional
lrv2.sottApi.generateSott(timeDifference).then((response) => {
console.log(response);
}).catch((error) => {
console.log(error);
});
List of APIs in this Section:
- GET : Access Token via Facebook Token
- GET : Access Token via Twitter Token
- GET : Access Token via Google Token
- GET : Access Token using google JWT token for Native Mobile Login
- GET : Access Token via Linkedin Token
- GET : Get Access Token By Foursquare Access Token
- GET : Access Token via Apple Id Code
- GET : Access Token via WeChat Code
- GET : Access Token via Vkontakte Token
- GET : Access Token via Google AuthCode
var fbAccessToken = "<fbAccessToken>"; //Required
var socialAppName = "<socialAppName>"; //Optional
lrv2.nativeSocialApi.getAccessTokenByFacebookAccessToken(fbAccessToken, socialAppName).then((response) => {
console.log(response);
}).catch((error) => {
console.log(error);
});
var twAccessToken = "<twAccessToken>"; //Required
var twTokenSecret = "<twTokenSecret>"; //Required
var socialAppName = "<socialAppName>"; //Optional
lrv2.nativeSocialApi.getAccessTokenByTwitterAccessToken(twAccessToken, twTokenSecret, socialAppName).then((response) => {
console.log(response);
}).catch((error) => {
console.log(error);
});
var googleAccessToken = "<googleAccessToken>"; //Required
var clientId = "<clientId>"; //Optional
var refreshToken = "<refreshToken>"; //Optional
var socialAppName = "<socialAppName>"; //Optional
lrv2.nativeSocialApi.getAccessTokenByGoogleAccessToken(googleAccessToken, clientId, refreshToken, socialAppName).then((response) => {
console.log(response);
}).catch((error) => {
console.log(error);
});
var idToken = "<idToken>"; //Required
lrv2.nativeSocialApi.getAccessTokenByGoogleJWTAccessToken(idToken).then((response) => {
console.log(response);
}).catch((error) => {
console.log(error);
});
var lnAccessToken = "<lnAccessToken>"; //Required
var socialAppName = "<socialAppName>"; //Optional
lrv2.nativeSocialApi.getAccessTokenByLinkedinAccessToken(lnAccessToken, socialAppName).then((response) => {
console.log(response);
}).catch((error) => {
console.log(error);
});
var fsAccessToken = "<fsAccessToken>"; //Required
lrv2.nativeSocialApi.getAccessTokenByFoursquareAccessToken(fsAccessToken).then((response) => {
console.log(response);
}).catch((error) => {
console.log(error);
});
var code = "<code>"; //Required
var socialAppName = "<socialAppName>"; //Optional
lrv2.nativeSocialApi.getAccessTokenByAppleIdCode(code, socialAppName).then((response) => {
console.log(response);
}).catch((error) => {
console.log(error);
});
var code = "<code>"; //Required
lrv2.nativeSocialApi.getAccessTokenByWeChatCode(code).then((response) => {
console.log(response);
}).catch((error) => {
console.log(error);
});
var vkAccessToken = "<vkAccessToken>"; //Required
lrv2.nativeSocialApi.getAccessTokenByVkontakteAccessToken(vkAccessToken).then((response) => {
console.log(response);
}).catch((error) => {
console.log(error);
});
var googleAuthcode = "<googleAuthcode>"; //Required
var socialAppName = "<socialAppName>"; //Optional
lrv2.nativeSocialApi.getAccessTokenByGoogleAuthCode(googleAuthcode, socialAppName).then((response) => {
console.log(response);
}).catch((error) => {
console.log(error);
});
List of APIs in this Section:
- POST : Webhook Subscribe
- GET : Webhook Subscribed URLs
- GET : Webhook Test
- DELETE : WebHook Unsubscribe
var webHookSubscribeModel ={
"event" : "<event>",
"targetUrl" : "<targetUrl>"
}; //Required
lrv2.webHookApi.webHookSubscribe(webHookSubscribeModel).then((response) => {
console.log(response);
}).catch((error) => {
console.log(error);
});
var event = "<event>"; //Required
lrv2.webHookApi.getWebHookSubscribedURLs(event).then((response) => {
console.log(response);
}).catch((error) => {
console.log(error);
});
lrv2.webHookApi.webhookTest().then((response) => {
console.log(response);
}).catch((error) => {
console.log(error);
});
var webHookSubscribeModel ={
"event" : "<event>",
"targetUrl" : "<targetUrl>"
}; //Required
lrv2.webHookApi.webHookUnsubscribe(webHookSubscribeModel).then((response) => {
console.log(response);
}).catch((error) => {
console.log(error);
});
We have a demo web application using the Node SDK, which includes the following features:
- Traditional email login
- Multi-Factor login
- Passwordless login
- Social login
- Register
- Email verification
- Forgot password
- Reset password
- Change password
- Set password
- Update account
- Account linking
- Custom object management
- Roles management
You can get a copy of our demo project at Github .
Terminal/Command Line:
- Install Node.Js here . Ensure
npm --versionandnode --versionruns properly - Navigate to the demo directory, and run:
npm install - Set your LoginRadius credentials on the client and server side:
- Client side:
demo/demo/assets/js/options.js - Server side (note: do not set credentials as consts i.e. with quotes):
demo/server.js
- Client side:
- Navigate to the demo directory, and run: node server.js
- Demo will appear on http://localhost:3000