Multi-Factor Authentication

Update MFA by Access Token

copy-icon
curl -X PUT \
'https://api.loginradius.com/identity/v2/auth/account/2FA/Verification/GoogleAuthenticatorCode?access_token=&apikey=&Fields=&SmsTemplate=' \
-H 'Cache-Control: no-cache' \
-H 'content-Type: application/json' \
-H 'Authorization: Bearer ' \
-d "{ "googleAuthenticatorCode" : "<googleAuthenticatorCode>" }"

The above command returns JSON structured like this:

copy-icon
{
"Identities" : [
{
"About" : "About value that need to be inserted",
"Addresses" : [
{
"Address1" : "Address field value that needs to be updated",
"Address2" : "Address field value that needs to be updated",
"City" : "user's city",
"Country" : "Country of the user",
"PostalCode" : "Postal code value that need to be updated",
"Region" : "Region",
"State" : "State of the user",
"Type" : "Residential"
}
],
"Age" : "User's Age",
"AgeRange" : {
"Max" : 0,
"Min" : 0
},
"Associations" : "Organization a person is assosciated with",
"Awards" : [
{
"Id" : "Id of the Awards",
"Issuer" : "Award issuer details",
"Name" : "Award name"
}
],
"Badges" : [
{
"BadgeId" : "Badge ID",
"BadgeMessage" : "Badge Message",
"BageId" : "Badge ID",
"BageMessage" : "Badge Message",
"Description" : "detailed information",
"ImageUrl" : "image URL should be absolute and has HTTPS domain",
"Name" : "Badge Name"
}
],
"BirthDate" : "10-15-2000",
"BoardsCount" : 0,
"Books" : [
{
"Category" : "Book category",
"CreatedDate" : "Date of Creation of Profile",
"Id" : "Id of book",
"Name" : "book name"
}
],
"Certifications" : [
{
"Authority" : "Authority of certifications",
"EndDate" : "Certification end date",
"Id" : "Certification id",
"Name" : "Certification name",
"Number" : "Certification number",
"StartDate" : "Certification start date"
}
],
"City" : "user's city",
"Company" : "users company name",
"Country" : {
"Code" : "Country code",
"Name" : "Country name"
},
"Courses" : [
{
"Id" : "Course id",
"Name" : "Course name",
"Number" : "Course number"
}
],
"CoverPhoto" : "URL of the photo that need to be inserted",
"Created" : "created",
"CreatedDate" : "Date of Creation of Profile",
"Currency" : "Currency",
"CurrentStatus" : [
{
"CreatedDate" : "Current status created date",
"Id" : "Current status id",
"Source" : "Current status source",
"Text" : "Current status text"
}
],
"Educations" : [
{
"activities" : "Activities",
"degree" : "Degree",
"EndDate" : "Education End Date",
"fieldofstudy" : "Fields of study",
"notes" : "Notes",
"School" : "School of the user",
"StartDate" : "Start date of Education of user",
"type" : "Type",
"year" : "Year of Education"
}
],
"Email" : [
{
"Type" : "Primary",
"Value" : "Email address"
}
],
"Family" : [
{
"Id" : "Family id",
"Name" : "Family name",
"Relationship" : "Family relationship"
}
],
"Favicon" : "URL of the favicon that need to be inserted",
"FavoriteThings" : [
{
"Id" : "Id of favorite things",
"Name" : "Name of favorite things",
"Type" : "Type of favorite things"
}
],
"FirstLogin" : true,
"FirstName" : "John",
"FollowersCount" : 0,
"FriendsCount" : 0,
"FullName" : "Users complete name",
"Games" : [
{
"Category" : "Category of game",
"CreatedDate" : "Game created date",
"Id" : "Id of game",
"Name" : "Game name"
}
],
"Gender" : "Male",
"GistsUrl" : "Git Repository URL",
"GravatarImageUrl" : "URL of image that need to be inserted",
"Hireable" : true,
"HomeTown" : "user's home town name",
"Honors" : "Awards lists from the social provider",
"HttpsImageUrl" : "URL of the Image that need to be inserted",
"ID" : "ID of the User",
"IMAccounts" : [
{
"AccountName" : "Name of account",
"AccountType" : "Type of account"
}
],
"ImageUrl" : "image URL should be absolute and has HTTPS domain",
"Industry" : "Industry name",
"InspirationalPeople" : [
{
"Id" : "ID of inspirational people",
"Name" : "name of inspirational people"
}
],
"InterestedIn" : [
"" , ""
],
"Interests" : [
{
"InterestedName" : "Name of interested",
"InterestedType" : "Type of interested"
}
],
"IsGeoEnabled" : "boolean type value, default is true",
"IsProtected" : true,
"JobBookmarks" : [
{
"ApplyTimestamp" : "Job Bookmarks Apply Timestamp",
"IsApplied" : true,
"IsSaved" : true,
"Job" : {
"Active" : true,
"Company" : {
"Id" : "Company id",
"Name" : "Company name"
},
"DescriptionSnippet" : "Job description",
"Id" : "Job id",
"Position" : {
"Title" : "Position title"
},
"PostingTimestamp" : "Job posting timestamp"
},
"SavedTimestamp" : "Saved time stamp of Job bookmarks"
}
],
"KloutScore" : {
"KloutId" : "Id of klout",
"Score" : 0
},
"Language" : "language known by user's",
"Languages" : [
{
"Id" : "Language id",
"Name" : "Name of language",
"Proficiency" : "Proficiency in language"
}
],
"LastLoginDate" : "last login date",
"LastName" : "Doe",
"LikesCount" : 0,
"LocalCity" : "Local City of the user",
"LocalCountry" : "Local country of the user",
"LocalLanguage" : "Local language of the user",
"LRUserID" : "LR user id",
"MainAddress" : "Main address of the user",
"MemberUrlResources" : [
{
"Url" : "String represents website url",
"UrlName" : "URL name"
}
],
"MiddleName" : "user's middle name",
"ModifiedDate" : "profile updated date",
"Movies" : [
{
"Category" : "Category of movie",
"CreatedDate" : "Movie created date",
"Id" : "Id of movie",
"Name" : "Name of movie"
}
],
"MutualFriends" : [
{
"Birthday" : "Birthday of mutual friend",
"FirstName" : "first name of mutual friend",
"Gender" : "Gender of mutual friend",
"Hometown" : "Hometown of mutual friend",
"Id" : "Id of mutual friend",
"LastName" : "Last name of mutual friend",
"Link" : "Link of mutual friend",
"Name" : "Name of mutual friend"
}
],
"NickName" : "Nick name of the user",
"NumRecommenders" : 0,
"Patents" : [
{
"Date" : "Date of patents",
"Id" : "Id of the patents",
"Title" : "Title of the patents"
}
],
"PhoneNumbers" : [
{
"PhoneNumber" : "Phone number",
"PhoneType" : "Phone type"
}
],
"PinsCount" : 0,
"PlacesLived" : [
{
"IsPrimary" : true,
"Name" : "Name of lived place"
}
],
"Political" : "List of Political interest",
"Positions" : [
{
"Company" : {
"Industry" : "position company industry",
"Name" : "position company name",
"Type" : "position company type"
},
"EndDate" : "End date of the professional position",
"IsCurrent" : "Is current or not",
"Location" : "Location of the professional position",
"Position" : "Position",
"StartDate" : "Start date of the professional position",
"Summary" : "Summary of the professional position"
}
],
"Prefix" : "Mr.",
"PreviousUids" : [
"" , ""
],
"PrivateGists" : 0,
"ProfessionalHeadline" : "This field provide by linkedin.contain our linkedin profile headline",
"ProfileCity" : "ProfileCity value that need to be inserted",
"ProfileCountry" : "ProfileCountry value that need to be inserted",
"ProfileImageUrls" : {"key1":"value1","key2":"value2"},
"ProfileModifiedDate" : "profile updated date",
"ProfileName" : "ProfileName value field that need to be inserted",
"ProfileUrl" : "User profile url like facebook profile Url",
"Projects" : [
{
"EndDate" : "End date of the project",
"Id" : "Id of the project",
"IsCurrent" : "is current or not",
"Name" : "Name of the project",
"StartDate" : "Start date of the project",
"Summary" : "Summary of the project",
"With" : [
{
"Id" : "Id",
"Name" : "Name"
}
]
}
],
"Provider" : "Name of the provider",
"ProviderAccessCredential" : {
"AccessToken" : "Uniquely generated identifier key by LoginRadius that is activated after successful authentication.",
"TokenSecret" : "secret token of the provider"
},
"Publications" : [
{
"Authors" : [
{
"Id" : "Author id of the publication",
"Name" : "Author name"
}
],
"Date" : "Date of the publication",
"Id" : "Id of the Publication",
"Publisher" : "Publisher of the Publication",
"Summary" : "Summary of the publication",
"Title" : "Title of the publication",
"Url" : "Publication url"
}
],
"PublicGists" : 0,
"PublicRepository" : "user public Repository Urls",
"Quota" : "Quota",
"Quote" : "quote",
"RecommendationsReceived" : [
{
"Id" : "Recommendation id",
"RecommendationText" : "Recommendation text",
"RecommendationType" : "Recommendation type",
"Recommender" : "Recommender"
}
],
"RelatedProfileViews" : [
{
"FirstName" : "John",
"Id" : "Id of profile view",
"LastName" : "Doe"
}
],
"RelationshipStatus" : "user's relationship status",
"Religion" : "String shows users religion",
"RepositoryUrl" : "Repository URL",
"SignupDate" : "Signup date",
"Skills" : [
{
"Id" : "id of skill",
"Name" : "name of skills"
}
],
"Sports" : [
{
"Id" : "Id of sport",
"Name" : "Name of sport"
}
],
"StarredUrl" : "Git users bookmark repositories",
"State" : "State of the user",
"Subscription" : {
"Collaborators" : "Github plan collaborators",
"Name" : "Github plan name",
"PrivateRepos" : "Private repos of github",
"Space" : "Github plan space"
},
"Suffix" : "Jr.",
"Suggestions" : {
"CompaniestoFollow" : [
{
"Id" : "Id",
"Name" : "Name"
}
],
"IndustriestoFollow" : [
{
"Id" : "Id",
"Name" : "Name"
}
],
"NewssourcetoFollow" : [
{
"Id" : "Id",
"Name" : "Name"
}
],
"PeopletoFollow" : [
{
"Id" : "Id",
"Name" : "Name"
}
]
},
"TagLine" : "Tagline that need to be inserted",
"TeleVisionShow" : [
{
"Category" : "Television category",
"CreatedDate" : "Date",
"Id" : "Id of television",
"Name" : "Name of volunteer"
}
],
"ThumbnailImageUrl" : "URL for the Thumbnail",
"TimeZone" : "The Current Time Zone.",
"TotalPrivateRepository" : 0,
"TotalStatusesCount" : 0,
"UpdatedTime" : "updated date",
"Verified" : "verified",
"Volunteer" : [
{
"Cause" : "Cause of volunteer",
"Id" : "Volunteer Id",
"Organization" : "name",
"Role" : "Name of role"
}
],
"WebProfiles" : {"key1":"value1","key2":"value2"},
"Website" : "Personal Website a User has"
}
],
"ConsentProfile" : {
"AcceptedConsentVersions" : [
{
"Event" : "Allowed events: Login, Register, UpdateProfile, ResetPassword, ChangePassword, emailVerification, AddEmail, RemoveEmail, BlockAccount, DeleteAccount, SetUsername, AssignRoles, UnassignRoles, SetPassword, LinkAccount, UnlinkAccount, UpdatePhoneId, VerifyPhoneNumber, CreateCustomObject, UpdateCustomobject, DeleteCustomObject",
"IsCustom" : true,
"Version" : 0
}
],
"Consents" : [
{
"AcceptOnDate" : "Consent Accept on Date",
"ConsentOptionId" : "Consent Option Id"
}
]
},
"CustomFields" : {"key1":"value1","key2":"value2"},
"EmailVerified" : true,
"ExternalIds" : [
{
"Source" : "ExternalId source",
"SourceId" : "External source id"
}
],
"ExternalUserLoginId" : "External User Login Id",
"IsActive" : true,
"IsCustomUid" : true,
"IsDeleted" : true,
"IsEmailSubscribed" : true,
"IsLoginLocked" : true,
"IsRequiredFieldsFilledOnce" : true,
"IsSecurePassword" : true,
"LastLoginLocation" : "Last login location",
"LastPasswordChangeDate" : "Last password change date",
"LastPasswordChangeToken" : "Last password change token",
"LoginLockedType" : "Type of Lockout",
"NoOfLogins" : 0,
"Password" : "Password for the email",
"PasswordExpirationDate" : "Date of password expiration",
"PhoneId" : "Phone ID (Unique Phone Number Identifier of the user)",
"PhoneIdVerified" : true,
"PIN" : {
"LastPINChangeDate" : "Last PIN Change Date",
"PIN" : "PIN of user",
"Skipped" : true,
"SkippedDate" : "Skipped Date"
},
"PrivacyPolicy" : {
"AcceptDateTime" : "Privacy policy accept date time",
"AcceptSource" : "Privacy policy accept source",
"Version" : "Privacy policy version"
},
"RegistrationData" : {
"Data" : [
{
"DataSource" : "Registration Data Source",
"Value" : {
"Id" : "ID of the User"
}
}
]
},
"RegistrationProvider" : "Provider with which user registered",
"RegistrationSource" : "URL of the webproperty from where the user is registered.",
"Roles" : [
"" , ""
],
"Uid" : "UID, the unified identifier for each user account",
"UnverifiedEmail" : [
{
"Type" : "Primary",
"Value" : "Email address"
}
],
"UserName" : "Username of the user",
"About" : "About value that need to be inserted",
"Addresses" : [
{
"Address1" : "Address field value that needs to be updated",
"Address2" : "Address field value that needs to be updated",
"City" : "user's city",
"Country" : "Country of the user",
"PostalCode" : "Postal code value that need to be updated",
"Region" : "Region",
"State" : "State of the user",
"Type" : "Residential"
}
],
"Age" : "User's Age",
"AgeRange" : {
"Max" : 0,
"Min" : 0
},
"Associations" : "Organization a person is assosciated with",
"Awards" : [
{
"Id" : "Id of the Awards",
"Issuer" : "Award issuer details",
"Name" : "Award name"
}
],
"Badges" : [
{
"BadgeId" : "Badge ID",
"BadgeMessage" : "Badge Message",
"BageId" : "Badge ID",
"BageMessage" : "Badge Message",
"Description" : "detailed information",
"ImageUrl" : "image URL should be absolute and has HTTPS domain",
"Name" : "Badge Name"
}
],
"BirthDate" : "10-15-2000",
"BoardsCount" : 0,
"Books" : [
{
"Category" : "Book category",
"CreatedDate" : "Date of Creation of Profile",
"Id" : "Id of book",
"Name" : "book name"
}
],
"Certifications" : [
{
"Authority" : "Authority of certifications",
"EndDate" : "Certification end date",
"Id" : "Certification id",
"Name" : "Certification name",
"Number" : "Certification number",
"StartDate" : "Certification start date"
}
],
"City" : "user's city",
"Company" : "users company name",
"Country" : {
"Code" : "Country code",
"Name" : "Country name"
},
"Courses" : [
{
"Id" : "Course id",
"Name" : "Course name",
"Number" : "Course number"
}
],
"CoverPhoto" : "URL of the photo that need to be inserted",
"Created" : "created",
"CreatedDate" : "Date of Creation of Profile",
"Currency" : "Currency",
"CurrentStatus" : [
{
"CreatedDate" : "Current status created date",
"Id" : "Current status id",
"Source" : "Current status source",
"Text" : "Current status text"
}
],
"Educations" : [
{
"activities" : "Activities",
"degree" : "Degree",
"EndDate" : "Education End Date",
"fieldofstudy" : "Fields of study",
"notes" : "Notes",
"School" : "School of the user",
"StartDate" : "Start date of Education of user",
"type" : "Type",
"year" : "Year of Education"
}
],
"Email" : [
{
"Type" : "Primary",
"Value" : "Email address"
}
],
"Family" : [
{
"Id" : "Family id",
"Name" : "Family name",
"Relationship" : "Family relationship"
}
],
"Favicon" : "URL of the favicon that need to be inserted",
"FavoriteThings" : [
{
"Id" : "Id of favorite things",
"Name" : "Name of favorite things",
"Type" : "Type of favorite things"
}
],
"FirstLogin" : true,
"FirstName" : "John",
"FollowersCount" : 0,
"FriendsCount" : 0,
"FullName" : "Users complete name",
"Games" : [
{
"Category" : "Category of game",
"CreatedDate" : "Game created date",
"Id" : "Id of game",
"Name" : "Game name"
}
],
"Gender" : "Male",
"GistsUrl" : "Git Repository URL",
"GravatarImageUrl" : "URL of image that need to be inserted",
"Hireable" : true,
"HomeTown" : "user's home town name",
"Honors" : "Awards lists from the social provider",
"HttpsImageUrl" : "URL of the Image that need to be inserted",
"ID" : "ID of the User",
"IMAccounts" : [
{
"AccountName" : "Name of account",
"AccountType" : "Type of account"
}
],
"ImageUrl" : "image URL should be absolute and has HTTPS domain",
"Industry" : "Industry name",
"InspirationalPeople" : [
{
"Id" : "ID of inspirational people",
"Name" : "name of inspirational people"
}
],
"InterestedIn" : [
"" , ""
],
"Interests" : [
{
"InterestedName" : "Name of interested",
"InterestedType" : "Type of interested"
}
],
"IsGeoEnabled" : "boolean type value, default is true",
"IsProtected" : true,
"JobBookmarks" : [
{
"ApplyTimestamp" : "Job Bookmarks Apply Timestamp",
"IsApplied" : true,
"IsSaved" : true,
"Job" : {
"Active" : true,
"Company" : {
"Id" : "Company id",
"Name" : "Company name"
},
"DescriptionSnippet" : "Job description",
"Id" : "Job id",
"Position" : {
"Title" : "Position title"
},
"PostingTimestamp" : "Job posting timestamp"
},
"SavedTimestamp" : "Saved time stamp of Job bookmarks"
}
],
"KloutScore" : {
"KloutId" : "Id of klout",
"Score" : 0
},
"Language" : "language known by user's",
"Languages" : [
{
"Id" : "Language id",
"Name" : "Name of language",
"Proficiency" : "Proficiency in language"
}
],
"LastLoginDate" : "last login date",
"LastName" : "Doe",
"LikesCount" : 0,
"LocalCity" : "Local City of the user",
"LocalCountry" : "Local country of the user",
"LocalLanguage" : "Local language of the user",
"LRUserID" : "LR user id",
"MainAddress" : "Main address of the user",
"MemberUrlResources" : [
{
"Url" : "String represents website url",
"UrlName" : "URL name"
}
],
"MiddleName" : "user's middle name",
"ModifiedDate" : "profile updated date",
"Movies" : [
{
"Category" : "Category of movie",
"CreatedDate" : "Movie created date",
"Id" : "Id of movie",
"Name" : "Name of movie"
}
],
"MutualFriends" : [
{
"Birthday" : "Birthday of mutual friend",
"FirstName" : "first name of mutual friend",
"Gender" : "Gender of mutual friend",
"Hometown" : "Hometown of mutual friend",
"Id" : "Id of mutual friend",
"LastName" : "Last name of mutual friend",
"Link" : "Link of mutual friend",
"Name" : "Name of mutual friend"
}
],
"NickName" : "Nick name of the user",
"NumRecommenders" : 0,
"Patents" : [
{
"Date" : "Date of patents",
"Id" : "Id of the patents",
"Title" : "Title of the patents"
}
],
"PhoneNumbers" : [
{
"PhoneNumber" : "Phone number",
"PhoneType" : "Phone type"
}
],
"PinsCount" : 0,
"PlacesLived" : [
{
"IsPrimary" : true,
"Name" : "Name of lived place"
}
],
"Political" : "List of Political interest",
"Positions" : [
{
"Company" : {
"Industry" : "position company industry",
"Name" : "position company name",
"Type" : "position company type"
},
"EndDate" : "End date of the professional position",
"IsCurrent" : "Is current or not",
"Location" : "Location of the professional position",
"Position" : "Position",
"StartDate" : "Start date of the professional position",
"Summary" : "Summary of the professional position"
}
],
"Prefix" : "Mr.",
"PreviousUids" : [
"" , ""
],
"PrivateGists" : 0,
"ProfessionalHeadline" : "This field provide by linkedin.contain our linkedin profile headline",
"ProfileCity" : "ProfileCity value that need to be inserted",
"ProfileCountry" : "ProfileCountry value that need to be inserted",
"ProfileImageUrls" : {"key1":"value1","key2":"value2"},
"ProfileModifiedDate" : "profile updated date",
"ProfileName" : "ProfileName value field that need to be inserted",
"ProfileUrl" : "User profile url like facebook profile Url",
"Projects" : [
{
"EndDate" : "End date of the project",
"Id" : "Id of the project",
"IsCurrent" : "is current or not",
"Name" : "Name of the project",
"StartDate" : "Start date of the project",
"Summary" : "Summary of the project",
"With" : [
{
"Id" : "Id",
"Name" : "Name"
}
]
}
],
"Provider" : "Name of the provider",
"ProviderAccessCredential" : {
"AccessToken" : "Uniquely generated identifier key by LoginRadius that is activated after successful authentication.",
"TokenSecret" : "secret token of the provider"
},
"Publications" : [
{
"Authors" : [
{
"Id" : "Author id of the publication",
"Name" : "Author name"
}
],
"Date" : "Date of the publication",
"Id" : "Id of the Publication",
"Publisher" : "Publisher of the Publication",
"Summary" : "Summary of the publication",
"Title" : "Title of the publication",
"Url" : "Publication url"
}
],
"PublicGists" : 0,
"PublicRepository" : "user public Repository Urls",
"Quota" : "Quota",
"Quote" : "quote",
"RecommendationsReceived" : [
{
"Id" : "Recommendation id",
"RecommendationText" : "Recommendation text",
"RecommendationType" : "Recommendation type",
"Recommender" : "Recommender"
}
],
"RelatedProfileViews" : [
{
"FirstName" : "John",
"Id" : "Id of profile view",
"LastName" : "Doe"
}
],
"RelationshipStatus" : "user's relationship status",
"Religion" : "String shows users religion",
"RepositoryUrl" : "Repository URL",
"SignupDate" : "Signup date",
"Skills" : [
{
"Id" : "id of skill",
"Name" : "name of skills"
}
],
"Sports" : [
{
"Id" : "Id of sport",
"Name" : "Name of sport"
}
],
"StarredUrl" : "Git users bookmark repositories",
"State" : "State of the user",
"Subscription" : {
"Collaborators" : "Github plan collaborators",
"Name" : "Github plan name",
"PrivateRepos" : "Private repos of github",
"Space" : "Github plan space"
},
"Suffix" : "Jr.",
"Suggestions" : {
"CompaniestoFollow" : [
{
"Id" : "Id",
"Name" : "Name"
}
],
"IndustriestoFollow" : [
{
"Id" : "Id",
"Name" : "Name"
}
],
"NewssourcetoFollow" : [
{
"Id" : "Id",
"Name" : "Name"
}
],
"PeopletoFollow" : [
{
"Id" : "Id",
"Name" : "Name"
}
]
},
"TagLine" : "Tagline that need to be inserted",
"TeleVisionShow" : [
{
"Category" : "Television category",
"CreatedDate" : "Date",
"Id" : "Id of television",
"Name" : "Name of volunteer"
}
],
"ThumbnailImageUrl" : "URL for the Thumbnail",
"TimeZone" : "The Current Time Zone.",
"TotalPrivateRepository" : 0,
"TotalStatusesCount" : 0,
"UpdatedTime" : "updated date",
"Verified" : "verified",
"Volunteer" : [
{
"Cause" : "Cause of volunteer",
"Id" : "Volunteer Id",
"Organization" : "name",
"Role" : "Name of role"
}
],
"WebProfiles" : {"key1":"value1","key2":"value2"},
"Website" : "Personal Website a User has"
}

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

