Auth0 PHP

https://github.com/auth0/auth0-php
Admin
A PHP SDK for integrating Auth0's Authentication and Management APIs into your application.
Tokens:311,261
Snippets:2,227
Trust Score:9.7
License:MIT
Update:3 weeks ago
Show doc for...
Tokens:
Raw
### Install dotenv and routing libraries

Source: https://github.com/auth0/auth0-php/blob/main/docs/Getting Started/README.md

Install vlucas/phpdotenv and nikic/fast-route to simplify the demo application. This is part of the manual setup process.

```bash
composer require vlucas/phpdotenv nikic/fast-route
```

--------------------------------

### Configure Auth0 class and use factory methods for Authentication and Management

Source: https://github.com/auth0/auth0-php/blob/main/UPGRADE.md

Shows how to configure the base Auth0 class once and then use the authentication() and management() factory methods to get pre-configured API sub-classes. Includes a fluent example for fetching all users.

```PHP
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();
```

--------------------------------

### Start PHP local development server

Source: https://github.com/auth0/auth0-php/blob/main/docs/Getting Started/README.md

Run this command to start the PHP local development server for the demo application. Then point your browser to http://localhost:3000 to try the demo.

```bash
php -S localhost:3000 -t public/bootstrap.php
```

--------------------------------

### Install Auth0 PHP SDK via Composer

Source: https://github.com/auth0/auth0-php/blob/main/README.md

Install the Auth0 PHP SDK using Composer. Ensure all prerequisites are installed before running this command.

```bash
composer require auth0/auth0-php
```

--------------------------------

### Users Management

Source: https://github.com/auth0/auth0-php/blob/main/docs/Management.md

Example of using the Users class to create, get, and list users.

```APIDOC
## Users Management

### Description
Manage users in Auth0 using the Users class.

### Methods

#### create

##### Description
Create a new user.

##### Parameters
- **connection** (string) - Required - The connection to use for the user.
- **body** (array) - Required - The user data to create.

##### Request Example
```php
$users->create(
  connection: 'Username-Password-Authentication',
  body: [
    'email' => '...',
    'password' => '...',
    'email_verified' => true,
  ]
);
```

#### get

##### Description
Get a single user by ID.

##### Parameters
- **id** (string) - Required - The user ID.

##### Response Example
```php
$result = $users->get('auth0|...');
dump(HttpResponse::decodedBody($result));
// {
//   "user_id": "...",
//   "email": "...",
//   "email_verified": true,
//   ...
// }
```

#### getAll

##### Description
Get all users.

##### Response Example
```php
$results = $users->getAll();
var_dump(HttpResponse::decode($results));
// [
//   {
//     "user_id": "...",
//     "email": "...",
//     "email_verified": true,
//     ...
//   }
// ]
```

#### getResponsePaginator

##### Description
Get a paginator to iterate through all results.

##### Response Example
```php
foreach ($users->getResponsePaginator() as $user) {
  dump($user);
  // {
  //   "user_id": "...",
  //   "email": "...",
  //   "email_verified": true,
  //   ...
  // }
}
```
```

--------------------------------

### $client->prompts->rendering->get($prompt, $screen) -> ?GetAculResponseContent

Source: https://github.com/auth0/auth0-php/blob/main/reference.md

Get render settings for a specific screen.

```APIDOC
## $client->prompts->rendering->get($prompt, $screen) -> ?GetAculResponseContent

### Description
Get render settings for a screen.

### Method
get

### Endpoint
$client->prompts->rendering->get

### Parameters
#### Path Parameters
- **$prompt** (`string`) - Required - Name of the prompt
- **$screen** (`string`) - Required - Name of the screen

### Request Example
```php
$client->prompts->rendering->get(
    PromptGroupNameEnum::Login->value,
    ScreenGroupNameEnum::Login->value,
);
```

### Response
#### Success Response
- **GetAculResponseContent** - The response content.

```

--------------------------------

### List actions with ListActionsRequestParameters

Source: https://github.com/auth0/auth0-php/blob/main/reference.md

Retrieves all actions. The example passes optional filters: triggerId, actionName, deployed, page, perPage, and installed. The perPage parameter defaults to 20.

```php
$client->actions->list(
    new ListActionsRequestParameters([
        'triggerId' => ActionTriggerTypeEnum::PostLogin->value,
        'actionName' => 'actionName',
        'deployed' => true,
        'page' => 1,
        'perPage' => 1,
        'installed' => true,
    ]),
);
```

--------------------------------

### SDK Usage Example

Source: https://github.com/auth0/auth0-php/blob/main/docs/Management.md

Example of using the Management API Connections class in PHP SDK.

```APIDOC
## SDK Usage Example

### Description
Demonstrates how to instantiate the SDK and use the Connections API methods.

### Code
```php
use Auth0\SDK\Auth0;
use Auth0\SDK\Configuration\SdkConfiguration;
use Auth0\SDK\Utility\HttpResponse;

// Set up the SDK configuration object.
$configuration = new SdkConfiguration(
  domain: '...',
  clientId: '...',
  clientSecret: '...',
);

// Instantiate the SDK using the configuration.
$auth0 = new Auth0($configuration);

// The Management API class is accessible from the SDK's management() method.
$management = $auth0->management();

// Connections API methods are available from the Management class' connections() method.
$connections = $management->connections();

// Retrieves the first batch of results.
$results = $connections->getAll();

// You can then iterate (and auto-paginate) through all available results.
foreach ($connections->getResponsePaginator() as $connection) {
  // Do something with the connection.
}

