LoginRadius v1.0.0 LoginRadius.Authentication View Source

Elixir wrapper for the LoginRadius Authentication API module

Link to this section Summary

Functions

POST - Auth Add Email: Adds additional emails to a user’s account. https://docs.loginradius.com/api/v2/customer-identity-api/authentication/auth-add-email

PUT - Auth Change Password: Changes an account’s password based on previous password. https://docs.loginradius.com/api/v2/customer-identity-api/authentication/auth-change-password

GET - Auth Check Email Availability: Check if the specified email exists on your site. https://docs.loginradius.com/api/v2/customer-identity-api/authentication/auth-email-availability

GET - Auth Check Username Availability: Check if the specified username exists on your site. https://docs.loginradius.com/api/v2/customer-identity-api/authentication/auth-username-availability

GET - Auth Delete Account: Delete an account based on delete token. https://docs.loginradius.com/api/v2/customer-identity-api/authentication/auth-delete-account

DELETE - Auth Delete Account with Email Confirmation: Deletes a user account using its access token. https://docs.loginradius.com/api/v2/customer-identity-api/authentication/auth-delete-account-with-email-confirmation

POST - Auth Forgot Password: Sends a reset password url to a specified account. https://docs.loginradius.com/api/v2/customer-identity-api/authentication/auth-forgot-password

GET - Invalidate Access Token: Invalidates an active access token. https://docs.loginradius.com/api/v2/customer-identity-api/authentication/auth-invalidate-access-token

PUT - Auth Link Social Identities: Links a social provider account with a specified account based on access token and social provider’s user access token. https://docs.loginradius.com/api/v2/customer-identity-api/authentication/auth-link-social-identities

POST - Auth Login by Email: Retrieves a copy of user data based on email. https://docs.loginradius.com/api/v2/customer-identity-api/authentication/auth-login-by-email

POST - Auth Login by Username: Retrieves a copy of user data based on username. https://docs.loginradius.com/api/v2/customer-identity-api/authentication/auth-login-by-username

GET - Auth Privacy Policy Accept: Updates the privacy policy status in a user’s profile based on access token. https://docs.loginradius.com/api/v2/customer-identity-api/authentication/auth-privacy-policy-accept

GET - Auth Read All Profiles by Token: Retrieves a copy of user data based on access token. https://docs.loginradius.com/api/v2/customer-identity-api/authentication/auth-read-profiles-by-token

DELETE - Auth Remove Email: Removes additional emails from a user’s account. https://docs.loginradius.com/api/v2/customer-identity-api/authentication/auth-remove-email

PUT - Auth Resend Email Verification: Resends a verification email to the user. https://docs.loginradius.com/api/v2/customer-identity-api/authentication/auth-resend-email-verification

PUT - Auth Reset Password by OTP: Sets a new password for a specified account using a One Time Passcode. https://docs.loginradius.com/api/v2/customer-identity-api/authentication/auth-reset-password-by-otp

PUT - Auth Reset Password by Reset Token: Sets a new password for a specified account using a reset token. https://docs.loginradius.com/api/v2/customer-identity-api/authentication/auth-reset-password-by-reset-token

PUT - Auth Reset Password by Security Answer and Email: Sets a new password for a specified account using a security answer and email. https://docs.loginradius.com/api/v2/customer-identity-api/authentication/auth-reset-password-by-email

PUT - Auth Reset Password by Security Answer and Phone: Sets a new password for a specified account using a security answer and phone. https://docs.loginradius.com/api/v2/customer-identity-api/authentication/auth-reset-password-by-phone

PUT - Auth Reset Password by Security Answer and UserName: Sets a new password for a specified account using a security answer and username. https://docs.loginradius.com/api/v2/customer-identity-api/authentication/auth-reset-password-by-username

GET - Get Security Questions by Access Token: Retrieves the list of security questions that have been configured for an account by access token. https://docs.loginradius.com/api/v2/customer-identity-api/authentication/security-questions-by-access-token

GET - Get Security Questions by Email: Retrieves the list of security questions that have been configured for an account by email. https://docs.loginradius.com/api/v2/customer-identity-api/authentication/security-questions-by-email

GET - Get Security Questions by Phone: Retrieves the list of security questions that have been configured for an account by phone ID. https://docs.loginradius.com/api/v2/customer-identity-api/authentication/security-questions-by-phone

