README.md in els_token-1.2.3 vs README.md in els_token-1.2.4

- old
+ new

@@ -1,17 +1,34 @@ # ELS Token A simple library for interfacing with forgeRock OpenAM REST Interface. -Still pretty much in development but kind of workable. ## Usage -include ElsToken into your class or module +ElsToken can be mixed into a class/module and/or used directly. + +__authenticate, validate and extract__ + + # The ELS end point + opts = {'uri' => 'https://els-sso.corp.aol.com/opensso/identity'} + + # Generate a token + token = ElsToken.authenticate('username','password', opts) + + # Determine if token is valid + is_valid = ElsToken.is_token_valid?(token, opts) + + # Retrieve an Identity Object (includes group membership, etc) + ad_user = ElsToken.get_identity(token, opts) + ## change log +1.2.3 + Fixed Ruby 2.0.0 compatibility + 1.2.2 Removed Rails logger dependency Added a couple of extra attributes to the ELS Identity Object 1.2.0 @@ -24,10 +41,5 @@ 1.0.0 Initial release :) -## TODO -With the correct level of priviledge it's possible to perform granular LDAP searches against the OpenAM REST interface. -By Default one can only pull identity details for a provided token but it might be nice to search against other attributes. - -Erm some tests might be nice :)