ory-hydra-client 1.9.1 → 1.10.5
Sign up to get free protection for your applications and to get access to all the features.
- checksums.yaml +4 -4
- data/README.md +11 -7
- data/docs/AdminApi.md +32 -22
- data/docs/JsonError.md +24 -0
- data/docs/LogoutRequest.md +4 -0
- data/docs/MetadataApi.md +68 -0
- data/docs/PatchDocument.md +24 -0
- data/docs/PublicApi.md +1 -1
- data/docs/RequestWasHandledResponse.md +18 -0
- data/docs/Volume.md +34 -0
- data/docs/WellKnown.md +2 -0
- data/lib/ory-hydra-client.rb +7 -3
- data/lib/ory-hydra-client/api/admin_api.rb +43 -21
- data/lib/ory-hydra-client/api/metadata_api.rb +77 -0
- data/lib/ory-hydra-client/api/public_api.rb +4 -4
- data/lib/ory-hydra-client/api_client.rb +3 -3
- data/lib/ory-hydra-client/api_error.rb +2 -2
- data/lib/ory-hydra-client/configuration.rb +8 -6
- data/lib/ory-hydra-client/models/accept_consent_request.rb +2 -2
- data/lib/ory-hydra-client/models/accept_login_request.rb +2 -2
- data/lib/ory-hydra-client/models/completed_request.rb +2 -2
- data/lib/ory-hydra-client/models/consent_request.rb +2 -2
- data/lib/ory-hydra-client/models/consent_request_session.rb +2 -2
- data/lib/ory-hydra-client/models/container_wait_ok_body_error.rb +2 -2
- data/lib/ory-hydra-client/models/flush_inactive_o_auth2_tokens_request.rb +2 -2
- data/lib/ory-hydra-client/models/generic_error.rb +2 -2
- data/lib/ory-hydra-client/models/health_not_ready_status.rb +2 -2
- data/lib/ory-hydra-client/models/health_status.rb +2 -2
- data/lib/ory-hydra-client/models/json_error.rb +250 -0
- data/lib/ory-hydra-client/models/json_web_key.rb +2 -2
- data/lib/ory-hydra-client/models/json_web_key_set.rb +2 -2
- data/lib/ory-hydra-client/models/json_web_key_set_generator_request.rb +2 -2
- data/lib/ory-hydra-client/models/login_request.rb +2 -2
- data/lib/ory-hydra-client/models/logout_request.rb +22 -3
- data/lib/ory-hydra-client/models/o_auth2_client.rb +2 -2
- data/lib/ory-hydra-client/models/o_auth2_token_introspection.rb +2 -2
- data/lib/ory-hydra-client/models/oauth2_token_response.rb +2 -2
- data/lib/ory-hydra-client/models/open_id_connect_context.rb +2 -2
- data/lib/ory-hydra-client/models/patch_document.rb +260 -0
- data/lib/ory-hydra-client/models/plugin_config.rb +2 -2
- data/lib/ory-hydra-client/models/plugin_config_args.rb +2 -2
- data/lib/ory-hydra-client/models/plugin_config_interface.rb +2 -2
- data/lib/ory-hydra-client/models/plugin_config_linux.rb +2 -2
- data/lib/ory-hydra-client/models/plugin_config_network.rb +2 -2
- data/lib/ory-hydra-client/models/plugin_config_rootfs.rb +2 -2
- data/lib/ory-hydra-client/models/plugin_config_user.rb +2 -2
- data/lib/ory-hydra-client/models/plugin_device.rb +2 -2
- data/lib/ory-hydra-client/models/plugin_env.rb +2 -2
- data/lib/ory-hydra-client/models/plugin_interface_type.rb +2 -2
- data/lib/ory-hydra-client/models/plugin_mount.rb +2 -2
- data/lib/ory-hydra-client/models/plugin_settings.rb +2 -2
- data/lib/ory-hydra-client/models/previous_consent_session.rb +2 -2
- data/lib/ory-hydra-client/models/reject_request.rb +2 -2
- data/lib/ory-hydra-client/models/request_was_handled_response.rb +224 -0
- data/lib/ory-hydra-client/models/userinfo_response.rb +2 -2
- data/lib/ory-hydra-client/models/version.rb +2 -2
- data/lib/ory-hydra-client/models/volume.rb +333 -0
- data/lib/ory-hydra-client/models/volume_usage_data.rb +2 -2
- data/lib/ory-hydra-client/models/well_known.rb +15 -3
- data/lib/ory-hydra-client/version.rb +3 -3
- data/ory-hydra-client.gemspec +2 -2
- data/spec/api/metadata_api_spec.rb +46 -0
- data/spec/api_client_spec.rb +2 -2
- data/spec/configuration_spec.rb +2 -2
- data/spec/models/json_error_spec.rb +52 -0
- data/spec/models/patch_document_spec.rb +52 -0
- data/spec/models/request_was_handled_response_spec.rb +34 -0
- data/spec/models/volume_spec.rb +82 -0
- data/spec/spec_helper.rb +2 -2
- metadata +50 -30
checksums.yaml
CHANGED
@@ -1,7 +1,7 @@
|
|
1
1
|
---
|
2
2
|
SHA256:
|
3
|
-
metadata.gz:
|
4
|
-
data.tar.gz:
|
3
|
+
metadata.gz: 53b06158f62b00a5a59cf2e1272c0aafc252d57803cebee1e80c66a43503e7e6
|
4
|
+
data.tar.gz: 9a2db4c84485cb1b9c09eed0aae320ab38c39174af0a08d54feccaac6ffd4fd2
|
5
5
|
SHA512:
|
6
|
-
metadata.gz:
|
7
|
-
data.tar.gz:
|
6
|
+
metadata.gz: 6b188df4cd2243c0962221b607eba998952d5b0786e6bf7fbc748435d21b12a41a47b52743c726f99128edb63fc1d18abf44619158c2c9ec423ac4e783666543
|
7
|
+
data.tar.gz: e2f713698e4325eda69a4fae1eeeb1b51c73d4da6af6d4d8e10ba0004d4bbb08634b6c90b3b178bad722d26126a09b14bdebab659099e9c00d21ea19f034658d
|
data/README.md
CHANGED
@@ -6,8 +6,8 @@ Welcome to the ORY Hydra HTTP API documentation. You will find documentation for
|
|
6
6
|
|
7
7
|
This SDK is automatically generated by the [OpenAPI Generator](https://openapi-generator.tech) project:
|
8
8
|
|
9
|
-
- API version: v1.
|
10
|
-
- Package version: v1.
|
9
|
+
- API version: v1.10.5
|
10
|
+
- Package version: v1.10.5
|
11
11
|
- Build package: org.openapitools.codegen.languages.RubyClientCodegen
|
12
12
|
|
13
13
|
## Installation
|
@@ -23,16 +23,16 @@ gem build ory-hydra-client.gemspec
|
|
23
23
|
Then either install the gem locally:
|
24
24
|
|
25
25
|
```shell
|
26
|
-
gem install ./ory-hydra-client-v1.
|
26
|
+
gem install ./ory-hydra-client-v1.10.5.gem
|
27
27
|
```
|
28
28
|
|
29
|
-
(for development, run `gem install --dev ./ory-hydra-client-v1.
|
29
|
+
(for development, run `gem install --dev ./ory-hydra-client-v1.10.5.gem` to install the development dependencies)
|
30
30
|
|
31
31
|
or publish the gem to a gem hosting service, e.g. [RubyGems](https://rubygems.org/).
|
32
32
|
|
33
33
|
Finally add this to the Gemfile:
|
34
34
|
|
35
|
-
gem 'ory-hydra-client', '~> v1.
|
35
|
+
gem 'ory-hydra-client', '~> v1.10.5'
|
36
36
|
|
37
37
|
### Install from Git
|
38
38
|
|
@@ -99,7 +99,7 @@ Class | Method | HTTP request | Description
|
|
99
99
|
*OryHydraClient::AdminApi* | [**is_instance_alive**](docs/AdminApi.md#is_instance_alive) | **GET** /health/alive | Check Alive Status
|
100
100
|
*OryHydraClient::AdminApi* | [**list_o_auth2_clients**](docs/AdminApi.md#list_o_auth2_clients) | **GET** /clients | List OAuth 2.0 Clients
|
101
101
|
*OryHydraClient::AdminApi* | [**list_subject_consent_sessions**](docs/AdminApi.md#list_subject_consent_sessions) | **GET** /oauth2/auth/sessions/consent | Lists All Consent Sessions of a Subject
|
102
|
-
*OryHydraClient::AdminApi* | [**
|
102
|
+
*OryHydraClient::AdminApi* | [**patch_o_auth2_client**](docs/AdminApi.md#patch_o_auth2_client) | **PATCH** /clients/{id} | Patch an OAuth 2.0 Client
|
103
103
|
*OryHydraClient::AdminApi* | [**reject_consent_request**](docs/AdminApi.md#reject_consent_request) | **PUT** /oauth2/auth/requests/consent/reject | Reject a Consent Request
|
104
104
|
*OryHydraClient::AdminApi* | [**reject_login_request**](docs/AdminApi.md#reject_login_request) | **PUT** /oauth2/auth/requests/login/reject | Reject a Login Request
|
105
105
|
*OryHydraClient::AdminApi* | [**reject_logout_request**](docs/AdminApi.md#reject_logout_request) | **PUT** /oauth2/auth/requests/logout/reject | Reject a Logout Request
|
@@ -108,6 +108,7 @@ Class | Method | HTTP request | Description
|
|
108
108
|
*OryHydraClient::AdminApi* | [**update_json_web_key**](docs/AdminApi.md#update_json_web_key) | **PUT** /keys/{set}/{kid} | Update a JSON Web Key
|
109
109
|
*OryHydraClient::AdminApi* | [**update_json_web_key_set**](docs/AdminApi.md#update_json_web_key_set) | **PUT** /keys/{set} | Update a JSON Web Key Set
|
110
110
|
*OryHydraClient::AdminApi* | [**update_o_auth2_client**](docs/AdminApi.md#update_o_auth2_client) | **PUT** /clients/{id} | Update an OAuth 2.0 Client
|
111
|
+
*OryHydraClient::MetadataApi* | [**prometheus**](docs/MetadataApi.md#prometheus) | **GET** /metrics/prometheus | Get snapshot metrics from the service. If you're using k8s, you can then add annotations to your deployment like so:
|
111
112
|
*OryHydraClient::PublicApi* | [**disconnect_user**](docs/PublicApi.md#disconnect_user) | **GET** /oauth2/sessions/logout | OpenID Connect Front-Backchannel Enabled Logout
|
112
113
|
*OryHydraClient::PublicApi* | [**discover_open_id_configuration**](docs/PublicApi.md#discover_open_id_configuration) | **GET** /.well-known/openid-configuration | OpenID Connect Discovery
|
113
114
|
*OryHydraClient::PublicApi* | [**is_instance_ready**](docs/PublicApi.md#is_instance_ready) | **GET** /health/ready | Check Readiness Status
|
@@ -127,11 +128,11 @@ Class | Method | HTTP request | Description
|
|
127
128
|
- [OryHydraClient::ConsentRequestSession](docs/ConsentRequestSession.md)
|
128
129
|
- [OryHydraClient::ContainerWaitOKBodyError](docs/ContainerWaitOKBodyError.md)
|
129
130
|
- [OryHydraClient::FlushInactiveOAuth2TokensRequest](docs/FlushInactiveOAuth2TokensRequest.md)
|
130
|
-
- [OryHydraClient::GenericError](docs/GenericError.md)
|
131
131
|
- [OryHydraClient::HealthNotReadyStatus](docs/HealthNotReadyStatus.md)
|
132
132
|
- [OryHydraClient::HealthStatus](docs/HealthStatus.md)
|
133
133
|
- [OryHydraClient::JSONWebKey](docs/JSONWebKey.md)
|
134
134
|
- [OryHydraClient::JSONWebKeySet](docs/JSONWebKeySet.md)
|
135
|
+
- [OryHydraClient::JsonError](docs/JsonError.md)
|
135
136
|
- [OryHydraClient::JsonWebKeySetGeneratorRequest](docs/JsonWebKeySetGeneratorRequest.md)
|
136
137
|
- [OryHydraClient::LoginRequest](docs/LoginRequest.md)
|
137
138
|
- [OryHydraClient::LogoutRequest](docs/LogoutRequest.md)
|
@@ -139,6 +140,7 @@ Class | Method | HTTP request | Description
|
|
139
140
|
- [OryHydraClient::OAuth2TokenIntrospection](docs/OAuth2TokenIntrospection.md)
|
140
141
|
- [OryHydraClient::Oauth2TokenResponse](docs/Oauth2TokenResponse.md)
|
141
142
|
- [OryHydraClient::OpenIDConnectContext](docs/OpenIDConnectContext.md)
|
143
|
+
- [OryHydraClient::PatchDocument](docs/PatchDocument.md)
|
142
144
|
- [OryHydraClient::PluginConfig](docs/PluginConfig.md)
|
143
145
|
- [OryHydraClient::PluginConfigArgs](docs/PluginConfigArgs.md)
|
144
146
|
- [OryHydraClient::PluginConfigInterface](docs/PluginConfigInterface.md)
|
@@ -153,8 +155,10 @@ Class | Method | HTTP request | Description
|
|
153
155
|
- [OryHydraClient::PluginSettings](docs/PluginSettings.md)
|
154
156
|
- [OryHydraClient::PreviousConsentSession](docs/PreviousConsentSession.md)
|
155
157
|
- [OryHydraClient::RejectRequest](docs/RejectRequest.md)
|
158
|
+
- [OryHydraClient::RequestWasHandledResponse](docs/RequestWasHandledResponse.md)
|
156
159
|
- [OryHydraClient::UserinfoResponse](docs/UserinfoResponse.md)
|
157
160
|
- [OryHydraClient::Version](docs/Version.md)
|
161
|
+
- [OryHydraClient::Volume](docs/Volume.md)
|
158
162
|
- [OryHydraClient::VolumeUsageData](docs/VolumeUsageData.md)
|
159
163
|
- [OryHydraClient::WellKnown](docs/WellKnown.md)
|
160
164
|
|
data/docs/AdminApi.md
CHANGED
@@ -25,7 +25,7 @@ All URIs are relative to *http://localhost*
|
|
25
25
|
| [**is_instance_alive**](AdminApi.md#is_instance_alive) | **GET** /health/alive | Check Alive Status |
|
26
26
|
| [**list_o_auth2_clients**](AdminApi.md#list_o_auth2_clients) | **GET** /clients | List OAuth 2.0 Clients |
|
27
27
|
| [**list_subject_consent_sessions**](AdminApi.md#list_subject_consent_sessions) | **GET** /oauth2/auth/sessions/consent | Lists All Consent Sessions of a Subject |
|
28
|
-
| [**
|
28
|
+
| [**patch_o_auth2_client**](AdminApi.md#patch_o_auth2_client) | **PATCH** /clients/{id} | Patch an OAuth 2.0 Client |
|
29
29
|
| [**reject_consent_request**](AdminApi.md#reject_consent_request) | **PUT** /oauth2/auth/requests/consent/reject | Reject a Consent Request |
|
30
30
|
| [**reject_login_request**](AdminApi.md#reject_login_request) | **PUT** /oauth2/auth/requests/login/reject | Reject a Login Request |
|
31
31
|
| [**reject_logout_request**](AdminApi.md#reject_logout_request) | **PUT** /oauth2/auth/requests/logout/reject | Reject a Logout Request |
|
@@ -1279,8 +1279,10 @@ require 'ory-hydra-client'
|
|
1279
1279
|
|
1280
1280
|
api_instance = OryHydraClient::AdminApi.new
|
1281
1281
|
opts = {
|
1282
|
-
limit: 789, # Integer | The maximum amount of
|
1283
|
-
offset: 789 # Integer | The offset from where to start looking.
|
1282
|
+
limit: 789, # Integer | The maximum amount of clients to returned, upper bound is 500 clients.
|
1283
|
+
offset: 789, # Integer | The offset from where to start looking.
|
1284
|
+
name: 'name_example', # String | The name of the clients to filter by.
|
1285
|
+
owner: 'owner_example' # String | The owner of the clients to filter by.
|
1284
1286
|
}
|
1285
1287
|
|
1286
1288
|
begin
|
@@ -1314,8 +1316,10 @@ end
|
|
1314
1316
|
|
1315
1317
|
| Name | Type | Description | Notes |
|
1316
1318
|
| ---- | ---- | ----------- | ----- |
|
1317
|
-
| **limit** | **Integer** | The maximum amount of
|
1319
|
+
| **limit** | **Integer** | The maximum amount of clients to returned, upper bound is 500 clients. | [optional] |
|
1318
1320
|
| **offset** | **Integer** | The offset from where to start looking. | [optional] |
|
1321
|
+
| **name** | **String** | The name of the clients to filter by. | [optional] |
|
1322
|
+
| **owner** | **String** | The owner of the clients to filter by. | [optional] |
|
1319
1323
|
|
1320
1324
|
### Return type
|
1321
1325
|
|
@@ -1395,13 +1399,13 @@ No authorization required
|
|
1395
1399
|
- **Accept**: application/json
|
1396
1400
|
|
1397
1401
|
|
1398
|
-
##
|
1402
|
+
## patch_o_auth2_client
|
1399
1403
|
|
1400
|
-
>
|
1404
|
+
> <OAuth2Client> patch_o_auth2_client(id, body)
|
1401
1405
|
|
1402
|
-
|
1406
|
+
Patch an OAuth 2.0 Client
|
1403
1407
|
|
1404
|
-
If you
|
1408
|
+
Patch an existing OAuth 2.0 Client. If you pass `client_secret` the secret will be updated and returned via the API. This is the only time you will be able to retrieve the client secret, so write it down and keep it safe. OAuth 2.0 clients are used to perform OAuth 2.0 and OpenID Connect flows. Usually, OAuth 2.0 clients are generated for applications which want to consume your OAuth 2.0 or OpenID Connect capabilities. To manage ORY Hydra, you will need an OAuth 2.0 Client as well. Make sure that this endpoint is well protected and only callable by first-party components.
|
1405
1409
|
|
1406
1410
|
### Examples
|
1407
1411
|
|
@@ -1410,40 +1414,46 @@ require 'time'
|
|
1410
1414
|
require 'ory-hydra-client'
|
1411
1415
|
|
1412
1416
|
api_instance = OryHydraClient::AdminApi.new
|
1417
|
+
id = 'id_example' # String |
|
1418
|
+
body = [OryHydraClient::PatchDocument.new({op: '"replace"', path: '"/name"'})] # Array<PatchDocument> |
|
1413
1419
|
|
1414
1420
|
begin
|
1415
|
-
#
|
1416
|
-
api_instance.
|
1421
|
+
# Patch an OAuth 2.0 Client
|
1422
|
+
result = api_instance.patch_o_auth2_client(id, body)
|
1423
|
+
p result
|
1417
1424
|
rescue OryHydraClient::ApiError => e
|
1418
|
-
puts "Error when calling AdminApi->
|
1425
|
+
puts "Error when calling AdminApi->patch_o_auth2_client: #{e}"
|
1419
1426
|
end
|
1420
1427
|
```
|
1421
1428
|
|
1422
|
-
#### Using the
|
1429
|
+
#### Using the patch_o_auth2_client_with_http_info variant
|
1423
1430
|
|
1424
|
-
This returns an Array which contains the response data
|
1431
|
+
This returns an Array which contains the response data, status code and headers.
|
1425
1432
|
|
1426
|
-
> <Array(
|
1433
|
+
> <Array(<OAuth2Client>, Integer, Hash)> patch_o_auth2_client_with_http_info(id, body)
|
1427
1434
|
|
1428
1435
|
```ruby
|
1429
1436
|
begin
|
1430
|
-
#
|
1431
|
-
data, status_code, headers = api_instance.
|
1437
|
+
# Patch an OAuth 2.0 Client
|
1438
|
+
data, status_code, headers = api_instance.patch_o_auth2_client_with_http_info(id, body)
|
1432
1439
|
p status_code # => 2xx
|
1433
1440
|
p headers # => { ... }
|
1434
|
-
p data # =>
|
1441
|
+
p data # => <OAuth2Client>
|
1435
1442
|
rescue OryHydraClient::ApiError => e
|
1436
|
-
puts "Error when calling AdminApi->
|
1443
|
+
puts "Error when calling AdminApi->patch_o_auth2_client_with_http_info: #{e}"
|
1437
1444
|
end
|
1438
1445
|
```
|
1439
1446
|
|
1440
1447
|
### Parameters
|
1441
1448
|
|
1442
|
-
|
1449
|
+
| Name | Type | Description | Notes |
|
1450
|
+
| ---- | ---- | ----------- | ----- |
|
1451
|
+
| **id** | **String** | | |
|
1452
|
+
| **body** | [**Array<PatchDocument>**](PatchDocument.md) | | |
|
1443
1453
|
|
1444
1454
|
### Return type
|
1445
1455
|
|
1446
|
-
|
1456
|
+
[**OAuth2Client**](OAuth2Client.md)
|
1447
1457
|
|
1448
1458
|
### Authorization
|
1449
1459
|
|
@@ -1451,8 +1461,8 @@ No authorization required
|
|
1451
1461
|
|
1452
1462
|
### HTTP request headers
|
1453
1463
|
|
1454
|
-
- **Content-Type**:
|
1455
|
-
- **Accept**:
|
1464
|
+
- **Content-Type**: application/json
|
1465
|
+
- **Accept**: application/json
|
1456
1466
|
|
1457
1467
|
|
1458
1468
|
## reject_consent_request
|
data/docs/JsonError.md
ADDED
@@ -0,0 +1,24 @@
|
|
1
|
+
# OryHydraClient::JsonError
|
2
|
+
|
3
|
+
## Properties
|
4
|
+
|
5
|
+
| Name | Type | Description | Notes |
|
6
|
+
| ---- | ---- | ----------- | ----- |
|
7
|
+
| **error** | **String** | Name is the error name. | [optional] |
|
8
|
+
| **error_debug** | **String** | Debug contains debug information. This is usually not available and has to be enabled. | [optional] |
|
9
|
+
| **error_description** | **String** | Description contains further information on the nature of the error. | [optional] |
|
10
|
+
| **status_code** | **Integer** | Code represents the error status code (404, 403, 401, ...). | [optional] |
|
11
|
+
|
12
|
+
## Example
|
13
|
+
|
14
|
+
```ruby
|
15
|
+
require 'ory-hydra-client'
|
16
|
+
|
17
|
+
instance = OryHydraClient::JsonError.new(
|
18
|
+
error: The requested resource could not be found,
|
19
|
+
error_debug: The database adapter was unable to find the element,
|
20
|
+
error_description: Object with ID 12345 does not exist,
|
21
|
+
status_code: 404
|
22
|
+
)
|
23
|
+
```
|
24
|
+
|
data/docs/LogoutRequest.md
CHANGED
@@ -4,6 +4,8 @@
|
|
4
4
|
|
5
5
|
| Name | Type | Description | Notes |
|
6
6
|
| ---- | ---- | ----------- | ----- |
|
7
|
+
| **challenge** | **String** | Challenge is the identifier (\"logout challenge\") of the logout authentication request. It is used to identify the session. | [optional] |
|
8
|
+
| **client** | [**OAuth2Client**](OAuth2Client.md) | | [optional] |
|
7
9
|
| **request_url** | **String** | RequestURL is the original Logout URL requested. | [optional] |
|
8
10
|
| **rp_initiated** | **Boolean** | RPInitiated is set to true if the request was initiated by a Relying Party (RP), also known as an OAuth 2.0 Client. | [optional] |
|
9
11
|
| **sid** | **String** | SessionID is the login session ID that was requested to log out. | [optional] |
|
@@ -15,6 +17,8 @@
|
|
15
17
|
require 'ory-hydra-client'
|
16
18
|
|
17
19
|
instance = OryHydraClient::LogoutRequest.new(
|
20
|
+
challenge: null,
|
21
|
+
client: null,
|
18
22
|
request_url: null,
|
19
23
|
rp_initiated: null,
|
20
24
|
sid: null,
|
data/docs/MetadataApi.md
ADDED
@@ -0,0 +1,68 @@
|
|
1
|
+
# OryHydraClient::MetadataApi
|
2
|
+
|
3
|
+
All URIs are relative to *http://localhost*
|
4
|
+
|
5
|
+
| Method | HTTP request | Description |
|
6
|
+
| ------ | ------------ | ----------- |
|
7
|
+
| [**prometheus**](MetadataApi.md#prometheus) | **GET** /metrics/prometheus | Get snapshot metrics from the service. If you're using k8s, you can then add annotations to your deployment like so: |
|
8
|
+
|
9
|
+
|
10
|
+
## prometheus
|
11
|
+
|
12
|
+
> prometheus
|
13
|
+
|
14
|
+
Get snapshot metrics from the service. If you're using k8s, you can then add annotations to your deployment like so:
|
15
|
+
|
16
|
+
``` metadata: annotations: prometheus.io/port: \"4434\" prometheus.io/path: \"/metrics/prometheus\" ```
|
17
|
+
|
18
|
+
### Examples
|
19
|
+
|
20
|
+
```ruby
|
21
|
+
require 'time'
|
22
|
+
require 'ory-hydra-client'
|
23
|
+
|
24
|
+
api_instance = OryHydraClient::MetadataApi.new
|
25
|
+
|
26
|
+
begin
|
27
|
+
# Get snapshot metrics from the service. If you're using k8s, you can then add annotations to your deployment like so:
|
28
|
+
api_instance.prometheus
|
29
|
+
rescue OryHydraClient::ApiError => e
|
30
|
+
puts "Error when calling MetadataApi->prometheus: #{e}"
|
31
|
+
end
|
32
|
+
```
|
33
|
+
|
34
|
+
#### Using the prometheus_with_http_info variant
|
35
|
+
|
36
|
+
This returns an Array which contains the response data (`nil` in this case), status code and headers.
|
37
|
+
|
38
|
+
> <Array(nil, Integer, Hash)> prometheus_with_http_info
|
39
|
+
|
40
|
+
```ruby
|
41
|
+
begin
|
42
|
+
# Get snapshot metrics from the service. If you're using k8s, you can then add annotations to your deployment like so:
|
43
|
+
data, status_code, headers = api_instance.prometheus_with_http_info
|
44
|
+
p status_code # => 2xx
|
45
|
+
p headers # => { ... }
|
46
|
+
p data # => nil
|
47
|
+
rescue OryHydraClient::ApiError => e
|
48
|
+
puts "Error when calling MetadataApi->prometheus_with_http_info: #{e}"
|
49
|
+
end
|
50
|
+
```
|
51
|
+
|
52
|
+
### Parameters
|
53
|
+
|
54
|
+
This endpoint does not need any parameter.
|
55
|
+
|
56
|
+
### Return type
|
57
|
+
|
58
|
+
nil (empty response body)
|
59
|
+
|
60
|
+
### Authorization
|
61
|
+
|
62
|
+
No authorization required
|
63
|
+
|
64
|
+
### HTTP request headers
|
65
|
+
|
66
|
+
- **Content-Type**: Not defined
|
67
|
+
- **Accept**: Not defined
|
68
|
+
|
@@ -0,0 +1,24 @@
|
|
1
|
+
# OryHydraClient::PatchDocument
|
2
|
+
|
3
|
+
## Properties
|
4
|
+
|
5
|
+
| Name | Type | Description | Notes |
|
6
|
+
| ---- | ---- | ----------- | ----- |
|
7
|
+
| **from** | **String** | A JSON-pointer | [optional] |
|
8
|
+
| **op** | **String** | The operation to be performed | |
|
9
|
+
| **path** | **String** | A JSON-pointer | |
|
10
|
+
| **value** | **Object** | The value to be used within the operations | [optional] |
|
11
|
+
|
12
|
+
## Example
|
13
|
+
|
14
|
+
```ruby
|
15
|
+
require 'ory-hydra-client'
|
16
|
+
|
17
|
+
instance = OryHydraClient::PatchDocument.new(
|
18
|
+
from: null,
|
19
|
+
op: "replace",
|
20
|
+
path: "/name",
|
21
|
+
value: null
|
22
|
+
)
|
23
|
+
```
|
24
|
+
|
data/docs/PublicApi.md
CHANGED
@@ -417,7 +417,7 @@ nil (empty response body)
|
|
417
417
|
|
418
418
|
OpenID Connect Userinfo
|
419
419
|
|
420
|
-
This endpoint returns the payload of the ID Token, including the idTokenExtra values, of the provided OAuth 2.0 Access Token. For more information please [refer to the spec](http://openid.net/specs/openid-connect-core-1_0.html#UserInfo).
|
420
|
+
This endpoint returns the payload of the ID Token, including the idTokenExtra values, of the provided OAuth 2.0 Access Token. For more information please [refer to the spec](http://openid.net/specs/openid-connect-core-1_0.html#UserInfo). In the case of authentication error, a WWW-Authenticate header might be set in the response with more information about the error. See [the spec](https://datatracker.ietf.org/doc/html/rfc6750#section-3) for more details about header format.
|
421
421
|
|
422
422
|
### Examples
|
423
423
|
|
@@ -0,0 +1,18 @@
|
|
1
|
+
# OryHydraClient::RequestWasHandledResponse
|
2
|
+
|
3
|
+
## Properties
|
4
|
+
|
5
|
+
| Name | Type | Description | Notes |
|
6
|
+
| ---- | ---- | ----------- | ----- |
|
7
|
+
| **redirect_to** | **String** | Original request URL to which you should redirect the user if request was already handled. | |
|
8
|
+
|
9
|
+
## Example
|
10
|
+
|
11
|
+
```ruby
|
12
|
+
require 'ory-hydra-client'
|
13
|
+
|
14
|
+
instance = OryHydraClient::RequestWasHandledResponse.new(
|
15
|
+
redirect_to: null
|
16
|
+
)
|
17
|
+
```
|
18
|
+
|
data/docs/Volume.md
ADDED
@@ -0,0 +1,34 @@
|
|
1
|
+
# OryHydraClient::Volume
|
2
|
+
|
3
|
+
## Properties
|
4
|
+
|
5
|
+
| Name | Type | Description | Notes |
|
6
|
+
| ---- | ---- | ----------- | ----- |
|
7
|
+
| **created_at** | **String** | Date/Time the volume was created. | [optional] |
|
8
|
+
| **driver** | **String** | Name of the volume driver used by the volume. | |
|
9
|
+
| **labels** | **Hash<String, String>** | User-defined key/value metadata. | |
|
10
|
+
| **mountpoint** | **String** | Mount path of the volume on the host. | |
|
11
|
+
| **name** | **String** | Name of the volume. | |
|
12
|
+
| **options** | **Hash<String, String>** | The driver specific options used when creating the volume. | |
|
13
|
+
| **scope** | **String** | The level at which the volume exists. Either `global` for cluster-wide, or `local` for machine level. | |
|
14
|
+
| **status** | **Object** | Low-level details about the volume, provided by the volume driver. Details are returned as a map with key/value pairs: `{\"key\":\"value\",\"key2\":\"value2\"}`. The `Status` field is optional, and is omitted if the volume driver does not support this feature. | [optional] |
|
15
|
+
| **usage_data** | [**VolumeUsageData**](VolumeUsageData.md) | | [optional] |
|
16
|
+
|
17
|
+
## Example
|
18
|
+
|
19
|
+
```ruby
|
20
|
+
require 'ory-hydra-client'
|
21
|
+
|
22
|
+
instance = OryHydraClient::Volume.new(
|
23
|
+
created_at: null,
|
24
|
+
driver: null,
|
25
|
+
labels: null,
|
26
|
+
mountpoint: null,
|
27
|
+
name: null,
|
28
|
+
options: null,
|
29
|
+
scope: null,
|
30
|
+
status: null,
|
31
|
+
usage_data: null
|
32
|
+
)
|
33
|
+
```
|
34
|
+
|
data/docs/WellKnown.md
CHANGED
@@ -9,6 +9,7 @@
|
|
9
9
|
| **backchannel_logout_supported** | **Boolean** | Boolean value specifying whether the OP supports back-channel logout, with true indicating support. | [optional] |
|
10
10
|
| **claims_parameter_supported** | **Boolean** | Boolean value specifying whether the OP supports use of the claims parameter, with true indicating support. | [optional] |
|
11
11
|
| **claims_supported** | **Array<String>** | JSON array containing a list of the Claim Names of the Claims that the OpenID Provider MAY be able to supply values for. Note that for privacy or other reasons, this might not be an exhaustive list. | [optional] |
|
12
|
+
| **code_challenge_methods_supported** | **Array<String>** | JSON array containing a list of Proof Key for Code Exchange (PKCE) [RFC7636] code challenge methods supported by this authorization server. | [optional] |
|
12
13
|
| **end_session_endpoint** | **String** | URL at the OP to which an RP can perform a redirect to request that the End-User be logged out at the OP. | [optional] |
|
13
14
|
| **frontchannel_logout_session_supported** | **Boolean** | Boolean value specifying whether the OP can pass iss (issuer) and sid (session ID) query parameters to identify the RP session with the OP when the frontchannel_logout_uri is used. If supported, the sid Claim is also included in ID Tokens issued by the OP. | [optional] |
|
14
15
|
| **frontchannel_logout_supported** | **Boolean** | Boolean value specifying whether the OP supports HTTP-based logout, with true indicating support. | [optional] |
|
@@ -42,6 +43,7 @@ instance = OryHydraClient::WellKnown.new(
|
|
42
43
|
backchannel_logout_supported: null,
|
43
44
|
claims_parameter_supported: null,
|
44
45
|
claims_supported: null,
|
46
|
+
code_challenge_methods_supported: null,
|
45
47
|
end_session_endpoint: null,
|
46
48
|
frontchannel_logout_session_supported: null,
|
47
49
|
frontchannel_logout_supported: null,
|
data/lib/ory-hydra-client.rb
CHANGED
@@ -3,10 +3,10 @@
|
|
3
3
|
|
4
4
|
#Welcome to the ORY Hydra HTTP API documentation. You will find documentation for all HTTP APIs here.
|
5
5
|
|
6
|
-
The version of the OpenAPI document: v1.
|
6
|
+
The version of the OpenAPI document: v1.10.5
|
7
7
|
|
8
8
|
Generated by: https://openapi-generator.tech
|
9
|
-
OpenAPI Generator version: 5.
|
9
|
+
OpenAPI Generator version: 5.1.1
|
10
10
|
|
11
11
|
=end
|
12
12
|
|
@@ -24,11 +24,11 @@ require 'ory-hydra-client/models/consent_request'
|
|
24
24
|
require 'ory-hydra-client/models/consent_request_session'
|
25
25
|
require 'ory-hydra-client/models/container_wait_ok_body_error'
|
26
26
|
require 'ory-hydra-client/models/flush_inactive_o_auth2_tokens_request'
|
27
|
-
require 'ory-hydra-client/models/generic_error'
|
28
27
|
require 'ory-hydra-client/models/health_not_ready_status'
|
29
28
|
require 'ory-hydra-client/models/health_status'
|
30
29
|
require 'ory-hydra-client/models/json_web_key'
|
31
30
|
require 'ory-hydra-client/models/json_web_key_set'
|
31
|
+
require 'ory-hydra-client/models/json_error'
|
32
32
|
require 'ory-hydra-client/models/json_web_key_set_generator_request'
|
33
33
|
require 'ory-hydra-client/models/login_request'
|
34
34
|
require 'ory-hydra-client/models/logout_request'
|
@@ -36,6 +36,7 @@ require 'ory-hydra-client/models/o_auth2_client'
|
|
36
36
|
require 'ory-hydra-client/models/o_auth2_token_introspection'
|
37
37
|
require 'ory-hydra-client/models/oauth2_token_response'
|
38
38
|
require 'ory-hydra-client/models/open_id_connect_context'
|
39
|
+
require 'ory-hydra-client/models/patch_document'
|
39
40
|
require 'ory-hydra-client/models/plugin_config'
|
40
41
|
require 'ory-hydra-client/models/plugin_config_args'
|
41
42
|
require 'ory-hydra-client/models/plugin_config_interface'
|
@@ -50,13 +51,16 @@ require 'ory-hydra-client/models/plugin_mount'
|
|
50
51
|
require 'ory-hydra-client/models/plugin_settings'
|
51
52
|
require 'ory-hydra-client/models/previous_consent_session'
|
52
53
|
require 'ory-hydra-client/models/reject_request'
|
54
|
+
require 'ory-hydra-client/models/request_was_handled_response'
|
53
55
|
require 'ory-hydra-client/models/userinfo_response'
|
54
56
|
require 'ory-hydra-client/models/version'
|
57
|
+
require 'ory-hydra-client/models/volume'
|
55
58
|
require 'ory-hydra-client/models/volume_usage_data'
|
56
59
|
require 'ory-hydra-client/models/well_known'
|
57
60
|
|
58
61
|
# APIs
|
59
62
|
require 'ory-hydra-client/api/admin_api'
|
63
|
+
require 'ory-hydra-client/api/metadata_api'
|
60
64
|
require 'ory-hydra-client/api/public_api'
|
61
65
|
|
62
66
|
module OryHydraClient
|