GET - Get Security Questions by Username: Retrieves the list of security questions that have been configured for an account by username. https://docs.loginradius.com/api/v2/customer-identity-api/authentication/security-questions-by-user-name

GET - Auth Send Welcome Email: Sends a welcome email. https://docs.loginradius.com/api/v2/customer-identity-api/authentication/auth-send-welcome-email

PUT - Set or Change UserName: Sets or changes a username using an access token. https://docs.loginradius.com/api/v2/customer-identity-api/authentication/auth-set-or-change-user-name

GET - Auth Social Identity: Prevents RAAS profile of the second account from getting created (called before account linking API). https://docs.loginradius.com/api/v2/customer-identity-api/authentication/auth-social-identity

DELETE - Auth Unlink Social Identities: Unlinks a social provider account with a specified account using its access token. https://docs.loginradius.com/api/v2/customer-identity-api/authentication/auth-unlink-social-identities

PUT - Auth Update Profile by Access Token: Updates a user’s profile using an access token. https://docs.loginradius.com/api/v2/customer-identity-api/authentication/auth-update-profile-by-token

PUT - Update Security Questions by Access Token: Updates security questions using an access token. https://docs.loginradius.com/api/v2/customer-identity-api/authentication/auth-update-security-question-by-access-token

POST - Auth User Registration by Email: Creates a user in the database and sends a verification email to the user. https://docs.loginradius.com/api/v2/customer-identity-api/authentication/auth-user-registration-by-email

GET - Validate Access Token: Validates access token, returns an error if token is invalid. https://docs.loginradius.com/api/v2/customer-identity-api/authentication/auth-validate-access-token

GET - Auth Verify Email: Verifies the email of a user. https://docs.loginradius.com/api/v2/customer-identity-api/authentication/auth-verify-email

PUT - Auth Verify Email by OTP: Verifies the email of a user when OTP Email verification flow is enabled. https://docs.loginradius.com/api/v2/customer-identity-api/authentication/auth-verify-email-by-otp

Link to this section Functions

Link to this function add_email(access_token, data, verification_url \\ "", email_template \\ "") View Source
add_email(String.t(), map(), String.t(), String.t()) :: LoginRadius.response()

POST - Auth Add Email: Adds additional emails to a user’s account. https://docs.loginradius.com/api/v2/customer-identity-api/authentication/auth-add-email

Link to this function change_password(access_token, data) View Source
change_password(String.t(), map()) :: LoginRadius.response()

PUT - Auth Change Password: Changes an account’s password based on previous password. https://docs.loginradius.com/api/v2/customer-identity-api/authentication/auth-change-password

Link to this function check_email_availability(email) View Source
check_email_availability(String.t()) :: LoginRadius.response()

GET - Auth Check Email Availability: Check if the specified email exists on your site. https://docs.loginradius.com/api/v2/customer-identity-api/authentication/auth-email-availability

Link to this function check_username_availability(username) View Source
check_username_availability(String.t()) :: LoginRadius.response()

GET - Auth Check Username Availability: Check if the specified username exists on your site. https://docs.loginradius.com/api/v2/customer-identity-api/authentication/auth-username-availability

Link to this function delete_account(delete_token) View Source
delete_account(String.t()) :: LoginRadius.response()

GET - Auth Delete Account: Delete an account based on delete token. https://docs.loginradius.com/api/v2/customer-identity-api/authentication/auth-delete-account

Link to this function delete_account_with_email_confirmation(access_token, delete_url \\ "", email_template \\ "") View Source
delete_account_with_email_confirmation(String.t(), String.t(), String.t()) ::
  LoginRadius.response()

DELETE - Auth Delete Account with Email Confirmation: Deletes a user account using its access token. https://docs.loginradius.com/api/v2/customer-identity-api/authentication/auth-delete-account-with-email-confirmation

Link to this function forgot_password(reset_password_url, data, email_template \\ "") View Source
forgot_password(String.t(), map(), String.t()) :: LoginRadius.response()

POST - Auth Forgot Password: Sends a reset password url to a specified account. https://docs.loginradius.com/api/v2/customer-identity-api/authentication/auth-forgot-password