// Or, just work with the initial batch from the response.
var_dump(HttpResponse::decode($results));
```
```

--------------------------------

### $client->supplementalSignals->get()

Source: https://github.com/auth0/auth0-php/blob/main/reference.md

Gets the supplemental signals configuration for a tenant.

```APIDOC
## $client->supplementalSignals->get()

### Description
Get the supplemental signals configuration for a tenant.

### Method
GET

### Endpoint
/supplemental-signals

### Parameters
None

### Request Example
```php
$client->supplementalSignals->get();
```

### Response
#### Success Response (200)
- **result** (?GetSupplementalSignalsResponseContent) - The supplemental signals configuration.

#### Response Example
```json
{
  "result": {}
}
```
```

--------------------------------

### PHP Usage Example

Source: https://github.com/auth0/auth0-php/blob/main/docs/Management.md

A PHP code example demonstrating how to use the Jobs API methods to create and monitor a user export job.

```APIDOC
```php
use Auth0\SDK\Auth0;
use Auth0\SDK\Configuration\SdkConfiguration;
use Auth0\SDK\Utility\HttpResponse;

// Set up the SDK configuration object.
$configuration = new SdkConfiguration(
  domain: '...',
  clientId: '...',
  clientSecret: '...',
)

// Instantiate the SDK using the configuration.
$auth0 = new Auth0($configuration);

// The Management API class is accessible from the SDK's management() method.
$management = $auth0->management();

// Connections API methods are available from the Management class' connections() method.
$connections = $management->connections();

// Jobs API methods are available from the Management class' jobs() method.
$jobs = $management->jobs();

// Create a connection.
$connection = $connections->create([
  'name' => 'Test Connection',
  'strategy' => 'auth0',
]);

if (! HttpResponse::wasSuccessful($job)) {
  throw new \Exception('Connection creation failed.');
}

$connection = HttpResponse::decode($connection);

// Create a new user export job.
$response = $jobs->createExportUsersJob([
  'format' => 'json',
  'fields' => [
    ['name' => 'user_id'],
    ['name' => 'name'],
    ['name' => 'email'],
    ['name' => 'identities[0].connection', "export_as": "provider"],
    ['name' => 'user_metadata.some_field'],
  ],
  'connection_id' => $connection['id'],
]);

if ($response->getStatusCode() === 201) {
  // The job was created successfully. Retrieve it's ID.
  $jobId = HttpResponse::decode($response)['id'];
  $job = null;

  while (true) {
    // Get the job status.
    $job = $jobs->get($jobId);

    if (! HttpResponse::wasSuccessful($job)) {
      $job = null;
      break;
    }

    $job = HttpResponse::decode($job);

    // If the job is complete, break out of the loop.
    if ($job['status'] === 'completed') {
      break;
    }

    // If the job has failed, break out of the loop.
    if ($job['status'] === 'failed') {
      $job = null
      break;
    }

    // Wait 1 second before checking the job status again.
    sleep(1);
  }

  if ($job === null) {
    // The job failed.
    $errors = $jobs->getErrors($jobId);
    var_dump($errors);
  }

  // The job completed successfully. Do something with the job.
  var_dump($job);

  // Delete the connection.
  $connections->delete($connection['id']);
}
```
```

--------------------------------

### Setup ManagementClient with ManagementClientOptions

Source: https://github.com/auth0/auth0-php/blob/main/EXAMPLES.md

Initializes the ManagementClient with domain, client ID, and client secret for automatic token management.

```php
use Auth0\SDK\API\Management\Wrapper\ManagementClient;
use Auth0\SDK\API\Management\Wrapper\ManagementClientOptions;

$client = new ManagementClient(new ManagementClientOptions(
    domain: 'your-tenant.auth0.com',
    clientId: 'YOUR_CLIENT_ID',
    clientSecret: 'YOUR_CLIENT_SECRET',
));
```

--------------------------------

### Install PSR-17 and PSR-18 libraries

Source: https://github.com/auth0/auth0-php/blob/main/docs/Getting Started/README.md

Install nyholm/psr7 and kriswallsmith/buzz as PSR-17 and PSR-18 implementations. Any implementations will work, but these are used in the guide.

```bash
composer require nyholm/psr7 kriswallsmith/buzz
```

--------------------------------

### Get a self-service profile by ID

Source: https://github.com/auth0/auth0-php/blob/main/reference.md

Retrieves a self-service profile by its ID using the get method. The example passes the ID as a string.

```php
$client->selfServiceProfiles->get(
    'id',
);
```

--------------------------------

### Bootstrap.php setup

Source: https://github.com/auth0/auth0-php/blob/main/docs/Getting Started/README.md

Paste this PHP code into public/bootstrap.php. It loads the Composer autoloader, loads environment variables, configures the SDK, sets up routes, and dispatches incoming requests.

