Ecosyste.ms: Awesome
An open API service indexing awesome lists of open source software.
https://github.com/descope/descope-php
PHP library used to integrate with Descope
https://github.com/descope/descope-php
authentication descope php sdk sdk-php
Last synced: 3 months ago
JSON representation
PHP library used to integrate with Descope
- Host: GitHub
- URL: https://github.com/descope/descope-php
- Owner: descope
- License: mit
- Created: 2023-05-23T03:52:32.000Z (over 1 year ago)
- Default Branch: main
- Last Pushed: 2024-05-14T00:35:35.000Z (9 months ago)
- Last Synced: 2024-05-17T15:26:33.495Z (9 months ago)
- Topics: authentication, descope, php, sdk, sdk-php
- Language: PHP
- Homepage: https://docs.descope.com
- Size: 83 KB
- Stars: 18
- Watchers: 6
- Forks: 0
- Open Issues: 3
-
Metadata Files:
- Readme: README.md
- License: LICENSE
Awesome Lists containing this project
README
# 
by Descope
[](https://opensource.org/licenses/MIT)
## Overview
The Descope SDK for PHP provides convenient access to Descope authentication. You can read more on the [Descope Website](https://descope.com).
## Getting started
### Requirements
- [PHP 7.4+](https://www.php.net/)
### Installation
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](https://app.descope.com/settings/project) like this:
```
DESCOPE_PROJECT_ID=
DESCOPE_MANAGEMENT_KEY=
```
## Using the SDK
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:
```php
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:
## Password Authentication
### Sign Up
```php
$response = $descopeSDK->auth->password->signUp("loginId", "password123");
print_r($response);
```
### Sign In
```php
$response = $descopeSDK->auth->password->signIn("loginId", "password123");
print_r($response);
```
### Send Reset Password
```php
$response = $descopeSDK->auth->password->sendReset("loginId", "https://example.com/reset");
print_r($response);
```
### Update Password
```php
$descopeSDK->auth->password->update("loginId", "newPassword123", "refreshToken");
```
### Replace Password
```php
$response = $descopeSDK->auth->password->replace("loginId", "oldPassword123", "newPassword123");
print_r($response);
```
### Get Password Policy
```php
$response = $descopeSDK->auth->password->getPolicy();
print_r($response);
```
## SSO Authentication
### SSO Sign In
```php
$response = $descopeSDK->auth->sso->signIn(
"tenant",
"https://example.com/callback",
"prompt",
true,
true,
["custom" => "claim"],
"ssoAppId"
);
print_r($response);
```
### Exchange Token
```php
$response = $descopeSDK->auth->sso->exchangeToken("code");
print_r($response);
```
## Session Management
1. `DescopeSDK->verify($sessionToken)` - will validate the JWT signature and return either **TRUE** or **FALSE**, depending on if the JWT is valid and expired
2. `DescopeSDK->getClaims($sessionToken)` - will return all of the claims from the JWT in an array format
3. `DescopeSDK->getUserDetails($refreshToken)` - will return all of the user information (email, phone, verification status, etc.) using a provided refresh token
> **Note**: To use `verify()` and `getClaims()`, you will need to pass in your session token into the function argument. To use `getUserDetails()`, you will need to pass in your refresh token.
## User Management Functions
### Create User
```php
$response = $descopeSDK->management->user->create(
"testuser1",
"[email protected]",
"1234567890",
"Test User",
"Test",
"Middle",
"User"
);
print_r($response);
```
### Update User
```php
$descopeSDK->management->user->update(
"testuser1",
"[email protected]",
"0987654321",
"Updated User",
"Updated",
"Middle",
"User"
);
```
### Delete User
```php
$descopeSDK->management->user->delete("testuser1");
```
### Add Tenant
```php
$response = $descopeSDK->management->user->addTenant("testuser1", "tenantId1");
print_r($response);
```
### Remove Tenant
```php
$response = $descopeSDK->management->user->removeTenant("testuser1", "tenantId1");
print_r($response);
```
### Set Tenant Roles
```php
$response = $descopeSDK->management->user->setTenantRoles("testuser1", "tenantId1", ["admin"]);
print_r($response);
```
### Add Tenant Roles
```php
$response = $descopeSDK->management->user->addTenantRoles("testuser1", "tenantId1", ["user"]);
print_r($response);
```
### Remove Tenant Roles
```php
$response = $descopeSDK->management->user->removeTenantRoles("testuser1", "tenantId1", ["admin"]);
print_r($response);
```
### Set Temporary Password
```php
$descopeSDK->management->user->setTemporaryPassword("testuser1", new UserPassword(cleartext: "temporaryPassword123"));
```
### Set Active Password
```php
$descopeSDK->management->user->setActivePassword("testuser1", new UserPassword(cleartext: "activePassword123"));
```
### Set Password
```php
$descopeSDK->management->user->setPassword("testuser1", new UserPassword(cleartext: "password123"), true);
```
## Unit Testing
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
```
## Running the PHP Sample App
In the `sample/static/descope.js`, replace the **projectId** with your Descope Project ID, which you can find in the [Descope Console](https://app.descope.com/settings/project).
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://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`.
## Other Code Samples
1. [WordPress Plugin](https://github.com/descope-sample-apps/wordpress-plugin)
## Feedback
### Contributing
We appreciate feedback and contribution to this repository!
### Raise an issue
To provide feedback or report a bug, please [raise an issue on our issue tracker](https://github.com/descope/php-sdk/issues).
This project is licensed under the MIT license. See the LICENSE file for more info.