HTTP Request

Put /identity/v2/auth/account/2FA/Verification/GoogleAuthenticatorCode?access_token=&apikey=&Fields=&SmsTemplate=

Query Parameters

ParameterDefaultDescription
access_tokennoneUniquely generated identifier key by LoginRadius that is activated after successful authentication. [Required]
apikeynoneLoginRadius API Key [Required]
FieldsnoneThe fields parameter filters the API response so that the response only includes a specific set of fields [Optional]
SmsTemplatenoneSMS Template name [Optional]

Body Attributes

AttributeDescription
GoogleAuthenticatorCodeThe code generated by google authenticator app after scanning QR codeModel Class containing Definition of payload for MultiFactorAuthModel By GoogleAuthenticator Code API [Required]

MFA Update Phone Number by Token

copy-icon
curl -X PUT \
'https://api.loginradius.com/identity/v2/auth/account/2FA?access_token=&apikey=&SmsTemplate2FA=' \
-H 'Cache-Control: no-cache' \
-H 'content-Type: application/json' \
-H 'Authorization: Bearer ' \

The above command returns JSON structured like this:

copy-icon
{
"AccountSid" : "Account Sid",
"Sid" : "Sid"
}

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

HTTP Request

Put /identity/v2/auth/account/2FA?access_token=&apikey=&SmsTemplate2FA=

