ory_oathkeeper_client 0.38.18-beta.1 copy "ory_oathkeeper_client: ^0.38.18-beta.1" to clipboard
ory_oathkeeper_client: ^0.38.18-beta.1 copied to clipboard

outdated

OpenAPI API client

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 Dart package is automatically generated by the OpenAPI Generator project:

  • API version: v0.38.18-beta.1
  • Build package: org.openapitools.codegen.languages.DartDioClientCodegen For more information, please visit https://www.ory.am

Requirements #

Dart 2.7.0 or later OR Flutter 1.12 or later

Installation & Usage #

Github #

If this Dart package is published to Github, please include the following in pubspec.yaml

name: ory_oathkeeper_client
version: 0.38.18-beta.1
description: OpenAPI API client
dependencies:
  ory_oathkeeper_client:
    git: https://github.com/ory/sdk.git
      version: 'any'

Local #

To use the package in 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/api.dart';


final api = ApiApi();

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

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 getVersion GET /version Get Service Version
ApiApi getWellKnownJSONWebKeys GET /.well-known/jwks.json Lists Cryptographic Keys
ApiApi isInstanceAlive GET /health/alive Check Alive Status
ApiApi isInstanceReady GET /health/ready Check Readiness Status
ApiApi listRules GET /rules List All Rules

Documentation For Models #

Documentation For Authorization #

All endpoints do not require authorization.

Author #

hi@ory.am