ory-hydra-client 1.10.3 → 1.10.5

Sign up to get free protection for your applications and to get access to all the features.
Files changed (67) hide show
  1. checksums.yaml +4 -4
  2. data/README.md +7 -7
  3. data/docs/AdminApi.md +7 -64
  4. data/docs/JsonError.md +24 -0
  5. data/docs/LogoutRequest.md +2 -0
  6. data/docs/MetadataApi.md +68 -0
  7. data/docs/PublicApi.md +1 -1
  8. data/docs/WellKnown.md +2 -0
  9. data/lib/ory-hydra-client.rb +3 -2
  10. data/lib/ory-hydra-client/api/admin_api.rb +9 -58
  11. data/lib/ory-hydra-client/api/metadata_api.rb +77 -0
  12. data/lib/ory-hydra-client/api/public_api.rb +3 -3
  13. data/lib/ory-hydra-client/api_client.rb +1 -1
  14. data/lib/ory-hydra-client/api_error.rb +1 -1
  15. data/lib/ory-hydra-client/configuration.rb +1 -1
  16. data/lib/ory-hydra-client/models/accept_consent_request.rb +1 -1
  17. data/lib/ory-hydra-client/models/accept_login_request.rb +1 -1
  18. data/lib/ory-hydra-client/models/completed_request.rb +1 -1
  19. data/lib/ory-hydra-client/models/consent_request.rb +1 -1
  20. data/lib/ory-hydra-client/models/consent_request_session.rb +1 -1
  21. data/lib/ory-hydra-client/models/container_wait_ok_body_error.rb +1 -1
  22. data/lib/ory-hydra-client/models/flush_inactive_o_auth2_tokens_request.rb +1 -1
  23. data/lib/ory-hydra-client/models/generic_error.rb +1 -1
  24. data/lib/ory-hydra-client/models/health_not_ready_status.rb +1 -1
  25. data/lib/ory-hydra-client/models/health_status.rb +1 -1
  26. data/lib/ory-hydra-client/models/json_error.rb +250 -0
  27. data/lib/ory-hydra-client/models/json_web_key.rb +1 -1
  28. data/lib/ory-hydra-client/models/json_web_key_set.rb +1 -1
  29. data/lib/ory-hydra-client/models/json_web_key_set_generator_request.rb +1 -1
  30. data/lib/ory-hydra-client/models/login_request.rb +1 -1
  31. data/lib/ory-hydra-client/models/logout_request.rb +11 -2
  32. data/lib/ory-hydra-client/models/o_auth2_client.rb +1 -1
  33. data/lib/ory-hydra-client/models/o_auth2_token_introspection.rb +1 -1
  34. data/lib/ory-hydra-client/models/oauth2_token_response.rb +1 -1
  35. data/lib/ory-hydra-client/models/open_id_connect_context.rb +1 -1
  36. data/lib/ory-hydra-client/models/patch_document.rb +1 -1
  37. data/lib/ory-hydra-client/models/plugin_config.rb +1 -1
  38. data/lib/ory-hydra-client/models/plugin_config_args.rb +1 -1
  39. data/lib/ory-hydra-client/models/plugin_config_interface.rb +1 -1
  40. data/lib/ory-hydra-client/models/plugin_config_linux.rb +1 -1
  41. data/lib/ory-hydra-client/models/plugin_config_network.rb +1 -1
  42. data/lib/ory-hydra-client/models/plugin_config_rootfs.rb +1 -1
  43. data/lib/ory-hydra-client/models/plugin_config_user.rb +1 -1
  44. data/lib/ory-hydra-client/models/plugin_device.rb +1 -1
  45. data/lib/ory-hydra-client/models/plugin_env.rb +1 -1
  46. data/lib/ory-hydra-client/models/plugin_interface_type.rb +1 -1
  47. data/lib/ory-hydra-client/models/plugin_mount.rb +1 -1
  48. data/lib/ory-hydra-client/models/plugin_settings.rb +1 -1
  49. data/lib/ory-hydra-client/models/previous_consent_session.rb +1 -1
  50. data/lib/ory-hydra-client/models/reject_request.rb +1 -1
  51. data/lib/ory-hydra-client/models/request_was_handled_response.rb +1 -1
  52. data/lib/ory-hydra-client/models/userinfo_response.rb +1 -1
  53. data/lib/ory-hydra-client/models/version.rb +1 -1
  54. data/lib/ory-hydra-client/models/volume.rb +1 -1
  55. data/lib/ory-hydra-client/models/volume_usage_data.rb +1 -1
  56. data/lib/ory-hydra-client/models/well_known.rb +14 -2
  57. data/lib/ory-hydra-client/version.rb +2 -2
  58. data/ory-hydra-client.gemspec +1 -1
  59. data/spec/api/metadata_api_spec.rb +46 -0
  60. data/spec/api_client_spec.rb +1 -1
  61. data/spec/configuration_spec.rb +1 -1
  62. data/spec/models/json_error_spec.rb +52 -0
  63. data/spec/models/patch_document_spec.rb +1 -1
  64. data/spec/models/request_was_handled_response_spec.rb +1 -1
  65. data/spec/models/volume_spec.rb +1 -1
  66. data/spec/spec_helper.rb +1 -1
  67. metadata +13 -5
