|
| 1 | +# Guardian Java |
| 2 | + |
| 3 | +[![Build][travis-ci-badge]][travis-ci-url] |
| 4 | +[![MIT][mit-badge]][mit-url] |
| 5 | +[![Maven][maven-badge]][maven-url] |
| 6 | +[![JCenter][jcenter-badge]][jcenter-url] |
| 7 | +[![codecov][codecov-badge]][codecov-url] |
| 8 | + |
| 9 | +Java library for Auth0's [Guardian](https://auth0.com/multifactor-authentication) platform. |
| 10 | + |
| 11 | +## Download |
| 12 | + |
| 13 | +Get Guardian Java via Maven: |
| 14 | + |
| 15 | +```xml |
| 16 | +<dependency> |
| 17 | + <groupId>com.auth0</groupId> |
| 18 | + <artifactId>guardian</artifactId> |
| 19 | + <version>0.0.1</version> |
| 20 | +</dependency> |
| 21 | +``` |
| 22 | + |
| 23 | +or Gradle: |
| 24 | + |
| 25 | +```gradle |
| 26 | +compile 'com.auth0:guardian:0.0.1' |
| 27 | +``` |
| 28 | + |
| 29 | +## Documentation |
| 30 | + |
| 31 | +For more information about [auth0](http://auth0.com) check our [documentation page](http://docs.auth0.com/). |
| 32 | + |
| 33 | +## What is Auth0? |
| 34 | + |
| 35 | +Auth0 helps you to: |
| 36 | + |
| 37 | +* Add authentication with [multiple authentication sources](https://docs.auth0.com/identityproviders), either social like **Google, Facebook, Microsoft Account, LinkedIn, GitHub, Twitter, Box, Salesforce, amont others**, or enterprise identity systems like **Windows Azure AD, Google Apps, Active Directory, ADFS or any SAML Identity Provider**. |
| 38 | +* Add authentication through more traditional **[username/password databases](https://docs.auth0.com/mysql-connection-tutorial)**. |
| 39 | +* Add support for **[linking different user accounts](https://docs.auth0.com/link-accounts)** with the same user. |
| 40 | +* Support for generating signed [Json Web Tokens](https://docs.auth0.com/jwt) to call your APIs and **flow the user identity** securely. |
| 41 | +* Analytics of how, when and where users are logging in. |
| 42 | +* Pull data from other sources and add it to the user profile, through [JavaScript rules](https://docs.auth0.com/rules). |
| 43 | + |
| 44 | +## Create a free Auth0 Account |
| 45 | + |
| 46 | +1. Go to [Auth0](https://auth0.com) and click Sign Up. |
| 47 | +2. Use Google, GitHub or Microsoft Account to login. |
| 48 | + |
| 49 | +## Issue Reporting |
| 50 | + |
| 51 | +If you have found a bug or if you have a feature request, please report them at this repository issues section. Please do not report security vulnerabilities on the public GitHub issue tracker. The [Responsible Disclosure Program](https://auth0.com/whitehat) details the procedure for disclosing security issues. |
| 52 | + |
| 53 | +## Author |
| 54 | + |
| 55 | +[Auth0](https://auth0.com) |
| 56 | + |
| 57 | +## License |
| 58 | + |
| 59 | +This project is licensed under the MIT license. See the [LICENSE](LICENSE) file for more info. |
| 60 | + |
| 61 | + |
| 62 | +<!-- Vars --> |
| 63 | + |
| 64 | +[travis-ci-badge]: https://travis-ci.org/auth0/Guardian.java.svg?branch=master |
| 65 | +[travis-ci-url]: https://travis-ci.org/auth0/Guardian.java |
| 66 | +[mit-badge]: http://img.shields.io/:license-mit-blue.svg?style=flat |
| 67 | +[mit-url]: https://raw.githubusercontent.com/auth0/Guardian.java/master/LICENSE |
| 68 | +[maven-badge]: https://img.shields.io/maven-central/v/com.auth0/guardian.svg |
| 69 | +[maven-url]: http://search.maven.org/#search%7Cga%7C1%7Cg%3A%22com.auth0%22%20AND%20a%3A%22guardian%22 |
| 70 | +[jcenter-badge]: https://api.bintray.com/packages/auth0/java/guardian/images/download.svg |
| 71 | +[jcenter-url]: https://bintray.com/auth0/java/guardian/_latestVersion |
| 72 | +[codecov-badge]: https://codecov.io/gh/auth0/Guardian.java/branch/master/graph/badge.svg |
| 73 | +[codecov-url]: https://codecov.io/gh/auth0/Guardian.java |
0 commit comments