All Classes and Interfaces
Class
Description
Request payload for accepting invitations
Represents a group for JWT generation (input).
Represents an identifier for a user (email, sms, etc.)
Used for JWT generation.
Represents an accepted invitation
Represents a group associated with an invitation.
Response wrapper for invitation API calls that return multiple invitations
Complete invitation result as returned by the Vortex API
Represents the target of an invitation (email, SMS, etc.)
JWT payload for Vortex token generation
Supports both new simplified format (userEmail, userIsAutoJoinAdmin) and
legacy format (identifiers, groups, role) for backward compatibility.
User data for JWT generation
Required fields:
- id: User's unique identifier in your system
- email: User's email address
Optional fields:
- adminScopes: List of admin scopes (e.g., ["autoJoin"])
Example:
Auto-configuration for Vortex Spring Boot integration
This automatically sets up VortexClient and related beans when the
vortex.api.key property is provided.
Main Vortex SDK client for Java applications
Provides JWT generation and Vortex API integration with the same functionality
as the Node.js SDK, ensuring compatibility with React providers.
Configuration interface for Vortex Spring integration
This interface allows applications to define how users are authenticated
and authorized for Vortex operations, matching the pattern from Express SDK.
Represents a user in the Vortex system
Supports both new simplified format (userEmail + userIsAutoJoinAdmin)
and legacy format (identifiers + groups + role) for backward compatibility.
Spring Boot controller providing Vortex API endpoints
This controller provides the same route structure as the Express SDK,
ensuring compatibility with React providers and other frontend frameworks.
Exception thrown by Vortex SDK operations
Constants defining the Vortex API route structure
These routes match exactly with the Express SDK and React provider
to ensure complete compatibility across different backend implementations.