ory/oathkeeper-client
ORY Oathkeeper is a reverse proxy that checks the HTTP Authorization for validity against a set of rules. This service uses Hydra to validate access tokens and policies.
This PHP package is automatically generated by the OpenAPI Generator project:
- API version: Latest
- Build package: org.openapitools.codegen.languages.PhpClientCodegen For more information, please visit https://www.ory.am
Requirements
PHP 5.5 and later
Installation & Usage
Composer
To install with Composer, run:
$ composer require ory/oathkeeper-client:*Manual Installation
Download the files and include autoload.php:
require_once('/path/to/ory/oathkeeper-client/vendor/autoload.php');Tests
To run the unit tests:
composer install
./vendor/bin/phpunitGetting Started
Please follow the installation procedure and then run the following:
<?php
require_once(__DIR__ . '/vendor/autoload.php');
$apiInstance = new Ory\Oathkeeper\Client\Api\ApiApi(
// If you want use custom http client, pass your client which implements `GuzzleHttp\ClientInterface`.
// This is optional, `GuzzleHttp\Client` will be used as default.
new GuzzleHttp\Client()
);
try {
$apiInstance->decisions();
} catch (Exception $e) {
echo 'Exception when calling ApiApi->decisions: ', $e->getMessage(), PHP_EOL;
}
?>Documentation for API Endpoints
All URIs are relative to http://localhost
| Class | Method | HTTP request | Description |
|---|---|---|---|
| ApiApi | decisions | GET /decisions | Access Control Decision API |
| ApiApi | getRule | GET /rules/{id} | Retrieve a rule |
| ApiApi | getWellKnownJSONWebKeys | GET /.well-known/jwks.json | Lists cryptographic keys |
| ApiApi | listRules | GET /rules | List all rules |
| HealthApi | isInstanceAlive | GET /health/alive | Check alive status |
| HealthApi | isInstanceReady | GET /health/ready | Check readiness status |
| VersionApi | getVersion | GET /version | Get service version |
Documentation For Models
- HealthNotReadyStatus
- HealthStatus
- InlineResponse500
- JsonWebKey
- JsonWebKeySet
- Rule
- RuleHandler
- RuleMatch
- Upstream
- Version
Documentation For Authorization
All endpoints do not require authorization.