Documentation or a Quick start guide

Issue #59 on hold
Malcolm Rivers created an issue

Hi, I want to use your sdk to build an OAuth 2.0, OpenID Connect application. I am interested in using your,

  • Client registration endpoint.
  • Authorization endpoint.
  • Token endpoint.
  • UserInfo endpoint.

So could you please tell me about any of the Documentation or any Quick start guide that you have?

Thanks

Comments (8)

  1. Vladimir Dzhuvinov

    Hi Malcolm!

    Server or client side app?

    We're planning to put up docs for the SDK once our OpenID Connect server is released (within the next couple of weeks) and the APIs have stabilised, although this is more or less a fact now.

    You can browse the current JavaDocs at

    http://nimbusds.com/files/openid-connect-sdk/javadoc

    The JavaDocs are complete and contain a lot of usage info. The entire code has been rigorously tested and nothing is added to the trunk until it's fully understood to work and comes with a test.

    If you let me know which side of the protocol you want to cover I'll try to put a few quick start examples in the wiki section.

    Cheers,

    Vladimir

  2. Vladimir Dzhuvinov

    I apologise for not being able to get this sooner.

    Today I added a wiki section to the project and put a simple example how to encode and decode OIDC authorisation requests. In the next few days I'll try to cover the token and userinfo endpoints.

    Writing an OIDC server is no simple task. It took us 18 months to code that, but I need to mention that we're doing a fairly extensive implementation of the protocol, that also has to provide for horizontal scaling for very large social net + corporate deployments.

    My advice is to keep the implementation scope on the server side tightly defined and get just the bare minimum done first.

    Good luck,

    Vladimir

  3. Log in to comment