Query Parameters

ParameterDefaultDescription
access_tokennoneUniquely generated identifier key by LoginRadius that is activated after successful authentication. [Required]
apikeynoneLoginRadius API Key [Required]
SmsTemplate2FAnoneSMS Template Name [Optional]

MFA Validate Google Auth Code

copy-icon
curl -X PUT \
'https://api.loginradius.com/identity/v2/auth/login/2FA/verification/GoogleAuthenticatorCode?apikey=&SecondFactorAuthenticationToken=&Fields=&SmsTemplate2FA=' \
-H 'Cache-Control: no-cache' \
-H 'content-Type: application/json' \

The above command returns JSON structured like this:

copy-icon
{
"Profile" : {
},
"access_token" : "Uniquely generated identifier key by LoginRadius that is activated after successful authentication.",
"expires_in" : "Expiration time of Access Token",
"refresh_token" : "refresh token to refresh access token",
"session_expires_in" : "session token expiry time",
"session_token" : "session token of user"
}

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

HTTP Request

Put /identity/v2/auth/login/2FA/verification/GoogleAuthenticatorCode?apikey=&SecondFactorAuthenticationToken=&Fields=&SmsTemplate2FA=

Query Parameters

ParameterDefaultDescription
apikeynoneLoginRadius API Key [Required]
SecondFactorAuthenticationTokennoneA Uniquely generated MFA identifier token after successful authentication [Required]
FieldsnoneThe fields parameter filters the API response so that the response only includes a specific set of fields [Optional]
SmsTemplate2FAnoneSMS Template Name [Optional]

