ory_oathkeeper_client 0.38.20-beta.1 ory_oathkeeper_client: ^0.38.20-beta.1 copied to clipboard
OpenAPI API client
ory_oathkeeper_client #
Documentation for all of Ory Oathkeeper's APIs.
This Dart package is automatically generated by the OpenAPI Generator project:
- API version: v0.38.20-beta.1
- Build package: org.openapitools.codegen.languages.DartDioClientCodegen
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.20-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 | getWellKnownJSONWebKeys | GET /.well-known/jwks.json | Lists Cryptographic Keys |
ApiApi | listRules | GET /rules | List All Rules |
MetadataApi | getVersion | GET /version | Return Running Software Version. |
MetadataApi | isAlive | GET /health/alive | Check HTTP Server Status |
MetadataApi | isReady | GET /health/ready | Check HTTP Server and Database Status |
Documentation For Models #
- GenericError
- HealthNotReadyStatus
- HealthStatus
- InlineResponse200
- InlineResponse2001
- InlineResponse503
- JsonWebKey
- JsonWebKeySet
- Rule
- RuleHandler
- RuleMatch
- Upstream
- Version
Documentation For Authorization #
All endpoints do not require authorization.