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.39.0
  • Build package: org.openapitools.codegen.languages.DartDioClientCodegen For more information, please visit https://www.ory.am

Requirements

  • Dart 2.12.0 or later OR Flutter 1.26.0 or later
  • Dio 4.0.0+

Installation & Usage

pub.dev

To use the package from pub.dev, please include the following in pubspec.yaml

dependencies:
  ory_oathkeeper_client: 0.39.0

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

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

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");
}

Documentation for API Endpoints

All URIs are relative to http://localhost

ClassMethodHTTP requestDescription
ApiApidecisionsGET /decisionsAccess Control Decision API
ApiApigetRuleGET /rules/{id}Retrieve a rule
ApiApigetVersionGET /versionGet service version
ApiApigetWellKnownJSONWebKeysGET /.well-known/jwks.jsonLists cryptographic keys
ApiApiisInstanceAliveGET /health/aliveCheck alive status
ApiApiisInstanceReadyGET /health/readyCheck readiness status
ApiApilistRulesGET /rulesList all rules

Documentation For Models

Documentation For Authorization

All endpoints do not require authorization.

Author

hi@ory.am

Libraries

ory_oathkeeper_client