MFA Update Phone Number

copy-icon
curl -X PUT \
'https://api.loginradius.com/identity/v2/auth/login/2FA?apikey=&SecondFactorAuthenticationToken=&SmsTemplate2FA=' \
-H 'Cache-Control: no-cache' \
-H 'content-Type: application/json' \

The above command returns JSON structured like this:

copy-icon
{
"AccountSid" : "Account Sid",
"Sid" : "Sid"
}

This API is used to update (if configured) the phone number used for Multi-factor authentication by sending the verification OTP to the provided phone number

HTTP Request

Put /identity/v2/auth/login/2FA?apikey=&SecondFactorAuthenticationToken=&SmsTemplate2FA=

Query Parameters

ParameterDefaultDescription
apikeynoneLoginRadius API Key [Required]
SecondFactorAuthenticationTokennoneA Uniquely generated MFA identifier token after successful authentication [Required]
SmsTemplate2FAnoneSMS Template Name [Optional]

MFA Email Login

copy-icon
curl -X POST \
'https://api.loginradius.com/identity/v2/auth/login/2FA?apikey=&EmailTemplate=&Fields=&LoginUrl=&SmsTemplate=&SmsTemplate2FA=&VerificationUrl=' \
-H 'Cache-Control: no-cache' \
-H 'content-Type: application/json' \
copy-icon
curl -X POST \
'https://api.loginradius.com/identity/v2/auth/login/2FA?apikey=&EmailTemplate=&Fields=&LoginUrl=&SmsTemplate=&SmsTemplate2FA=&VerificationUrl=' \
-H 'Cache-Control: no-cache' \
-H 'content-Type: application/json' \

