Auth0 PHP SDK

The Auth0\SDK\API\ namespace serves as the entry point for interacting with Auth0 services via the PHP SDK. It is divided into two primary functional areas:

1. Authentication: Used for handling user authentication flows, such as logging in, logging out, and managing sessions.
2. Management: Used for interacting with the Auth0 Management API to perform administrative tasks like managing users, connections, clients, and tenant configurations.

Refer to the specific documentation for Authentication or Management to learn how to instantiate and use these sub-namespaces.

The Auth0\SDK\Store\ namespace provides various implementations for storing data required by the SDK (such as state or nonces). Depending on your application architecture and persistence requirements, you can choose from the following store types:

• CookieStore: Stores data in browser cookies.
• MemoryStore: Stores data in memory (volatile, suitable for single-request lifecycles or testing).
• Psr6Store: Implements the PSR-6 Cache Interface for standardized caching integration.
• Psr14Store: Implements the PSR-14 Event Dispatcher interface (for event-driven storage patterns).
• SessionStore: Stores data within the PHP session.

The Auth0\SDK\Event\ namespace contains event objects that are dispatched during the lifecycle of an Auth0 request. These events allow you to hook into specific points in the request/response cycle.

Currently, the available event types are:

• HttpRequestBuilt: Dispatched when an HTTP request has been constructed and is ready to be sent.
• HttpResponseBuilt: Dispatched when an HTTP response has been received and constructed.

You can use a Psr14Store to manage and listen for these events.

The Auth0 PHP SDK uses a specific hierarchy of exceptions to signal different types of failures. When integrating the SDK, you should catch these exceptions to handle errors gracefully. The available exception types include:

• Auth0Exception: The base exception class for all SDK-related errors.
• AuthenticationException: Errors occurring during the authentication process.
• ConfigurationException: Errors related to incorrect or missing SDK configuration.
• InvalidTokenException: Errors when a provided token is malformed or invalid.
• NetworkException: Errors related to connectivity or communication with Auth0 servers.
• ArgumentException: Errors caused by passing invalid arguments to SDK methods.
• PaginatorException: Errors occurring during paginated API requests.
• StateException: Errors related to the internal state of the SDK or session.

The Auth0\SDK\Token\ namespace provides the core tools for handling JSON Web Tokens (JWTs) within the Auth0 PHP SDK. It is composed of three primary functional areas:

• Parser: Used to decode and extract information from a JWT without necessarily validating its signature.
• Validator: Used to verify the integrity and authenticity of a token by checking its signature and standard claims.
• Verifier: Provides the mechanism to define and execute the validation logic against specific requirements.

In SDK v8.0, you can access the Authentication and Management API sub-classes via factory methods on the Auth0 instance. These methods return pre-configured singletons that share the base configuration, eliminating the need to reconfigure them independently.

use Auth0//SDK//Auth0;

// Configure just once:
$auth0 = new Auth0([
    'domain' => 'your-tenant.auth0.com',
    'clientId' => 'application_client_id',
    'clientSecret' => 'application_client_secret',
    'redirectUri' => 'https://yourapplication.com/auth/callback',
    'tokenAlgorithm' => 'HS256'
]);

// Returns an instance already configured for you.
$authentication = $auth0->authentication();
$management = $auth0->management();

// Or, a fluent example:
$response = $auth0->management()->users()->getAll();

The SDK handles network requests to the Auth0 API using a combination of three PSR standards. To use the SDK, you must provide implementations for these interfaces:

1. PSR-18 (HTTP Client): Used to actually send the network requests and receive responses. The SDK uses your provided PSR-18 Client to issue requests.
2. PSR-17 (HTTP Factories): Used to create the message objects. The SDK uses your provided PSR-17 Factory to generate the requests and responses.
3. PSR-7 (HTTP Messages): The standard for the message objects themselves. The SDK uses PSR-7 to represent the HTTP requests and responses being sent to and from the Auth0 API.

Workflow: The PSR-18 Client uses the PSR-17 Factory to create PSR-7 Messages which are then sent over the wire.