ory-hydra-client 1.9.0 → 1.9.1

Sign up to get free protection for your applications and to get access to all the features.
Files changed (90) hide show
  1. checksums.yaml +4 -4
  2. data/README.md +5 -5
  3. data/docs/AcceptConsentRequest.md +18 -17
  4. data/docs/AcceptLoginRequest.md +18 -17
  5. data/docs/AdminApi.md +815 -303
  6. data/docs/CompletedRequest.md +8 -7
  7. data/docs/ConsentRequest.md +30 -29
  8. data/docs/ConsentRequestSession.md +10 -9
  9. data/docs/ContainerWaitOKBodyError.md +8 -7
  10. data/docs/FlushInactiveOAuth2TokensRequest.md +8 -7
  11. data/docs/GenericError.md +14 -13
  12. data/docs/HealthNotReadyStatus.md +8 -7
  13. data/docs/HealthStatus.md +8 -7
  14. data/docs/JSONWebKey.md +40 -39
  15. data/docs/JSONWebKeySet.md +8 -7
  16. data/docs/JsonWebKeySetGeneratorRequest.md +12 -11
  17. data/docs/LoginRequest.md +24 -23
  18. data/docs/LogoutRequest.md +14 -13
  19. data/docs/OAuth2Client.md +72 -71
  20. data/docs/OAuth2TokenIntrospection.md +34 -33
  21. data/docs/Oauth2TokenResponse.md +18 -17
  22. data/docs/OpenIDConnectContext.md +16 -15
  23. data/docs/PluginConfig.md +38 -37
  24. data/docs/PluginConfigArgs.md +14 -13
  25. data/docs/PluginConfigInterface.md +10 -9
  26. data/docs/PluginConfigLinux.md +12 -11
  27. data/docs/PluginConfigNetwork.md +8 -7
  28. data/docs/PluginConfigRootfs.md +10 -9
  29. data/docs/PluginConfigUser.md +10 -9
  30. data/docs/PluginDevice.md +14 -13
  31. data/docs/PluginEnv.md +14 -13
  32. data/docs/PluginInterfaceType.md +12 -11
  33. data/docs/PluginMount.md +20 -19
  34. data/docs/PluginSettings.md +14 -13
  35. data/docs/PreviousConsentSession.md +20 -19
  36. data/docs/PublicApi.md +201 -60
  37. data/docs/RejectRequest.md +16 -15
  38. data/docs/UserinfoResponse.md +44 -43
  39. data/docs/Version.md +8 -7
  40. data/docs/VolumeUsageData.md +10 -9
  41. data/docs/WellKnown.md +58 -57
  42. data/lib/ory-hydra-client.rb +2 -2
  43. data/lib/ory-hydra-client/api/admin_api.rb +122 -92
  44. data/lib/ory-hydra-client/api/public_api.rb +34 -26
  45. data/lib/ory-hydra-client/api_client.rb +50 -48
  46. data/lib/ory-hydra-client/api_error.rb +2 -2
  47. data/lib/ory-hydra-client/configuration.rb +34 -7
  48. data/lib/ory-hydra-client/models/accept_consent_request.rb +21 -9
  49. data/lib/ory-hydra-client/models/accept_login_request.rb +20 -8
  50. data/lib/ory-hydra-client/models/completed_request.rb +20 -8
  51. data/lib/ory-hydra-client/models/consent_request.rb +20 -8
  52. data/lib/ory-hydra-client/models/consent_request_session.rb +20 -8
  53. data/lib/ory-hydra-client/models/container_wait_ok_body_error.rb +20 -8
  54. data/lib/ory-hydra-client/models/flush_inactive_o_auth2_tokens_request.rb +21 -9
  55. data/lib/ory-hydra-client/models/generic_error.rb +20 -8
  56. data/lib/ory-hydra-client/models/health_not_ready_status.rb +20 -8
  57. data/lib/ory-hydra-client/models/health_status.rb +20 -8
  58. data/lib/ory-hydra-client/models/json_web_key.rb +20 -8
  59. data/lib/ory-hydra-client/models/json_web_key_set.rb +20 -8
  60. data/lib/ory-hydra-client/models/json_web_key_set_generator_request.rb +20 -8
  61. data/lib/ory-hydra-client/models/login_request.rb +20 -8
  62. data/lib/ory-hydra-client/models/logout_request.rb +20 -8
  63. data/lib/ory-hydra-client/models/o_auth2_client.rb +22 -10
  64. data/lib/ory-hydra-client/models/o_auth2_token_introspection.rb +20 -8
  65. data/lib/ory-hydra-client/models/oauth2_token_response.rb +20 -8
  66. data/lib/ory-hydra-client/models/open_id_connect_context.rb +20 -8
  67. data/lib/ory-hydra-client/models/plugin_config.rb +20 -8
  68. data/lib/ory-hydra-client/models/plugin_config_args.rb +20 -8
  69. data/lib/ory-hydra-client/models/plugin_config_interface.rb +20 -8
  70. data/lib/ory-hydra-client/models/plugin_config_linux.rb +20 -8
  71. data/lib/ory-hydra-client/models/plugin_config_network.rb +20 -8
  72. data/lib/ory-hydra-client/models/plugin_config_rootfs.rb +20 -8
  73. data/lib/ory-hydra-client/models/plugin_config_user.rb +20 -8
  74. data/lib/ory-hydra-client/models/plugin_device.rb +20 -8
  75. data/lib/ory-hydra-client/models/plugin_env.rb +20 -8
  76. data/lib/ory-hydra-client/models/plugin_interface_type.rb +20 -8
  77. data/lib/ory-hydra-client/models/plugin_mount.rb +20 -8
  78. data/lib/ory-hydra-client/models/plugin_settings.rb +20 -8
  79. data/lib/ory-hydra-client/models/previous_consent_session.rb +21 -9
  80. data/lib/ory-hydra-client/models/reject_request.rb +20 -8
  81. data/lib/ory-hydra-client/models/userinfo_response.rb +20 -8
  82. data/lib/ory-hydra-client/models/version.rb +20 -8
  83. data/lib/ory-hydra-client/models/volume_usage_data.rb +20 -8
  84. data/lib/ory-hydra-client/models/well_known.rb +20 -8
  85. data/lib/ory-hydra-client/version.rb +3 -3
  86. data/ory-hydra-client.gemspec +4 -5
  87. data/spec/api_client_spec.rb +3 -3
  88. data/spec/configuration_spec.rb +2 -2
  89. data/spec/spec_helper.rb +2 -2
  90. metadata +32 -52