checksums.yaml CHANGED
@@ -1,7 +1,7 @@
1
1
  ---
2
2
  SHA256:
3
- metadata.gz: 1efb3a82132599def96fdfc67c815fbd7b4ef02eadf8af2dafee974645940aa1
4
- data.tar.gz: 791e34b0dc8bfc819c4899eeffa13b44ece11192e96b4aa33a8a9444b854dd13
3
+ metadata.gz: 53b06158f62b00a5a59cf2e1272c0aafc252d57803cebee1e80c66a43503e7e6
4
+ data.tar.gz: 9a2db4c84485cb1b9c09eed0aae320ab38c39174af0a08d54feccaac6ffd4fd2
5
5
  SHA512:
6
- metadata.gz: 4ca26f02b1e07372b0dbfd43b098aa9636c687b9878897432b101abc65d7367f91f7ead11205ee9722f9ca4edcfb880da5b8905a26a2801c2de1db51b07251cd
7
- data.tar.gz: bb980cb227f164d85427c52be786cffd5fb9ab8bb02efb02262deca8a2379eeb6ca2c4887b918d9a9b6d6d4b82062a11dc2838f1bd601be252c8bc86d2dcfa9b
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.3
10
- - Package version: v1.10.3
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.10.3.gem
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.10.3.gem` to install the development dependencies)
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.10.3'
35
+ gem 'ory-hydra-client', '~> v1.10.5'
36
36
 
37
37
  ### Install from Git
38
38
 
@@ -100,7 +100,6 @@ Class | Method | HTTP request | Description
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
102
  *OryHydraClient::AdminApi* | [**patch_o_auth2_client**](docs/AdminApi.md#patch_o_auth2_client) | **PATCH** /clients/{id} | Patch an OAuth 2.0 Client
103
- *OryHydraClient::AdminApi* | [**prometheus**](docs/AdminApi.md#prometheus) | **GET** /metrics/prometheus | Get Snapshot Metrics from the Hydra Service.
104
103
  *OryHydraClient::AdminApi* | [**reject_consent_request**](docs/AdminApi.md#reject_consent_request) | **PUT** /oauth2/auth/requests/consent/reject | Reject a Consent Request
105
104
  *OryHydraClient::AdminApi* | [**reject_login_request**](docs/AdminApi.md#reject_login_request) | **PUT** /oauth2/auth/requests/login/reject | Reject a Login Request
106
105
  *OryHydraClient::AdminApi* | [**reject_logout_request**](docs/AdminApi.md#reject_logout_request) | **PUT** /oauth2/auth/requests/logout/reject | Reject a Logout Request
@@ -109,6 +108,7 @@ Class | Method | HTTP request | Description
109
108
  *OryHydraClient::AdminApi* | [**update_json_web_key**](docs/AdminApi.md#update_json_web_key) | **PUT** /keys/{set}/{kid} | Update a JSON Web Key
110
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
111
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:
112
112
  *OryHydraClient::PublicApi* | [**disconnect_user**](docs/PublicApi.md#disconnect_user) | **GET** /oauth2/sessions/logout | OpenID Connect Front-Backchannel Enabled Logout
113
113
  *OryHydraClient::PublicApi* | [**discover_open_id_configuration**](docs/PublicApi.md#discover_open_id_configuration) | **GET** /.well-known/openid-configuration | OpenID Connect Discovery
114
114
  *OryHydraClient::PublicApi* | [**is_instance_ready**](docs/PublicApi.md#is_instance_ready) | **GET** /health/ready | Check Readiness Status
@@ -128,11 +128,11 @@ Class | Method | HTTP request | Description
128
128
  - [OryHydraClient::ConsentRequestSession](docs/ConsentRequestSession.md)
129
129
  - [OryHydraClient::ContainerWaitOKBodyError](docs/ContainerWaitOKBodyError.md)
130
130
  - [OryHydraClient::FlushInactiveOAuth2TokensRequest](docs/FlushInactiveOAuth2TokensRequest.md)
131
- - [OryHydraClient::GenericError](docs/GenericError.md)
132
131
  - [OryHydraClient::HealthNotReadyStatus](docs/HealthNotReadyStatus.md)
133
132
  - [OryHydraClient::HealthStatus](docs/HealthStatus.md)
134
133
  - [OryHydraClient::JSONWebKey](docs/JSONWebKey.md)
135
134
  - [OryHydraClient::JSONWebKeySet](docs/JSONWebKeySet.md)
135
+ - [OryHydraClient::JsonError](docs/JsonError.md)
136
136
  - [OryHydraClient::JsonWebKeySetGeneratorRequest](docs/JsonWebKeySetGeneratorRequest.md)
137
137
  - [OryHydraClient::LoginRequest](docs/LoginRequest.md)
138
138
  - [OryHydraClient::LogoutRequest](docs/LogoutRequest.md)
data/docs/AdminApi.md CHANGED
@@ -26,7 +26,6 @@ All URIs are relative to *http://localhost*
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
- | [**prometheus**](AdminApi.md#prometheus) | **GET** /metrics/prometheus | Get Snapshot Metrics from the Hydra Service. |
30
29
  | [**reject_consent_request**](AdminApi.md#reject_consent_request) | **PUT** /oauth2/auth/requests/consent/reject | Reject a Consent Request |
31
30
  | [**reject_login_request**](AdminApi.md#reject_login_request) | **PUT** /oauth2/auth/requests/login/reject | Reject a Login Request |
32
31
  | [**reject_logout_request**](AdminApi.md#reject_logout_request) | **PUT** /oauth2/auth/requests/logout/reject | Reject a Logout Request |
@@ -1280,8 +1279,10 @@ require 'ory-hydra-client'
1280
1279
 
1281
1280
  api_instance = OryHydraClient::AdminApi.new
1282
1281
  opts = {
1283
- limit: 789, # Integer | The maximum amount of policies returned, upper bound is 500 policies
1284
- 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.
1285
1286
  }
1286
1287
 
1287
1288
  begin
@@ -1315,8 +1316,10 @@ end
1315
1316
 
1316
1317
  | Name | Type | Description | Notes |
1317
1318
  | ---- | ---- | ----------- | ----- |
1318
- | **limit** | **Integer** | The maximum amount of policies returned, upper bound is 500 policies | [optional] |
1319
+ | **limit** | **Integer** | The maximum amount of clients to returned, upper bound is 500 clients. | [optional] |
1319
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] |
1320
1323
 
1321
1324
  ### Return type
1322
1325
 
@@ -1462,66 +1465,6 @@ No authorization required
1462
1465
  - **Accept**: application/json
1463
1466
 
1464
1467
 
1465
- ## prometheus
1466
-
1467
- > prometheus
1468
-
1469
- Get Snapshot Metrics from the Hydra Service.
1470
-
1471
- If you're using k8s, you can then add annotations to your deployment like so: ``` metadata: annotations: prometheus.io/port: \"4445\" prometheus.io/path: \"/metrics/prometheus\" ``` If the service supports TLS Edge Termination, this endpoint does not require the `X-Forwarded-Proto` header to be set.
1472
-
1473
- ### Examples
1474
-
1475
- ```ruby
1476
- require 'time'
1477
- require 'ory-hydra-client'
1478
-
1479
- api_instance = OryHydraClient::AdminApi.new
1480
-
1481
- begin
1482
- # Get Snapshot Metrics from the Hydra Service.
1483
- api_instance.prometheus
1484
- rescue OryHydraClient::ApiError => e
1485
- puts "Error when calling AdminApi->prometheus: #{e}"
1486
- end
1487
- ```
1488
-
1489
- #### Using the prometheus_with_http_info variant
1490
-
1491
- This returns an Array which contains the response data (`nil` in this case), status code and headers.
1492
-
1493
- > <Array(nil, Integer, Hash)> prometheus_with_http_info
1494
-
1495
- ```ruby
1496
- begin
1497
- # Get Snapshot Metrics from the Hydra Service.
1498
- data, status_code, headers = api_instance.prometheus_with_http_info
1499
- p status_code # => 2xx
1500
- p headers # => { ... }
1501
- p data # => nil
1502
- rescue OryHydraClient::ApiError => e
1503
- puts "Error when calling AdminApi->prometheus_with_http_info: #{e}"
1504
- end
1505
- ```
1506
-
1507
- ### Parameters
1508
-
1509
- This endpoint does not need any parameter.
1510
-
1511
- ### Return type
1512
-
1513
- nil (empty response body)
1514
-
1515
- ### Authorization
1516
-
1517
- No authorization required
1518
-
1519
- ### HTTP request headers
1520
-
1521
- - **Content-Type**: Not defined
1522
- - **Accept**: Not defined
1523
-
1524
-
1525
1468
  ## reject_consent_request