```php
<?php

// Import the Composer autoloader
require __DIR__ . '/vendor/autoload.php';

// Load the .env environment file
$dotenv = Dotenv\Dotenv::createImmutable(__DIR__);
$dotenv->load();

// Configure and instantiate the SDK
require __DIR__ . '/../auth0.php';

if (getenv('HTTP_HOST') !== 'localhost') {
     die('Please invoke this application from `localhost`.');
}

// Setup the routes for the application
$dispatcher = FastRoute\simpleDispatcher(function(FastRoute\RouteCollector $r) {
    $r->addRoute('GET', '/', 'index');
    $r->addRoute('GET', '/login', 'login');
    $r->addRoute('GET', '/callback', 'callback');
    $r->addRoute('GET', '/logout', 'logout');
});

// Fetch method and URI of the incoming request
$httpMethod = $_SERVER['REQUEST_METHOD'];
$uri = $_SERVER['REQUEST_URI'];

// Strip query string (?foo=bar) and decode URI
if (false !== $pos = strpos($uri, '?')) {
    $uri = substr($uri, 0, $pos);
}
$uri = rawurldecode($uri);

// Match the incoming request against the routes
$routeInfo = $dispatcher->dispatch($httpMethod, $uri);
switch ($routeInfo[0]) {
    case FastRoute\Dispatcher::NOT_FOUND:
        // ... 404 Not Found
        break;
    case FastRoute\Dispatcher::METHOD_NOT_ALLOWED:
        $allowedMethods = $routeInfo[1];
        // ... 405 Method Not Allowed
        break;
    case FastRoute\Dispatcher::FOUND:
        $handler = $routeInfo[1];
        $vars = $routeInfo[2];

        // Include the route's matching PHP file
        require __DIR__ . '/routes/' . $handler . '.php';
        break;
}
```

--------------------------------

### Users by Email

Source: https://github.com/auth0/auth0-php/blob/main/docs/Management.md

Example of using the UsersByEmail class to get a user by email.

```APIDOC
## Users by Email

### Description
Access the Users by Email endpoint of the v2 Management API.

### Methods

#### get

##### Description
Get a single user by email.

##### Parameters
- **email** (string) - Required - The email address to search for.

##### Response Example
```php
$result = $usersByEmail->get('...');
dump(HttpResponse::decodedBody($result));
// {
//   "user_id": "...",
//   "email": "...",
//   "email_verified": true,
//   ...
// }
```
```

--------------------------------

### $client->prompts->getSettings()

Source: https://github.com/auth0/auth0-php/blob/main/reference.md

Retrieves the Universal Login configuration of the tenant, including Identifier First Authentication and WebAuthn with Device Biometrics for MFA.

```APIDOC
## $client->prompts->getSettings()

### Description
Retrieve details of the Universal Login configuration of your tenant. This includes the Identifier First Authentication and WebAuthn with Device Biometrics for MFA features.

### Method
GET

### Endpoint
$client->prompts->getSettings()

### Parameters
None

### Request Example
```php
$client->prompts->getSettings();
```

### Response
#### Success Response (200)
- **GetSettingsResponseContent** (object) - The settings content.

#### Response Example
```json
{}
```
```

--------------------------------

### Get action by ID

Source: https://github.com/auth0/auth0-php/blob/main/reference.md

Retrieves an action by its ID. The example passes the ID as a string.

```php
$client->actions->get(
    'id',
);
```

--------------------------------

### $client->prompts->rendering->list($request) -> ?ListAculsOffsetPaginatedResponseContent

Source: https://github.com/auth0/auth0-php/blob/main/reference.md

Get render setting configurations for all screens.

```APIDOC
## $client->prompts->rendering->list($request) -> ?ListAculsOffsetPaginatedResponseContent

### Description
Get render setting configurations for all screens.

### Method
list

### Endpoint
$client->prompts->rendering->list

### Parameters
#### Request Body
- **$fields** (`?string`) - Optional - Comma-separated list of fields to include or exclude (based on value provided for include_fields) in the result. Leave empty to retrieve all fields.
- **$includeFields** (`?bool`) - Optional - Whether specified fields are to be included (default: true) or excluded (false).
- **$page** (`?int`) - Optional - Page index of the results to return. First page is 0.
- **$perPage** (`?int`) - Optional - Number of results per page. Maximum value is 100, default value is 50.
- **$includeTotals** (`?bool`) - Optional - Return results inside an object that contains the total configuration count (true) or as a direct array of results (false, default).
- **$prompt** (`?string`) - Optional - Name of the prompt to filter by
- **$screen** (`?string`) - Optional - Name of the screen to filter by
- **$renderingMode** (`?string`) - Optional - Rendering mode to filter by

### Request Example
```php
$client->prompts->rendering->list(
    new ListAculsRequestParameters([
        'fields' => 'fields',
        'includeFields' => true,
        'page' => 1,
        'perPage' => 1,
        'includeTotals' => true,
        'prompt' => 'prompt',
        'screen' => 'screen',
        'renderingMode' => AculRenderingModeEnum::Advanced->value,
    ]),
);
```

### Response
#### Success Response
- **ListAculsOffsetPaginatedResponseContent** - The response content.

```

--------------------------------

### $client->connections->directoryProvisioning->create($id, $request)

Source: https://github.com/auth0/auth0-php/blob/main/reference.md

Create a directory provisioning configuration for a connection.

```APIDOC
## $client->connections->directoryProvisioning->create($id, $request) -> ?CreateDirectoryProvisioningResponseContent

### Description
Create a directory provisioning configuration for a connection.

### Method
create

### Parameters
#### Path Parameters
- **id** (string) - Required - The id of the connection to create its directory provisioning configuration.

#### Request Body
- **request** (CreateDirectoryProvisioningRequestContent) - Optional - The request content for creating the configuration.

### Request Example
```php
$client->connections->directoryProvisioning->create(
    'id',
    new CreateDirectoryProvisioningRequestContent([]),
);
```

### Response
#### Success Response
- **CreateDirectoryProvisioningResponseContent** - The created directory provisioning configuration.
```

--------------------------------