@@ -2,18 +2,19 @@
2
2
 
3
3
  ## Properties
4
4
 
5
- Name | Type | Description | Notes
6
- ------------ | ------------- | ------------- | -------------
7
- **socket** | **String** | socket |
8
- **types** | [**Array<PluginInterfaceType>**](PluginInterfaceType.md) | types |
5
+ | Name | Type | Description | Notes |
6
+ | ---- | ---- | ----------- | ----- |
7
+ | **socket** | **String** | socket | |
8
+ | **types** | [**Array<PluginInterfaceType>**](PluginInterfaceType.md) | types | |
9
9
 
10
- ## Code Sample
10
+ ## Example
11
11
 
12
12
  ```ruby
13
- require 'OryHydraClient'
13
+ require 'ory-hydra-client'
14
14
 
15
- instance = OryHydraClient::PluginConfigInterface.new(socket: null,
16
- types: null)
15
+ instance = OryHydraClient::PluginConfigInterface.new(
16
+ socket: null,
17
+ types: null
18
+ )
17
19
  ```
18
20
 
19
-
@@ -2,20 +2,21 @@
2
2
 
3
3
  ## Properties
4
4
 
5
- Name | Type | Description | Notes
6
- ------------ | ------------- | ------------- | -------------
7
- **allow_all_devices** | **Boolean** | allow all devices |
8
- **capabilities** | **Array<String>** | capabilities |
9
- **devices** | [**Array<PluginDevice>**](PluginDevice.md) | devices |
5
+ | Name | Type | Description | Notes |
6
+ | ---- | ---- | ----------- | ----- |
7
+ | **allow_all_devices** | **Boolean** | allow all devices | |
8
+ | **capabilities** | **Array<String>** | capabilities | |
9
+ | **devices** | [**Array<PluginDevice>**](PluginDevice.md) | devices | |
10
10
 
11
- ## Code Sample
11
+ ## Example
12
12
 
13
13
  ```ruby
14
- require 'OryHydraClient'
14
+ require 'ory-hydra-client'
15
15
 
16
- instance = OryHydraClient::PluginConfigLinux.new(allow_all_devices: null,
17
- capabilities: null,
18
- devices: null)
16
+ instance = OryHydraClient::PluginConfigLinux.new(
17
+ allow_all_devices: null,
18
+ capabilities: null,
19
+ devices: null
20
+ )
19
21
  ```
20
22
 
21
-
@@ -2,16 +2,17 @@
2
2
 
3
3
  ## Properties
4
4
 
5
- Name | Type | Description | Notes
6
- ------------ | ------------- | ------------- | -------------
7
- **type** | **String** | type |
5
+ | Name | Type | Description | Notes |
6
+ | ---- | ---- | ----------- | ----- |
7
+ | **type** | **String** | type | |
8
8
 
9
- ## Code Sample
9
+ ## Example
10
10
 
11
11
  ```ruby
12
- require 'OryHydraClient'
12
+ require 'ory-hydra-client'
13
13
 
14
- instance = OryHydraClient::PluginConfigNetwork.new(type: null)
14
+ instance = OryHydraClient::PluginConfigNetwork.new(
15
+ type: null
16
+ )
15
17
  ```
16
18
 
17
-
@@ -2,18 +2,19 @@
2
2
 
3
3
  ## Properties
4
4
 
5
- Name | Type | Description | Notes
6
- ------------ | ------------- | ------------- | -------------
7
- **diff_ids** | **Array<String>** | diff ids | [optional]
8
- **type** | **String** | type | [optional]
5
+ | Name | Type | Description | Notes |
6
+ | ---- | ---- | ----------- | ----- |
7
+ | **diff_ids** | **Array<String>** | diff ids | [optional] |
8
+ | **type** | **String** | type | [optional] |
9
9
 
