Giter Club home page Giter Club logo

agama-hello's Introduction

Contributors Forks Stargazers Issues Apache License

Agama-Hellō

This Agama project uses agama-openid for OpenID authentication to leverage the powerful hello.coop platform for consumer authentication, which supports a variety of authenticators and social login options. Also, This is an example to show the reusability of agama flows from one project to another.

Requirements

Supported IDPs

IDP How to Install?
Jans Auth Server https://docs.jans.io/stable/admin/install/
Gluu Flex https://docs.gluu.org/stable/install/

Flows

Qualified Name Description
org.gluu.hello.coop Main agama flow of this project. It first collects the configuration details and triggers to org.gluu.inbound.oauth2.AuthzCodeWithUserInfo flow of agama-openid project. After successful authentication, redirect to this main flow for the user onboard. Kindly, check the diagram for better understanding

Configurations

Sample JSON:

{
  "org.gluu.hello.coop": {
    "hello": {
      "oauth": {
        "authzEndpoint": "https://wallet.hello.coop/authorize",
        "tokenEndpoint": "https://wallet.hello.coop/oauth/token",
        "userInfoEndpoint": "https://wallet.hello.coop/oauth/userinfo",
        "clientId": "CLIENT_INDENTIFIER",
        "clientSecret": "CLIENT_SECRET",
        "scopes": [
          "openid"
        ]
      },
      "uidPrefix": "hello-"
    }
  }
}
Flow Property Description
org.gluu.hello.coop oauth These are OAuth parameters for OpenID authentication. To know more details on these (oauthParams), Kindly check agama-openid section
org.gluu.hello.coop uidPrefix Prefix string value for user unique ID. By default, Each user those are onboarded through this flow will use the prefix hello- with username

Sequence Diagram

A basic diagram to understand how the agama-hello works.

hello-agama-diagram (Source Image)

Demo

You'll need an OpenID Connect test RP. You can try oidcdebugger, jans-tarp or jans-tent. Check out this video to see an example of agama-hello in action:

ezgif-1-1574bd2d5c

Contributors

Mobarak
Mobarak Hosen Shakil

License

This project is licensed under the Apache 2.0

Acknowledgments

This project is based on agama-openid.

agama-hello's People

Contributors

imshakil avatar nynymike avatar moabu avatar github-actions[bot] avatar jgomer2001 avatar

Recommend Projects

  • React photo React

    A declarative, efficient, and flexible JavaScript library for building user interfaces.

  • Vue.js photo Vue.js

    🖖 Vue.js is a progressive, incrementally-adoptable JavaScript framework for building UI on the web.

  • Typescript photo Typescript

    TypeScript is a superset of JavaScript that compiles to clean JavaScript output.

  • TensorFlow photo TensorFlow

    An Open Source Machine Learning Framework for Everyone

  • Django photo Django

    The Web framework for perfectionists with deadlines.

  • D3 photo D3

    Bring data to life with SVG, Canvas and HTML. 📊📈🎉

Recommend Topics

  • javascript

    JavaScript (JS) is a lightweight interpreted programming language with first-class functions.

  • web

    Some thing interesting about web. New door for the world.

  • server

    A server is a program made to process requests and deliver data to clients.

  • Machine learning

    Machine learning is a way of modeling and interpreting data that allows a piece of software to respond intelligently.

  • Game

    Some thing interesting about game, make everyone happy.

Recommend Org

  • Facebook photo Facebook

    We are working to build community through open source technology. NB: members must have two-factor auth.

  • Microsoft photo Microsoft

    Open source projects and samples from Microsoft.

  • Google photo Google

    Google ❤️ Open Source for everyone.

  • D3 photo D3

    Data-Driven Documents codes.