### Get role by ID

Source: https://github.com/auth0/auth0-php/blob/main/reference.md

Retrieves details about a specific role by its ID. The example passes the role ID as a string.

```php
$client->roles->get(
    'id',
);
```

--------------------------------

### Create Auth0 PHP web app sample project

Source: https://github.com/auth0/auth0-php/blob/main/docs/Examples/README.md

Creates a new project from the Auth0 PHP web app sample repository. Use this to quickly scaffold a working Auth0 PHP web application.

```bash
composer create-project auth0-samples/auth0-php-web-app:dev-main
```

--------------------------------

### Get template partials for a prompt

Source: https://github.com/auth0/auth0-php/blob/main/reference.md

Retrieves template partials for a specific prompt. Uses PartialGroupsEnum::Login as an example parameter.

```php
$client->prompts->partials->get(
    PartialGroupsEnum::Login->value,
);
```

--------------------------------

### v8: Management client with SdkConfiguration

Source: https://github.com/auth0/auth0-php/blob/main/v9_MIGRATION_GUIDE.md

In v8, the SdkConfiguration class automatically handled client credentials and fetched management tokens. This example shows the v8 way to create a Management client and call users()->getAll().

```php
use Auth0\SDK\API\Management;
use Auth0\SDK\Configuration\SdkConfiguration;

$config = new SdkConfiguration(
    domain: 'tenant.auth0.com',
    clientId: 'YOUR_CLIENT_ID',
    clientSecret: 'YOUR_CLIENT_SECRET',
);

$management = new Management($config);
$users = $management->users()->getAll();
```

--------------------------------

### Get a hook by ID

Source: https://github.com/auth0/auth0-php/blob/main/reference.md

Retrieves a specific hook by its ID, with optional field selection. The example passes an ID and a fields parameter.

```php
$client->hooks->get(
    'id',
    new GetHookRequestParameters([
        'fields' => 'fields',
    ]),
);
```

--------------------------------

### List directory provisioning configurations

Source: https://github.com/auth0/auth0-php/blob/main/reference.md

Retrieves a list of directory provisioning configurations for a tenant. The `from` parameter is an optional ID to start selection, and `take` is the number of results per page (defaults to 50).

```php
$client->connections->directoryProvisioning->list(
    new ListDirectoryProvisioningsRequestParameters([
        'from' => 'from',
        'take' => 1,
    ]),
);
```

--------------------------------

### Get connection by ID with fields

Source: https://github.com/auth0/auth0-php/blob/main/reference.md

Retrieves details for a specified connection. The example passes the connection ID and a GetConnectionRequestParameters object with 'fields' and 'includeFields' options.

```php
$client->connections->get(
    'id',
    new GetConnectionRequestParameters([
        'fields' => 'fields',
        'includeFields' => true,
    ]),
);
```

--------------------------------

### Organizations Management API usage example

Source: https://github.com/auth0/auth0-php/blob/main/docs/Management.md

This example demonstrates how to use the Auth0 PHP SDK's Management API to interact with organizations. It covers retrieving all organizations with pagination, getting a single organization, creating, updating, and deleting organizations, managing members, invitations, enabled connections, and member roles. The example shows the expected response structure for the getAll() method.

```php
use Auth0\SDK\Auth0;
use Auth0\SDK\Configuration\SdkConfiguration;
use Auth0\SDK\Utility\HttpResponse;

// Set up the SDK configuration object.
$configuration = new SdkConfiguration(
  domain: '...',
  clientId: '...',
  clientSecret: '...',
)

// Instantiate the SDK using the configuration.
$auth0 = new Auth0($configuration);

// The Management API class is accessible from the SDK's management() method.
$management = $auth0->management();

// The Organizations class is accessible from the Management class' organizations() method.
$organizations = $management->organizations();

// Get all organizations.
$results = $organizations->getAll();

// You can then iterate (and auto-paginate) through all available results.
foreach ($logStreams->getResponsePaginator() as $logStream) {
  // Do something with the log stream.
  dump($logStream);

  // {
  //   "id": "",
  //   "name": "...",
  //   "display_name": "...",
  // }
}

// Or, just work with the initial batch from the response.
var_dump(HttpResponse::decode($results));

// [
//   {
//     "id": "",
//     "name": "...",
//     "display_name": "...",
// ]

// Get a single organization.
$results = $organizations->get('org_id');

// Create a new organization.
$results = $organizations->create('name', 'display_name');

// Update an existing organization.
$results = $organizations->update('org_id', 'name', 'display_name');

// Delete an organization.
$results = $organizations->delete('org_id');

// Get all members of an organization.
$results = $organizations->getMembers('org_id');

// Add members to an organization.
$results = $organizations->addMembers('org_id', ['user_id_1', 'user_id_2']);

// Remove members from an organization.
$results = $organizations->removeMembers('org_id', ['user_id_1', 'user_id_2']);

// Get all invitations for an organization.
$results = $organizations->getInvitations('org_id');

// Create a new invitation for an organization.
$results = $organizations->createInvitation('org_id', 'client_id', 'inviter_user_id', 'invitee_email');

// Get a single invitation for an organization.
$results = $organizations->getInvitation('org_id', 'invitation_id');

// Delete an invitation for an organization.
$results = $organizations->deleteInvitation('org_id', 'invitation_id');

// Get all enabled connections for an organization.
$results = $organizations->getEnabledConnections('org_id');

// Add a connection to an organization.
$results = $organizations->addEnabledConnection('org_id', 'connection_id', ['assign_membership_on_login' => true]);

// Get a single enabled connection for an organization.
$results = $organizations->getEnabledConnection('org_id', 'connection_id');

// Update an enabled connection for an organization.
$results = $organizations->updateEnabledConnection('org_id', 'connection_id', ['assign_membership_on_login' => false]);

// Remove a connection from an organization.
$results = $organizations->removeEnabledConnection('org_id', 'connection_id');

// Get all roles for a member of an organization.
$results = $organizations->getMemberRoles('org_id', 'user_id');

// Add roles to a member of an organization.
$results = $organizations->addMemberRoles('org_id', 'user_id', ['role_id_1', 'role_id_2']);

// Remove roles from a member of an organization.
$results = $organizations->removeMemberRoles('org_id', 'user_id', ['role_id_1', 'role_id_2']);
```

