ory_oathkeeper_client 0.0.0-alpha.55 ory_oathkeeper_client: ^0.0.0-alpha.55 copied to clipboard
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.0.0-alpha.55
- Build package: org.openapitools.codegen.languages.DartClientCodegen For more information, please visit https://www.ory.am
Requirements #
Dart 2.0 or later
Installation & Usage #
Github #
If this Dart package is published to Github, add the following dependency to your pubspec.yaml
dependencies:
ory_oathkeeper_client:
git: https://github.com/ory/sdk.git
Local #
To use the package in your local drive, add the following dependency to your pubspec.yaml
dependencies:
ory_oathkeeper_client:
path: /path/to/ory_oathkeeper_client
Tests #
TODO
Getting Started #
Please follow the installation procedure and then run the following:
import 'package:ory_oathkeeper_client/api.dart';
final api_instance = ApiApi();
try {
api_instance.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 #
- CreateRuleCreated
- CreateRuleForbidden
- CreateRuleForbiddenBody
- CreateRuleInternalServerError
- CreateRuleInternalServerErrorBody
- CreateRuleUnauthorized
- CreateRuleUnauthorizedBody
- DecisionsForbidden
- DecisionsForbiddenBody
- DecisionsInternalServerError
- DecisionsInternalServerErrorBody
- DecisionsNotFound
- DecisionsNotFoundBody
- DecisionsUnauthorized
- DecisionsUnauthorizedBody
- DeleteRuleForbidden
- DeleteRuleForbiddenBody
- DeleteRuleInternalServerError
- DeleteRuleInternalServerErrorBody
- DeleteRuleNotFound
- DeleteRuleNotFoundBody
- DeleteRuleUnauthorized
- DeleteRuleUnauthorizedBody
- GetRuleForbidden
- GetRuleForbiddenBody
- GetRuleInternalServerError
- GetRuleInternalServerErrorBody
- GetRuleNotFound
- GetRuleNotFoundBody
- GetRuleOK
- GetRuleUnauthorized
- GetRuleUnauthorizedBody
- GetWellKnownForbidden
- GetWellKnownForbiddenBody
- GetWellKnownJSONWebKeysInternalServerError
- GetWellKnownJSONWebKeysInternalServerErrorBody
- GetWellKnownJSONWebKeysOK
- GetWellKnownOK
- GetWellKnownUnauthorized
- GetWellKnownUnauthorizedBody
- HealthNotReadyStatus
- HealthStatus
- InlineResponse500
- IsInstanceAliveInternalServerError
- IsInstanceAliveInternalServerErrorBody
- IsInstanceAliveOK
- JsonWebKey
- JsonWebKeySet
- JudgeForbidden
- JudgeForbiddenBody
- JudgeInternalServerError
- JudgeInternalServerErrorBody
- JudgeNotFound
- JudgeNotFoundBody
- JudgeUnauthorized
- JudgeUnauthorizedBody
- ListRulesForbidden
- ListRulesForbiddenBody
- ListRulesInternalServerError
- ListRulesInternalServerErrorBody
- ListRulesOK
- ListRulesUnauthorized
- ListRulesUnauthorizedBody
- Rule
- RuleHandler
- RuleMatch
- SwaggerCreateRuleParameters
- SwaggerGetRuleParameters
- SwaggerHealthStatus
- SwaggerJSONWebKey
- SwaggerJSONWebKeySet
- SwaggerListRulesParameters
- SwaggerNotReadyStatus
- SwaggerRule
- SwaggerRuleHandler
- SwaggerRuleMatch
- SwaggerRuleResponse
- SwaggerRulesResponse
- SwaggerUpdateRuleParameters
- SwaggerVersion
- UpdateRuleForbidden
- UpdateRuleForbiddenBody
- UpdateRuleInternalServerError
- UpdateRuleInternalServerErrorBody
- UpdateRuleNotFound
- UpdateRuleNotFoundBody
- UpdateRuleOK
- UpdateRuleUnauthorized
- UpdateRuleUnauthorizedBody
- Upstream
- Version
Documentation For Authorization #
All endpoints do not require authorization.