keystackapp / keystack-php-auth-client
KeyStack PHP Authentication client for REST API integration.
Package info
github.com/KeyStackApp/keystack-php-auth-client
pkg:composer/keystackapp/keystack-php-auth-client
Requires
- php: ^8.1
- ext-curl: *
- ext-json: *
- ext-mbstring: *
- guzzlehttp/psr7: ^1.8 || ^2.0
- php-http/async-client-implementation: ^1.0
- php-http/client-common: ^2.4
- php-http/discovery: ^1.14
- php-http/httplug: ^2.2
- psr/http-client-implementation: ^1.0
- psr/http-factory: ^1.0
- psr/http-factory-implementation: ^1.0
- psr/http-message: ^1.0
Requires (Dev)
- friendsofphp/php-cs-fixer: ^3.5
- guzzlehttp/guzzle: ^7.0
- php-http/guzzle7-adapter: ^1.0
- phpunit/phpunit: ^8.0 || ^9.0
README
Requirements
PHP 7.2 and later.
Composer
To install the bindings via Composer, add the following to composer.json:
{
"repositories": [
{
"type": "vcs",
"url": "https://github.com/KeyStackApp/keystack-php-auth-client"
}
]
}
Then run composer install
Your project is free to choose the http client of your choice Please require packages that will provide http client functionality: https://packagist.org/providers/psr/http-client-implementation https://packagist.org/providers/php-http/async-client-implementation https://packagist.org/providers/psr/http-factory-implementation
As an example:
composer require guzzlehttp/guzzle php-http/guzzle7-adapter http-interop/http-factory-guzzle
Manual Installation
Download the files and include autoload.php:
<?php require_once('/path/to/OpenAPIClient-php/vendor/autoload.php');
Getting Started
Please follow the installation procedure and then run the following:
<?php require_once(__DIR__ . '/vendor/autoload.php'); $apiInstance = new KeyStackApp\Authentication\Api\AuthenticationApi( // If you want use custom http client, pass your client which implements `Psr\Http\Client\ClientInterface`. // This is optional, `Psr18ClientDiscovery` will be used to find http client. For instance `GuzzleHttp\Client` implements that interface new GuzzleHttp\Client() ); $loginInput = new \KeyStackApp\Authentication\Model\LoginInput(); // \KeyStackApp\Authentication\Model\LoginInput | The input parameters for the login endpoint. try { $result = $apiInstance->login($loginInput); print_r($result); } catch (Exception $e) { echo 'Exception when calling AuthenticationApi->login: ', $e->getMessage(), PHP_EOL; }
API Endpoints
All URIs are relative to http://localhost
| Class | Method | HTTP request | Description |
|---|---|---|---|
| AuthenticationApi | login | POST /v1/login | Login to obtain a JWT token |
Models
- ActivateLicense
- ActivateLicenseFingerprint
- ActivationDelete
- ActivationList
- ActivationListMeta
- ActivationRecord
- ActivationResponse
- AddManifestRecord200Response
- DeactivateLicenseInput
- DeactivationResponse
- LicenseCreateInput
- LicenseDelete
- LicenseKey
- LicenseList
- LicenseListMeta
- LicenseRecord
- LicenseRecordHistoryInner
- LicenseUpdateInput
- LoginInput
- LoginOutput
- ManifestAddSchema
- ValidateLicense401Response
- ValidateLicense404Response
- ValidateLicense423Response
- ValidateLicenseRequest
Authorization
Bearer
- Type: Bearer authentication (JWT)
Tests
To run the tests, use:
composer install vendor/bin/phpunit
Author
About this package
This PHP package is automatically generated by the OpenAPI Generator project:
- API version:
1.0.0- Generator version:
7.17.0-SNAPSHOT
- Generator version:
- Build package:
org.openapitools.codegen.languages.PhpClientCodegen