Overview
The @espressif/rainmaker-base-sdk simplifies the integration of user management features like signup, login (via password or OTP), password recovery, and more into applications within the ESP RainMaker ecosystem.
Overview
User management in RainMaker enables you to:
- Authenticate users (signup and login)
- Manage passwords and account recovery
- Update user profile information
- Manage custom data and geo coordinates
- Handle tags and security features
- Manage user sessions and tokens
- Register and manage push notification endpoints
User Management Sections
Authentication
User authentication including signup, password-based login, and OTP-based login.
- Get Auth Instance
- User Signup (send signup code, confirm signup)
- User Sign in (password login, OTP login)
Password Management
Password recovery and password change operations.
- Forgot Password (request and set new password)
- Change Password
User Profile
User information and profile management.
- Get User Info
- Update Name
- Phone Number Management (set and confirm)
- Time Zone Management
Custom Data Management
Store, retrieve, and manage custom user data with permissions.
- Fetch, Set, and Delete Custom Data
- Geo Coordinates Management
Tags Management
Manage user tags for categorization and feature access.
- Add Tags
- Remove Tags
- Confirm Tag Assignment
Security
Security features including multi-factor authentication and account management.
- Multi-Factor Authentication (MFA) Configuration
- Account Deletion
Session Management
User session and token management.
- Logout
- Clean Up Resources
- Token Management (get access token, extend session, clear tokens)
Push Notifications
Register and manage push notification endpoints for your app.
- Create Platform Endpoint (register for push notifications)
- Delete Platform Endpoint (unregister from push notifications)