Skip to main contentOverview
The Users API provides comprehensive functionality for managing users within your organization, including user lifecycle management, authentication flows, password management, and role-based access control (RBAC).
What You Can Expect
User Lifecycle Management
Manage the complete user journey from invitation to activation:
- User Invitation: Send email invitations to new users to join your platform
- User Activation: Handle user account activation through secure email verification links
- Email Management: Resend activation emails if users don’t receive them initially
Authentication & Password Management
Secure authentication endpoints for user login and password recovery:
- Password Recovery: Request password reset emails and complete password updates
- Secure Token Handling: Use single-use tokens for secure password reset flows
Access and manage user data within your organization:
- User Retrieval: Get individual user information and details
- Organization User Lists: Retrieve lists of all users within your organization
Role-Based Access Control (RBAC)
Manage user permissions and roles within your system:
- Role Assignment: Assign specific roles to users to control their access levels
- Role Revocation: Remove roles from users when permissions change
- Permission Management: Control what actions users can perform based on their assigned roles
Authentication Requirements
All Users API endpoints require proper authentication using Bearer tokens. Ensure your requests include valid authorization headers as specified in the OpenAPI specification.
Use Cases
This API is designed to support:
- Administrative Dashboards: User management interfaces for organization admins
- Self-Service Portals: User profile management and password reset functionality
- Automated Onboarding: Programmatic user creation and role assignment workflows
- Compliance Systems: Audit trails and permission management for regulatory requirements