The above command returns JSON structured like this:

copy-icon
{
"access_token" : "Uniquely generated identifier key by LoginRadius that is activated after successful authentication.",
"expires_in" : "Expiration time of Access Token",
"Profile" : {
},
"refresh_token" : "refresh token to refresh access token",
"SecondFactorAuthentication" : {
"ExpireIn" : "Expiration time of Access Token",
"SecondFactorAuthenticationToken" : "second factor authentication token",
"IsGoogleAuthenticatorVerified" : true,
"IsOTPAuthenticatorVerified" : true,
"ManualEntryCode" : "Manual entry code",
"OTPPhoneNo" : "Otp phone number",
"OTPStatus" : {
"AccountSid" : "Account Sid",
"Sid" : "Sid"
},
"QRCode" : "QR code"
}
}

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

HTTP Request

Post /identity/v2/auth/login/2FA?apikey=&EmailTemplate=&Fields=&LoginUrl=&SmsTemplate=&SmsTemplate2FA=&VerificationUrl=

Query Parameters

ParameterDefaultDescription
apikeynoneLoginRadius API Key [Required]
EmailTemplatenoneEmail template name [Optional]
FieldsnoneThe fields parameter filters the API response so that the response only includes a specific set of fields [Optional]
LoginUrlnoneUrl where the user is logging from [Optional]
SmsTemplatenoneSMS Template name [Optional]
SmsTemplate2FAnoneSMS Template Name [Optional]
VerificationUrlnoneEmail verification url [Optional]