--------------------------------

### signup

Source: https://github.com/auth0/auth0-php/blob/main/docs/API/Auth0.md

Establishes a session for the user, generates necessary code challenges, and returns a URL to redirect the user through to begin the authentication flow. Identical to login() but adds the screen_hint=signup parameter.

```APIDOC
## signup

### Description
Establishes a session for the user, generates necessary code challenges, and returns a URL which your application should redirect the user through to begin the authentication flow. This method is identical to `login()`, but adds the `screen_hint=signup` parameter to customize Universal Login prompts.

### Method
signup

### Parameters
- **redirectUrl** (string | null) - Optional - URI to return to after logging out. Defaults to the SDK's configured redirectUri.
- **params** (array | null) - Optional - Additional parameters to include with the request.

### Returns
(string) URL to redirect the user through.
```

--------------------------------

### Get custom text for a prompt and language

Source: https://github.com/auth0/auth0-php/blob/main/reference.md

Retrieves custom text for a specific prompt and language. Uses PromptGroupNameEnum::Login and PromptLanguageEnum::Am as example parameters.

```php
$client->prompts->customText->get(
    PromptGroupNameEnum::Login->value,
    PromptLanguageEnum::Am->value,
);
```

--------------------------------

### Create Auth0 SdkConfiguration and Instance

Source: https://github.com/auth0/auth0-php/blob/main/README.md

Initialize the Auth0 SDK with your Auth0 domain, client ID, client secret, and a cookie secret generated using `openssl rand -hex 32`. Replace the placeholder values with your actual credentials.

```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);
```

--------------------------------

### Get an email template with $client->emailTemplates->get()

Source: https://github.com/auth0/auth0-php/blob/main/reference.md

Retrieves an email template by its pre-defined name. The example uses EmailTemplateNameEnum::VerifyEmail->value. Supported names include verify_email, verify_email_by_code, auth_email_by_code, reset_email, reset_email_by_code, welcome_email, blocked_account, stolen_credentials, enrollment_email, mfa_oob_code, user_invitation, async_approval, and legacy change_password and password_reset.

```php
$client->emailTemplates->get(
    EmailTemplateNameEnum::VerifyEmail->value,
);
```

--------------------------------

### Configure SDK with API strategy

Source: https://github.com/auth0/auth0-php/blob/main/EXAMPLES.md

Sets up the Auth0 SDK with the API strategy for stateless applications. Requires domain and audience to be configured.

```php
use Auth0\SDK\Auth0;
use Auth0\SDK\Configuration\SdkConfiguration;

$configuration = new SdkConfiguration(
    strategy: SdkConfiguration::STRATEGY_API,
);

$auth0 = new Auth0($configuration);
```

--------------------------------

### Create file structure

Source: https://github.com/auth0/auth0-php/blob/main/docs/Getting Started/README.md

Create the required file structure for the demo application. This includes .env, auth0.php, public/bootstrap.php, and route files.

```text
.env
auth0.php
public/bootstrap.php
routes/index.php
routes/login.php
routes/callback.php
routes/logout.php
```

--------------------------------

### Start email passwordless authentication via Auth0->authentication()

Source: https://github.com/auth0/auth0-php/blob/main/EXAMPLES.md

Use Auth0->authentication() to access advanced Authentication API calls. This example starts an email passwordless flow. Never pass unsanitized user input into $params of login(), getLoginLink(), or getLogoutLink(); the SDK ignores attempts to override client_id, response_type, and response_mode.

```PHP
use Auth0\SDK\Auth0;
use Auth0\SDK\Configuration\SdkConfiguration;

$configuration = new SdkConfiguration(
    domain: '...',
    clientId: '...',
    clientSecret: '..',
    cookieSecret: '...',
);

$auth0 = new Auth0($configuration);
$api = $auth0->authentication();

$api->emailPasswordlessStart(
  email: 'someone@somewhere.com',
);
```

--------------------------------

### Configure organizations with Auth0 PHP SDK

Source: https://github.com/auth0/auth0-php/blob/main/EXAMPLES.md

Configure one or more organization IDs. Authentication uses the first configured organization by default. The example shows how to start the login flow if the session is missing or expired.

```PHP
use Auth0\SDK\Auth0;
use Auth0\SDK\Configuration\SdkConfiguration;
use Auth0\SDK\Utility\HttpResponse;

$configuration = new SdkConfiguration(
    organization: ['org_1', 'org_2', 'org_...'],
);

$auth0 = new Auth0($configuration);
$session = $auth0->getCredentials();

if (null === $session || $session->accessTokenExpired) {
    // Begin the authentication flow using `org_1`:
    header('Location: ' . $auth0->login());
    exit;
}
```