1526
1469
 
1527
1470
  > <CompletedRequest> reject_consent_request(consent_challenge, opts)
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
+
@@ -5,6 +5,7 @@
5
5
  | Name | Type | Description | Notes |
6
6
  | ---- | ---- | ----------- | ----- |
7
7
  | **challenge** | **String** | Challenge is the identifier (\&quot;logout challenge\&quot;) of the logout authentication request. It is used to identify the session. | [optional] |
8
+ | **client** | [**OAuth2Client**](OAuth2Client.md) | | [optional] |
8
9
  | **request_url** | **String** | RequestURL is the original Logout URL requested. | [optional] |
9
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] |
10
11
  | **sid** | **String** | SessionID is the login session ID that was requested to log out. | [optional] |
@@ -17,6 +18,7 @@ require 'ory-hydra-client'
17
18
 
18
19
  instance = OryHydraClient::LogoutRequest.new(
19
20
  challenge: null,
21
+ client: null,
20
22
  request_url: null,
21
23
  rp_initiated: null,
22
24
  sid: null,
@@ -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&#39;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
+
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
 
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&lt;String&gt;** | 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&lt;String&gt;** | 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,
@@ -3,7 +3,7 @@
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.10.3
6
+ The version of the OpenAPI document: v1.10.5
7
7
 
8
8
  Generated by: https://openapi-generator.tech
9
9
  OpenAPI Generator version: 5.1.1
@@ -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'
@@ -60,6 +60,7 @@ require 'ory-hydra-client/models/well_known'
60
60
 
61
61
  # APIs
62
62
  require 'ory-hydra-client/api/admin_api'
63
+ require 'ory-hydra-client/api/metadata_api'
63
64
  require 'ory-hydra-client/api/public_api'
64
65
 
65
66
  module OryHydraClient
@@ -3,7 +3,7 @@
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.10.3
6
+ The version of the OpenAPI document: v1.10.5
7
7
 
8
8
  Generated by: https://openapi-generator.tech
9
9
  OpenAPI Generator version: 5.1.1
@@ -1244,8 +1244,10 @@ module OryHydraClient
1244
1244
  # List OAuth 2.0 Clients
1245
1245
  # This endpoint lists all clients in the database, and never returns client secrets. As a default it lists the first 100 clients. The `limit` parameter can be used to retrieve more clients, but it has an upper bound at 500 objects. Pagination should be used to retrieve more than 500 objects. 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. The \"Link\" header is also included in successful responses, which contains one or more links for pagination, formatted like so: '<https://hydra-url/admin/clients?limit={limit}&offset={offset}>; rel=\"{page}\"', where page is one of the following applicable pages: 'first', 'next', 'last', and 'previous'. Multiple links can be included in this header, and will be separated by a comma.
1246
1246
  # @param [Hash] opts the optional parameters
1247
- # @option opts [Integer] :limit The maximum amount of policies returned, upper bound is 500 policies
1247
+ # @option opts [Integer] :limit The maximum amount of clients to returned, upper bound is 500 clients.
1248
1248
  # @option opts [Integer] :offset The offset from where to start looking.
1249
+ # @option opts [String] :name The name of the clients to filter by.
1250
+ # @option opts [String] :owner The owner of the clients to filter by.
1249
1251
  # @return [Array<OAuth2Client>]
1250
1252
  def list_o_auth2_clients(opts = {})
1251
1253
  data, _status_code, _headers = list_o_auth2_clients_with_http_info(opts)
@@ -1255,8 +1257,10 @@ module OryHydraClient
1255
1257
  # List OAuth 2.0 Clients
1256
1258
  # This endpoint lists all clients in the database, and never returns client secrets. As a default it lists the first 100 clients. The &#x60;limit&#x60; parameter can be used to retrieve more clients, but it has an upper bound at 500 objects. Pagination should be used to retrieve more than 500 objects. 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. The \&quot;Link\&quot; header is also included in successful responses, which contains one or more links for pagination, formatted like so: &#39;&lt;https://hydra-url/admin/clients?limit&#x3D;{limit}&amp;offset&#x3D;{offset}&gt;; rel&#x3D;\&quot;{page}\&quot;&#39;, where page is one of the following applicable pages: &#39;first&#39;, &#39;next&#39;, &#39;last&#39;, and &#39;previous&#39;. Multiple links can be included in this header, and will be separated by a comma.
1257
1259
  # @param [Hash] opts the optional parameters
1258
- # @option opts [Integer] :limit The maximum amount of policies returned, upper bound is 500 policies
1260
+ # @option opts [Integer] :limit The maximum amount of clients to returned, upper bound is 500 clients.
1259
1261
  # @option opts [Integer] :offset The offset from where to start looking.
1262
+ # @option opts [String] :name The name of the clients to filter by.
1263
+ # @option opts [String] :owner The owner of the clients to filter by.
1260
1264
  # @return [Array<(Array<OAuth2Client>, Integer, Hash)>] Array<OAuth2Client> data, response status code and response headers
1261
1265
  def list_o_auth2_clients_with_http_info(opts = {})
1262
1266
  if @api_client.config.debugging
@@ -1269,6 +1273,8 @@ module OryHydraClient
1269
1273
  query_params = opts[:query_params] || {}
1270
1274
  query_params[:'limit'] = opts[:'limit'] if !opts[:'limit'].nil?
1271
1275
  query_params[:'offset'] = opts[:'offset'] if !opts[:'offset'].nil?
1276
+ query_params[:'name'] = opts[:'name'] if !opts[:'name'].nil?
1277
+ query_params[:'owner'] = opts[:'owner'] if !opts[:'owner'].nil?
1272
1278
 
1273
1279
  # header parameters
1274
1280
  header_params = opts[:header_params] || {}
@@ -1439,61 +1445,6 @@ module OryHydraClient
1439
1445
  return data, status_code, headers
1440
1446
  end
1441
1447
 
1442
- # Get Snapshot Metrics from the Hydra Service.
1443
- # If you're using k8s, you can then add annotations to your deployment like so: ``` metadata: annotations: prometheus.io/port: \"4445\" prometheus.io/path: \"/metrics/prometheus\" ``` If the service supports TLS Edge Termination, this endpoint does not require the `X-Forwarded-Proto` header to be set.
1444
- # @param [Hash] opts the optional parameters
1445
- # @return [nil]
1446
- def prometheus(opts = {})
1447
- prometheus_with_http_info(opts)
1448
- nil
1449
- end
1450
-
1451
- # Get Snapshot Metrics from the Hydra Service.
1452
- # If you&#39;re using k8s, you can then add annotations to your deployment like so: &#x60;&#x60;&#x60; metadata: annotations: prometheus.io/port: \&quot;4445\&quot; prometheus.io/path: \&quot;/metrics/prometheus\&quot; &#x60;&#x60;&#x60; If the service supports TLS Edge Termination, this endpoint does not require the &#x60;X-Forwarded-Proto&#x60; header to be set.
1453
- # @param [Hash] opts the optional parameters
1454
- # @return [Array<(nil, Integer, Hash)>] nil, response status code and response headers
1455
- def prometheus_with_http_info(opts = {})
1456
- if @api_client.config.debugging
1457
- @api_client.config.logger.debug 'Calling API: AdminApi.prometheus ...'
1458
- end
1459
- # resource path
1460
- local_var_path = '/metrics/prometheus'
1461
-
1462
- # query parameters
1463
- query_params = opts[:query_params] || {}
1464
-
1465
- # header parameters
1466
- header_params = opts[:header_params] || {}
1467
-
1468
- # form parameters
1469
- form_params = opts[:form_params] || {}
1470
-
1471
- # http body (model)
1472
- post_body = opts[:debug_body]
1473
-
1474
- # return_type
1475
- return_type = opts[:debug_return_type]
1476
-
1477
- # auth_names
1478
- auth_names = opts[:debug_auth_names] || []
1479
-
1480
- new_options = opts.merge(
1481
- :operation => :"AdminApi.prometheus",
1482
- :header_params => header_params,
1483
- :query_params => query_params,
1484
- :form_params => form_params,
1485
- :body => post_body,
1486
- :auth_names => auth_names,
1487
- :return_type => return_type
1488
- )
1489
-
1490
- data, status_code, headers = @api_client.call_api(:GET, local_var_path, new_options)
1491
- if @api_client.config.debugging
1492
- @api_client.config.logger.debug "API called: AdminApi#prometheus\nData: #{data.inspect}\nStatus code: #{status_code}\nHeaders: #{headers}"
1493
- end
1494
- return data, status_code, headers
1495
- end
1496
-
1497
1448
  # Reject a Consent Request
1498
1449
  # When an authorization code, hybrid, or implicit OAuth 2.0 Flow is initiated, ORY Hydra asks the login provider to authenticate the subject and then tell ORY Hydra now about it. If the subject authenticated, he/she must now be asked if the OAuth 2.0 Client which initiated the flow should be allowed to access the resources on the subject's behalf. The consent provider which handles this request and is a web app implemented and hosted by you. It shows a subject interface which asks the subject to grant or deny the client access to the requested scope (\"Application my-dropbox-app wants write access to all your private files\"). The consent challenge is appended to the consent provider's URL to which the subject's user-agent (browser) is redirected to. The consent provider uses that challenge to fetch information on the OAuth2 request and then tells ORY Hydra if the subject accepted or rejected the request. This endpoint tells ORY Hydra that the subject has not authorized the OAuth 2.0 client to access resources on his/her behalf. The consent provider must include a reason why the consent was not granted. The response contains a redirect URL which the consent provider should redirect the user-agent to.
1499
1450
  # @param consent_challenge [String]
@@ -0,0 +1,77 @@
1
+ =begin
2
+ #ORY Hydra
3
+
4
+ #Welcome to the ORY Hydra HTTP API documentation. You will find documentation for all HTTP APIs here.
5
+
6
+ The version of the OpenAPI document: v1.10.5
7
+
8
+ Generated by: https://openapi-generator.tech
9
+ OpenAPI Generator version: 5.1.1
10
+
11
+ =end
12
+
13
+ require 'cgi'
14
+
15
+ module OryHydraClient
16
+ class MetadataApi
17
+ attr_accessor :api_client
18
+
19
+ def initialize(api_client = ApiClient.default)
20
+ @api_client = api_client
21
+ end
22
+ # Get snapshot metrics from the service. If you're using k8s, you can then add annotations to your deployment like so:
23
+ # ``` metadata: annotations: prometheus.io/port: \"4434\" prometheus.io/path: \"/metrics/prometheus\" ```
24
+ # @param [Hash] opts the optional parameters
25
+ # @return [nil]
26
+ def prometheus(opts = {})
27
+ prometheus_with_http_info(opts)
28
+ nil
29
+ end
30
+
31
+ # Get snapshot metrics from the service. If you&#39;re using k8s, you can then add annotations to your deployment like so:
32
+ # &#x60;&#x60;&#x60; metadata: annotations: prometheus.io/port: \&quot;4434\&quot; prometheus.io/path: \&quot;/metrics/prometheus\&quot; &#x60;&#x60;&#x60;
33
+ # @param [Hash] opts the optional parameters
34
+ # @return [Array<(nil, Integer, Hash)>] nil, response status code and response headers
35
+ def prometheus_with_http_info(opts = {})
36
+ if @api_client.config.debugging
37
+ @api_client.config.logger.debug 'Calling API: MetadataApi.prometheus ...'
38
+ end
39
+ # resource path
40
+ local_var_path = '/metrics/prometheus'
41
+
42
+ # query parameters
43
+ query_params = opts[:query_params] || {}
44
+
45
+ # header parameters
46
+ header_params = opts[:header_params] || {}
47
+
48
+ # form parameters
49
+ form_params = opts[:form_params] || {}
50
+
51
+ # http body (model)
52
+ post_body = opts[:debug_body]
53
+
54
+ # return_type
55
+ return_type = opts[:debug_return_type]
56
+
57
+ # auth_names
58
+ auth_names = opts[:debug_auth_names] || []
59
+
60
+ new_options = opts.merge(
61
+ :operation => :"MetadataApi.prometheus",
62
+ :header_params => header_params,
63
+ :query_params => query_params,
64
+ :form_params => form_params,
65
+ :body => post_body,
66
+ :auth_names => auth_names,
67
+ :return_type => return_type
68
+ )
69
+
70
+ data, status_code, headers = @api_client.call_api(:GET, local_var_path, new_options)
71
+ if @api_client.config.debugging
72
+ @api_client.config.logger.debug "API called: MetadataApi#prometheus\nData: #{data.inspect}\nStatus code: #{status_code}\nHeaders: #{headers}"
73
+ end
74
+ return data, status_code, headers
75
+ end
76
+ end
77
+ end