[{"_1":2,"_3":-5,"_4":-5},"loaderData",{"_5":6,"_7":8},"actionData","errors","root",{"_131":132},"routes/agama/detail",{"_9":10,"_11":12},"entry",{"_16":-5,"_17":115,"_19":20,"_21":116,"_23":117,"_25":118,"_27":-5,"_28":119,"_30":31,"_32":120,"_34":121,"_36":122,"_38":123,"_40":124,"_42":125,"_44":126,"_46":60},"related",[13,14,15],{"_16":-5,"_17":91,"_19":20,"_21":92,"_23":93,"_25":94,"_27":-5,"_28":95,"_30":31,"_32":96,"_34":97,"_36":98,"_38":99,"_40":100,"_42":101,"_44":102,"_46":103},{"_16":-5,"_17":66,"_19":20,"_21":67,"_23":68,"_25":69,"_27":-5,"_28":70,"_30":71,"_32":72,"_34":73,"_36":74,"_38":75,"_40":76,"_42":77,"_44":78,"_46":79},{"_16":-5,"_17":18,"_19":20,"_21":22,"_23":24,"_25":26,"_27":-5,"_28":29,"_30":31,"_32":33,"_34":35,"_36":37,"_38":39,"_40":41,"_42":43,"_44":45,"_46":47},"author","categories",[],"collection","agama","data",{"_62":63,"_64":65},"date","2024-12-03T19:41:19Z","excerpt","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.…","featuredImage","html","

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 form of a .gama package and start using after providing a 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 an Assets section that has 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, we need to provide configuration for the project.
Agama projects take a JSON structured string as configuration. The GitHub repository’s README should provide guidelines about 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 Janssen Server project documentation to quickly get and integrate projects from Agama Lab and start using it.

#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 license, documentation, and proper organization.

\n","readingMinutes",1,"route","/agama/explore-section","slug","explore-section","sourcePath","content/agama/explore-section.md","tags",[],"title","Explore Section","toc",[48,49,50],"updated","2025-01-04T18:47:29Z","wordCount",298,{"_51":59,"_53":60,"_55":61},{"_51":57,"_53":54,"_55":58},{"_51":52,"_53":54,"_55":56},"id","contributing-projects-to-the-explore-catalog","depth",3,"text","Contributing Projects To The Explore Catalog","when-using-janssen-server-as-idp","When Using Janssen Server as IDP","using-projects-from-explore-catalog",2,"Using Projects From Explore Catalog","wpId","34371","wpLink","https://gluu.org/agama/explore-section/",[],{"_62":89,"_64":90},"2024-12-04T14:01:10Z","Policy designer tool provides you a visual editor to build, manage, and test authorization policies written in Cedar language. Policy designer helps you quickly test these policies to authorise users…","

#Policy Designer

Policy designer tool provides you a visual editor to build, manage, and test authorization policies written in Cedar language. Policy designer helps you quickly test these policies to authorise users based on tokens using Jans Cedarling.

You can use policy designer to:

Create and manage policy stores that store multiple Cedar policies in a GitHub repository
Create Cedar schema and policy using a visual editor
Import Cedar schema and policies
Validate policies against a given schema
Test Token based authorisation control scenarios using Jans Cedarling

#Key Features

#Policy Store

Policy designer uses a GitHub repository designated by the user for storing details about schema, policy files etc. Using GitHub repository enables proper version control and release management of the changes in the policies and schema.

Policy designer stores these details in a grouping called Policy Store. Essentially, a policy store is a directory in a GitHub repository with schema and policy details in it.

One GitHub repository can have multiple policy stores. Each policy stores can have multiple policies and schema with multiple namespaces.

#Wizard based editors

Policy designer allows you to write policies and test scenarios using step-by-step wizard. This further reduces learning curve around writing Cedar policies by hand and makes it less error prone.

#Policy Wizard

$\"\"$

#Test Wizard

$\"\"$

#Detailed Walkthrough

#Dashboard

Policy designer dashboard lists policy stores available in the repository. When the user has not selected the repository yet, the dashboard shows instructions for GitHub integration and repository selection as shown below:

$\"\"$

After successful GitHub integration, the user can select a repository by choosing the appropriate option.

$\"\"$

Once the repository has been selected, the dashboard will automatically load the stores from GitHub. Now the user can create new store as well.

$\"\"$

There are some quick access tools available in the list.

$\"\"$

Edit: used to edit store
Download: used to download the store in JSON form, which you can directly use in Cedarling authorization
Link: used to copy store GitHub link which you can use in Cedarling authorization
Manage: used to manage store schema, policies, trusted issuer, and test policies.
Delete: used to delete store

#Schema Section

Click on the Manage button on the Store List, it will navigate you to the store manage page. Once you create a store, Agama Lab creates one default schema for you, which you can easily modify in the schema section.

$\"\"$

#Manage Namespace

Click on Manage Namespace button and you will get the following option:

$\"\"$

#Add namespace

Select + Add New Namespace option from Manage Namespace to add a new namespace. It will open a dialog box for you to enter the new namespace name. Just enter a custom name and click on save to make a new store.

$\"\"$

#Rename namespace

Select Rename Namespace option from Manage Namespace to rename namespace. In the rename dialog box, select the namespace and enter a new name to replace the name.

$\"\"$

#Delete namespace

Select Delete Namespace option from Manage Namespace to delete the namespace. In the delete dialog box, select the namespace to delete it.

#Import Namespace

If you already have the Cedar JSON Schema, then you can easily import it and save it in the policy store. Click on Import Schema button and select file.

#View Schema

Use this feature to see your schema in JSON and Text format.

$\"\"$

Example of schema JSON view:

$\"\"$

Example of schema Text view:

$\"\"$

#Update and Delete Schema Elements

There are options in UI where you can easily view, update and delete schema elements like Common Types, Entities, and Actions.

$\"\"$

#Policies Section

This section helps you to view, add, update, and delete policies. You can see your list of policies and there are Actions to manage policies.

$\"\"$

#Policy Creation

There are 2 options to create a policy.

$\"\"$

#Text Editor

This option is simple to use. Click on Add Policy > Text Editor option. It will open a dialog box, write your policy, and Save the policy.

$\"\"$

#Form Editor

Writing a good and complete Cedar policy is an expert’s job, but the form editor provides a simple UI to easily write complex Cedar policies.

First step is to select Policy Effect. Whether you want to Permit or Forbid policy as per your requirements.

$\"\"$

2. Second step is to add principal for your policy. There are several options. Choose as per your need.

$\"\"$

3. Click on Next and it will take you to Actions scope.

$\"\"$

4. Next step is to add a resource for your policy.

$\"\"$

5. Next step is to add a condition. This is optional. You can use it to make an ABAC(Attribute-based access control) policy. Check button will help to validate the condition.

$\"\"$

6. Last step is to add a description about your policy. At this step, you can preview and save the policy. Once you save the policy, you can see the policy and store the content on your selected GitHub repository.

$\"\"$

Click on Preview button to see JSON Policy.

$\"\"$

On policy dialog box, click on Text Policy to see human readable format of policy.

$\"\"$

#Trusted Issuer Section

In jans-cedarling there are some more features like token validation. For token validation, you need to register your Trusted Issuer(IDP) to validate token. Jans-Cedarling will also use this config to map tokens with cedar entities that are used during cedar authorization.

You can see your list of Trusted Issuers and there are Actions on this section.

$\"\"$

Click on Add Issuer to add a new issuer. The tokens metadata is important to map tokens with the cedar entities. More Details

$\"\"$

#Testing

This feature will help you to quickly test your policy with your tokens and requested data. You can easily pass custom data that helps to test all your cases and save time. Agama Lab uses Jans Cedarling WASM to test requested in this section.

First step is to set initial settings for cedarling-wasm. Check here for details about settings.

$\"\"$

2. The second step is to set the Access Token, ID Token, and Userinfo token that you want to authorize.

$\"\"$

3. Third step is to set Action

$\"\"$

4. Fourth step is to set the Resource

$\"\"$

5. In the fifth step, you can set context

6.In the last step, you can see the whole request which will be sent to Jans Cedarling. Click on Test button to authorize request.

$\"\"$

\n",5,"/agama/authorization-policy-designer","authorization-policy-designer","content/agama/authorization-policy-designer.md",[],"Authorization Policy Designer",[80,81,82],"2025-03-12T16:20:52Z",1046,{"_51":87,"_53":60,"_55":88},{"_51":85,"_53":54,"_55":86},{"_51":83,"_53":54,"_55":84},"detailed-walkthrough","Detailed Walkthrough","key-features","Key Features","policy-designer","Policy Designer","34420","https://gluu.org/agama/authorization-policy-designer/",[],{"_62":113,"_64":114},"2024-12-19T00:00:14Z","This app enables developers to specify granular repository access control for the Agama Lab code authoring tool. See here why the Agama Lab requires access to the GitHub account. To integrate the…","

#What Is the Agama Lab GitHub App

This app enables developers to specify granular repository access control for the Agama Lab code authoring tool. See here why the Agama Lab requires access to the GitHub account.

#Install the Agama-Lab GitHub App

To integrate the Agama Lab GitHub app with your GitHub account

Sign In to the GitHub using your account credentials
Use the GitHub Apps Page to install the Agama Lab GitHub app in your GitHub account

$\"\"$

#Configure the repository permissions

On your GitHub account, navigate to Settings > Applications.
Under the Installed GitHub Apps, locate the agama-lab app. Click Configure button
In the configure -> Repository access, select the repositories you want to allow access to.

$\"\"$

\n","/agama/how-to-integrate-agama‐lab-github-app-with-your-github-account","how-to-integrate-agama‐lab-github-app-with-your-github-account","content/agama/how-to-integrate-agama‐lab-github-app-with-your-github-account.md",[],"How To Integrate Agama‐Lab Github App With Your GitHub Account",[104,105,106],"2025-01-13T17:01:45Z",120,{"_51":111,"_53":60,"_55":112},{"_51":109,"_53":54,"_55":110},{"_51":107,"_53":54,"_55":108},"configure-the-repository-permissions","Configure the repository permissions","install-the-agama-lab-github-app","Install the Agama-Lab GitHub App","what-is-the-agama-lab-github-app","What Is the Agama Lab GitHub App","34488","https://gluu.org/agama/how-to-integrate-agama%e2%80%90lab-github-app-with-your-github-account/",[],{"_62":129,"_64":130},"2024-12-05T17:19:54Z","Coming Soon","

#Coming Soon

\n","/agama/test-agama-lab-projects","test-agama-lab-projects","content/agama/test-agama-lab-projects.md",[],"Test Agama Lab Projects",[127],"2024-12-09T23:07:44Z",{"_51":128,"_53":60,"_55":118},"coming-soon","34431","https://gluu.org/agama/test-agama-lab-projects/","indexable",true]

Test Agama Lab Projects

#Coming Soon

Related