Skip to content

Start of PHP doc updates #1476

New issue

Have a question about this project? Sign up for a free GitHub account to open an issue and contact its maintainers and the community.

Sign up for GitHub

By clicking “Sign up for GitHub”, you agree to our terms of service and privacy statement. We’ll occasionally send you account related emails.

Already on GitHub? Sign in to your account

Open
avanscoy wants to merge 1 commit into
base: main
Choose a base branch
from
Open

Start of PHP doc updates #1476

Show file tree
Hide file tree
Changes from all commits
Commits
Show all changes
1 commit
Select commit
File filter

Filter by extension

Filter by extension
Conversations
Failed to load comments.
Loading
Jump to
Jump to file
Failed to load files.
Loading
Diff view
Diff view
11 changes: 8 additions & 3 deletions main/docs/libraries/auth0-php.mdx
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -10,8 +10,12 @@ The Auth0-PHP repository is open source and [hosted on GitHub](https://github.co

## Requirements

* PHP 7.4+ (8.0+ recommended)
* PHP 8.2+
* [Composer](https://getcomposer.org/doc/00-intro.md)
* PHP `mbstring` extension
* A [PSR-18 HTTP Client](https://packagist.org/providers/psr/http-client-implementation) implementation
* A [PSR-17 HTTP Factory](https://packagist.org/providers/psr/http-factory-implementation) implementation
* A [PSR-7 HTTP Messages](https://packagist.org/providers/psr/http-message-implementation) implementation

## Installation

Expand Down Expand Up @@ -42,7 +46,7 @@ The easiest way to use environment variables in your project is to use a library

export const codeExample = `# The URL of our Auth0 Tenant Domain.
# If we're using a Custom Domain, be sure to set this to that value instead.
AUTH0_DOMAIN='https://{yourDomain}'
AUTH0_DOMAIN='{yourDomain}'

# Our Auth0 application's Client ID.
AUTH0_CLIENT_ID='{yourClientId}'
Expand Down Expand Up @@ -83,7 +87,8 @@ $auth0 = new \Auth0\SDK\Auth0([
'domain' => $_ENV['AUTH0_DOMAIN'],
'clientId' => $_ENV['AUTH0_CLIENT_ID'],
'clientSecret' => $_ENV['AUTH0_CLIENT_SECRET'],
'cookieSecret' => $_ENV['AUTH0_COOKIE_SECRET']
'cookieSecret' => $_ENV['AUTH0_COOKIE_SECRET'],
'redirectUri' => $_ENV['AUTH0_BASE_URL'],
]);
```

Expand Down
11 changes: 6 additions & 5 deletions main/docs/libraries/auth0-php/auth0-php-basic-use.mdx
View file
Open in desktop
Original file line number Diff line number Diff line change
@@ -1,6 +1,7 @@
---
description: Integrate a frictionless login and signup experience for your PHP applications.
title: 'PHP: Logging in, out, and returning user profiles with Auth0-PHP'
description: Integrate a frictionless login and signup experience for your PHP applications.
validatedOn: 2026-06-29
---
The Auth0-PHP SDK bundles three core classes: `Auth0\SDK\Auth0`, `Auth0\SDK\API\Authentication` and `Auth0\SDK\API\Management`, each offering interfaces for different functionality across Auth0's APIs. If you're building a stateful web application that needs to keep track of users' sessions, the base `Auth0` class is what you'll be working with the most. It provides methods for handling common authentication and session handling tasks such as logging in and out, retrieving user credentials, checking of an available session, and callback handling. These tasks are explained below.

Expand All @@ -12,7 +13,7 @@ The documentation below assumes that you followed the steps in the [Auth0-PHP](/

### Logging In

The default login process in the PHP SDK uses an [Authentication Code grant](/docs/get-started/authentication-and-authorization-flow/authorization-code-flow/call-your-api-using-the-authorization-code-flow) combined with Auth0's <Tooltip tip="Universal Login: Your application redirects to Universal Login, hosted on Auth0's Authorization Server, to verify a user's identity." cta="View Glossary" href="/docs/glossary?term=Universal+Login">Universal Login</Tooltip> Page. In short, that process is:
The default login process in the PHP SDK uses an [Authorization Code grant](/docs/get-started/authentication-and-authorization-flow/authorization-code-flow/call-your-api-using-the-authorization-code-flow) combined with Auth0's <Tooltip tip="Universal Login: Your application redirects to Universal Login, hosted on Auth0's Authorization Server, to verify a user's identity." cta="View Glossary" href="/docs/glossary?term=Universal+Login">Universal Login</Tooltip> Page. In short, that process is:

1. A user requesting access is redirected to the Universal Login Page.
2. The user authenticates using one of [many possible connections](/docs/authenticate/identity-providers): social (Google, X, Facebook), database (email and password), passwordless (email, SMS), or enterprise (ActiveDirectory, ADFS, Office 365).
Expand Down Expand Up @@ -41,8 +42,8 @@ if ($auth0->getExchangeParameters()) {
// Check if the user is logged in already
$session = $auth0->getCredentials();

if ($session === null) {
// User is not logged in!
if ($session === null || $session->accessTokenExpired) {
// User is not logged in, or their access token has expired.
// Redirect to the Universal Login Page for authentication.
header("Location: " . $auth0->login());
exit;
Expand Down Expand Up @@ -85,7 +86,7 @@ In addition to logging in, we also want users to be able to log out. When users

```php lines
// Log out of the application.
header("Location: $auth0->logout());
header("Location: " . $auth0->logout());
```

If you're using <Tooltip tip="Single Sign-On (SSO): Service that, after a user logs into one applicaton, automatically logs that user in to other applications." cta="View Glossary" href="/docs/glossary?term=Single+Sign-on">Single Sign-on</Tooltip> (SSO) and also want to end their Auth0 session, see the [SSO Logout section here](/docs/libraries/auth0-php/using-the-authentication-api-with-auth0-php). More information about logging out, in general, can be found [here](/docs/authenticate/login/logout).
Expand Down
Loading