MFA Phone Login

The above command returns JSON structured like this:

copy-icon
{
"access_token" : "Uniquely generated identifier key by LoginRadius that is activated after successful authentication.",
"expires_in" : "Expiration time of Access Token",
"Profile" : {
},
"refresh_token" : "refresh token to refresh access token",
"SecondFactorAuthentication" : {
"ExpireIn" : "Expiration time of Access Token",
"SecondFactorAuthenticationToken" : "second factor authentication token",
"IsGoogleAuthenticatorVerified" : true,
"IsOTPAuthenticatorVerified" : true,
"ManualEntryCode" : "Manual entry code",
"OTPPhoneNo" : "Otp phone number",
"OTPStatus" : {
"AccountSid" : "Account Sid",
"Sid" : "Sid"
},
"QRCode" : "QR code"
}
}

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

HTTP Request

Post /identity/v2/auth/login/2FA?apikey=&EmailTemplate=&Fields=&LoginUrl=&SmsTemplate=&SmsTemplate2FA=&VerificationUrl=

Query Parameters

ParameterDefaultDescription
apikeynoneLoginRadius API Key [Required]
EmailTemplatenoneEmail template name [Optional]
FieldsnoneThe fields parameter filters the API response so that the response only includes a specific set of fields [Optional]
LoginUrlnoneUrl where the user is logging from [Optional]
SmsTemplatenoneSMS Template name [Optional]
SmsTemplate2FAnoneSMS Template Name [Optional]
VerificationUrlnoneEmail verification url [Optional]

