ory_oathkeeper_client 0.40.6 copy "ory_oathkeeper_client: ^0.40.6" to clipboard
ory_oathkeeper_client: ^0.40.6 copied to clipboard

OpenAPI API client for Ory Oathkeeper, a cloud native Identity & Access Proxy and Access Control Decision API that authenticates, authorizes, and mutates incoming HTTP(s) requests.

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 #

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

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

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 #

Documentation For Authorization #

Endpoints do not require authorization.

Author #

hi@ory.am

1
likes
115
pub points
0%
popularity

Publisher

verified publisherory.sh

OpenAPI API client for Ory Oathkeeper, a cloud native Identity & Access Proxy and Access Control Decision API that authenticates, authorizes, and mutates incoming HTTP(s) requests.

Homepage
Repository (GitHub)
View/report issues
Contributing

Documentation

API reference

License

Apache-2.0 (LICENSE)

Dependencies

built_collection, built_value, dio, one_of, one_of_serializer

More

Packages that depend on ory_oathkeeper_client