The following documentation is applicable to Free, Developer, and Developer Pro plans. For documentation related to the enterprise plan, please click here.

Authentication API

Refer this document to get API Key and Secret.

Auth Add Email

Adds additional emails to the consumer corresponding to the specified access token.

Endpoint

POST https://api.loginradius.com/identity/v2/auth/email

Query Parameters

ParameterDefaultDescription
access_tokennoneUniquely generated identifier key by LoginRadius that is activated after successful authentication. [Required]
apikeynoneLoginRadius API Key [Required]
EmailTemplatenoneEmail template name [Optional]
VerificationUrlnoneEmail verification url [Optional]

Try Me Out

Click the button below to enter parameters, send a request and see the response.

Auth Login by Email

Exchanges consumer login details for a copy of their user data and a LoginRadius access token.

Endpoint

POST https://api.loginradius.com/identity/v2/auth/login

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]
VerificationUrlnoneEmail verification url [Optional]

Body Attributes

AttributeDescription
emailuser’s email id with it’s type. Sample - [{“Type”: “Primary”, “Value”: “test@test.com”}]
passwordPassword for the emailModel Class containing Definition of payload for Email Authentication API [Required]

Try Me Out

Click the button below to enter parameters, send a request and see the response.

Auth Forgot Password

Sends a reset password URL to the consumer corresponding to the specified Email ID.

Endpoint

POST https://api.loginradius.com/identity/v2/auth/password

Query Parameters

ParameterDefaultDescription
apikeynoneLoginRadius API Key [Required]
ResetPasswordUrlnoneUrl to which user should get re-directed to for resetting the password [Required]
EmailTemplatenoneEmail template name [Optional]

Try Me Out

Click the button below to enter parameters, send a request and see the response.

Auth User Registration by Email

Creates a new consumer, sending a verification email to the specified Email ID.

Endpoint

POST https://api.loginradius.com/identity/v2/auth/register

Query Parameters

ParameterDefaultDescription
apikeynoneLoginRadius API Key [Required]
sottnoneLoginRadius Secured One Time Token [Required]
EmailTemplatenoneEmail template name [Optional]
FieldsnoneThe fields parameter filters the API response so that the response only includes a specific set of fields [Optional]
OptionsnonePreventVerificationEmail (Specifying this value prevents the verification email from being sent. Only applicable if you have the optional email verification flow) [Optional]
VerificationUrlnoneEmail verification url [Optional]
WelcomeEmailTemplatenoneName of the welcome email template [Optional]

Body Attributes

AttributeDescription
Emailuser’s email id with it’s type. Sample - [{“Type”: “Primary”, “Value”: “test@test.com”}]
FirstNameuser’s first name
LastNameuser’s last name
PasswordPassword for the emailModel Class containing Definition of payload for Auth User Registration API [Required]

Try Me Out

Click the button below to enter parameters, send a request and see the response.

Auth User Registration By Captcha

Creates a new consumer using the Captcha flow, sending a verification email to the specified Email ID.

Endpoint

POST https://api.loginradius.com/identity/v2/auth/register/captcha

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]
OptionsnonePreventVerificationEmail (Specifying this value prevents the verification email from being sent. Only applicable if you have the optional email verification flow) [Optional]
SmsTemplatenoneSMS Template name [Optional]
VerificationUrlnoneEmail verification url [Optional]
WelcomeEmailTemplatenoneName of the welcome email template [Optional]

Body Attributes

AttributeDescription
Emailuser’s email id with it’s type. Sample - [{“Type”: “Primary”, “Value”: “test@test.com”}]
FirstNameuser’s first name
g-recaptcha-responseThe acknowledgement received by Google in Google recaptcha authorisation process.
LastNameuser’s last name
PasswordPassword for the emailModel Class containing Definition of payload for Auth User Registration by Recaptcha API [Required]

Try Me Out

Click the button below to enter parameters, send a request and see the response.

Auth Validate Access Token

Validates specified access token.

Endpoint

GET https://api.loginradius.com/identity/v2/auth/access_token/validate

Query Parameters

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

Try Me Out

Click the button below to enter parameters, send a request and see the response.

Access Token Invalidate

Invalidates specified access token.

Endpoint

GET https://api.loginradius.com/identity/v2/auth/access_token/invalidate

Query Parameters

ParameterDefaultDescription
access_tokennoneUniquely generated identifier key by LoginRadius that is activated after successful authentication. [Required]
apikeynoneLoginRadius API Key [Required]
PreventRefreshnoneBoolean 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]

Try Me Out

Click the button below to enter parameters, send a request and see the response.

Access Token Info

Retrieves token data for the specified access token.

Endpoint

GET https://api.loginradius.com/identity/v2/auth/access_token

Query Parameters

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