10
- ## Code Sample
10
+ ## Example
11
11
 
12
12
  ```ruby
13
- require 'OryHydraClient'
13
+ require 'ory-hydra-client'
14
14
 
15
- instance = OryHydraClient::PluginConfigRootfs.new(diff_ids: null,
16
- type: null)
15
+ instance = OryHydraClient::PluginConfigRootfs.new(
16
+ diff_ids: null,
17
+ type: null
18
+ )
17
19
  ```
18
20
 
19
-
@@ -2,18 +2,19 @@
2
2
 
3
3
  ## Properties
4
4
 
5
- Name | Type | Description | Notes
6
- ------------ | ------------- | ------------- | -------------
7
- **gid** | **Integer** | g ID | [optional]
8
- **uid** | **Integer** | UID | [optional]
5
+ | Name | Type | Description | Notes |
6
+ | ---- | ---- | ----------- | ----- |
7
+ | **gid** | **Integer** | g ID | [optional] |
8
+ | **uid** | **Integer** | UID | [optional] |
9
9
 
10
- ## Code Sample
10
+ ## Example
11
11
 
12
12
  ```ruby
13
- require 'OryHydraClient'
13
+ require 'ory-hydra-client'
14
14
 
15
- instance = OryHydraClient::PluginConfigUser.new(gid: null,
16
- uid: null)
15
+ instance = OryHydraClient::PluginConfigUser.new(
16
+ gid: null,
17
+ uid: null
18
+ )
17
19
  ```
18
20
 
19
-
@@ -2,22 +2,23 @@
2
2
 
3
3
  ## Properties
4
4
 
5
- Name | Type | Description | Notes
6
- ------------ | ------------- | ------------- | -------------
7
- **description** | **String** | description |
8
- **name** | **String** | name |
9
- **path** | **String** | path |
10
- **settable** | **Array<String>** | settable |
5
+ | Name | Type | Description | Notes |
6
+ | ---- | ---- | ----------- | ----- |
7
+ | **description** | **String** | description | |
8
+ | **name** | **String** | name | |
9
+ | **path** | **String** | path | |
10
+ | **settable** | **Array<String>** | settable | |
11
11
 
12
- ## Code Sample
12
+ ## Example
13
13
 
14
14
  ```ruby
15
- require 'OryHydraClient'
15
+ require 'ory-hydra-client'
16
16
 
17
- instance = OryHydraClient::PluginDevice.new(description: null,
18
- name: null,
19
- path: null,
20
- settable: null)
17
+ instance = OryHydraClient::PluginDevice.new(
18
+ description: null,
19
+ name: null,
20
+ path: null,
21
+ settable: null
22
+ )
21
23
  ```
22
24
 
23
-
@@ -2,22 +2,23 @@
2
2
 
3
3
  ## Properties
4
4
 
5
- Name | Type | Description | Notes
6
- ------------ | ------------- | ------------- | -------------
7
- **description** | **String** | description |
8
- **name** | **String** | name |
9
- **settable** | **Array<String>** | settable |
10
- **value** | **String** | value |
5
+ | Name | Type | Description | Notes |
6
+ | ---- | ---- | ----------- | ----- |
7
+ | **description** | **String** | description | |
8
+ | **name** | **String** | name | |
9
+ | **settable** | **Array<String>** | settable | |
10
+ | **value** | **String** | value | |
11
11
 
12
- ## Code Sample
12
+ ## Example
13
13
 
14
14
  ```ruby
15
- require 'OryHydraClient'
15
+ require 'ory-hydra-client'
16
16
 
17
- instance = OryHydraClient::PluginEnv.new(description: null,
18
- name: null,
19
- settable: null,
20
- value: null)
17
+ instance = OryHydraClient::PluginEnv.new(
18
+ description: null,
19
+ name: null,
20
+ settable: null,
21
+ value: null
22
+ )
21
23
  ```
22
24
 
23
-
@@ -2,20 +2,21 @@
2
2
 
3
3
  ## Properties
4
4
 
5
- Name | Type | Description | Notes
6
- ------------ | ------------- | ------------- | -------------
7
- **capability** | **String** | capability |
8
- **prefix** | **String** | prefix |
9
- **version** | **String** | version |
5
+ | Name | Type | Description | Notes |
6
+ | ---- | ---- | ----------- | ----- |
7
+ | **capability** | **String** | capability | |
8
+ | **prefix** | **String** | prefix | |
9
+ | **version** | **String** | version | |
10
10
 
11
- ## Code Sample
11
+ ## Example
12
12
 
13
13
  ```ruby
14
- require 'OryHydraClient'
14
+ require 'ory-hydra-client'
15
15
 
16
- instance = OryHydraClient::PluginInterfaceType.new(capability: null,
17
- prefix: null,
18
- version: null)
16
+ instance = OryHydraClient::PluginInterfaceType.new(
17
+ capability: null,
18
+ prefix: null,
19
+ version: null
20
+ )
19
21
  ```
20
22
 
21
-
@@ -2,28 +2,29 @@
2
2
 
3
3
  ## Properties