Link to this function invalidate_access_token(access_token) View Source
invalidate_access_token(String.t()) :: LoginRadius.response()

GET - Invalidate Access Token: Invalidates an active access token. https://docs.loginradius.com/api/v2/customer-identity-api/authentication/auth-invalidate-access-token

Link to this function login_by_email(data, verification_url \\ "", login_url \\ "", email_template \\ "", g_recaptcha_response \\ "", options \\ "") View Source
login_by_email(
  map(),
  String.t(),
  String.t(),
  String.t(),
  String.t(),
  String.t()
) :: LoginRadius.response()

POST - Auth Login by Email: Retrieves a copy of user data based on email. https://docs.loginradius.com/api/v2/customer-identity-api/authentication/auth-login-by-email

Link to this function login_by_username(data, verification_url \\ "", login_url \\ "", email_template \\ "", g_recaptcha_response \\ "", options \\ "") View Source
login_by_username(
  map(),
  String.t(),
  String.t(),
  String.t(),
  String.t(),
  String.t()
) :: LoginRadius.response()

POST - Auth Login by Username: Retrieves a copy of user data based on username. https://docs.loginradius.com/api/v2/customer-identity-api/authentication/auth-login-by-username

Link to this function privacy_policy_accept(access_token) View Source
privacy_policy_accept(String.t()) :: LoginRadius.response()

GET - Auth Privacy Policy Accept: Updates the privacy policy status in a user’s profile based on access token. https://docs.loginradius.com/api/v2/customer-identity-api/authentication/auth-privacy-policy-accept

Link to this function read_profiles_by_access_token(access_token) View Source
read_profiles_by_access_token(String.t()) :: LoginRadius.response()

GET - Auth Read All Profiles by Token: Retrieves a copy of user data based on access token. https://docs.loginradius.com/api/v2/customer-identity-api/authentication/auth-read-profiles-by-token

Link to this function remove_email(access_token, data) View Source
remove_email(String.t(), map()) :: LoginRadius.response()

DELETE - Auth Remove Email: Removes additional emails from a user’s account. https://docs.loginradius.com/api/v2/customer-identity-api/authentication/auth-remove-email

Link to this function resend_email_verification(data, verification_url \\ "", email_template \\ "") View Source
resend_email_verification(map(), String.t(), String.t()) ::
  LoginRadius.response()

PUT - Auth Resend Email Verification: Resends a verification email to the user. https://docs.loginradius.com/api/v2/customer-identity-api/authentication/auth-resend-email-verification

Link to this function reset_password_by_otp(data) View Source
reset_password_by_otp(map()) :: LoginRadius.response()

PUT - Auth Reset Password by OTP: Sets a new password for a specified account using a One Time Passcode. https://docs.loginradius.com/api/v2/customer-identity-api/authentication/auth-reset-password-by-otp

Link to this function reset_password_by_reset_token(data) View Source
reset_password_by_reset_token(map()) :: LoginRadius.response()

PUT - Auth Reset Password by Reset Token: Sets a new password for a specified account using a reset token. https://docs.loginradius.com/api/v2/customer-identity-api/authentication/auth-reset-password-by-reset-token

Link to this function reset_password_by_security_answer_and_email(data) View Source
reset_password_by_security_answer_and_email(map()) :: LoginRadius.response()

PUT - Auth Reset Password by Security Answer and Email: Sets a new password for a specified account using a security answer and email. https://docs.loginradius.com/api/v2/customer-identity-api/authentication/auth-reset-password-by-email

Link to this function reset_password_by_security_answer_and_phone(data) View Source
reset_password_by_security_answer_and_phone(map()) :: LoginRadius.response()

PUT - Auth Reset Password by Security Answer and Phone: Sets a new password for a specified account using a security answer and phone. https://docs.loginradius.com/api/v2/customer-identity-api/authentication/auth-reset-password-by-phone

Link to this function reset_password_by_security_answer_and_username(data) View Source
reset_password_by_security_answer_and_username(map()) :: LoginRadius.response()

PUT - Auth Reset Password by Security Answer and UserName: Sets a new password for a specified account using a security answer and username. https://docs.loginradius.com/api/v2/customer-identity-api/authentication/auth-reset-password-by-username

Link to this function security_questions_by_access_token(access_token) View Source
security_questions_by_access_token(String.t()) :: LoginRadius.response()

