Explore Section
Explore Section
Explore section lists all the community-contributed, ready-to-use Agama projects. It contains the most frequently used authentication journeys like passwords, passkeys, SMS-OTP, E-Mail OTP, etc. These projects can be downloaded in the form of a .agama
package and started using after providing the minimal required configuration. An Agama project can be added to an IDP that has an Agama integration. For example, IDPs like Janssen Server, Gluu Flex, etc.
Using Projects From Explore Catalog
- Sign in to the Agama Lab and navigate to the
Explore
section. - From the list of available projects, click on the Agama project that you want to use. This will lead you to the GitHub repository for that project.
- Go to the
Releases
section of the GitHub repository to locate the most recent release. Each release has anAssets
section that contains a downloadable.gama
archive. - Download the
.gama
archive and add it to the IDP. Every IDP that has Agama integration may have different steps for adding a.gama
archive. - Once the project has been added to the IDP using the
.gama
archive, you need to provide configuration for the project. - Agama projects require a JSON-structured string as configuration. The GitHub repository’s README should provide guidelines on how to structure the configuration JSON.
- Once you have the configuration JSON ready, follow the instructions provided by your IDP on how to add the configuration to the project.
When Using Janssen Server as IDP
Janssen Server comes with Agama Lab integration out-of-the-box. Follow these instructions from the Janssen Server project documentation to quickly retrieve and integrate projects from Agama Lab and start using them.
Contributing Projects To The Explore Catalog
The Explore Catalog lists Agama projects that have been reviewed by Gluu and meet the requirements of the catalog for licensing, documentation, and proper organization.