Stormpath PHP SDK
Stormpath is a complete user management API. This library gives your PHP application access to all of Stormpath's features:
- Robust authentication and authorization.
- Schemaless user data and profiles.
- A hosted login subdomain, for easy Single Sign-On across your apps.
- External login with social providers like Facebook and Google, or SAML IdPs.
- Secure API key authentication for your service.
stormpath-sdk-php is available on Packagist as the stormpath/sdk package.
composer require stormpath/sdk from the root of your project in terminal, and you are done.
To learn how to use the Stompath PHP SDK in a simple project, follow our quickstart:
We have moved our full documentation away from the Github readme file. For full documentation, please visit our new documentation
The PHP SDK uses
phpunit for testing. These tests are full integration tests which means it hits actual endpoints of the API.
To setup testing, first, clone the repository. You will not be able to run the tests from your vendor folder as all unnecessary items are removed when you require the SDK with composer. You will also need to set an environment variable to set up your API keys.
setx STORMPATH_SDK_TEST_API_KEY_FILE_LOCATION path_to_apiKey.properties_file
After you have this set, you will be able to run
phpunit from the root of the SDK folder. If your API keys are not from a subscription that has access to
the SAML resources, you will have to make sure you skip those tests. You can do so by running
phpunit --exclude-group=saml from the command line.
Contributions, bug reports, and issues are very welcome! Stormpath regularly maintains this repository, and are quick to review pull requests and accept changes.
You can make your own contributions by forking the develop branch of this repository, making your changes, and issuing pull requests against the
Continuous Integration (Travis CI)
Please note that due to security reasons, travis will not run pull requests submitted. With your pull request, please submit the results of the tests in the comments.
If you feel the contributions require document changes as well, or the contributions you want to make are for documentation, please submit a PR to our documentation repo
Copyright © 2013-2016 Stormpath, Inc. and contributors.
This project is open-source via the Apache 2.0 License.