GET - Get Security Questions by Access Token: Retrieves the list of security questions that have been configured for an account by access token. https://docs.loginradius.com/api/v2/customer-identity-api/authentication/security-questions-by-access-token

Link to this function security_questions_by_email(email) View Source
security_questions_by_email(String.t()) :: LoginRadius.response()

GET - Get Security Questions by Email: Retrieves the list of security questions that have been configured for an account by email. https://docs.loginradius.com/api/v2/customer-identity-api/authentication/security-questions-by-email

Link to this function security_questions_by_phone(phone_id) View Source
security_questions_by_phone(String.t()) :: LoginRadius.response()

GET - Get Security Questions by Phone: Retrieves the list of security questions that have been configured for an account by phone ID. https://docs.loginradius.com/api/v2/customer-identity-api/authentication/security-questions-by-phone

Link to this function security_questions_by_username(username) View Source
security_questions_by_username(String.t()) :: LoginRadius.response()

GET - Get Security Questions by Username: Retrieves the list of security questions that have been configured for an account by username. https://docs.loginradius.com/api/v2/customer-identity-api/authentication/security-questions-by-user-name

Link to this function send_welcome_email(access_token, welcome_email_template \\ "") View Source
send_welcome_email(String.t(), String.t()) :: LoginRadius.response()

GET - Auth Send Welcome Email: Sends a welcome email. https://docs.loginradius.com/api/v2/customer-identity-api/authentication/auth-send-welcome-email

Link to this function set_or_change_username(access_token, data) View Source
set_or_change_username(String.t(), map()) :: LoginRadius.response()

PUT - Set or Change UserName: Sets or changes a username using an access token. https://docs.loginradius.com/api/v2/customer-identity-api/authentication/auth-set-or-change-user-name

Link to this function social_identity(access_token) View Source
social_identity(String.t()) :: LoginRadius.response()

GET - Auth Social Identity: Prevents RAAS profile of the second account from getting created (called before account linking API). https://docs.loginradius.com/api/v2/customer-identity-api/authentication/auth-social-identity

Link to this function update_profile_by_access_token(access_token, data, verification_url \\ "", email_template \\ "", sms_template \\ "") View Source
update_profile_by_access_token(
  String.t(),
  map(),
  String.t(),
  String.t(),
  String.t()
) :: LoginRadius.response()

PUT - Auth Update Profile by Access Token: Updates a user’s profile using an access token. https://docs.loginradius.com/api/v2/customer-identity-api/authentication/auth-update-profile-by-token

Link to this function update_security_questions_by_access_token(access_token, data) View Source
update_security_questions_by_access_token(String.t(), map()) ::
  LoginRadius.response()

PUT - Update Security Questions by Access Token: Updates security questions using an access token. https://docs.loginradius.com/api/v2/customer-identity-api/authentication/auth-update-security-question-by-access-token

Link to this function user_registration_by_email(data, verification_url \\ "", email_template \\ "", options \\ "") View Source
user_registration_by_email(map(), String.t(), String.t(), String.t()) ::
  LoginRadius.response()

POST - Auth User Registration by Email: Creates a user in the database and sends a verification email to the user. https://docs.loginradius.com/api/v2/customer-identity-api/authentication/auth-user-registration-by-email

Link to this function validate_access_token(access_token) View Source
validate_access_token(String.t()) :: LoginRadius.response()

GET - Validate Access Token: Validates access token, returns an error if token is invalid. https://docs.loginradius.com/api/v2/customer-identity-api/authentication/auth-validate-access-token

Link to this function verify_email(verification_token, url \\ "", welcome_email_template \\ "") View Source
verify_email(String.t(), String.t(), String.t()) :: LoginRadius.response()

GET - Auth Verify Email: Verifies the email of a user. https://docs.loginradius.com/api/v2/customer-identity-api/authentication/auth-verify-email

Link to this function verify_email_by_otp(data, url \\ "", welcome_email_template \\ "") View Source
verify_email_by_otp(map(), String.t(), String.t()) :: LoginRadius.response()

PUT - Auth Verify Email by OTP: Verifies the email of a user when OTP Email verification flow is enabled. https://docs.loginradius.com/api/v2/customer-identity-api/authentication/auth-verify-email-by-otp