https://github.com/linkorb/userbase-client-php
UserBase Client for PHP
https://github.com/linkorb/userbase-client-php
php-7 php-library
Last synced: about 1 year ago
JSON representation
UserBase Client for PHP
- Host: GitHub
- URL: https://github.com/linkorb/userbase-client-php
- Owner: linkorb
- License: mit
- Created: 2015-05-26T16:31:47.000Z (almost 11 years ago)
- Default Branch: main
- Last Pushed: 2025-04-07T09:15:58.000Z (about 1 year ago)
- Last Synced: 2025-04-09T20:04:08.424Z (about 1 year ago)
- Topics: php-7, php-library
- Language: PHP
- Size: 116 KB
- Stars: 5
- Watchers: 3
- Forks: 6
- Open Issues: 2
-
Metadata Files:
- Readme: README.md
- License: LICENSE
Awesome Lists containing this project
README
> [!WARNING]
> This is a read-only repository used to release the subtree. Any issues and pull requests should be forwarded to the
> upstream [Nebula repository](https://github.com/linkorb/nebula).
Userbase client for PHP
=======================
## About Userbase
Userbase is a micro-service with a REST/JSON API that manages users, organizations and api keys.
A Userbase Client can make calls to a Userbase Server authenticate users, get account details, etc.
## Usage
### Instantiate the client
Instantiate a new client object:
```php
$url = 'https://joe:secret@userbase.example.com';
$client = new Client($url);
```
The provided credentials need to have "Admin" privileges on the Userbase Server.
### Check credentials
```php
if (!$client->checkCredentials('alice', 'shhhh')) {
exit('Invalid credentials');
}
echo 'Welcome back!';
```
## Testing/Development
The `examples/` directory contains a few example scripts that you can use during testing and development.
First, copy the `.env.dist` file to `.env`. Edit the contents to match your Userbase server and credentials.
```bash
cp .env.dist .env e
edit .env # Edit configuration, database settings etc
./vendor/bin/envoi validate # Run command validate based on meta file .env.yaml
```
Then you can simply execute the examples like this:
php examples/checkcredentials.php alice sshhh
Please refer to the `examples/` directory for other examples.
## Integrations
### Silex
A Silex Provider is available [here](https://github.com/linkorb/silex-provider-userbase-client)
### Symfony
A Symfony bundle can be found [here](https://github.com/linkorb/userbase-client-bundle).
It works with Symfony 4 and 5 projects.
## License
MIT. Please refer to the [license file](LICENSE) for details.
## Brought to you by the LinkORB Engineering team
Check out our other projects at [linkorb.com/engineering](http://www.linkorb.com/engineering).
Btw, we're hiring!