--------------------------------

### Get enabled clients for a connection

Source: https://github.com/auth0/auth0-php/blob/main/reference.md

Retrieves all clients that have the specified connection enabled. The first call should omit the `from` parameter; if more results exist, a `next` value is returned for subsequent calls. The example uses `take` and `from` parameters.

```php
$client->connections->clients->get(
    'id',
    new GetConnectionEnabledClientsRequestParameters([
        'take' => 1,
        'from' => 'from',
    ]),
);
```

--------------------------------

### Create and list roles with Auth0 PHP Management roles()

Source: https://github.com/auth0/auth0-php/blob/main/docs/Management.md

Example of using the Roles Management endpoint in the Auth0 PHP SDK. Sets up the SDK configuration, instantiates the Management API, and demonstrates creating a rolehol and retrieving all roles with pagination. The example shows iteration over a response paginator and decoding the initial batch response.

```php
use Auth0\SDK\Auth0;
use Auth0\SDK\Configuration\SdkConfiguration;
use Auth0\SDK\Utility\HttpResponse;

// Set up the SDK configuration object.
$configuration = new SdkConfiguration(
  domain: '...',
  clientId: '...',
  clientSecret: '...',
)

// Instantiate the SDK using the configuration.
$auth0 = new Auth0($configuration);

// The Management API class is accessible from the SDK's management() method.
$management = $auth0->management();

// The Roles endpoint class is accessible from the Management class' roles() method.
$roles = $management->roles();

// Create a new role.
$roles->create(
  name: 'My Example Role',
  body: [
    'description' => 'This is an example role.',
  ]
);

// Get all roles.
$results = $roles->getAll();

// You can then iterate (and auto-paginate) through all available results.
foreach ($logStreams->getResponsePaginator() as $logStream) {
  // Do something with the log stream.
  dump($logStream);

  // {
  //   "id": "",
  //   "name": "",
  //   "description": "",
  // }
}

// Or, just work with the initial batch from the response.
var_dump(HttpResponse::decode($results));

// [
//   {
//     "id": "",
//     "name": "",
//     "description": "",
//   }
// ]
```

--------------------------------

### List self-service profiles with pagination

Source: https://github.com/auth0/auth0-php/blob/main/reference.md

Retrieves self-service profiles using the list method. The example passes page, perPage, and includeTotals parameters. Page index starts at 0, perPage defaults to 50, and includeTotals defaults to false.

```php
$client->selfServiceProfiles->list(
    new ListSelfServiceProfilesRequestParameters([
        'page' => 1,
        'perPage' => 1,
        'includeTotals' => true,
    ]),
);
```

--------------------------------

### Update client initialization (old vs new)

Source: https://github.com/auth0/auth0-php/blob/main/v9_MIGRATION_GUIDE.md

The new Management client is created directly with a token parameter, removing the need for SdkConfiguration and the old constructor.

```php
// Old
$config = new SdkConfiguration([
    'domain' => 'your-tenant.auth0.com',
    'managementToken' => 'YOUR_TOKEN',
]);
$management = new Management($config);

// New
$management = new Management(token: 'YOUR_TOKEN');
```

--------------------------------

### List groups assigned to a role: $client->roles->groups->get()

Source: https://github.com/auth0/auth0-php/blob/main/reference.md

Lists the groups to which the specified role is assigned. The $id parameter is the role's unique identifier. The optional ListRoleGroupsParameters can include 'from' (optional ID to start selection) and 'take' (number of results per page, defaults to 50).

```php
$client->roles->groups->get(
    'id',
    new ListRoleGroupsParameters([
        'from' => 'from',
        'take' => 1,
    ]),
);
```

--------------------------------

### Create a user with CreateUserRequestContent

Source: https://github.com/auth0/auth0-php/blob/main/EXAMPLES.md

Creates a new user with email, password, connection, and name, then prints the new user's ID.

```php
use Auth0\SDK\API\Management\Users\Requests\CreateUserRequestContent;

$user = $client->users->create(new CreateUserRequestContent([
    'email' => 'user@example.com',
    'password' => 'SecurePassword123!',
    'connection' => 'Username-Password-Authentication',
    'name' => 'John Doe',
]));

echo $user->getUserId();
```

--------------------------------

### $client->connections->directoryProvisioning->list($request)

Source: https://github.com/auth0/auth0-php/blob/main/reference.md

Retrieve a list of directory provisioning configurations of a tenant.

```APIDOC
## $client->connections->directoryProvisioning->list($request) -> ?ListDirectoryProvisioningsResponseContent

### Description
Retrieve a list of directory provisioning configurations of a tenant.

### Method
list

### Parameters
#### Query Parameters
- **from** (?string) - Optional - Id from which to start selection.
- **take** (?int) - Optional - Number of results per page. Defaults to 50.

### Request Example
```php
$client->connections->directoryProvisioning->list(
    new ListDirectoryProvisioningsRequestParameters([
        'from' => 'from',
        'take' => 1,
    ]),
);
```

### Response
#### Success Response
- **ListDirectoryProvisioningsResponseContent** - The list of directory provisioning configurations.
```

--------------------------------

### List user permissions with $client->users->permissions->list()

Source: https://github.com/auth0/auth0-php/blob/main/reference.md

Retrieves all permissions associated with a user. Returns only permissions from direct assignments and directly assigned roles; for group-based role assignments, use GET /api/v2/users/{id}/effective-permissions. The example passes a user ID and request parameters including perPage, page, and includeTotals.