MFA Validate Access Token

copy-icon
curl -X GET \
'https://api.loginradius.com/identity/v2/auth/account/2FA?access_token=&apikey=&SmsTemplate2FA=' \
-H 'Cache-Control: no-cache' \
-H 'content-Type: application/json' \
-H 'Authorization: Bearer ' \

The above command returns JSON structured like this:

copy-icon
{
"IsGoogleAuthenticatorVerified" : true,
"IsOTPAuthenticatorVerified" : true,
"ManualEntryCode" : "Manual entry code",
"OTPPhoneNo" : "Otp phone number",
"OTPStatus" : {
"AccountSid" : "Account Sid",
"Sid" : "Sid"
},
"QRCode" : "QR code"
}

This API is used to configure the Multi-factor authentication after login by using the access token when MFA is set as optional on the LoginRadius site.

HTTP Request

Get /identity/v2/auth/account/2FA?access_token=&apikey=&SmsTemplate2FA=

Query Parameters

ParameterDefaultDescription
access_tokennoneUniquely generated identifier key by LoginRadius that is activated after successful authentication. [Required]
apikeynoneLoginRadius API Key [Required]
SmsTemplate2FAnoneSMS Template Name [Optional]

MFA Reset Google Authenticator by Token

copy-icon
curl -X DELETE \
'https://api.loginradius.com/identity/v2/auth/account/2FA/authenticator?access_token=&apikey=' \
-H 'Cache-Control: no-cache' \
-H 'content-Type: application/json' \
-H 'Authorization: Bearer ' \
copy-icon
curl -X DELETE \
'https://api.loginradius.com/identity/v2/auth/account/2FA/authenticator?access_token=&apikey=' \
-H 'Cache-Control: no-cache' \
-H 'content-Type: application/json' \
-H 'Authorization: Bearer ' \