4
4
 
5
- Name | Type | Description | Notes
6
- ------------ | ------------- | ------------- | -------------
7
- **description** | **String** | description |
8
- **destination** | **String** | destination |
9
- **name** | **String** | name |
10
- **options** | **Array<String>** | options |
11
- **settable** | **Array<String>** | settable |
12
- **source** | **String** | source |
13
- **type** | **String** | type |
5
+ | Name | Type | Description | Notes |
6
+ | ---- | ---- | ----------- | ----- |
7
+ | **description** | **String** | description | |
8
+ | **destination** | **String** | destination | |
9
+ | **name** | **String** | name | |
10
+ | **options** | **Array<String>** | options | |
11
+ | **settable** | **Array<String>** | settable | |
12
+ | **source** | **String** | source | |
13
+ | **type** | **String** | type | |
14
14
 
15
- ## Code Sample
15
+ ## Example
16
16
 
17
17
  ```ruby
18
- require 'OryHydraClient'
18
+ require 'ory-hydra-client'
19
19
 
20
- instance = OryHydraClient::PluginMount.new(description: null,
21
- destination: null,
22
- name: null,
23
- options: null,
24
- settable: null,
25
- source: null,
26
- type: null)
20
+ instance = OryHydraClient::PluginMount.new(
21
+ description: null,
22
+ destination: null,
23
+ name: null,
24
+ options: null,
25
+ settable: null,
26
+ source: null,
27
+ type: null
28
+ )
27
29
  ```
28
30
 
29
-
@@ -2,22 +2,23 @@
2
2
 
3
3
  ## Properties
4
4
 
5
- Name | Type | Description | Notes
6
- ------------ | ------------- | ------------- | -------------
7
- **args** | **Array<String>** | args |
8
- **devices** | [**Array<PluginDevice>**](PluginDevice.md) | devices |
9
- **env** | **Array<String>** | env |
10
- **mounts** | [**Array<PluginMount>**](PluginMount.md) | mounts |
5
+ | Name | Type | Description | Notes |
6
+ | ---- | ---- | ----------- | ----- |
7
+ | **args** | **Array<String>** | args | |
8
+ | **devices** | [**Array<PluginDevice>**](PluginDevice.md) | devices | |
9
+ | **env** | **Array<String>** | env | |
10
+ | **mounts** | [**Array<PluginMount>**](PluginMount.md) | mounts | |
11
11
 
12
- ## Code Sample
12
+ ## Example
13
13
 
14
14
  ```ruby
15
- require 'OryHydraClient'
15
+ require 'ory-hydra-client'
16
16
 
17
- instance = OryHydraClient::PluginSettings.new(args: null,
18
- devices: null,
19
- env: null,
20
- mounts: null)
17
+ instance = OryHydraClient::PluginSettings.new(
18
+ args: null,
19
+ devices: null,
20
+ env: null,
21
+ mounts: null
22
+ )
21
23
  ```
22
24
 
23
-
@@ -2,28 +2,29 @@
2
2
 
3
3
  ## Properties
4
4
 
5
- Name | Type | Description | Notes
6
- ------------ | ------------- | ------------- | -------------
7
- **consent_request** | [**ConsentRequest**](ConsentRequest.md) | | [optional]
8
- **grant_access_token_audience** | **Array<String>** | | [optional]
9
- **grant_scope** | **Array<String>** | | [optional]
10
- **handled_at** | **DateTime** | | [optional]
11
- **remember** | **Boolean** | Remember, if set to true, tells ORY Hydra to remember this consent authorization and reuse it if the same client asks the same user for the same, or a subset of, scope. | [optional]
12
- **remember_for** | **Integer** | RememberFor sets how long the consent authorization should be remembered for in seconds. If set to `0`, the authorization will be remembered indefinitely. | [optional]
13
- **session** | [**ConsentRequestSession**](ConsentRequestSession.md) | | [optional]
5
+ | Name | Type | Description | Notes |
6
+ | ---- | ---- | ----------- | ----- |
7
+ | **consent_request** | [**ConsentRequest**](ConsentRequest.md) | | [optional] |
8
+ | **grant_access_token_audience** | **Array<String>** | | [optional] |
9
+ | **grant_scope** | **Array<String>** | | [optional] |
10
+ | **handled_at** | **Time** | | [optional] |
11
+ | **remember** | **Boolean** | Remember, if set to true, tells ORY Hydra to remember this consent authorization and reuse it if the same client asks the same user for the same, or a subset of, scope. | [optional] |
12
+ | **remember_for** | **Integer** | RememberFor sets how long the consent authorization should be remembered for in seconds. If set to `0`, the authorization will be remembered indefinitely. | [optional] |
13
+ | **session** | [**ConsentRequestSession**](ConsentRequestSession.md) | | [optional] |
14
14
 
15
- ## Code Sample
15
+ ## Example
16
16
 
