Authentication API
Auth Update Profile by Token
curl -X PUT \'https://api.loginradius.com/identity/v2/auth/account?access_token=&apikey=&EmailTemplate=&Fields=&NullSupport=&SmsTemplate=&VerificationUrl=' \-H 'Cache-Control: no-cache' \-H 'content-Type: application/json' \-H 'Authorization: Bearer ' \-d "{ "firstName" : "<firstName>","lastName" : "<lastName>" }"
The above command returns JSON structured like this:
{"Data" : {},"IsPosted" : true}
This API is used to update the user's profile by passing the access token.
HTTP Request
Put /identity/v2/auth/account?access_token=&apikey=&EmailTemplate=&Fields=&NullSupport=&SmsTemplate=&VerificationUrl=
Query Parameters
Parameter | Default | Description |
---|---|---|
access_token | none | Uniquely generated identifier key by LoginRadius that is activated after successful authentication. [Required] |
apikey | none | LoginRadius API Key [Required] |
EmailTemplate | none | Email template name [Optional] |
Fields | none | The fields parameter filters the API response so that the response only includes a specific set of fields [Optional] |
NullSupport | none | Boolean, pass true if you wish to update any user profile field with a NULL value, You can get the details [Optional] |
SmsTemplate | none | SMS Template name [Optional] |
VerificationUrl | none | Email verification url [Optional] |
Body Attributes
Attribute | Description | |
---|---|---|
FirstName | user's first name | |
LastName | user's last name | Model Class containing Definition of payload for User Profile update API [Required] |
Auth Resend Email Verification
curl -X PUT \'https://api.loginradius.com/identity/v2/auth/register?apikey=&emailTemplate=&verificationUrl=' \-H 'Cache-Control: no-cache' \-H 'content-Type: application/json' \
The above command returns JSON structured like this:
{"IsPosted" : true}
This API is used to resends the verification email to the user.
HTTP Request
Put /identity/v2/auth/register?apikey=&emailTemplate=&verificationUrl=
Query Parameters
Parameter | Default | Description |
---|---|---|
apikey | none | LoginRadius API Key [Required] |
emailTemplate | none | Email template name [Optional] |
verificationUrl | none | Email verification url [Optional] |
Auth Add Email
curl -X POST \'https://api.loginradius.com/identity/v2/auth/email?access_token=&apikey=&EmailTemplate=&VerificationUrl=' \-H 'Cache-Control: no-cache' \-H 'content-Type: application/json' \-H 'Authorization: Bearer ' \
The above command returns JSON structured like this:
{"IsPosted" : true}
This API is used to add additional emails to a user's account.
HTTP Request
Post /identity/v2/auth/email?access_token=&apikey=&EmailTemplate=&VerificationUrl=
Query Parameters
Parameter | Default | Description |
---|---|---|
access_token | none | Uniquely generated identifier key by LoginRadius that is activated after successful authentication. [Required] |
apikey | none | LoginRadius API Key [Required] |
EmailTemplate | none | Email template name [Optional] |
VerificationUrl | none | Email verification url [Optional] |
Auth Login by Email
curl -X POST \'https://api.loginradius.com/identity/v2/auth/login?apikey=&EmailTemplate=&Fields=&LoginUrl=&VerificationUrl=' \-H 'Cache-Control: no-cache' \-H 'content-Type: application/json' \-d "{ "email" : "<email>","password" : "<password>" }"
The above command returns JSON structured like this:
{"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 retrieves a copy of the user data based on the Email
HTTP Request
Post /identity/v2/auth/login?apikey=&EmailTemplate=&Fields=&LoginUrl=&VerificationUrl=
Query Parameters
Parameter | Default | Description |
---|---|---|
apikey | none | LoginRadius API Key [Required] |
EmailTemplate | none | Email template name [Optional] |
Fields | none | The fields parameter filters the API response so that the response only includes a specific set of fields [Optional] |
LoginUrl | none | Url where the user is logging from [Optional] |
VerificationUrl | none | Email verification url [Optional] |
Body Attributes
Attribute | Description | |
---|---|---|
user's email | ||
password | Password for the email | Model Class containing Definition of payload for Email Authentication API [Required] |
Auth Forgot Password
curl -X POST \'https://api.loginradius.com/identity/v2/auth/password?apikey=&ResetPasswordUrl=&EmailTemplate=' \-H 'Cache-Control: no-cache' \-H 'content-Type: application/json' \
The above command returns JSON structured like this:
{"IsPosted" : true}
This API is used to send the reset password url to a specified account.
HTTP Request
Post /identity/v2/auth/password?apikey=&ResetPasswordUrl=&EmailTemplate=
Query Parameters
Parameter | Default | Description |
---|---|---|
apikey | none | LoginRadius API Key [Required] |
ResetPasswordUrl | none | Url to which user should get re-directed to for resetting the password [Required] |
EmailTemplate | none | Email template name [Optional] |
Auth User Registration by Email
curl -X POST \'https://api.loginradius.com/identity/v2/auth/register?apikey=&sott=&EmailTemplate=&Fields=&Options=&VerificationUrl=&WelcomeEmailTemplate=' \-H 'Cache-Control: no-cache' \-H 'content-Type: application/json' \-d "{ "email" : [ {"type" => "<type>" ,"value" => "<value>"} ] ,"firstName" : "<firstName>","lastName" : "<lastName>","password" : "<password>" }"
The above command returns JSON structured like this:
{"Data" : {},"IsPosted" : true}
This API creates a user and send a verification email to the user.
HTTP Request
Post /identity/v2/auth/register?apikey=&sott=&EmailTemplate=&Fields=&Options=&VerificationUrl=&WelcomeEmailTemplate=
Query Parameters
Parameter | Default | Description |
---|---|---|
apikey | none | LoginRadius API Key [Required] |
sott | none | LoginRadius Secured One Time Token [Required] |
EmailTemplate | none | Email template name [Optional] |
Fields | none | The fields parameter filters the API response so that the response only includes a specific set of fields [Optional] |
Options | none | PreventVerificationEmail (Specifying this value prevents the verification email from being sent. Only applicable if you have the optional email verification flow) [Optional] |
VerificationUrl | none | Email verification url [Optional] |
WelcomeEmailTemplate | none | Name of the welcome email template [Optional] |
Body Attributes
Attribute | Description | |
---|---|---|
boolean type value, default is true | ||
FirstName | user's first name | |
LastName | user's last name | |
Password | Password for the email | Model Class containing Definition of payload for Auth User Registration API [Required] |
Auth User Registration By Captcha
curl -X POST \'https://api.loginradius.com/identity/v2/auth/register/captcha?apikey=&EmailTemplate=&Fields=&Options=&SmsTemplate=&VerificationUrl=&WelcomeEmailTemplate=' \-H 'Cache-Control: no-cache' \-H 'content-Type: application/json' \-d { "email" : [{"type" => "<type>" ,"value" => "<value>"}],"firstName" : "<firstName>","g-recaptcha-response" : "<g-recaptcha-response>","lastName" : "<lastName>","password" : "<password>"}
The above command returns JSON structured like this:
{"Data" : {},"IsPosted" : true}
This API creates a user and sends a verification email to the user.
HTTP Request
Post /identity/v2/auth/register/captcha?apikey=&EmailTemplate=&Fields=&Options=&SmsTemplate=&VerificationUrl=&WelcomeEmailTemplate=
Query Parameters
Parameter | Default | Description |
---|---|---|
apikey | none | LoginRadius API Key [Required] |
EmailTemplate | none | Email template name [Optional] |
Fields | none | The fields parameter filters the API response so that the response only includes a specific set of fields [Optional] |
Options | none | PreventVerificationEmail (Specifying this value prevents the verification email from being sent. Only applicable if you have the optional email verification flow) [Optional] |
SmsTemplate | none | SMS Template name [Optional] |
VerificationUrl | none | Email verification url [Optional] |
WelcomeEmailTemplate | none | Name of the welcome email template [Optional] |
Body Attributes
Attribute | Description | |
---|---|---|
boolean type value, default is true | ||
FirstName | user's first name | |
g-recaptcha-response | The acknowledgement received by Google in Google recaptcha authorisation process. | |
LastName | user's last name | |
Password | Password for the email | Model Class containing Definition of payload for Auth User Registration by Recaptcha API [Required] |
Auth Validate Access token
curl -X GET \'https://api.loginradius.com/identity/v2/auth/access_token/Validate?access_token=&apikey=' \-H 'Cache-Control: no-cache' \-H 'content-Type: application/json' \-H 'Authorization: Bearer ' \
The above command returns JSON structured like this:
{"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 validate access token, if token is valid then returns a response with its expiry otherwise returns a token invalid error response.
HTTP Request
Get /identity/v2/auth/access_token/Validate?access_token=&apikey=
Query Parameters
Parameter | Default | Description |
---|---|---|
access_token | none | Uniquely generated identifier key by LoginRadius that is activated after successful authentication. [Required] |
apikey | none | LoginRadius API Key [Required] |
Access Token Invalidate
curl -X GET \'https://api.loginradius.com/identity/v2/auth/access_token/InValidate?access_token=&apikey=&PreventRefresh=' \-H 'Cache-Control: no-cache' \-H 'content-Type: application/json' \-H 'Authorization: Bearer ' \
The above command returns JSON structured like this:
{"IsPosted" : true}
This API invalidates the active access token or expires an access token's validity.
HTTP Request
Get /identity/v2/auth/access_token/InValidate?access_token=&apikey=&PreventRefresh=
Query Parameters
Parameter | Default | Description |
---|---|---|
access_token | none | Uniquely generated identifier key by LoginRadius that is activated after successful authentication. [Required] |
apikey | none | LoginRadius API Key [Required] |
PreventRefresh | none | Boolean value that when set as true, in addition of the access token being invalidated, it will no longer have the capability of being refreshed. [Optional] |
Access Token Info
curl -X GET \'https://api.loginradius.com/identity/v2/auth/access_token?access_token=&apikey=' \-H 'Cache-Control: no-cache' \-H 'content-Type: application/json' \-H 'Authorization: Bearer ' \
The above command returns JSON structured like this:
{"access_token" : "Uniquely generated identifier key by LoginRadius that is activated after successful authentication.","isrememberme" : true,"provider" : "Name of the provider"}
This API provides the active access token Information.
HTTP Request
Get /identity/v2/auth/access_token?access_token=&apikey=
Query Parameters
Parameter | Default | Description |
---|---|---|
access_token | none | Uniquely generated identifier key by LoginRadius that is activated after successful authentication. [Required] |
apikey | none | LoginRadius API Key [Required] |
Auth Read all Profiles by Token
curl -X GET \'https://api.loginradius.com/identity/v2/auth/account?access_token=&apikey=&Fields=' \-H 'Cache-Control: no-cache' \-H 'content-Type: application/json' \-H 'Authorization: Bearer ' \
The above command returns JSON structured like this:
{"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 retrieves a copy of the user data based on the access token.
HTTP Request
Get /identity/v2/auth/account?access_token=&apikey=&Fields=
Query Parameters
Parameter | Default | Description |
---|---|---|
access_token | none | Uniquely generated identifier key by LoginRadius that is activated after successful authentication. [Required] |
apikey | none | LoginRadius API Key [Required] |
Fields | none | The fields parameter filters the API response so that the response only includes a specific set of fields [Optional] |
Auth Delete Account
curl -X GET \'https://api.loginradius.com/identity/v2/auth/account/delete?apikey=&deletetoken=' \-H 'Cache-Control: no-cache' \-H 'content-Type: application/json' \
The above command returns JSON structured like this:
{"IsPosted" : true}
This API is used to delete an account by passing it a delete token.
HTTP Request
Get /identity/v2/auth/account/delete?apikey=&deletetoken=
Query Parameters
Parameter | Default | Description |
---|---|---|
apikey | none | LoginRadius API Key [Required] |
deletetoken | none | Delete token received in the email [Required] |
Auth Check Email Availability
curl -X GET \'https://api.loginradius.com/identity/v2/auth/email?apikey=&Email=' \-H 'Cache-Control: no-cache' \-H 'content-Type: application/json' \
The above command returns JSON structured like this:
{"IsExist" : true}
This API is used to check the email exists or not on your site.
HTTP Request
Get /identity/v2/auth/email?apikey=&Email=
Query Parameters
Parameter | Default | Description |
---|---|---|
apikey | none | LoginRadius API Key [Required] |
none | Email of the user [Required] |
Auth Verify Email
curl -X GET \'https://api.loginradius.com/identity/v2/auth/email?apikey=&VerificationToken=&Fields=&Url=&WelcomeEmailTemplate=' \-H 'Cache-Control: no-cache' \-H 'content-Type: application/json' \
The above command returns JSON structured like this:
{"Data" : {},"IsPosted" : true}
This API is used to verify the email of user.
HTTP Request
Get /identity/v2/auth/email?apikey=&VerificationToken=&Fields=&Url=&WelcomeEmailTemplate=
Query Parameters
Parameter | Default | Description |
---|---|---|
apikey | none | LoginRadius API Key [Required] |
VerificationToken | none | Verification token received in the email [Required] |
Fields | none | The fields parameter filters the API response so that the response only includes a specific set of fields [Optional] |
Url | none | Mention URL to log the main URL(Domain name) in Database. [Optional] |
WelcomeEmailTemplate | none | Name of the welcome email template [Optional] |
Auth Social Identity
curl -X GET \'https://api.loginradius.com/identity/v2/auth/socialIdentity?access_token=&apikey=&Fields=' \-H 'Cache-Control: no-cache' \-H 'content-Type: application/json' \-H 'Authorization: Bearer ' \
The above command returns JSON structured like this:
{"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 called just after account linking API and it prevents the raas profile of the second account from getting created.
HTTP Request
Get /identity/v2/auth/socialIdentity?access_token=&apikey=&Fields=
Query Parameters
Parameter | Default | Description |
---|---|---|
access_token | none | Uniquely generated identifier key by LoginRadius that is activated after successful authentication. [Required] |
apikey | none | LoginRadius API Key [Required] |
Fields | none | The fields parameter filters the API response so that the response only includes a specific set of fields [Optional] |
Auth Delete Account with Email Confirmation
curl -X DELETE \'https://api.loginradius.com/identity/v2/auth/account?access_token=&apikey=&DeleteUrl=&EmailTemplate=' \-H 'Cache-Control: no-cache' \-H 'content-Type: application/json' \-H 'Authorization: Bearer ' \
The above command returns JSON structured like this:
{"IsDeleteRequestAccepted" : true}
This API will send a confirmation email for account deletion to the customer's email when passed the customer's access token
HTTP Request
Delete /identity/v2/auth/account?access_token=&apikey=&DeleteUrl=&EmailTemplate=
Query Parameters
Parameter | Default | Description |
---|---|---|
access_token | none | Uniquely generated identifier key by LoginRadius that is activated after successful authentication. [Required] |
apikey | none | LoginRadius API Key [Required] |
DeleteUrl | none | Url of the site [Optional] |
EmailTemplate | none | Email template name [Optional] |
Auth Remove Email
curl -X DELETE \'https://api.loginradius.com/identity/v2/auth/email?access_token=&apikey=' \-H 'Cache-Control: no-cache' \-H 'content-Type: application/json' \-H 'Authorization: Bearer ' \
The above command returns JSON structured like this:
{"IsDeleted" : true,"RecordsDeleted" : 0}
This API is used to remove additional emails from a user's account.
HTTP Request
Delete /identity/v2/auth/email?access_token=&apikey=
Query Parameters
Parameter | Default | Description |
---|---|---|
access_token | none | Uniquely generated identifier key by LoginRadius that is activated after successful authentication. [Required] |
apikey | none | LoginRadius API Key [Required] |