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
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
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
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
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
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
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
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
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_social_identities(String.t(), map()) :: LoginRadius.response()
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
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
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
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
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
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
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
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
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
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
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
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
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
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
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
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
unlink_social_identities(String.t(), map()) :: LoginRadius.response()
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
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
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
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
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
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
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