ory-oathkeeper-client 0.0.0.alpha62 → 0.35.0.alpha1
Sign up to get free protection for your applications and to get access to all the features.
- checksums.yaml +4 -4
- data/Gemfile +1 -1
- data/README.md +34 -106
- data/docs/ApiApi.md +46 -301
- data/docs/CreateRuleCreated.md +8 -9
- data/docs/CreateRuleForbidden.md +8 -9
- data/docs/CreateRuleForbiddenBody.md +18 -19
- data/docs/CreateRuleInternalServerError.md +8 -9
- data/docs/CreateRuleInternalServerErrorBody.md +18 -19
- data/docs/CreateRuleUnauthorized.md +8 -9
- data/docs/CreateRuleUnauthorizedBody.md +18 -19
- data/docs/DecisionsForbidden.md +8 -9
- data/docs/DecisionsForbiddenBody.md +18 -19
- data/docs/DecisionsInternalServerError.md +8 -9
- data/docs/DecisionsInternalServerErrorBody.md +18 -19
- data/docs/DecisionsNotFound.md +8 -9
- data/docs/DecisionsNotFoundBody.md +18 -19
- data/docs/DecisionsUnauthorized.md +8 -9
- data/docs/DecisionsUnauthorizedBody.md +18 -19
- data/docs/DeleteRuleForbidden.md +8 -9
- data/docs/DeleteRuleForbiddenBody.md +18 -19
- data/docs/DeleteRuleInternalServerError.md +8 -9
- data/docs/DeleteRuleInternalServerErrorBody.md +18 -19
- data/docs/DeleteRuleNotFound.md +8 -9
- data/docs/DeleteRuleNotFoundBody.md +18 -19
- data/docs/DeleteRuleUnauthorized.md +8 -9
- data/docs/DeleteRuleUnauthorizedBody.md +18 -19
- data/docs/GetRuleForbidden.md +8 -9
- data/docs/GetRuleForbiddenBody.md +18 -19
- data/docs/GetRuleInternalServerError.md +8 -9
- data/docs/GetRuleInternalServerErrorBody.md +18 -19
- data/docs/GetRuleNotFound.md +8 -9
- data/docs/GetRuleNotFoundBody.md +18 -19
- data/docs/GetRuleOK.md +8 -9
- data/docs/GetRuleUnauthorized.md +8 -9
- data/docs/GetRuleUnauthorizedBody.md +18 -19
- data/docs/GetWellKnownForbidden.md +8 -9
- data/docs/GetWellKnownForbiddenBody.md +18 -19
- data/docs/GetWellKnownJSONWebKeysInternalServerError.md +8 -9
- data/docs/GetWellKnownJSONWebKeysInternalServerErrorBody.md +18 -19
- data/docs/GetWellKnownJSONWebKeysOK.md +8 -9
- data/docs/GetWellKnownOK.md +8 -9
- data/docs/GetWellKnownUnauthorized.md +8 -9
- data/docs/GetWellKnownUnauthorizedBody.md +18 -19
- data/docs/HealthNotReadyStatus.md +8 -9
- data/docs/HealthStatus.md +8 -9
- data/docs/InlineResponse500.md +18 -19
- data/docs/IsInstanceAliveInternalServerError.md +8 -9
- data/docs/IsInstanceAliveInternalServerErrorBody.md +18 -19
- data/docs/IsInstanceAliveOK.md +8 -9
- data/docs/JsonWebKey.md +40 -41
- data/docs/JsonWebKeySet.md +8 -9
- data/docs/JudgeForbidden.md +8 -9
- data/docs/JudgeForbiddenBody.md +18 -19
- data/docs/JudgeInternalServerError.md +8 -9
- data/docs/JudgeInternalServerErrorBody.md +18 -19
- data/docs/JudgeNotFound.md +8 -9
- data/docs/JudgeNotFoundBody.md +18 -19
- data/docs/JudgeUnauthorized.md +8 -9
- data/docs/JudgeUnauthorizedBody.md +18 -19
- data/docs/ListRulesForbidden.md +8 -9
- data/docs/ListRulesForbiddenBody.md +18 -19
- data/docs/ListRulesInternalServerError.md +8 -9
- data/docs/ListRulesInternalServerErrorBody.md +18 -19
- data/docs/ListRulesOK.md +8 -9
- data/docs/ListRulesUnauthorized.md +8 -9
- data/docs/ListRulesUnauthorizedBody.md +18 -19
- data/docs/Rule.md +20 -21
- data/docs/RuleHandler.md +10 -11
- data/docs/RuleMatch.md +10 -11
- data/docs/SwaggerCreateRuleParameters.md +8 -9
- data/docs/SwaggerGetRuleParameters.md +8 -9
- data/docs/SwaggerHealthStatus.md +8 -9
- data/docs/SwaggerJSONWebKey.md +40 -41
- data/docs/SwaggerJSONWebKeySet.md +8 -9
- data/docs/SwaggerListRulesParameters.md +10 -11
- data/docs/SwaggerNotReadyStatus.md +8 -9
- data/docs/SwaggerRule.md +20 -21
- data/docs/SwaggerRuleHandler.md +10 -11
- data/docs/SwaggerRuleMatch.md +10 -11
- data/docs/SwaggerRuleResponse.md +8 -9
- data/docs/SwaggerRulesResponse.md +8 -9
- data/docs/SwaggerUpdateRuleParameters.md +10 -11
- data/docs/SwaggerVersion.md +8 -9
- data/docs/UpdateRuleForbidden.md +8 -9
- data/docs/UpdateRuleForbiddenBody.md +18 -19
- data/docs/UpdateRuleInternalServerError.md +8 -9
- data/docs/UpdateRuleInternalServerErrorBody.md +18 -19
- data/docs/UpdateRuleNotFound.md +8 -9
- data/docs/UpdateRuleNotFoundBody.md +18 -19
- data/docs/UpdateRuleOK.md +8 -9
- data/docs/UpdateRuleUnauthorized.md +8 -9
- data/docs/UpdateRuleUnauthorizedBody.md +18 -19
- data/docs/Upstream.md +12 -13
- data/docs/Version.md +8 -9
- data/lib/ory-oathkeeper-client/api/api_api.rb +15 -190
- data/lib/ory-oathkeeper-client/api/health_api.rb +2 -2
- data/lib/ory-oathkeeper-client/api/version_api.rb +2 -2
- data/lib/ory-oathkeeper-client/api_client.rb +48 -52
- data/lib/ory-oathkeeper-client/api_error.rb +3 -3
- data/lib/ory-oathkeeper-client/configuration.rb +12 -41
- data/lib/ory-oathkeeper-client/models/create_rule_created.rb +11 -23
- data/lib/ory-oathkeeper-client/models/create_rule_forbidden.rb +11 -23
- data/lib/ory-oathkeeper-client/models/create_rule_forbidden_body.rb +12 -24
- data/lib/ory-oathkeeper-client/models/create_rule_internal_server_error.rb +11 -23
- data/lib/ory-oathkeeper-client/models/create_rule_internal_server_error_body.rb +12 -24
- data/lib/ory-oathkeeper-client/models/create_rule_unauthorized.rb +11 -23
- data/lib/ory-oathkeeper-client/models/create_rule_unauthorized_body.rb +12 -24
- data/lib/ory-oathkeeper-client/models/decisions_forbidden.rb +11 -23
- data/lib/ory-oathkeeper-client/models/decisions_forbidden_body.rb +13 -25
- data/lib/ory-oathkeeper-client/models/decisions_internal_server_error.rb +11 -23
- data/lib/ory-oathkeeper-client/models/decisions_internal_server_error_body.rb +13 -25
- data/lib/ory-oathkeeper-client/models/decisions_not_found.rb +11 -23
- data/lib/ory-oathkeeper-client/models/decisions_not_found_body.rb +13 -25
- data/lib/ory-oathkeeper-client/models/decisions_unauthorized.rb +11 -23
- data/lib/ory-oathkeeper-client/models/decisions_unauthorized_body.rb +13 -25
- data/lib/ory-oathkeeper-client/models/delete_rule_forbidden.rb +11 -23
- data/lib/ory-oathkeeper-client/models/delete_rule_forbidden_body.rb +12 -24
- data/lib/ory-oathkeeper-client/models/delete_rule_internal_server_error.rb +11 -23
- data/lib/ory-oathkeeper-client/models/delete_rule_internal_server_error_body.rb +12 -24
- data/lib/ory-oathkeeper-client/models/delete_rule_not_found.rb +11 -23
- data/lib/ory-oathkeeper-client/models/delete_rule_not_found_body.rb +12 -24
- data/lib/ory-oathkeeper-client/models/delete_rule_unauthorized.rb +11 -23
- data/lib/ory-oathkeeper-client/models/delete_rule_unauthorized_body.rb +12 -24
- data/lib/ory-oathkeeper-client/models/get_rule_forbidden.rb +11 -23
- data/lib/ory-oathkeeper-client/models/get_rule_forbidden_body.rb +12 -24
- data/lib/ory-oathkeeper-client/models/get_rule_internal_server_error.rb +11 -23
- data/lib/ory-oathkeeper-client/models/get_rule_internal_server_error_body.rb +13 -25
- data/lib/ory-oathkeeper-client/models/get_rule_not_found.rb +11 -23
- data/lib/ory-oathkeeper-client/models/get_rule_not_found_body.rb +13 -25
- data/lib/ory-oathkeeper-client/models/get_rule_ok.rb +11 -23
- data/lib/ory-oathkeeper-client/models/get_rule_unauthorized.rb +11 -23
- data/lib/ory-oathkeeper-client/models/get_rule_unauthorized_body.rb +12 -24
- data/lib/ory-oathkeeper-client/models/get_well_known_forbidden.rb +11 -23
- data/lib/ory-oathkeeper-client/models/get_well_known_forbidden_body.rb +12 -24
- data/lib/ory-oathkeeper-client/models/get_well_known_json_web_keys_internal_server_error.rb +11 -23
- data/lib/ory-oathkeeper-client/models/get_well_known_json_web_keys_internal_server_error_body.rb +13 -25
- data/lib/ory-oathkeeper-client/models/get_well_known_json_web_keys_ok.rb +11 -23
- data/lib/ory-oathkeeper-client/models/get_well_known_ok.rb +11 -23
- data/lib/ory-oathkeeper-client/models/get_well_known_unauthorized.rb +11 -23
- data/lib/ory-oathkeeper-client/models/get_well_known_unauthorized_body.rb +12 -24
- data/lib/ory-oathkeeper-client/models/health_not_ready_status.rb +12 -23
- data/lib/ory-oathkeeper-client/models/health_status.rb +11 -23
- data/lib/ory-oathkeeper-client/models/inline_response500.rb +12 -24
- data/lib/ory-oathkeeper-client/models/is_instance_alive_internal_server_error.rb +11 -23
- data/lib/ory-oathkeeper-client/models/is_instance_alive_internal_server_error_body.rb +13 -25
- data/lib/ory-oathkeeper-client/models/is_instance_alive_ok.rb +11 -23
- data/lib/ory-oathkeeper-client/models/json_web_key.rb +24 -23
- data/lib/ory-oathkeeper-client/models/json_web_key_set.rb +11 -23
- data/lib/ory-oathkeeper-client/models/judge_forbidden.rb +11 -23
- data/lib/ory-oathkeeper-client/models/judge_forbidden_body.rb +12 -24
- data/lib/ory-oathkeeper-client/models/judge_internal_server_error.rb +11 -23
- data/lib/ory-oathkeeper-client/models/judge_internal_server_error_body.rb +12 -24
- data/lib/ory-oathkeeper-client/models/judge_not_found.rb +11 -23
- data/lib/ory-oathkeeper-client/models/judge_not_found_body.rb +12 -24
- data/lib/ory-oathkeeper-client/models/judge_unauthorized.rb +11 -23
- data/lib/ory-oathkeeper-client/models/judge_unauthorized_body.rb +12 -24
- data/lib/ory-oathkeeper-client/models/list_rules_forbidden.rb +11 -23
- data/lib/ory-oathkeeper-client/models/list_rules_forbidden_body.rb +12 -24
- data/lib/ory-oathkeeper-client/models/list_rules_internal_server_error.rb +11 -23
- data/lib/ory-oathkeeper-client/models/list_rules_internal_server_error_body.rb +13 -25
- data/lib/ory-oathkeeper-client/models/list_rules_ok.rb +11 -23
- data/lib/ory-oathkeeper-client/models/list_rules_unauthorized.rb +11 -23
- data/lib/ory-oathkeeper-client/models/list_rules_unauthorized_body.rb +12 -24
- data/lib/ory-oathkeeper-client/models/rule.rb +11 -23
- data/lib/ory-oathkeeper-client/models/rule_handler.rb +12 -23
- data/lib/ory-oathkeeper-client/models/rule_match.rb +12 -23
- data/lib/ory-oathkeeper-client/models/swagger_create_rule_parameters.rb +11 -23
- data/lib/ory-oathkeeper-client/models/swagger_get_rule_parameters.rb +11 -23
- data/lib/ory-oathkeeper-client/models/swagger_health_status.rb +11 -23
- data/lib/ory-oathkeeper-client/models/swagger_json_web_key.rb +11 -23
- data/lib/ory-oathkeeper-client/models/swagger_json_web_key_set.rb +11 -23
- data/lib/ory-oathkeeper-client/models/swagger_list_rules_parameters.rb +11 -23
- data/lib/ory-oathkeeper-client/models/swagger_not_ready_status.rb +11 -23
- data/lib/ory-oathkeeper-client/models/swagger_rule.rb +11 -23
- data/lib/ory-oathkeeper-client/models/swagger_rule_handler.rb +11 -23
- data/lib/ory-oathkeeper-client/models/swagger_rule_match.rb +11 -23
- data/lib/ory-oathkeeper-client/models/swagger_rule_response.rb +11 -23
- data/lib/ory-oathkeeper-client/models/swagger_rules_response.rb +11 -23
- data/lib/ory-oathkeeper-client/models/swagger_update_rule_parameters.rb +11 -23
- data/lib/ory-oathkeeper-client/models/swagger_version.rb +11 -23
- data/lib/ory-oathkeeper-client/models/update_rule_forbidden.rb +11 -23
- data/lib/ory-oathkeeper-client/models/update_rule_forbidden_body.rb +12 -24
- data/lib/ory-oathkeeper-client/models/update_rule_internal_server_error.rb +11 -23
- data/lib/ory-oathkeeper-client/models/update_rule_internal_server_error_body.rb +12 -24
- data/lib/ory-oathkeeper-client/models/update_rule_not_found.rb +11 -23
- data/lib/ory-oathkeeper-client/models/update_rule_not_found_body.rb +12 -24
- data/lib/ory-oathkeeper-client/models/update_rule_ok.rb +11 -23
- data/lib/ory-oathkeeper-client/models/update_rule_unauthorized.rb +11 -23
- data/lib/ory-oathkeeper-client/models/update_rule_unauthorized_body.rb +12 -24
- data/lib/ory-oathkeeper-client/models/upstream.rb +12 -24
- data/lib/ory-oathkeeper-client/models/version.rb +12 -23
- data/lib/ory-oathkeeper-client/version.rb +4 -4
- data/lib/ory-oathkeeper-client.rb +6 -76
- data/ory-oathkeeper-client.gemspec +6 -5
- data/spec/api/health_api_spec.rb +2 -2
- data/spec/api/version_api_spec.rb +2 -2
- data/spec/api_client_spec.rb +32 -32
- data/spec/configuration_spec.rb +5 -5
- data/spec/spec_helper.rb +2 -2
- metadata +99 -79
checksums.yaml
CHANGED
@@ -1,7 +1,7 @@
|
|
1
1
|
---
|
2
2
|
SHA256:
|
3
|
-
metadata.gz:
|
4
|
-
data.tar.gz:
|
3
|
+
metadata.gz: 8922e2da38e4386caf31dbfff601f152d124fad1fd0dd2d36798be507b814847
|
4
|
+
data.tar.gz: 4daabdaa7468c46c0744e1f0f95b5fa8dc2d36dbaea2a5a0540feb3cf0ba6daa
|
5
5
|
SHA512:
|
6
|
-
metadata.gz:
|
7
|
-
data.tar.gz:
|
6
|
+
metadata.gz: 8a8606529269c52bb51e33cf061561b86f2e15d3710fa834333370482a004ac22b02a75c14cfeff976b4495357a0cb8b3e230ff1d28cb63c983f1e3ab706ed8c
|
7
|
+
data.tar.gz: c1a74897f1656b42d6fc0807506a16fe140cacb61e6cc693d13771023dbefd0e275f71815e997ba955b02b0216811613b3672ffb604cc3d9a31779abef52552f
|
data/Gemfile
CHANGED
data/README.md
CHANGED
@@ -1,13 +1,13 @@
|
|
1
1
|
# ory-oathkeeper-client
|
2
2
|
|
3
|
-
|
3
|
+
OryHydraClient - the Ruby gem for the ORY Oathkeeper
|
4
4
|
|
5
5
|
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.
|
6
6
|
|
7
7
|
This SDK is automatically generated by the [OpenAPI Generator](https://openapi-generator.tech) project:
|
8
8
|
|
9
|
-
- API version:
|
10
|
-
- Package version: v0.
|
9
|
+
- API version: Latest
|
10
|
+
- Package version: v0.35.0-alpha.1
|
11
11
|
- Build package: org.openapitools.codegen.languages.RubyClientCodegen
|
12
12
|
For more information, please visit [https://www.ory.am](https://www.ory.am)
|
13
13
|
|
@@ -24,16 +24,16 @@ gem build ory-oathkeeper-client.gemspec
|
|
24
24
|
Then either install the gem locally:
|
25
25
|
|
26
26
|
```shell
|
27
|
-
gem install ./ory-oathkeeper-client-v0.
|
27
|
+
gem install ./ory-oathkeeper-client-v0.35.0-alpha.1.gem
|
28
28
|
```
|
29
29
|
|
30
|
-
(for development, run `gem install --dev ./ory-oathkeeper-client-v0.
|
30
|
+
(for development, run `gem install --dev ./ory-oathkeeper-client-v0.35.0-alpha.1.gem` to install the development dependencies)
|
31
31
|
|
32
32
|
or publish the gem to a gem hosting service, e.g. [RubyGems](https://rubygems.org/).
|
33
33
|
|
34
34
|
Finally add this to the Gemfile:
|
35
35
|
|
36
|
-
gem 'ory-oathkeeper-client', '~> v0.
|
36
|
+
gem 'ory-oathkeeper-client', '~> v0.35.0-alpha.1'
|
37
37
|
|
38
38
|
### Install from Git
|
39
39
|
|
@@ -57,12 +57,12 @@ Please follow the [installation](#installation) procedure and then run the follo
|
|
57
57
|
# Load the gem
|
58
58
|
require 'ory-oathkeeper-client'
|
59
59
|
|
60
|
-
api_instance =
|
60
|
+
api_instance = OryHydraClient::ApiApi.new
|
61
61
|
|
62
62
|
begin
|
63
63
|
#Access Control Decision API
|
64
64
|
api_instance.decisions
|
65
|
-
rescue
|
65
|
+
rescue OryHydraClient::ApiError => e
|
66
66
|
puts "Exception when calling ApiApi->decisions: #{e}"
|
67
67
|
end
|
68
68
|
|
@@ -74,108 +74,36 @@ All URIs are relative to *http://localhost*
|
|
74
74
|
|
75
75
|
Class | Method | HTTP request | Description
|
76
76
|
------------ | ------------- | ------------- | -------------
|
77
|
-
*
|
78
|
-
*
|
79
|
-
*
|
80
|
-
*
|
81
|
-
*
|
82
|
-
*
|
83
|
-
*
|
77
|
+
*OryHydraClient::ApiApi* | [**decisions**](docs/ApiApi.md#decisions) | **GET** /decisions | Access Control Decision API
|
78
|
+
*OryHydraClient::ApiApi* | [**get_rule**](docs/ApiApi.md#get_rule) | **GET** /rules/{id} | Retrieve a rule
|
79
|
+
*OryHydraClient::ApiApi* | [**get_well_known_json_web_keys**](docs/ApiApi.md#get_well_known_json_web_keys) | **GET** /.well-known/jwks.json | Lists cryptographic keys
|
80
|
+
*OryHydraClient::ApiApi* | [**list_rules**](docs/ApiApi.md#list_rules) | **GET** /rules | List all rules
|
81
|
+
*OryHydraClient::HealthApi* | [**is_instance_alive**](docs/HealthApi.md#is_instance_alive) | **GET** /health/alive | Check alive status
|
82
|
+
*OryHydraClient::HealthApi* | [**is_instance_ready**](docs/HealthApi.md#is_instance_ready) | **GET** /health/ready | Check readiness status
|
83
|
+
*OryHydraClient::VersionApi* | [**get_version**](docs/VersionApi.md#get_version) | **GET** /version | Get service version
|
84
84
|
|
85
85
|
|
86
86
|
## Documentation for Models
|
87
87
|
|
88
|
-
- [
|
89
|
-
- [
|
90
|
-
- [
|
91
|
-
- [
|
92
|
-
- [
|
93
|
-
- [
|
94
|
-
- [
|
95
|
-
- [
|
96
|
-
- [
|
97
|
-
- [
|
98
|
-
- [
|
99
|
-
- [
|
100
|
-
- [
|
101
|
-
- [
|
102
|
-
- [
|
103
|
-
- [
|
104
|
-
- [
|
105
|
-
- [
|
106
|
-
- [
|
107
|
-
- [OryOathkeeperClient::DeleteRuleNotFound](docs/DeleteRuleNotFound.md)
|
108
|
-
- [OryOathkeeperClient::DeleteRuleNotFoundBody](docs/DeleteRuleNotFoundBody.md)
|
109
|
-
- [OryOathkeeperClient::DeleteRuleUnauthorized](docs/DeleteRuleUnauthorized.md)
|
110
|
-
- [OryOathkeeperClient::DeleteRuleUnauthorizedBody](docs/DeleteRuleUnauthorizedBody.md)
|
111
|
-
- [OryOathkeeperClient::GetRuleForbidden](docs/GetRuleForbidden.md)
|
112
|
-
- [OryOathkeeperClient::GetRuleForbiddenBody](docs/GetRuleForbiddenBody.md)
|
113
|
-
- [OryOathkeeperClient::GetRuleInternalServerError](docs/GetRuleInternalServerError.md)
|
114
|
-
- [OryOathkeeperClient::GetRuleInternalServerErrorBody](docs/GetRuleInternalServerErrorBody.md)
|
115
|
-
- [OryOathkeeperClient::GetRuleNotFound](docs/GetRuleNotFound.md)
|
116
|
-
- [OryOathkeeperClient::GetRuleNotFoundBody](docs/GetRuleNotFoundBody.md)
|
117
|
-
- [OryOathkeeperClient::GetRuleOK](docs/GetRuleOK.md)
|
118
|
-
- [OryOathkeeperClient::GetRuleUnauthorized](docs/GetRuleUnauthorized.md)
|
119
|
-
- [OryOathkeeperClient::GetRuleUnauthorizedBody](docs/GetRuleUnauthorizedBody.md)
|
120
|
-
- [OryOathkeeperClient::GetWellKnownForbidden](docs/GetWellKnownForbidden.md)
|
121
|
-
- [OryOathkeeperClient::GetWellKnownForbiddenBody](docs/GetWellKnownForbiddenBody.md)
|
122
|
-
- [OryOathkeeperClient::GetWellKnownJSONWebKeysInternalServerError](docs/GetWellKnownJSONWebKeysInternalServerError.md)
|
123
|
-
- [OryOathkeeperClient::GetWellKnownJSONWebKeysInternalServerErrorBody](docs/GetWellKnownJSONWebKeysInternalServerErrorBody.md)
|
124
|
-
- [OryOathkeeperClient::GetWellKnownJSONWebKeysOK](docs/GetWellKnownJSONWebKeysOK.md)
|
125
|
-
- [OryOathkeeperClient::GetWellKnownOK](docs/GetWellKnownOK.md)
|
126
|
-
- [OryOathkeeperClient::GetWellKnownUnauthorized](docs/GetWellKnownUnauthorized.md)
|
127
|
-
- [OryOathkeeperClient::GetWellKnownUnauthorizedBody](docs/GetWellKnownUnauthorizedBody.md)
|
128
|
-
- [OryOathkeeperClient::HealthNotReadyStatus](docs/HealthNotReadyStatus.md)
|
129
|
-
- [OryOathkeeperClient::HealthStatus](docs/HealthStatus.md)
|
130
|
-
- [OryOathkeeperClient::InlineResponse500](docs/InlineResponse500.md)
|
131
|
-
- [OryOathkeeperClient::IsInstanceAliveInternalServerError](docs/IsInstanceAliveInternalServerError.md)
|
132
|
-
- [OryOathkeeperClient::IsInstanceAliveInternalServerErrorBody](docs/IsInstanceAliveInternalServerErrorBody.md)
|
133
|
-
- [OryOathkeeperClient::IsInstanceAliveOK](docs/IsInstanceAliveOK.md)
|
134
|
-
- [OryOathkeeperClient::JsonWebKey](docs/JsonWebKey.md)
|
135
|
-
- [OryOathkeeperClient::JsonWebKeySet](docs/JsonWebKeySet.md)
|
136
|
-
- [OryOathkeeperClient::JudgeForbidden](docs/JudgeForbidden.md)
|
137
|
-
- [OryOathkeeperClient::JudgeForbiddenBody](docs/JudgeForbiddenBody.md)
|
138
|
-
- [OryOathkeeperClient::JudgeInternalServerError](docs/JudgeInternalServerError.md)
|
139
|
-
- [OryOathkeeperClient::JudgeInternalServerErrorBody](docs/JudgeInternalServerErrorBody.md)
|
140
|
-
- [OryOathkeeperClient::JudgeNotFound](docs/JudgeNotFound.md)
|
141
|
-
- [OryOathkeeperClient::JudgeNotFoundBody](docs/JudgeNotFoundBody.md)
|
142
|
-
- [OryOathkeeperClient::JudgeUnauthorized](docs/JudgeUnauthorized.md)
|
143
|
-
- [OryOathkeeperClient::JudgeUnauthorizedBody](docs/JudgeUnauthorizedBody.md)
|
144
|
-
- [OryOathkeeperClient::ListRulesForbidden](docs/ListRulesForbidden.md)
|
145
|
-
- [OryOathkeeperClient::ListRulesForbiddenBody](docs/ListRulesForbiddenBody.md)
|
146
|
-
- [OryOathkeeperClient::ListRulesInternalServerError](docs/ListRulesInternalServerError.md)
|
147
|
-
- [OryOathkeeperClient::ListRulesInternalServerErrorBody](docs/ListRulesInternalServerErrorBody.md)
|
148
|
-
- [OryOathkeeperClient::ListRulesOK](docs/ListRulesOK.md)
|
149
|
-
- [OryOathkeeperClient::ListRulesUnauthorized](docs/ListRulesUnauthorized.md)
|
150
|
-
- [OryOathkeeperClient::ListRulesUnauthorizedBody](docs/ListRulesUnauthorizedBody.md)
|
151
|
-
- [OryOathkeeperClient::Rule](docs/Rule.md)
|
152
|
-
- [OryOathkeeperClient::RuleHandler](docs/RuleHandler.md)
|
153
|
-
- [OryOathkeeperClient::RuleMatch](docs/RuleMatch.md)
|
154
|
-
- [OryOathkeeperClient::SwaggerCreateRuleParameters](docs/SwaggerCreateRuleParameters.md)
|
155
|
-
- [OryOathkeeperClient::SwaggerGetRuleParameters](docs/SwaggerGetRuleParameters.md)
|
156
|
-
- [OryOathkeeperClient::SwaggerHealthStatus](docs/SwaggerHealthStatus.md)
|
157
|
-
- [OryOathkeeperClient::SwaggerJSONWebKey](docs/SwaggerJSONWebKey.md)
|
158
|
-
- [OryOathkeeperClient::SwaggerJSONWebKeySet](docs/SwaggerJSONWebKeySet.md)
|
159
|
-
- [OryOathkeeperClient::SwaggerListRulesParameters](docs/SwaggerListRulesParameters.md)
|
160
|
-
- [OryOathkeeperClient::SwaggerNotReadyStatus](docs/SwaggerNotReadyStatus.md)
|
161
|
-
- [OryOathkeeperClient::SwaggerRule](docs/SwaggerRule.md)
|
162
|
-
- [OryOathkeeperClient::SwaggerRuleHandler](docs/SwaggerRuleHandler.md)
|
163
|
-
- [OryOathkeeperClient::SwaggerRuleMatch](docs/SwaggerRuleMatch.md)
|
164
|
-
- [OryOathkeeperClient::SwaggerRuleResponse](docs/SwaggerRuleResponse.md)
|
165
|
-
- [OryOathkeeperClient::SwaggerRulesResponse](docs/SwaggerRulesResponse.md)
|
166
|
-
- [OryOathkeeperClient::SwaggerUpdateRuleParameters](docs/SwaggerUpdateRuleParameters.md)
|
167
|
-
- [OryOathkeeperClient::SwaggerVersion](docs/SwaggerVersion.md)
|
168
|
-
- [OryOathkeeperClient::UpdateRuleForbidden](docs/UpdateRuleForbidden.md)
|
169
|
-
- [OryOathkeeperClient::UpdateRuleForbiddenBody](docs/UpdateRuleForbiddenBody.md)
|
170
|
-
- [OryOathkeeperClient::UpdateRuleInternalServerError](docs/UpdateRuleInternalServerError.md)
|
171
|
-
- [OryOathkeeperClient::UpdateRuleInternalServerErrorBody](docs/UpdateRuleInternalServerErrorBody.md)
|
172
|
-
- [OryOathkeeperClient::UpdateRuleNotFound](docs/UpdateRuleNotFound.md)
|
173
|
-
- [OryOathkeeperClient::UpdateRuleNotFoundBody](docs/UpdateRuleNotFoundBody.md)
|
174
|
-
- [OryOathkeeperClient::UpdateRuleOK](docs/UpdateRuleOK.md)
|
175
|
-
- [OryOathkeeperClient::UpdateRuleUnauthorized](docs/UpdateRuleUnauthorized.md)
|
176
|
-
- [OryOathkeeperClient::UpdateRuleUnauthorizedBody](docs/UpdateRuleUnauthorizedBody.md)
|
177
|
-
- [OryOathkeeperClient::Upstream](docs/Upstream.md)
|
178
|
-
- [OryOathkeeperClient::Version](docs/Version.md)
|
88
|
+
- [OryHydraClient::DecisionsForbiddenBody](docs/DecisionsForbiddenBody.md)
|
89
|
+
- [OryHydraClient::DecisionsInternalServerErrorBody](docs/DecisionsInternalServerErrorBody.md)
|
90
|
+
- [OryHydraClient::DecisionsNotFoundBody](docs/DecisionsNotFoundBody.md)
|
91
|
+
- [OryHydraClient::DecisionsUnauthorizedBody](docs/DecisionsUnauthorizedBody.md)
|
92
|
+
- [OryHydraClient::GetRuleInternalServerErrorBody](docs/GetRuleInternalServerErrorBody.md)
|
93
|
+
- [OryHydraClient::GetRuleNotFoundBody](docs/GetRuleNotFoundBody.md)
|
94
|
+
- [OryHydraClient::GetWellKnownJSONWebKeysInternalServerErrorBody](docs/GetWellKnownJSONWebKeysInternalServerErrorBody.md)
|
95
|
+
- [OryHydraClient::HealthNotReadyStatus](docs/HealthNotReadyStatus.md)
|
96
|
+
- [OryHydraClient::HealthStatus](docs/HealthStatus.md)
|
97
|
+
- [OryHydraClient::InlineResponse500](docs/InlineResponse500.md)
|
98
|
+
- [OryHydraClient::IsInstanceAliveInternalServerErrorBody](docs/IsInstanceAliveInternalServerErrorBody.md)
|
99
|
+
- [OryHydraClient::JsonWebKey](docs/JsonWebKey.md)
|
100
|
+
- [OryHydraClient::JsonWebKeySet](docs/JsonWebKeySet.md)
|
101
|
+
- [OryHydraClient::ListRulesInternalServerErrorBody](docs/ListRulesInternalServerErrorBody.md)
|
102
|
+
- [OryHydraClient::Rule](docs/Rule.md)
|
103
|
+
- [OryHydraClient::RuleHandler](docs/RuleHandler.md)
|
104
|
+
- [OryHydraClient::RuleMatch](docs/RuleMatch.md)
|
105
|
+
- [OryHydraClient::Upstream](docs/Upstream.md)
|
106
|
+
- [OryHydraClient::Version](docs/Version.md)
|
179
107
|
|
180
108
|
|
181
109
|
## Documentation for Authorization
|
data/docs/ApiApi.md
CHANGED
@@ -1,16 +1,14 @@
|
|
1
|
-
#
|
1
|
+
# OryHydraClient::ApiApi
|
2
2
|
|
3
3
|
All URIs are relative to *http://localhost*
|
4
4
|
|
5
|
-
|
6
|
-
|
7
|
-
|
8
|
-
|
9
|
-
|
10
|
-
|
11
|
-
|
12
|
-
| [**is_instance_ready**](ApiApi.md#is_instance_ready) | **GET** /health/ready | Check readiness status |
|
13
|
-
| [**list_rules**](ApiApi.md#list_rules) | **GET** /rules | List all rules |
|
5
|
+
Method | HTTP request | Description
|
6
|
+
------------- | ------------- | -------------
|
7
|
+
[**decisions**](ApiApi.md#decisions) | **GET** /decisions | Access Control Decision API
|
8
|
+
[**get_rule**](ApiApi.md#get_rule) | **GET** /rules/{id} | Retrieve a rule
|
9
|
+
[**get_well_known_json_web_keys**](ApiApi.md#get_well_known_json_web_keys) | **GET** /.well-known/jwks.json | Lists cryptographic keys
|
10
|
+
[**list_rules**](ApiApi.md#list_rules) | **GET** /rules | List all rules
|
11
|
+
|
14
12
|
|
15
13
|
|
16
14
|
## decisions
|
@@ -21,37 +19,19 @@ Access Control Decision API
|
|
21
19
|
|
22
20
|
> This endpoint works with all HTTP Methods (GET, POST, PUT, ...) and matches every path prefixed with /decision. This endpoint mirrors the proxy capability of ORY Oathkeeper's proxy functionality but instead of forwarding the request to the upstream server, returns 200 (request should be allowed), 401 (unauthorized), or 403 (forbidden) status codes. This endpoint can be used to integrate with other API Proxies like Ambassador, Kong, Envoy, and many more.
|
23
21
|
|
24
|
-
###
|
22
|
+
### Example
|
25
23
|
|
26
24
|
```ruby
|
27
|
-
|
25
|
+
# load the gem
|
28
26
|
require 'ory-oathkeeper-client'
|
29
27
|
|
30
|
-
api_instance =
|
28
|
+
api_instance = OryHydraClient::ApiApi.new
|
31
29
|
|
32
30
|
begin
|
33
|
-
#
|
31
|
+
#Access Control Decision API
|
34
32
|
api_instance.decisions
|
35
|
-
rescue
|
36
|
-
puts "
|
37
|
-
end
|
38
|
-
```
|
39
|
-
|
40
|
-
#### Using the decisions_with_http_info variant
|
41
|
-
|
42
|
-
This returns an Array which contains the response data (`nil` in this case), status code and headers.
|
43
|
-
|
44
|
-
> <Array(nil, Integer, Hash)> decisions_with_http_info
|
45
|
-
|
46
|
-
```ruby
|
47
|
-
begin
|
48
|
-
# Access Control Decision API
|
49
|
-
data, status_code, headers = api_instance.decisions_with_http_info
|
50
|
-
p status_code # => 2xx
|
51
|
-
p headers # => { ... }
|
52
|
-
p data # => nil
|
53
|
-
rescue OryOathkeeperClient::ApiError => e
|
54
|
-
puts "Error when calling ApiApi->decisions_with_http_info: #{e}"
|
33
|
+
rescue OryHydraClient::ApiError => e
|
34
|
+
puts "Exception when calling ApiApi->decisions: #{e}"
|
55
35
|
end
|
56
36
|
```
|
57
37
|
|
@@ -75,118 +55,40 @@ No authorization required
|
|
75
55
|
|
76
56
|
## get_rule
|
77
57
|
|
78
|
-
>
|
58
|
+
> Rule get_rule(id)
|
79
59
|
|
80
60
|
Retrieve a rule
|
81
61
|
|
82
62
|
Use this method to retrieve a rule from the storage. If it does not exist you will receive a 404 error.
|
83
63
|
|
84
|
-
###
|
64
|
+
### Example
|
85
65
|
|
86
66
|
```ruby
|
87
|
-
|
67
|
+
# load the gem
|
88
68
|
require 'ory-oathkeeper-client'
|
89
69
|
|
90
|
-
api_instance =
|
70
|
+
api_instance = OryHydraClient::ApiApi.new
|
91
71
|
id = 'id_example' # String |
|
92
72
|
|
93
73
|
begin
|
94
|
-
#
|
74
|
+
#Retrieve a rule
|
95
75
|
result = api_instance.get_rule(id)
|
96
76
|
p result
|
97
|
-
rescue
|
98
|
-
puts "
|
99
|
-
end
|
100
|
-
```
|
101
|
-
|
102
|
-
#### Using the get_rule_with_http_info variant
|
103
|
-
|
104
|
-
This returns an Array which contains the response data, status code and headers.
|
105
|
-
|
106
|
-
> <Array(<Rule>, Integer, Hash)> get_rule_with_http_info(id)
|
107
|
-
|
108
|
-
```ruby
|
109
|
-
begin
|
110
|
-
# Retrieve a rule
|
111
|
-
data, status_code, headers = api_instance.get_rule_with_http_info(id)
|
112
|
-
p status_code # => 2xx
|
113
|
-
p headers # => { ... }
|
114
|
-
p data # => <Rule>
|
115
|
-
rescue OryOathkeeperClient::ApiError => e
|
116
|
-
puts "Error when calling ApiApi->get_rule_with_http_info: #{e}"
|
77
|
+
rescue OryHydraClient::ApiError => e
|
78
|
+
puts "Exception when calling ApiApi->get_rule: #{e}"
|
117
79
|
end
|
118
80
|
```
|
119
81
|
|
120
82
|
### Parameters
|
121
83
|
|
122
|
-
| Name | Type | Description | Notes |
|
123
|
-
| ---- | ---- | ----------- | ----- |
|
124
|
-
| **id** | **String** | | |
|
125
|
-
|
126
|
-
### Return type
|
127
|
-
|
128
|
-
[**Rule**](Rule.md)
|
129
|
-
|
130
|
-
### Authorization
|
131
|
-
|
132
|
-
No authorization required
|
133
|
-
|
134
|
-
### HTTP request headers
|
135
|
-
|
136
|
-
- **Content-Type**: Not defined
|
137
|
-
- **Accept**: application/json
|
138
|
-
|
139
|
-
|
140
|
-
## get_version
|
141
|
-
|
142
|
-
> <Version> get_version
|
143
|
-
|
144
|
-
Get service version
|
145
|
-
|
146
|
-
This endpoint returns the service version typically notated using semantic versioning. If the service supports TLS Edge Termination, this endpoint does not require the `X-Forwarded-Proto` header to be set. Be aware that if you are running multiple nodes of this service, the health status will never refer to the cluster state, only to a single instance.
|
147
|
-
|
148
|
-
### Examples
|
149
|
-
|
150
|
-
```ruby
|
151
|
-
require 'time'
|
152
|
-
require 'ory-oathkeeper-client'
|
153
|
-
|
154
|
-
api_instance = OryOathkeeperClient::ApiApi.new
|
155
|
-
|
156
|
-
begin
|
157
|
-
# Get service version
|
158
|
-
result = api_instance.get_version
|
159
|
-
p result
|
160
|
-
rescue OryOathkeeperClient::ApiError => e
|
161
|
-
puts "Error when calling ApiApi->get_version: #{e}"
|
162
|
-
end
|
163
|
-
```
|
164
|
-
|
165
|
-
#### Using the get_version_with_http_info variant
|
166
84
|
|
167
|
-
|
168
|
-
|
169
|
-
|
170
|
-
|
171
|
-
```ruby
|
172
|
-
begin
|
173
|
-
# Get service version
|
174
|
-
data, status_code, headers = api_instance.get_version_with_http_info
|
175
|
-
p status_code # => 2xx
|
176
|
-
p headers # => { ... }
|
177
|
-
p data # => <Version>
|
178
|
-
rescue OryOathkeeperClient::ApiError => e
|
179
|
-
puts "Error when calling ApiApi->get_version_with_http_info: #{e}"
|
180
|
-
end
|
181
|
-
```
|
182
|
-
|
183
|
-
### Parameters
|
184
|
-
|
185
|
-
This endpoint does not need any parameter.
|
85
|
+
Name | Type | Description | Notes
|
86
|
+
------------- | ------------- | ------------- | -------------
|
87
|
+
**id** | **String**| |
|
186
88
|
|
187
89
|
### Return type
|
188
90
|
|
189
|
-
[**
|
91
|
+
[**Rule**](Rule.md)
|
190
92
|
|
191
93
|
### Authorization
|
192
94
|
|
@@ -200,44 +102,26 @@ No authorization required
|
|
200
102
|
|
201
103
|
## get_well_known_json_web_keys
|
202
104
|
|
203
|
-
>
|
105
|
+
> JsonWebKeySet get_well_known_json_web_keys
|
204
106
|
|
205
107
|
Lists cryptographic keys
|
206
108
|
|
207
109
|
This endpoint returns cryptographic keys that are required to, for example, verify signatures of ID Tokens.
|
208
110
|
|
209
|
-
###
|
111
|
+
### Example
|
210
112
|
|
211
113
|
```ruby
|
212
|
-
|
114
|
+
# load the gem
|
213
115
|
require 'ory-oathkeeper-client'
|
214
116
|
|
215
|
-
api_instance =
|
117
|
+
api_instance = OryHydraClient::ApiApi.new
|
216
118
|
|
217
119
|
begin
|
218
|
-
#
|
120
|
+
#Lists cryptographic keys
|
219
121
|
result = api_instance.get_well_known_json_web_keys
|
220
122
|
p result
|
221
|
-
rescue
|
222
|
-
puts "
|
223
|
-
end
|
224
|
-
```
|
225
|
-
|
226
|
-
#### Using the get_well_known_json_web_keys_with_http_info variant
|
227
|
-
|
228
|
-
This returns an Array which contains the response data, status code and headers.
|
229
|
-
|
230
|
-
> <Array(<JsonWebKeySet>, Integer, Hash)> get_well_known_json_web_keys_with_http_info
|
231
|
-
|
232
|
-
```ruby
|
233
|
-
begin
|
234
|
-
# Lists cryptographic keys
|
235
|
-
data, status_code, headers = api_instance.get_well_known_json_web_keys_with_http_info
|
236
|
-
p status_code # => 2xx
|
237
|
-
p headers # => { ... }
|
238
|
-
p data # => <JsonWebKeySet>
|
239
|
-
rescue OryOathkeeperClient::ApiError => e
|
240
|
-
puts "Error when calling ApiApi->get_well_known_json_web_keys_with_http_info: #{e}"
|
123
|
+
rescue OryHydraClient::ApiError => e
|
124
|
+
puts "Exception when calling ApiApi->get_well_known_json_web_keys: #{e}"
|
241
125
|
end
|
242
126
|
```
|
243
127
|
|
@@ -259,181 +143,42 @@ No authorization required
|
|
259
143
|
- **Accept**: application/json
|
260
144
|
|
261
145
|
|
262
|
-
## is_instance_alive
|
263
|
-
|
264
|
-
> <HealthStatus> is_instance_alive
|
265
|
-
|
266
|
-
Check alive status
|
267
|
-
|
268
|
-
This endpoint returns a 200 status code when the HTTP server is up running. This status does currently not include checks whether the database connection is working. If the service supports TLS Edge Termination, this endpoint does not require the `X-Forwarded-Proto` header to be set. Be aware that if you are running multiple nodes of this service, the health status will never refer to the cluster state, only to a single instance.
|
269
|
-
|
270
|
-
### Examples
|
271
|
-
|
272
|
-
```ruby
|
273
|
-
require 'time'
|
274
|
-
require 'ory-oathkeeper-client'
|
275
|
-
|
276
|
-
api_instance = OryOathkeeperClient::ApiApi.new
|
277
|
-
|
278
|
-
begin
|
279
|
-
# Check alive status
|
280
|
-
result = api_instance.is_instance_alive
|
281
|
-
p result
|
282
|
-
rescue OryOathkeeperClient::ApiError => e
|
283
|
-
puts "Error when calling ApiApi->is_instance_alive: #{e}"
|
284
|
-
end
|
285
|
-
```
|
286
|
-
|
287
|
-
#### Using the is_instance_alive_with_http_info variant
|
288
|
-
|
289
|
-
This returns an Array which contains the response data, status code and headers.
|
290
|
-
|
291
|
-
> <Array(<HealthStatus>, Integer, Hash)> is_instance_alive_with_http_info
|
292
|
-
|
293
|
-
```ruby
|
294
|
-
begin
|
295
|
-
# Check alive status
|
296
|
-
data, status_code, headers = api_instance.is_instance_alive_with_http_info
|
297
|
-
p status_code # => 2xx
|
298
|
-
p headers # => { ... }
|
299
|
-
p data # => <HealthStatus>
|
300
|
-
rescue OryOathkeeperClient::ApiError => e
|
301
|
-
puts "Error when calling ApiApi->is_instance_alive_with_http_info: #{e}"
|
302
|
-
end
|
303
|
-
```
|
304
|
-
|
305
|
-
### Parameters
|
306
|
-
|
307
|
-
This endpoint does not need any parameter.
|
308
|
-
|
309
|
-
### Return type
|
310
|
-
|
311
|
-
[**HealthStatus**](HealthStatus.md)
|
312
|
-
|
313
|
-
### Authorization
|
314
|
-
|
315
|
-
No authorization required
|
316
|
-
|
317
|
-
### HTTP request headers
|
318
|
-
|
319
|
-
- **Content-Type**: Not defined
|
320
|
-
- **Accept**: application/json
|
321
|
-
|
322
|
-
|
323
|
-
## is_instance_ready
|
324
|
-
|
325
|
-
> <HealthStatus> is_instance_ready
|
326
|
-
|
327
|
-
Check readiness status
|
328
|
-
|
329
|
-
This endpoint returns a 200 status code when the HTTP server is up running and the environment dependencies (e.g. the database) are responsive as well. If the service supports TLS Edge Termination, this endpoint does not require the `X-Forwarded-Proto` header to be set. Be aware that if you are running multiple nodes of this service, the health status will never refer to the cluster state, only to a single instance.
|
330
|
-
|
331
|
-
### Examples
|
332
|
-
|
333
|
-
```ruby
|
334
|
-
require 'time'
|
335
|
-
require 'ory-oathkeeper-client'
|
336
|
-
|
337
|
-
api_instance = OryOathkeeperClient::ApiApi.new
|
338
|
-
|
339
|
-
begin
|
340
|
-
# Check readiness status
|
341
|
-
result = api_instance.is_instance_ready
|
342
|
-
p result
|
343
|
-
rescue OryOathkeeperClient::ApiError => e
|
344
|
-
puts "Error when calling ApiApi->is_instance_ready: #{e}"
|
345
|
-
end
|
346
|
-
```
|
347
|
-
|
348
|
-
#### Using the is_instance_ready_with_http_info variant
|
349
|
-
|
350
|
-
This returns an Array which contains the response data, status code and headers.
|
351
|
-
|
352
|
-
> <Array(<HealthStatus>, Integer, Hash)> is_instance_ready_with_http_info
|
353
|
-
|
354
|
-
```ruby
|
355
|
-
begin
|
356
|
-
# Check readiness status
|
357
|
-
data, status_code, headers = api_instance.is_instance_ready_with_http_info
|
358
|
-
p status_code # => 2xx
|
359
|
-
p headers # => { ... }
|
360
|
-
p data # => <HealthStatus>
|
361
|
-
rescue OryOathkeeperClient::ApiError => e
|
362
|
-
puts "Error when calling ApiApi->is_instance_ready_with_http_info: #{e}"
|
363
|
-
end
|
364
|
-
```
|
365
|
-
|
366
|
-
### Parameters
|
367
|
-
|
368
|
-
This endpoint does not need any parameter.
|
369
|
-
|
370
|
-
### Return type
|
371
|
-
|
372
|
-
[**HealthStatus**](HealthStatus.md)
|
373
|
-
|
374
|
-
### Authorization
|
375
|
-
|
376
|
-
No authorization required
|
377
|
-
|
378
|
-
### HTTP request headers
|
379
|
-
|
380
|
-
- **Content-Type**: Not defined
|
381
|
-
- **Accept**: application/json
|
382
|
-
|
383
|
-
|
384
146
|
## list_rules
|
385
147
|
|
386
|
-
>
|
148
|
+
> Array<Rule> list_rules(opts)
|
387
149
|
|
388
150
|
List all rules
|
389
151
|
|
390
152
|
This method returns an array of all rules that are stored in the backend. This is useful if you want to get a full view of what rules you have currently in place.
|
391
153
|
|
392
|
-
###
|
154
|
+
### Example
|
393
155
|
|
394
156
|
```ruby
|
395
|
-
|
157
|
+
# load the gem
|
396
158
|
require 'ory-oathkeeper-client'
|
397
159
|
|
398
|
-
api_instance =
|
160
|
+
api_instance = OryHydraClient::ApiApi.new
|
399
161
|
opts = {
|
400
|
-
limit:
|
401
|
-
offset:
|
162
|
+
limit: 56, # Integer | The maximum amount of rules returned.
|
163
|
+
offset: 56 # Integer | The offset from where to start looking.
|
402
164
|
}
|
403
165
|
|
404
166
|
begin
|
405
|
-
#
|
167
|
+
#List all rules
|
406
168
|
result = api_instance.list_rules(opts)
|
407
169
|
p result
|
408
|
-
rescue
|
409
|
-
puts "
|
410
|
-
end
|
411
|
-
```
|
412
|
-
|
413
|
-
#### Using the list_rules_with_http_info variant
|
414
|
-
|
415
|
-
This returns an Array which contains the response data, status code and headers.
|
416
|
-
|
417
|
-
> <Array(<Array<Rule>>, Integer, Hash)> list_rules_with_http_info(opts)
|
418
|
-
|
419
|
-
```ruby
|
420
|
-
begin
|
421
|
-
# List all rules
|
422
|
-
data, status_code, headers = api_instance.list_rules_with_http_info(opts)
|
423
|
-
p status_code # => 2xx
|
424
|
-
p headers # => { ... }
|
425
|
-
p data # => <Array<Rule>>
|
426
|
-
rescue OryOathkeeperClient::ApiError => e
|
427
|
-
puts "Error when calling ApiApi->list_rules_with_http_info: #{e}"
|
170
|
+
rescue OryHydraClient::ApiError => e
|
171
|
+
puts "Exception when calling ApiApi->list_rules: #{e}"
|
428
172
|
end
|
429
173
|
```
|
430
174
|
|
431
175
|
### Parameters
|
432
176
|
|
433
|
-
|
434
|
-
|
435
|
-
|
436
|
-
|
177
|
+
|
178
|
+
Name | Type | Description | Notes
|
179
|
+
------------- | ------------- | ------------- | -------------
|
180
|
+
**limit** | **Integer**| The maximum amount of rules returned. | [optional]
|
181
|
+
**offset** | **Integer**| The offset from where to start looking. | [optional]
|
437
182
|
|
438
183
|
### Return type
|
439
184
|
|