Try Me Out

Click the button below to enter parameters, send a request and see the response.

Auth Get Profiles by Token

Retrieves consumer profile data corresponding to the specified access token.

Endpoint

GET https://api.loginradius.com/identity/v2/auth/account

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]

Try Me Out

Click the button below to enter parameters, send a request and see the response.

Auth Delete Account

Deletes consumer corresponding to the specified delete token.

Endpoint

GET https://api.loginradius.com/identity/v2/auth/account/delete

Query Parameters

ParameterDefaultDescription
apikeynoneLoginRadius API Key [Required]
deletetokennoneDelete token received in the email [Required]

Try Me Out

Click the button below to enter parameters, send a request and see the response.

Auth Check Email Availability

Checks if the specified Email ID already exists on your app.

Endpoint

GET https://api.loginradius.com/identity/v2/auth/email

Query Parameters

ParameterDefaultDescription
apikeynoneLoginRadius API Key [Required]
EmailnoneEmail of the user [Required]

Try Me Out

Click the button below to enter parameters, send a request and see the response.

Auth Verify Email

Verifies email of the consumer corresponding to the specified verification token.

Endpoint

GET https://api.loginradius.com/identity/v2/auth/email

Query Parameters

ParameterDefaultDescription
apikeynoneLoginRadius API Key [Required]
VerificationTokennoneVerification token received in the email [Required]
FieldsnoneThe fields parameter filters the API response so that the response only includes a specific set of fields [Optional]
UrlnoneMention URL to log the main URL(Domain name) in Database. [Optional]
WelcomeEmailTemplatenoneName of the welcome email template [Optional]

Try Me Out

Click the button below to enter parameters, send a request and see the response.

Auth Social Identity

Retrieves all consumer’s profiles and social identities corresponding to the specified access token.

Endpoint

GET https://api.loginradius.com/identity/v2/auth/socialIdentity

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]

Try Me Out

Click the button below to enter parameters, send a request and see the response.

Auth Update Profile by Token

Updates consumer’s profile corresponding to the specified access token.

Endpoint

PUT https://api.loginradius.com/identity/v2/auth/account

Query Parameters

ParameterDefaultDescription
access_tokennoneUniquely generated identifier key by LoginRadius that is activated after successful authentication. [Required]
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]
NullSupportnoneBoolean, pass true if you wish to update any user profile field with a NULL value, You can get the details [Optional]
SmsTemplatenoneSMS Template name [Optional]
VerificationUrlnoneEmail verification url [Optional]

Body Attributes

AttributeDescription
FirstNameuser’s first name
LastNameuser’s last nameModel Class containing Definition of payload for User Profile update API [Required]

Try Me Out

Click the button below to enter parameters, send a request and see the response.

Auth Reset Password by Reset Token

Sets a new password for the consumer corresponding to the specified reset token.

Endpoint

PUT https://api.loginradius.com/identity/v2/auth/password/reset

Query Parameters

ParameterDefaultDescription
apikeynoneLoginRadius API Key [Required]

Body Attributes

AttributeDescription
resettokenThe reset token received in the forgot password email. [Required]
passwordThe new password for the consumer’s account. [Required]
welcomeemailtemplateWelcome email template. [Optional]
resetpasswordemailtemplateReset password email template. [Optional]

Try Me Out

Click the button below to enter parameters, send a request and see the response.

Auth Resend Email Verification

Resends the verification email to the consumer corresponding to the specified Email ID.

Endpoint

PUT https://api.loginradius.com/identity/v2/auth/register

Query Parameters

ParameterDefaultDescription
apikeynoneLoginRadius API Key [Required]
emailTemplatenoneEmail template name [Optional]
verificationUrlnoneEmail verification url [Optional]

Try Me Out

Click the button below to enter parameters, send a request and see the response.

Auth Delete Account with Email Confirmation

Triggers the delete account process for the consumer corresponding to the specified access token. A confirmation email for account deletion will be sent to the consumer.

Endpoint

DELETE https://api.loginradius.com/identity/v2/auth/account

Query Parameters

ParameterDefaultDescription
access_tokennoneUniquely generated identifier key by LoginRadius that is activated after successful authentication. [Required]
apikeynoneLoginRadius API Key [Required]
DeleteUrlnoneUrl of the site [Optional]
EmailTemplatenoneEmail template name [Optional]

Try Me Out

Click the button below to enter parameters, send a request and see the response.

Auth Remove Email

Removes additional emails from the consumer corresponding to the specified access token.

Endpoint

DELETE https://api.loginradius.com/identity/v2/auth/email

Query Parameters

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

Try Me Out

Click the button below to enter parameters, send a request and see the response.

Go Back to Home Page


Was this article helpful?

Have more questions? Submit a request