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:

1
register_response = client.register("[email protected]", "password123")

Email Verification

If email verification is enabled, verify a user’s email:

1
verify_response = client.verify_email("verification_code_here")

User Login

To log in and obtain access tokens:

1
login_response = client.login("[email protected]", "password123")

Get Current User Info

Retrieve information about the currently authenticated user:

1
user_info = client.user()

Refresh Access Token

Refresh an expired access token:

1
refresh_response = client.refresh_access_token()

Change Password

Change the user’s password:

1
change_password_result = client.change_password("password123", "new_password")

Request Password Reset

Request a password reset for a user:

1
reset_request_result = client.request_password_reset("[email protected]")

Confirm Password Reset

Confirm a password reset using the reset token:

1
reset_confirm_result = client.confirm_password_reset("reset_token_here", "new_password")

Update User Profile

Update the user’s profile information:

1
update_result = client.update_user(name="John Doe", bio="R2R enthusiast")

Delete User Account

Delete the user’s account:

1
user_id = register_response["results"]["id"] # input unique id here
2
delete_result = client.delete_user(user_id, "password123")

User Logout

Log out and invalidate the current access token:

1
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:

1
# Login as admin
2
login_result = client.login("[email protected]", "admin_password")
3
4
# Access superuser features
5
users_overview = client.users_overview()
6
logs = client.logs()
7
analytics_result = client.analytics(
8
    {"all_latencies": "search_latency"},
9
    {"search_latencies": ["basic_statistics", "search_latency"]}
10
)

Security Considerations

When implementing user authentication, consider the following best practices:

1. Always use HTTPS in production to encrypt data in transit.
2. Implement rate limiting to protect against brute-force attacks.
3. Use secure password hashing (R2R uses bcrypt by default).
4. Consider implementing multi-factor authentication (MFA) for enhanced security.
5. 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.