```php
$client->users->permissions->list(
    'id',
    new ListUserPermissionsRequestParameters([
        'perPage' => 1,
        'page' => 1,
        'includeTotals' => true,
    ]),
);
```

--------------------------------

### $client->experimentation->experiments->create($request)

Source: https://github.com/auth0/auth0-php/blob/main/reference.md

Create a new experiment for A/B testing.

```APIDOC
## $client->experimentation->experiments->create($request)

### Description
Create a new experiment for A/B testing.

### Method
create

### Endpoint
$client->experimentation->experiments->create($request)

### Parameters
#### Request Body
- **$name** (string) - Required - A human-readable name for the experiment
- **$description** (?string) - Optional - A description of the experiment
- **$featureFlagId** (string) - Required - The ID of the feature flag this experiment is based on
- **$authenticationFlow** (string) - Required - The authentication flow for the experiment
- **$defaultConfig** (?string) - Optional - Applies only to Auth0-managed flags. Controls where non-overridden config keys resolve from: 'tenant' inherits the tenant's live config so the experiment overlays only its changes, 'flag' uses the flag's frozen defaults for a complete config. Optional; defaults to 'tenant' when omitted. Rejected for customer-defined flags.
- **$allocationStrategy** (?string) - Optional - The traffic allocation strategy for this experiment
- **$allocations** (?array) - Optional - Traffic allocations mapping variations to weights or segments
- **$levels** (?array) - Optional - Ramp experiment levels configuration. A strictly-increasing sequence of exposure percentages, each an integer in [0, 100].

### Request Example
```php
$client->experimentation->experiments->create(
    new CreateExperimentRequestContent([
        'name' => 'name',
        'featureFlagId' => 'feature_flag_id',
        'authenticationFlow' => AuthenticationFlowEnum::Authentication->value,
    ]),
);
```

### Response
#### Success Response
Returns a `?CreateExperimentResponseContent` object.
```

--------------------------------

### Get organization by ID with get method

Source: https://github.com/auth0/auth0-php/blob/main/reference.md

Retrieves details about a single organization specified by its ID using the get method.

```php
$client->organizations->get(
    'id',
);
```

--------------------------------

### Create Composer Satis project

Source: https://github.com/auth0/auth0-php/blob/main/docs/Examples/README.md

Creates a new project from the Composer Satis repository. This is a generic Composer command example, not specific to Auth0.

```bash
composer create-project composer/satis:dev-main
```

--------------------------------

### $client->keys->encryption->import($kid, $request)

Source: https://github.com/auth0/auth0-php/blob/main/reference.md

Import wrapped key material and activate encryption key.

```APIDOC
## $client->keys->encryption->import($kid, $request) -> ?ImportEncryptionKeyResponseContent

### Description
Import wrapped key material and activate encryption key.

### Method
import

### Endpoint
$client->keys->encryption->import

### Parameters
#### Path Parameters
- **$kid** (`string`) - Required - Encryption key ID

#### Request Parameters
- **$wrappedKey** (`string`) - Required - Base64 encoded ciphertext of key material wrapped by public wrapping key.

### Request Example
```php
$client->keys->encryption->import(
    'kid',
    new ImportEncryptionKeyRequestContent([
        'wrappedKey' => 'wrapped_key',
    ]),
);
```

### Response
#### Success Response
- **ImportEncryptionKeyResponseContent** - The response content containing the imported encryption key details.

```

--------------------------------

### GET /api/v2/clients/{client_id}/credentials

Source: https://github.com/auth0/auth0-php/blob/main/reference.md

Get the details of a client credential.

```APIDOC
## GET /api/v2/clients/{client_id}/credentials

### Description
Get the details of a client credential. To enable credentials to be used for a client authentication method, set the `client_authentication_methods` property on the client. To enable credentials to be used for JWT-Secured Authorization requests set the `signed_request_object` property on the client.

### Method
GET

### Endpoint
/api/v2/clients/{client_id}/credentials

### Parameters
#### Path Parameters
- **clientId** (string) - Required - ID of the client.

### Request Example
```php
$client->clients->credentials->list(
    'client_id',
);
```

### Response
#### Success Response (200)
Returns an array of client credentials.

#### Response Example
```json
[
  {
    "id": "string",
    "credential_type": "public_key",
    "name": "string",
    "pem": "string",
    "alg": "RS256",
    "parse_expiry_from_cert": false,
    "expires_at": "2022-12-31T23:59:59Z"
  }
]
```
```

--------------------------------

### List SCIM configurations

Source: https://github.com/auth0/auth0-php/blob/main/reference.md

Retrieves a list of SCIM configurations for a tenant. The `from` parameter is an optional ID to start selection, and `take` is the number of results per page (defaults to 50).

```php
$client->connections->scimConfiguration->list(
    new ListScimConfigurationsRequestParameters([
        'from' => 'from',
        'take' => 1,
    ]),
);
```

--------------------------------

### $client->eventStreams->get($id)

Source: https://github.com/auth0/auth0-php/blob/main/reference.md

Gets a specific event stream by its unique identifier.

```APIDOC
## $client->eventStreams->get($id)

### Description
Retrieves a specific event stream by its unique identifier.

### Method
get

### Parameters
#### Path Parameters
- **$id** (`string`) - Required - Unique identifier for the event stream.

### Request Example
```php
$client->eventStreams->get(
    'id',
);
```

### Response
#### Success Response
- Returns `EventStreamWebhookResponseContent|EventStreamEventBridgeResponseContent|EventStreamActionResponseContent|null`
```

