https://github.com/auth0/auth0-php
PHP SDK for Auth0 Authentication and Management APIs.
https://github.com/auth0/auth0-php
auth0 dx-sdk php
Last synced: 5 months ago
JSON representation
PHP SDK for Auth0 Authentication and Management APIs.
- Host: GitHub
- URL: https://github.com/auth0/auth0-php
- Owner: auth0
- License: mit
- Created: 2013-10-18T16:51:11.000Z (almost 12 years ago)
- Default Branch: main
- Last Pushed: 2025-05-07T17:02:53.000Z (5 months ago)
- Last Synced: 2025-05-07T17:47:40.135Z (5 months ago)
- Topics: auth0, dx-sdk, php
- Language: PHP
- Homepage: https://auth0.com/docs/libraries/auth0-php
- Size: 6.26 MB
- Stars: 394
- Watchers: 77
- Forks: 215
- Open Issues: 2
-
Metadata Files:
- Readme: README.md
- Changelog: CHANGELOG.ARCHIVE.md
- Contributing: .github/CONTRIBUTING.md
- License: LICENSE.md
- Code of conduct: .github/CODE_OF_CONDUCT.md
- Codeowners: .github/CODEOWNERS
- Security: .github/SECURITY.md
- Support: .github/SUPPORT.md
Awesome Lists containing this project
README
PHP SDK for [Auth0](https://auth0.com) Authentication and Management APIs.
[](https://packagist.org/packages/auth0/auth0-php)
[](https://github.com/auth0/auth0-PHP/actions/workflows/tests.yml)
[](https://codecov.io/gh/auth0/auth0-PHP)
[](https://doge.mit-license.org/)
:books: [Documentation](#documentation) - :rocket: [Getting Started](#getting-started) - :computer: [API Reference](#api-reference) :speech_balloon: [Feedback](#feedback)
## Documentation
We also have tailored SDKs for [Laravel](https://github.com/auth0/laravel-auth0), [Symfony](https://github.com/auth0/symfony), and [WordPress](https://github.com/auth0/wordpress). If you are using one of these frameworks, use the tailored SDK for the best integration experience.
- Quickstarts
- [Application using Sessions (Stateful)](https://auth0.com/docs/quickstart/webapp/php) — Demonstrates a traditional web application that uses sessions and supports logging in, logging out, and querying user profiles. [The completed source code is also available.](https://github.com/auth0-samples/auth0-php-web-app)
- [API using Access Tokens (Stateless)](https://auth0.com/docs/quickstart/backend/php) — Demonstrates a backend API that authorizes endpoints using access tokens provided by a frontend client and returns JSON. [The completed source code is also available.](https://github.com/auth0-samples/auth0-php-api-samples)
- [PHP Examples](./EXAMPLES.md) — Code samples for common scenarios.
- [Documentation Hub](https://www.auth0.com/docs) — Learn more about integrating Auth0 with your application.
## Getting Started
### Requirements
- PHP 8.1+
- [Composer](https://getcomposer.org/)
- PHP Extensions:
- [mbstring](https://www.php.net/manual/en/book.mbstring.php)
- Dependencies:
- [PSR-18 HTTP Client implementation](./FAQ.md#what-is-psr-18)
- [PSR-17 HTTP Factory implementation](./FAQ.md#what-is-psr-17)
- [PSR-7 HTTP Messages implementation](./FAQ.md#what-is-psr-7)
> Please review our [support policy](#support-policy) for details on our PHP version support.
### Installation
Ensure you have [the necessary dependencies](#requirements) installed, then add the SDK to your application using [Composer](https://getcomposer.org/):
```
composer require auth0/auth0-php --no-dev
```
### Configure Auth0
Create a **Regular Web Application** in the [Auth0 Dashboard](https://manage.auth0.com/#/applications). Verify that the "Token Endpoint Authentication Method" is set to `POST`.
Next, configure the callback and logout URLs for your application under the "Application URIs" section of the "Settings" page:
- **Allowed Callback URLs**: The URL of your application where Auth0 will redirect to during authentication, e.g., `http://localhost:3000/callback`.
- **Allowed Logout URLs**: The URL of your application where Auth0 will redirect to after user logout, e.g., `http://localhost:3000/login`.
Note the **Domain**, **Client ID**, and **Client Secret**. These values will be used later.
### Add login to your application
Create a `SdkConfiguration` instance configured with your Auth0 domain and Auth0 application client ID and secret. Generate a sufficiently long, random string for your `cookieSecret` using `openssl rand -hex 32`. Create a new `Auth0` instance and pass your configuration to it.
```php
use Auth0\SDK\Auth0;
use Auth0\SDK\Configuration\SdkConfiguration;
$configuration = new SdkConfiguration(
domain: 'Your Auth0 domain',
clientId: 'Your Auth0 application client ID',
clientSecret: 'Your Auth0 application client secret',
cookieSecret: 'Your generated string',
);
$auth0 = new Auth0($configuration);
```
Use the `getCredentials()` method to check if a user is authenticated.
```php
// getCredentials() returns null if the user is not authenticated.
$session = $auth0->getCredentials();
if (null === $session || $session->accessTokenExpired) {
// Redirect to Auth0 to authenticate the user.
header('Location: ' . $auth0->login());
exit;
}
```
Complete the authentication flow and obtain the tokens by calling `exchange()`:
```php
if (null !== $auth0->getExchangeParameters()) {
$auth0->exchange();
}
```
Finally, you can use `getCredentials()?->user` to retrieve information about our authenticated user:
```php
print_r($auth0->getCredentials()?->user);
```
**That's it! You have successfully authenticated your first user with Auth0!** From here, you may want to try following along with [one of our quickstarts](#documentation) or browse through [our examples](./EXAMPLES.md) for additional insight and guidance.
If you have questions, the [Auth0 Community](https://community.auth0.com/) is a fantastic resource to ask questions and get help.
## Input from Untrusted Sources
If your application accepts input from untrusted sources (such as query parameters from HTTP requests) please ensure you are following best practices for data validation and sanitization. It is your application's responsibility to ensure any data provided to the SDK is valid and safe. For more information, see the [OWASP Data Validation Cheat Sheet](https://cheatsheetseries.owasp.org/cheatsheets/Input_Validation_Cheat_Sheet.html).
## API Reference
- [API Reference](https://auth0.github.io/auth0-PHP/)
## Support Policy
Our support lifecycle mirrors the [PHP release support schedule](https://www.php.net/supported-versions.php).
| SDK Version | PHP Version | Support Ends |
| ----------- | ----------- | ------------ |
| 8 | 8.3 | Dec 2027 |
| | 8.2 | Dec 2026 |
| | 8.1 | Dec 2025 |
We drop support for PHP versions when they reach end-of-life and cease receiving security fixes from the PHP Foundation. Please ensure your environment remains up to date so you can continue receiving updates for PHP and this SDK.
## Feedback
### Contributing
We appreciate feedback and contribution to this repo! Before you get started, please see the following:
- [Contribution Guide](./CONTRIBUTING.md)
- [Auth0's General Contribution Guidelines](https://github.com/auth0/open-source-template/blob/master/GENERAL-CONTRIBUTING.md)
- [Auth0's Code of Conduct Guidelines](https://github.com/auth0/open-source-template/blob/master/CODE-OF-CONDUCT.md)
### Raise an issue
To provide feedback or report a bug, [please raise an issue on our issue tracker](https://github.com/auth0/auth0-PHP/issues).
### 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.
---
Auth0 is an easy-to-implement, adaptable authentication and authorization platform.
To learn more, check out "Why Auth0?"
This project is licensed under the MIT license. See the LICENSE file for more info.