The Descope SDK for PHP provides convenient access to Descope authentication. You can read more on the Descope Website.
Install the package with Composer:
composer require descope/descope-php
You'll need to set up a .env file in the root directory with your Descope Project ID, which you can get from the Console like this:
DESCOPE_PROJECT_ID=<Descope Project ID>
DESCOPE_MANAGEMENT_KEY=<Descope Management Key>
In order to use the SDK you will need to initialize a DescopeSDK object with your Descope Project ID you defined in your .env file, like this:
require 'vendor/autoload.php';
use Descope\SDK\DescopeSDK;
$descopeSDK = new DescopeSDK([
'projectId' => $_ENV['DESCOPE_PROJECT_ID'],
'managementKey' => $_ENV['DESCOPE_MANAGEMENT_KEY'] // Optional, only used for Management functions
]);This SDK will easily allow you to handle Descope JWT tokens with the following built-in functions:
$response = $descopeSDK->auth->password->signUp("loginId", "password123");
print_r($response);$response = $descopeSDK->auth->password->signIn("loginId", "password123");
print_r($response);$response = $descopeSDK->auth->password->sendReset("loginId", "https://example.com/reset");
print_r($response);$descopeSDK->auth->password->update("loginId", "newPassword123", "refreshToken");$response = $descopeSDK->auth->password->replace("loginId", "oldPassword123", "newPassword123");
print_r($response);$response = $descopeSDK->auth->password->getPolicy();
print_r($response);$response = $descopeSDK->auth->sso->signIn(
"tenant",
"https://example.com/callback",
"prompt",
true,
true,
["custom" => "claim"],
"ssoAppId"
);
print_r($response);$response = $descopeSDK->auth->sso->exchangeToken("code");
print_r($response);DescopeSDK->verify($sessionToken)- will validate the JWT signature and return either TRUE or FALSE, depending on if the JWT is valid and expiredDescopeSDK->getClaims($sessionToken)- will return all of the claims from the JWT in an array formatDescopeSDK->getUserDetails($refreshToken)- will return all of the user information (email, phone, verification status, etc.) using a provided refresh token
Note: To use
verify()andgetClaims(), you will need to pass in your session token into the function argument. To usegetUserDetails(), you will need to pass in your refresh token.
$response = $descopeSDK->management->user->create(
"testuser1",
"[email protected]",
"1234567890",
"Test User",
"Test",
"Middle",
"User"
);
print_r($response);$descopeSDK->management->user->update(
"testuser1",
"[email protected]",
"0987654321",
"Updated User",
"Updated",
"Middle",
"User"
);$descopeSDK->management->user->delete("testuser1");$response = $descopeSDK->management->user->addTenant("testuser1", "tenantId1");
print_r($response);$response = $descopeSDK->management->user->removeTenant("testuser1", "tenantId1");
print_r($response);$response = $descopeSDK->management->user->setTenantRoles("testuser1", "tenantId1", ["admin"]);
print_r($response);$response = $descopeSDK->management->user->addTenantRoles("testuser1", "tenantId1", ["user"]);
print_r($response);$response = $descopeSDK->management->user->removeTenantRoles("testuser1", "tenantId1", ["admin"]);
print_r($response);$descopeSDK->management->user->setTemporaryPassword("testuser1", new UserPassword(cleartext: "temporaryPassword123"));$descopeSDK->management->user->setActivePassword("testuser1", new UserPassword(cleartext: "activePassword123"));$descopeSDK->management->user->setPassword("testuser1", new UserPassword(cleartext: "password123"), true);The PHP directory includes unit testing using PHPUnit. You can insert values for session token and refresh tokens in the src/tests/DescopeSDKTest.php file, and run to validate whether or not the functions are operating properly.
To run the tests, run this command:
./vendor/bin/phpunit --bootstrap bootstrap.php --verbose src/tests/DescopeSDKTest.php
In the sample/static/descope.js, replace the projectId with your Descope Project ID, which you can find in the Descope Console.
If you haven't already, make sure you run the composer command listed above, to install the necessary SDK packages.
Then, run this command from the root directory, to start the sample app:
php -S localhost:3000 -t sample/
The app should now be accessible at http:https://localhost:3000/ from your web browser.
This sample app showcases a Descope Flow using the WebJS SDK and PHP sessions to retain user information across multiple pages. It also showcases initializing the SDK and using it to validate the session token from formData sent from login.php.
We appreciate feedback and contribution to this repository!
To provide feedback or report a bug, please raise an issue on our issue tracker.
This project is licensed under the MIT license. See the LICENSE file for more info.