--------------------------------

### Create action with CreateActionRequestContent

Source: https://github.com/auth0/auth0-php/blob/main/reference.md

Creates an action. The example sets the name and supportedTriggers. After creation, the action must be deployed and bound to a trigger before execution. The runtime defaults to node22.

```php
$client->actions->create(
    new CreateActionRequestContent([
        'name' => 'name',
        'supportedTriggers' => [
            new ActionTrigger([
                'id' => ActionTriggerTypeEnum::PostLogin->value,
            ]),
        ],
    ]),
);
```

--------------------------------

### Create experiment for A/B testing

Source: https://github.com/auth0/auth0-php/blob/main/reference.md

Creates a new experiment. Requires 'name', 'featureFlagId', and 'authenticationFlow'. Optional parameters include 'description', 'defaultConfig', 'allocationStrategy', 'allocations', and 'levels'. The 'defaultConfig' parameter defaults to 'tenant' and is rejected for customer-defined flags.

```php
$client->experimentation->experiments->create(
    new CreateExperimentRequestContent([
        'name' => 'name',
        'featureFlagId' => 'feature_flag_id',
        'authenticationFlow' => AuthenticationFlowEnum::Authentication->value,
    ]),
);
```

--------------------------------

### $client->keys->signing->list()

Source: https://github.com/auth0/auth0-php/blob/main/reference.md

Retrieve details of all the application signing keys associated with your tenant.

```APIDOC
## $client->keys->signing->list()

### Description
Retrieve details of all the application signing keys associated with your tenant.

### Method
list

### Endpoint
$client->keys->signing->list()

### Parameters
None

### Request Example
```php
$client->keys->signing->list();
```

### Response
#### Success Response
- **?array** - The list of signing keys.

#### Response Example
```php
$result = $client->keys->signing->list();
```
```

--------------------------------

### Roles Usage Example

Source: https://github.com/auth0/auth0-php/blob/main/docs/Management.md

Example PHP code demonstrating how to use the Roles endpoint class from the Auth0 PHP SDK.

```APIDOC
```php
use Auth0\SDK\Auth0;
use Auth0\SDK\Configuration\SdkConfiguration;
use Auth0\SDK\Utility\HttpResponse;

// Set up the SDK configuration object.
$configuration = new SdkConfiguration(
  domain: '...',
  clientId: '...',
  clientSecret: '...',
)

// Instantiate the SDK using the configuration.
$auth0 = new Auth0($configuration);

// The Management API class is accessible from the SDK's management() method.
$management = $auth0->management();

// The Roles endpoint class is accessible from the Management class' roles() method.
$roles = $management->roles();

// Create a new role.
$roles->create(
  name: 'My Example Role',
  body: [
    'description' => 'This is an example role.',
  ]
);

// Get all roles.
$results = $roles->getAll();

// You can then iterate (and auto-paginate) through all available results.
foreach ($logStreams->getResponsePaginator() as $logStream) {
  // Do something with the log stream.
  dump($logStream);

  // {
  //   "id": "",
  //   "name": "",
  //   "description": "",
  // }
}

// Or, just work with the initial batch from the response.
var_dump(HttpResponse::decode($results));

// [
//   {
//     "id": "",
//     "name": "",
//     "description": "",
//   }
// ]
```
```

--------------------------------

### Create and list Auth0 rules via Management API

Source: https://github.com/auth0/auth0-php/blob/main/docs/Management.md

Shows how to instantiate the Auth0 SDK, access the Management API's rules() method, and create and retrieve rules. Uses SdkConfiguration with domain, clientId, and clientSecret. Includes pagination through getResponsePaginator() and decoding the initial response with HttpResponse::decode().

```php
use Auth0\SDK\Auth0;
use Auth0\SDK\Configuration\SdkConfiguration;
use Auth0\SDK\Utility\HttpResponse;

// Set up the SDK configuration object.
$configuration = new SdkConfiguration(
  domain: '...',
  clientId: '...',
  clientSecret: '...',
)

// Instantiate the SDK using the configuration.
$auth0 = new Auth0($configuration);

// The Management API class is accessible from the SDK's management() method.
$management = $auth0->management();

// The Rules endpoint class is accessible from the Management class' rules() method.
$rules = $management->rules();

// Create a new rule.
$rules->create(
  name: 'My Example Rule',
  script: 'function (user, context, callback) { callback(null, user, context); }'
);

// Get all rules.
$results = $rules->getAll();

// You can then iterate (and auto-paginate) through all available results.
foreach ($logStreams->getResponsePaginator() as $logStream) {
  // Do something with the log stream.
  dump($logStream);

  // {
  //   "id": "",
  //   "name": "",
  //   "script": "",
  //   "enabled": true,
  //   "order": 0,
  //   "stage": "login_success",
  // }
}

// Or, just work with the initial batch from the response.
var_dump(HttpResponse::decode($results));

// [
//   {
//     "id": "",
//     "name": "",
//     "script": "",
//     "enabled": true,
//     "order": 0,
//     "stage": "login_success",
//   }
// ]
```

--------------------------------

### Get Bot Detection Configuration with $client->attackProtection->botDetection->get()

Source: https://github.com/auth0/auth0-php/blob/main/reference.md

Retrieves the Bot Detection configuration of your tenant. Returns ?GetBotDetectionSettingsResponseContent.

```php
$client->attackProtection->botDetection->get();
```
Tokens:
Raw