17
17
  ```ruby
18
- require 'OryHydraClient'
18
+ require 'ory-hydra-client'
19
19
 
20
- instance = OryHydraClient::PreviousConsentSession.new(consent_request: null,
21
- grant_access_token_audience: null,
22
- grant_scope: null,
23
- handled_at: null,
24
- remember: null,
25
- remember_for: null,
26
- session: null)
20
+ instance = OryHydraClient::PreviousConsentSession.new(
21
+ consent_request: null,
22
+ grant_access_token_audience: null,
23
+ grant_scope: null,
24
+ handled_at: null,
25
+ remember: null,
26
+ remember_for: null,
27
+ session: null
28
+ )
27
29
  ```
28
30
 
29
-
@@ -2,17 +2,16 @@
2
2
 
3
3
  All URIs are relative to *http://localhost*
4
4
 
5
- Method | HTTP request | Description
6
- ------------- | ------------- | -------------
7
- [**disconnect_user**](PublicApi.md#disconnect_user) | **GET** /oauth2/sessions/logout | OpenID Connect Front-Backchannel Enabled Logout
8
- [**discover_open_id_configuration**](PublicApi.md#discover_open_id_configuration) | **GET** /.well-known/openid-configuration | OpenID Connect Discovery
9
- [**is_instance_ready**](PublicApi.md#is_instance_ready) | **GET** /health/ready | Check Readiness Status
10
- [**oauth2_token**](PublicApi.md#oauth2_token) | **POST** /oauth2/token | The OAuth 2.0 Token Endpoint
11
- [**oauth_auth**](PublicApi.md#oauth_auth) | **GET** /oauth2/auth | The OAuth 2.0 Authorize Endpoint
12
- [**revoke_o_auth2_token**](PublicApi.md#revoke_o_auth2_token) | **POST** /oauth2/revoke | Revoke OAuth2 Tokens
13
- [**userinfo**](PublicApi.md#userinfo) | **GET** /userinfo | OpenID Connect Userinfo
14
- [**well_known**](PublicApi.md#well_known) | **GET** /.well-known/jwks.json | JSON Web Keys Discovery
15
-
5
+ | Method | HTTP request | Description |
6
+ | ------ | ------------ | ----------- |
7
+ | [**disconnect_user**](PublicApi.md#disconnect_user) | **GET** /oauth2/sessions/logout | OpenID Connect Front-Backchannel Enabled Logout |
8
+ | [**discover_open_id_configuration**](PublicApi.md#discover_open_id_configuration) | **GET** /.well-known/openid-configuration | OpenID Connect Discovery |
9
+ | [**is_instance_ready**](PublicApi.md#is_instance_ready) | **GET** /health/ready | Check Readiness Status |
10
+ | [**oauth2_token**](PublicApi.md#oauth2_token) | **POST** /oauth2/token | The OAuth 2.0 Token Endpoint |
11
+ | [**oauth_auth**](PublicApi.md#oauth_auth) | **GET** /oauth2/auth | The OAuth 2.0 Authorize Endpoint |
12
+ | [**revoke_o_auth2_token**](PublicApi.md#revoke_o_auth2_token) | **POST** /oauth2/revoke | Revoke OAuth2 Tokens |
13
+ | [**userinfo**](PublicApi.md#userinfo) | **GET** /userinfo | OpenID Connect Userinfo |
14
+ | [**well_known**](PublicApi.md#well_known) | **GET** /.well-known/jwks.json | JSON Web Keys Discovery |
16
15
 
17
16
 
18
17
  ## disconnect_user
@@ -23,19 +22,37 @@ OpenID Connect Front-Backchannel Enabled Logout
23
22
 
24
23
  This endpoint initiates and completes user logout at ORY Hydra and initiates OpenID Connect Front-/Back-channel logout: https://openid.net/specs/openid-connect-frontchannel-1_0.html https://openid.net/specs/openid-connect-backchannel-1_0.html
25
24
 
26
- ### Example
25
+ ### Examples
27
26
 
28
27
  ```ruby
29
- # load the gem
28
+ require 'time'
30
29
  require 'ory-hydra-client'
31
30
 
32
31
  api_instance = OryHydraClient::PublicApi.new
33
32
 
34
33
  begin
35
- #OpenID Connect Front-Backchannel Enabled Logout
34
+ # OpenID Connect Front-Backchannel Enabled Logout
36
35
  api_instance.disconnect_user
37
36
  rescue OryHydraClient::ApiError => e
38
- puts "Exception when calling PublicApi->disconnect_user: #{e}"
37
+ puts "Error when calling PublicApi->disconnect_user: #{e}"
38
+ end
39
+ ```
40
+
41
+ #### Using the disconnect_user_with_http_info variant
42
+
43
+ This returns an Array which contains the response data (`nil` in this case), status code and headers.
44
+
45
+ > <Array(nil, Integer, Hash)> disconnect_user_with_http_info
46
+
47
+ ```ruby
48
+ begin
49
+ # OpenID Connect Front-Backchannel Enabled Logout
50
+ data, status_code, headers = api_instance.disconnect_user_with_http_info
51
+ p status_code # => 2xx
52
+ p headers # => { ... }
53
+ p data # => nil
54
+ rescue OryHydraClient::ApiError => e
55
+ puts "Error when calling PublicApi->disconnect_user_with_http_info: #{e}"
39
56
  end
40
57
  ```
41
58
 
@@ -59,26 +76,44 @@ No authorization required
59
76
 
60
77
  ## discover_open_id_configuration
61
78
 
62
- > WellKnown discover_open_id_configuration
79
+ > <WellKnown> discover_open_id_configuration
63
80
 
64
81
  OpenID Connect Discovery
65
82
 
66
83
  The well known endpoint an be used to retrieve information for OpenID Connect clients. We encourage you to not roll your own OpenID Connect client but to use an OpenID Connect client library instead. You can learn more on this flow at https://openid.net/specs/openid-connect-discovery-1_0.html . Popular libraries for OpenID Connect clients include oidc-client-js (JavaScript), go-oidc (Golang), and others. For a full list of clients go here: https://openid.net/developers/certified/
67
84
 
68
- ### Example
85
+ ### Examples
69
86
 
70
87
  ```ruby
71
- # load the gem
88
+ require 'time'
72
89
  require 'ory-hydra-client'
73
90
 
74
91
  api_instance = OryHydraClient::PublicApi.new
75
92
 
76
93
  begin
77
- #OpenID Connect Discovery
94
+ # OpenID Connect Discovery
78
95
  result = api_instance.discover_open_id_configuration
79
96
  p result
80
97
  rescue OryHydraClient::ApiError => e
81
- puts "Exception when calling PublicApi->discover_open_id_configuration: #{e}"
98
+ puts "Error when calling PublicApi->discover_open_id_configuration: #{e}"
99
+ end
100
+ ```
101
+
102
+ #### Using the discover_open_id_configuration_with_http_info variant
103
+
104
+ This returns an Array which contains the response data, status code and headers.
105
+
106
+ > <Array(<WellKnown>, Integer, Hash)> discover_open_id_configuration_with_http_info
107
+
108
+ ```ruby
109
+ begin
110
+ # OpenID Connect Discovery
111
+ data, status_code, headers = api_instance.discover_open_id_configuration_with_http_info
112
+ p status_code # => 2xx
113
+ p headers # => { ... }
114
+ p data # => <WellKnown>
115
+ rescue OryHydraClient::ApiError => e
116
+ puts "Error when calling PublicApi->discover_open_id_configuration_with_http_info: #{e}"
82
117
  end
83
118
  ```
84
119
 
@@ -102,26 +137,44 @@ No authorization required
102
137
 
103
138
  ## is_instance_ready
104
139
 
105
- > HealthStatus is_instance_ready
140
+ > <HealthStatus> is_instance_ready
106
141
 
107
142
  Check Readiness Status
108
143
 
109
144
  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.
110
145
 
111
- ### Example
146
+ ### Examples
112
147
 
113
148
  ```ruby
114
- # load the gem
149
+ require 'time'
115
150
  require 'ory-hydra-client'
116
151
 
117
152
  api_instance = OryHydraClient::PublicApi.new
118
153
 
119
154
  begin
120
- #Check Readiness Status
155
+ # Check Readiness Status
121
156
  result = api_instance.is_instance_ready
122
157
  p result
123
158
  rescue OryHydraClient::ApiError => e
124
- puts "Exception when calling PublicApi->is_instance_ready: #{e}"
159
+ puts "Error when calling PublicApi->is_instance_ready: #{e}"
160
+ end
161
+ ```
162
+
163
+ #### Using the is_instance_ready_with_http_info variant
164
+
165
+ This returns an Array which contains the response data, status code and headers.
166
+
167
+ > <Array(<HealthStatus>, Integer, Hash)> is_instance_ready_with_http_info
168
+
169
+ ```ruby
170
+ begin
171
+ # Check Readiness Status
172
+ data, status_code, headers = api_instance.is_instance_ready_with_http_info
173
+ p status_code # => 2xx
174
+ p headers # => { ... }
175
+ p data # => <HealthStatus>
176
+ rescue OryHydraClient::ApiError => e
177
+ puts "Error when calling PublicApi->is_instance_ready_with_http_info: #{e}"
125
178
  end
126
179
  ```
127
180
 
@@ -145,16 +198,16 @@ No authorization required
145
198
 
146
199
  ## oauth2_token
147
200
 
148
- > Oauth2TokenResponse oauth2_token(grant_type, opts)
201
+ > <Oauth2TokenResponse> oauth2_token(grant_type, opts)
149
202
 
150
203
  The OAuth 2.0 Token Endpoint
151
204
 
152
205
  The client makes a request to the token endpoint by sending the following parameters using the \"application/x-www-form-urlencoded\" HTTP request entity-body. > Do not implement a client for this endpoint yourself. Use a library. There are many libraries > available for any programming language. You can find a list of libraries here: https://oauth.net/code/ > > Do note that Hydra SDK does not implement this endpoint properly. Use one of the libraries listed above!
153
206
 
154
- ### Example
207
+ ### Examples
155
208
 
156
209
  ```ruby
157
- # load the gem
210
+ require 'time'
158
211
  require 'ory-hydra-client'
159
212
  # setup authorization
160
213
  OryHydraClient.configure do |config|
@@ -176,24 +229,41 @@ opts = {
176
229
  }
177
230
 
178
231
  begin
179
- #The OAuth 2.0 Token Endpoint
232
+ # The OAuth 2.0 Token Endpoint
180
233
  result = api_instance.oauth2_token(grant_type, opts)
181
234
  p result
182
235
  rescue OryHydraClient::ApiError => e
183
- puts "Exception when calling PublicApi->oauth2_token: #{e}"
236
+ puts "Error when calling PublicApi->oauth2_token: #{e}"
184
237
  end
185
238
  ```
186
239
 
187
- ### Parameters
240
+ #### Using the oauth2_token_with_http_info variant
188
241
 
242
+ This returns an Array which contains the response data, status code and headers.
243
+
244
+ > <Array(<Oauth2TokenResponse>, Integer, Hash)> oauth2_token_with_http_info(grant_type, opts)
245
+
246
+ ```ruby
247
+ begin
248
+ # The OAuth 2.0 Token Endpoint
249
+ data, status_code, headers = api_instance.oauth2_token_with_http_info(grant_type, opts)
250
+ p status_code # => 2xx
251
+ p headers # => { ... }
252
+ p data # => <Oauth2TokenResponse>
253
+ rescue OryHydraClient::ApiError => e
254
+ puts "Error when calling PublicApi->oauth2_token_with_http_info: #{e}"
255
+ end
256
+ ```
257
+
258
+ ### Parameters
189
259
 
190
- Name | Type | Description | Notes
191
- ------------- | ------------- | ------------- | -------------
192
- **grant_type** | **String**| |
193
- **code** | **String**| | [optional]
194
- **refresh_token** | **String**| | [optional]
195
- **redirect_uri** | **String**| | [optional]
196
- **client_id** | **String**| | [optional]
260
+ | Name | Type | Description | Notes |
261
+ | ---- | ---- | ----------- | ----- |
262
+ | **grant_type** | **String** | | |
263
+ | **code** | **String** | | [optional] |
264
+ | **refresh_token** | **String** | | [optional] |
265
+ | **redirect_uri** | **String** | | [optional] |
266
+ | **client_id** | **String** | | [optional] |
197
267
 
198
268
  ### Return type
199
269
 
@@ -217,19 +287,37 @@ The OAuth 2.0 Authorize Endpoint
217
287
 
218
288
  This endpoint is not documented here because you should never use your own implementation to perform OAuth2 flows. OAuth2 is a very popular protocol and a library for your programming language will exists. To learn more about this flow please refer to the specification: https://tools.ietf.org/html/rfc6749
219
289
 
220
- ### Example
290
+ ### Examples
221
291
 
222
292
  ```ruby
223
- # load the gem
293
+ require 'time'
224
294
  require 'ory-hydra-client'
225
295
 
226
296
  api_instance = OryHydraClient::PublicApi.new
227
297
 
228
298
  begin
229
- #The OAuth 2.0 Authorize Endpoint
299
+ # The OAuth 2.0 Authorize Endpoint
230
300
  api_instance.oauth_auth
231
301
  rescue OryHydraClient::ApiError => e
232
- puts "Exception when calling PublicApi->oauth_auth: #{e}"
302
+ puts "Error when calling PublicApi->oauth_auth: #{e}"
303
+ end
304
+ ```
305
+
306
+ #### Using the oauth_auth_with_http_info variant
307
+
308
+ This returns an Array which contains the response data (`nil` in this case), status code and headers.
309
+
310
+ > <Array(nil, Integer, Hash)> oauth_auth_with_http_info
311
+
312
+ ```ruby
313
+ begin
314
+ # The OAuth 2.0 Authorize Endpoint
315
+ data, status_code, headers = api_instance.oauth_auth_with_http_info
316
+ p status_code # => 2xx
317
+ p headers # => { ... }
318
+ p data # => nil
319
+ rescue OryHydraClient::ApiError => e
320
+ puts "Error when calling PublicApi->oauth_auth_with_http_info: #{e}"
233
321
  end
234
322
  ```
235
323
 
@@ -259,10 +347,10 @@ Revoke OAuth2 Tokens
259
347
 
260
348
  Revoking a token (both access and refresh) means that the tokens will be invalid. A revoked access token can no longer be used to make access requests, and a revoked refresh token can no longer be used to refresh an access token. Revoking a refresh token also invalidates the access token that was created with it. A token may only be revoked by the client the token was generated for.
261
349
 
262
- ### Example
350
+ ### Examples
263
351
 
264
352
  ```ruby
265
- # load the gem
353
+ require 'time'
266
354
  require 'ory-hydra-client'
267
355
  # setup authorization
268
356
  OryHydraClient.configure do |config|
@@ -278,19 +366,36 @@ api_instance = OryHydraClient::PublicApi.new
278
366
  token = 'token_example' # String |
279
367
 
280
368
  begin
281
- #Revoke OAuth2 Tokens
369
+ # Revoke OAuth2 Tokens
282
370
  api_instance.revoke_o_auth2_token(token)
283
371
  rescue OryHydraClient::ApiError => e
284
- puts "Exception when calling PublicApi->revoke_o_auth2_token: #{e}"
372
+ puts "Error when calling PublicApi->revoke_o_auth2_token: #{e}"
285
373
  end
286
374
  ```
287
375
 
288
- ### Parameters
376
+ #### Using the revoke_o_auth2_token_with_http_info variant
289
377
 
378
+ This returns an Array which contains the response data (`nil` in this case), status code and headers.
379
+
380
+ > <Array(nil, Integer, Hash)> revoke_o_auth2_token_with_http_info(token)
381
+
382
+ ```ruby
383
+ begin
384
+ # Revoke OAuth2 Tokens
385
+ data, status_code, headers = api_instance.revoke_o_auth2_token_with_http_info(token)
386
+ p status_code # => 2xx
387
+ p headers # => { ... }
388
+ p data # => nil
389
+ rescue OryHydraClient::ApiError => e
390
+ puts "Error when calling PublicApi->revoke_o_auth2_token_with_http_info: #{e}"
391
+ end
392
+ ```
393
+
394
+ ### Parameters
290
395
 
291
- Name | Type | Description | Notes
292
- ------------- | ------------- | ------------- | -------------
293
- **token** | **String**| |
396
+ | Name | Type | Description | Notes |
397
+ | ---- | ---- | ----------- | ----- |
398
+ | **token** | **String** | | |
294
399
 
295
400
  ### Return type
296
401
 
@@ -308,16 +413,16 @@ nil (empty response body)
308
413
 
309
414
  ## userinfo
310
415
 
311
- > UserinfoResponse userinfo
416
+ > <UserinfoResponse> userinfo
312
417
 
313
418
  OpenID Connect Userinfo
314
419
 
315
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).
316
421
 
317
- ### Example
422
+ ### Examples
318
423
 
319
424
  ```ruby
320
- # load the gem
425
+ require 'time'
321
426
  require 'ory-hydra-client'
322
427
  # setup authorization
323
428
  OryHydraClient.configure do |config|
@@ -328,11 +433,29 @@ end
328
433
  api_instance = OryHydraClient::PublicApi.new
329
434
 
330
435
  begin
331
- #OpenID Connect Userinfo
436
+ # OpenID Connect Userinfo
332
437
  result = api_instance.userinfo
333
438
  p result
334
439
  rescue OryHydraClient::ApiError => e
335
- puts "Exception when calling PublicApi->userinfo: #{e}"
440
+ puts "Error when calling PublicApi->userinfo: #{e}"
441
+ end
442
+ ```
443
+
444
+ #### Using the userinfo_with_http_info variant
445
+
446
+ This returns an Array which contains the response data, status code and headers.
447
+
448
+ > <Array(<UserinfoResponse>, Integer, Hash)> userinfo_with_http_info
449
+
450
+ ```ruby
451
+ begin
452
+ # OpenID Connect Userinfo
453
+ data, status_code, headers = api_instance.userinfo_with_http_info
454
+ p status_code # => 2xx
455
+ p headers # => { ... }
456
+ p data # => <UserinfoResponse>
457
+ rescue OryHydraClient::ApiError => e
458
+ puts "Error when calling PublicApi->userinfo_with_http_info: #{e}"
336
459
  end
337
460
  ```
338
461
 
@@ -356,26 +479,44 @@ This endpoint does not need any parameter.
356
479
 
357
480
  ## well_known
358
481
 
359
- > JSONWebKeySet well_known
482
+ > <JSONWebKeySet> well_known
360
483
 
361
484
  JSON Web Keys Discovery
362
485
 
363
486
  This endpoint returns JSON Web Keys to be used as public keys for verifying OpenID Connect ID Tokens and, if enabled, OAuth 2.0 JWT Access Tokens. This endpoint can be used with client libraries like [node-jwks-rsa](https://github.com/auth0/node-jwks-rsa) among others.
364
487
 
365
- ### Example
488
+ ### Examples
366
489
 
367
490
  ```ruby
368
- # load the gem
491
+ require 'time'
369
492
  require 'ory-hydra-client'
370
493
 
371
494
  api_instance = OryHydraClient::PublicApi.new
372
495
 
373
496
  begin
374
- #JSON Web Keys Discovery
497
+ # JSON Web Keys Discovery
375
498
  result = api_instance.well_known
376
499
  p result
377
500
  rescue OryHydraClient::ApiError => e
378
- puts "Exception when calling PublicApi->well_known: #{e}"
501
+ puts "Error when calling PublicApi->well_known: #{e}"
502
+ end
503
+ ```
504
+
505
+ #### Using the well_known_with_http_info variant
506
+
507
+ This returns an Array which contains the response data, status code and headers.
508
+
509
+ > <Array(<JSONWebKeySet>, Integer, Hash)> well_known_with_http_info
510
+
511
+ ```ruby
512
+ begin
513
+ # JSON Web Keys Discovery
514
+ data, status_code, headers = api_instance.well_known_with_http_info
515
+ p status_code # => 2xx
516
+ p headers # => { ... }
517
+ p data # => <JSONWebKeySet>
518
+ rescue OryHydraClient::ApiError => e
519
+ puts "Error when calling PublicApi->well_known_with_http_info: #{e}"
379
520
  end
380
521
  ```
381
522