Agama Project README Style Guide

Agama Project Readme's should look like this:

Agama ______

This Agama Project <solves the following list of challenges> for the <list of use cases>. For more information you can also see

• Vendor Home Page
• Relevant Open Standards
• Other helpful links

Requirements

• Agama Dependency: Name of Agama Project (link to Github home for project)
• Third Party Accounts: Any other info needed for this project to work

Deployment

See the links below for specific installation instructions on the following platforms.

• Janssen Project (link to page with any Platform specific deployment instructions)
• Gluu Flex
• Keycloak

Configuration

Flow	Property	Value
org.gluu.agama.<name>.<flow2>	ACCOUNT_ID	client id
org.gluu.agama.<name>.<flow2>	AUTH_TOKEN	yucky static token

Sample JSON:

    {
        "org.gluu.agama.<name>.<flow1>": {},
        "org.gluu.agama.<name>.<flow2>": {
          "ACCOUNT_ID": "PUT_YOUR__ACCOUNT_ID_HERE",
          "AUTH_TOKEN": "PUT_YOUR_AUTH_TOKEN_HERE"
        }
    }

Demo

Optional

Check out this video of the org.gluu.agama.<name> flow.