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.

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:

$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

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.

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

Symfony

A Symfony bundle can be found here. It works with Symfony 4 and 5 projects.

License

MIT. Please refer to the license file for details.

Brought to you by the LinkORB Engineering team

Check out our other projects at linkorb.com/engineering.

Btw, we're hiring!