ory_oathkeeper_client

Description:

ory oathkeeper client

ory_oathkeeper_client (EXPERIMENTAL) #
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 Dart package is automatically generated by the OpenAPI Generator project:

API version: v0.40.6
Build package: org.openapitools.codegen.languages.DartDioClientCodegen
For more information, please visit https://www.ory.am

Requirements #

Dart 2.15.0+ or Flutter 2.8.0+
Dio 5.0.0+ (https://pub.dev/packages/dio)

Installation & Usage #
pub.dev #
To use the package from pub.dev, please include the following in pubspec.yaml
dependencies:
ory_oathkeeper_client: 0.40.6
copied to clipboard
Github #
If this Dart package is published to Github, please include the following in pubspec.yaml
dependencies:
ory_oathkeeper_client:
git:
url: https://github.com/ory/sdk.git
#ref: main
copied to clipboard
Local development #
To use the package from your local drive, please include the following in pubspec.yaml
dependencies:
ory_oathkeeper_client:
path: /path/to/ory_oathkeeper_client
copied to clipboard
Getting Started #
Please follow the installation procedure and then run the following:
import 'package:ory_oathkeeper_client/ory_oathkeeper_client.dart';


final api = OryOathkeeperClient().getApiApi();

try {
api.decisions();
} catch on DioError (e) {
print("Exception when calling ApiApi->decisions: $e\n");
}

copied to clipboard
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 #

GenericError
HealthNotReadyStatus
HealthStatus
JsonWebKey
JsonWebKeySet
Rule
RuleHandler
RuleMatch
Upstream
Version

Documentation For Authorization #
Endpoints do not require authorization.
Author #
[email protected]