The above command returns JSON structured like this:

copy-icon
{
"IsDeleted" : true,
"RecordsDeleted" : 0
}

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

HTTP Request

Delete /identity/v2/auth/account/2FA/authenticator?access_token=&apikey=

Query Parameters

ParameterDefaultDescription
access_tokennoneUniquely generated identifier key by LoginRadius that is activated after successful authentication. [Required]
apikeynoneLoginRadius API Key [Required]

MFA Reset SMS Authenticator by Token

The above command returns JSON structured like this:

copy-icon
{
"IsDeleted" : true,
"RecordsDeleted" : 0
}

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

HTTP Request

Delete /identity/v2/auth/account/2FA/authenticator?access_token=&apikey=

Query Parameters

ParameterDefaultDescription
access_tokennoneUniquely generated identifier key by LoginRadius that is activated after successful authentication. [Required]
apikeynoneLoginRadius API Key [Required]

MFA Reset SMS Authenticator By UID

copy-icon
curl -X DELETE \
'https://api.loginradius.com/identity/v2/manage/account/2FA/authenticator?apikey=&apisecret=&Uid=' \
-H 'Cache-Control: no-cache' \
-H 'content-Type: application/json' \
copy-icon
curl -X DELETE \
'https://api.loginradius.com/identity/v2/manage/account/2FA/authenticator?apikey=&apisecret=&Uid=' \
-H 'Cache-Control: no-cache' \
-H 'content-Type: application/json' \

The above command returns JSON structured like this:

copy-icon
{
"IsDeleted" : true,
"RecordsDeleted" : 0
}

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

HTTP Request

Delete /identity/v2/manage/account/2FA/authenticator?apikey=&apisecret=&Uid=

Query Parameters

ParameterDefaultDescription
apikeynoneLoginRadius API Key [Required]
apisecretnoneLoginRadius API Secret [Required]
UidnoneUID, the unified identifier for each user account [Required]

MFA Reset Google Authenticator By UID

The above command returns JSON structured like this:

copy-icon
{
"IsDeleted" : true,
"RecordsDeleted" : 0
}

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

HTTP Request

Delete /identity/v2/manage/account/2FA/authenticator?apikey=&apisecret=&Uid=

Query Parameters

ParameterDefaultDescription
apikeynoneLoginRadius API Key [Required]
apisecretnoneLoginRadius API Secret [Required]
UidnoneUID, the unified identifier for each user account [Required]