Authentication
Manage users in R2R with built-in authentication
User Authentication and Management
R2R provides a comprehensive set of user authentication and management features, allowing you to implement secure and feature-rich authentication systems in your applications.
User Registration
To register a new user:
register_response = client.register("[email protected]", "password123")
Email Verification
If email verification is enabled, verify a user’s email:
verify_response = client.verify_email("verification_code_here")
User Login
To log in and obtain access tokens:
login_response = client.login("[email protected]", "password123")
Get Current User Info
Retrieve information about the currently authenticated user:
user_info = client.user()
Refresh Access Token
Refresh an expired access token:
refresh_response = client.refresh_access_token()
Change Password
Change the user’s password:
change_password_result = client.change_password("password123", "new_password")
Request Password Reset
Request a password reset for a user:
reset_request_result = client.request_password_reset("[email protected]")
Confirm Password Reset
Confirm a password reset using the reset token:
reset_confirm_result = client.confirm_password_reset("reset_token_here", "new_password")
Update User Profile
Update the user’s profile information:
update_result = client.update_user(name="John Doe", bio="R2R enthusiast")
Delete User Account
Delete the user’s account:
delete_result = client.delete_user("password123")
User Logout
Log out and invalidate the current access token:
logout_response = client.logout()
Superuser Capabilities
Superusers have additional privileges, including access to system-wide operations and sensitive information. To use superuser capabilities, authenticate as a superuser or the default admin:
# Login as admin
login_result = client.login("[email protected]", "admin_password")
# Access superuser features
users_overview = client.users_overview()
logs = client.logs()
analytics_result = client.analytics(
{"all_latencies": "search_latency"},
{"search_latencies": ["basic_statistics", "search_latency"]}
)
Superuser actions should be performed with caution and only by authorized personnel. Ensure proper security measures are in place when using superuser capabilities.
Security Considerations
When implementing user authentication, consider the following best practices:
- Always use HTTPS in production to encrypt data in transit.
- Implement rate limiting to protect against brute-force attacks.
- Use secure password hashing (R2R uses bcrypt by default).
- Consider implementing multi-factor authentication (MFA) for enhanced security.
- Conduct regular security audits of your authentication system.
For more advanced use cases or custom implementations, refer to the R2R documentation or reach out to the community for support.
Was this page helpful?