https://github.com/silinternational/idp-id-broker-php-client

PHP client to interact with our IdP ID Broker's API: https://github.com/silinternational/idp-id-broker
https://github.com/silinternational/idp-id-broker-php-client

Last synced: about 1 month ago
JSON representation

PHP client to interact with our IdP ID Broker's API: https://github.com/silinternational/idp-id-broker

• Host: GitHub
• URL: https://github.com/silinternational/idp-id-broker-php-client
• Owner: silinternational
• License: mit
• Created: 2017-02-24T16:20:59.000Z (almost 8 years ago)
• Default Branch: main
• Last Pushed: 2024-10-30T15:39:16.000Z (about 2 months ago)
• Last Synced: 2024-10-30T16:21:25.570Z (about 2 months ago)
• Language: PHP
• Homepage:
• Size: 217 KB
• Stars: 0
• Watchers: 6
• Forks: 2
• Open Issues: 0
• Metadata Files:
  • Readme: README.md
  • Changelog: CHANGELOG.md
  • License: LICENSE

Awesome Lists containing this project

README

        
# idp-id-broker-php-client

PHP client to interact with our [IdP ID Broker](https://github.com/silinternational/idp-id-broker)'s API.

This client is built on top of 

[Guzzle](http://docs.guzzlephp.org/en/stable/), the PHP HTTP Client. 

Guzzle has a simple way to create API clients by describing the API in a 

Swagger-like format without the need to implement every method yourself. So 

adding support for more APIs is relatively simple.

## Install ##

Installation is simple with [Composer](https://getcomposer.org/):

    $ composer require silinternational/idp-id-broker-php-client

## Usage ##

Example:

```php

 [

            'timeout' => 10, // An (optional) custom HTTP timeout, in seconds.

        ],

    ]

);

$users = $idBrokerClient->listUsers();

```

## User Information ##

Information about a user returned by this client (such as by `getUser(...)`) can

include the following fields:

- `employee_id` (string)

- `first_name` (string)

- `last_name` (string)

- `display_name` (string)

- `username` (string)

- `email` (string)

- `active` (string: 'yes' or 'no')

- `locked` (string: 'yes' or 'no')

## Tests ##

To run the unit tests for this, run `make test`.

## Guzzle Service Client Notes ##

- Tutorial on developing an API client with Guzzle Web Services:  

  

- Presentation by Jeremy Lindblom:  

  

- Example by Jeremy Lindblom:  

  

- Parameter docs in source comments:  

  

- Guzzle 3 Service Descriptions documentation (at least mostly still relevant):