workos / workos-php Goto Github PK

View Code? Open in Web Editor NEW

18.0 21.0 6.0 458 KB

Official PHP SDK for interacting with the WorkOS API

Home Page: https://workos.com/docs/sdk/php

License: MIT License

PHP 100.00%

saml audit-logs sso sso-authentication adfs scim okta php-sdk gsuite-saml-apps directory-sync

workos-php's Introduction

WorkOS PHP Library

The WorkOS library for PHP provides convenient access to the WorkOS API from applications written in PHP.

Documentation

See the API Reference for PHP usage examples.

Installation

To install via composer, run the following:

composer require workos/workos-php

Configuration

The package will need to be configured with your API Key and Client ID. By default, the packages looks for a WORKOS_API_KEY and WORKOS_CLIENT_ID environment variable.

SDK Versioning

For our SDKs WorkOS follows a Semantic Versioning (SemVer) process where all releases will have a version X.Y.Z (like 1.0.0) pattern wherein Z would be a bug fix (e.g., 1.0.1), Y would be a minor release (1.1.0) and X would be a major release (2.0.0). We permit any breaking changes to only be released in major versions and strongly recommend reading changelogs before making any major version upgrades.

Beta Releases

WorkOS has features in Beta that can be accessed via Beta releases. We would love for you to try these and share feedback with us before these features reach general availability (GA). To install a Beta version, please follow the installation steps above using the Beta release version.

Note: there can be breaking changes between Beta versions. Therefore, we recommend pinning the package version to a specific version. This way you can install the same version each time without breaking changes unless you are intentionally looking for the latest Beta version.

We highly recommend keeping an eye on when the Beta feature you are interested in goes from Beta to stable so that you can move to using the stable version.

More Information

workos-php's People

Contributors

Stargazers

Watchers

Forkers

laravel-shift whitewhidow workos-hackweek dachande663 lucasmichot abellion

workos-php's Issues

minor classname discrepancy between docs an actual sdk

Class in Docs:
$this->ap = new AdminPortal();

Class in sdk:
Portal()

'organization_id' parameter is ignored in listConnections()

see #97

Severity: 8192 --> Optional parameter $domain declared before required parameter $state is implicitly treated as a required parameter workos-php/lib/SSO.php 26

https://github.com/workos/workos-php/blob/main/lib/SSO.php#L26

After upgrading to PHP v8, I'm getting the following warning:

Severity: 8192 --> Optional parameter $domain declared before required parameter $state is implicitly treated as a required parameter workos-php/lib/SSO.php 26

Since the first parameter, $domain, is optional in getAuthorizationUrl, but some of the parameters after it are not.

Inconsistency with the docs

Referencing the docs example here https://workos.com/docs/reference/user-management/user/create

Code

$userManagement = new WorkOS\UserManagement();

$user = $userManagement->createUser(
      email: $u->email,
      firstName: $u->first_name,
      lastName: $u->last_name
);

TYPE ERROR  WorkOS\UserManagement::createUser(): Argument #2 ($password) not passed in phar:///tmp/tinker.phar/vendor/psy/psysh/src/Exception/TypeErrorException.php on line 20.

I am migrating from Laravel. There is no way I will be able to retrieve raw passwords. The docs mention that it can be omitted.

Failed request does not return an error message

The following call returned a bad request at around 2022-08-15 10:17:47 UTC:

Client::request(
    Client::METHOD_POST,
    "sso/token",
    null,
    array (
        "client_id" => "client_01FSQHN26PD53TF3WJSG8YXEYZ",
        "client_secret" => hidden,
        "code" => hidden,
        "grant_type" => "authorization_code"
    )
)

However it also caused an undefined index error in this library:

PHP Error (8): 'Undefined index: message' from /var/www/api/v1/vendor/workos/workos-php/lib/Exception/BaseRequestException.php:33

This makes it difficult to see what the problem is with the request.

Ideally, the full response payload should be available from the exception.

Commit `composer.lock`

We currently have composer.lock ignored from the repository.

However, the Composer docs state that libraries can commit composer.lock: https://getcomposer.org/doc/02-libraries.md#lock-file

I think we should commit the lockfile to make dependency resolution more deterministic.

Support Laravel 10

Laravel 10 was recently released. This package (and workos-php-laravel) depends on illuminate/support, with the version curerntly capped at 9. Can the composer.json be updated to allow illuminate/support @ 10, so that it can be installed in newer Laravel installs.