-
Notifications
You must be signed in to change notification settings - Fork 0
Commit
This commit does not belong to any branch on this repository, and may belong to a fork outside of the repository.
- Loading branch information
Showing
1 changed file
with
2 additions
and
91 deletions.
There are no files selected for viewing
This file contains bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
| Original file line number | Diff line number | Diff line change |
|---|---|---|
| @@ -1,92 +1,3 @@ | ||
| # Auth PHP SDK | ||
| ## | ||
|
|
||
| [](https://circleci.com/gh/auth0/auth0-PHP) | ||
| [](https://packagist.org/packages/auth0/auth0-php) | ||
| [](https://codecov.io/gh/auth0/auth0-PHP) | ||
| [](https://packagist.org/packages/auth0/auth0-php) | ||
| [](https://packagist.org/packages/auth0/auth0-php) | ||
|
|
||
| The Auth PHP SDK provides straight-forward and tested methods for accessing Authentication and Management API endpoints. This README describes how to get started and provides simple examples of how to use the SDK. | ||
|
|
||
| ## Table of Contents | ||
|
|
||
| - [Documentation](#documentation) | ||
| - [Installation](#installation) | ||
| - [Getting Started](#getting-started) | ||
| - [Contributing](#contributing) | ||
| - [Support + Feedback](#support--feedback) | ||
| - [Vulnerability Reporting](#vulnerability-reporting) | ||
| - [What is Auth](#what-is-auth0) | ||
| - [License](#license) | ||
|
|
||
| ## Documentation | ||
|
|
||
| * [Documentation](https://auth0.com/docs/libraries/auth0-php) | ||
| * [Basic PHP application quickstart](https://auth0.com/docs/quickstart/webapp/php/) | ||
| * [PHP API quickstart](https://auth0.com/docs/quickstart/backend/php/) | ||
|
|
||
| ## Installation | ||
|
|
||
| We recommend installing the SDK with [Composer](https://getcomposer.org/): | ||
|
|
||
| ```bash | ||
| $ composer require auth0/auth0-php | ||
| ``` | ||
|
|
||
| More details on this process as well as a manual option can be found on the [main documentation page](https://auth0.com/docs/libraries/auth0-php#installation). | ||
|
|
||
|
|
||
| ## Getting Started | ||
|
|
||
| To get started, you'll need a [free Auth account](https://auth0.com/signup) and an [Application](https://auth0.com/docs/applications). Use the settings from the Auth Application in the code snippet below: | ||
|
|
||
| ```php | ||
| // Instantiate the base Auth class. | ||
| $auth0 = new Auth([ | ||
| // The values below are found on the Application settings tab. | ||
| 'domain' => 'your-tenant.auth0.com', | ||
| 'client_id' => 'application_client_id', | ||
| 'client_secret' => 'application_client_secret', | ||
|
|
||
| // This is your application URL that will be used to process the login. | ||
| // Save this URL in the "Allowed Callback URLs" field on the Application settings tab | ||
| 'redirect_uri' => 'https://yourdomain.com/auth/callback', | ||
| ]); | ||
| ``` | ||
|
|
||
| **The values above should not be hard-coded in a production application** but will suffice for testing or local development. Please see our complete guide on the [main documentation page](https://auth0.com/docs/libraries/auth0-php#getting-started) for more information on how to store and use these values. | ||
|
|
||
| ## Contributing | ||
|
|
||
| We appreciate feedback and contribution to this repo! Before you get started, please see the following: | ||
|
|
||
| - [Auth's general contribution guidelines](https://github.com/auth0/open-source-template/blob/master/GENERAL-CONTRIBUTING.md) | ||
| - [Auth's code of conduct guidelines](https://github.com/auth0/open-source-template/blob/master/CODE-OF-CONDUCT.md) | ||
| - [This repo's contribution guide](CONTRIBUTING.md) | ||
|
|
||
| ## Support + Feedback | ||
|
|
||
| - Use [Community](https://community.auth0.com/) for usage, questions, specific cases | ||
| - Use [Issues](https://github.com/auth0/auth0-PHP/issues) here for code-level support and bug reports | ||
| - Customers with a paid Auth subscription can use the [Support Center](https://support.auth0.com/) to submit a ticket to our support specialists. | ||
|
|
||
| ## Vulnerability Reporting | ||
|
|
||
| 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. | ||
|
|
||
| ## What is Auth? | ||
|
|
||
| Auth helps you to easily: | ||
|
|
||
| - implement authentication with multiple identity providers, including social (e.g., Google, Facebook, Microsoft, LinkedIn, GitHub, Twitter, etc), or enterprise (e.g., Windows Azure AD, Google Apps, Active Directory, ADFS, SAML, etc.) | ||
| - log in users with username/password databases, passwordless, or multi-factor authentication | ||
| - link multiple user accounts together | ||
| - generate signed JSON Web Tokens to authorize your API calls and flow the user identity securely | ||
| - access demographics and analytics detailing how, when, and where users are logging in | ||
| - enrich user profiles from other data sources using customizable JavaScript rules | ||
|
|
||
| [Why Auth?](https://auth0.com/why-auth0) | ||
|
|
||
| ## License | ||
|
|
||
| The Auth-PHP SDK is licensed under MIT - [LICENSE](LICENSE.txt) | ||
| This package is inspired by Auth0 |