Integration Module 2.0 for Medusa is outRead the announcement
Keycloak logo

Keycloak

Enable secure Keycloak login and access control

npm install @vymalo/medusa-keycloak
Category
Built by
Regions
Worldwide
Service
Version
1.0.10
Last updated
1 year ago
Monthly downloads
Loading downloads

MedusaJS Keycloak Authentication

๐Ÿ” Seamless Keycloak Identity and Access Management for MedusaJS

๐ŸŒŸ Features

  • Native Keycloak authentication integration
  • Multi-provider authentication support
  • Secure OAuth 2.0 / OpenID Connect implementation
  • Flexible configuration options
  • Role-based access control
  • Single Sign-On (SSO) capabilities

๐Ÿ—๏ธ Authentication Architecture

๐Ÿ“ฆ Installation

Install the package using npm:

Or using yarn:

๐Ÿš€ Configuration Example

๐Ÿ”ง Environment Variables

Required Configuration:

  • : Keycloak server base URL
  • : Keycloak realm name
  • : Application client ID
  • : Client secret

Optional Configuration:

  • : Authentication scopes
  • : Custom callback URL

๐Ÿ›ก๏ธ Security Considerations

  • Use environment variables for sensitive credentials
  • Implement proper scope restrictions
  • Rotate client secrets periodically
  • Configure appropriate token lifetimes

๐ŸŒ Advanced Integration Options

Authentication Flow Customization

  • Support multiple authentication providers
  • Fallback mechanisms
  • Role-based access control
  • Custom claim mapping

Token Management

  • Access token validation
  • Refresh token handling
  • Session management
  • Single sign-on (SSO) support

๐Ÿ“Š Supported Authentication Flows

  • Authorization Code Flow
  • Implicit Flow
  • Hybrid Flow
  • Client Credentials Flow
  • Direct Access Grants

๐Ÿค Contributing

Contributions are welcome!

  • Improve authentication logic
  • Add new Keycloak configuration options
  • Enhance security features
  • Provide more robust error handling

๐Ÿ› Troubleshooting

  • Verify Keycloak server connectivity
  • Check client configuration
  • Validate environment variables
  • Review network and CORS settings

๐Ÿ“„ License

Check the license