ory-hydra-client 0.0.0.alpha63 → 1.2.0.alpha2

Sign up to get free protection for your applications and to get access to all the features.
Files changed (103) hide show
  1. checksums.yaml +4 -4
  2. data/Gemfile +1 -1
  3. data/README.md +37 -45
  4. data/docs/AcceptConsentRequest.md +2 -4
  5. data/docs/AcceptLoginRequest.md +1 -1
  6. data/docs/AdminApi.md +70 -110
  7. data/docs/AttributeTypeAndValue.md +19 -0
  8. data/docs/Certificate.md +101 -0
  9. data/docs/CompletedRequest.md +1 -1
  10. data/docs/ConsentRequest.md +4 -4
  11. data/docs/ConsentRequestSession.md +2 -2
  12. data/docs/Extension.md +21 -0
  13. data/docs/IPNet.md +19 -0
  14. data/docs/JSONWebKey.md +12 -12
  15. data/docs/LoginRequest.md +7 -7
  16. data/docs/Name.md +27 -0
  17. data/docs/OAuth2Client.md +11 -13
  18. data/docs/OAuth2TokenIntrospection.md +3 -5
  19. data/docs/Oauth2TokenResponse.md +6 -6
  20. data/docs/OpenIDConnectContext.md +1 -1
  21. data/docs/PreviousConsentSession.md +2 -4
  22. data/docs/PublicApi.md +15 -15
  23. data/docs/RejectRequest.md +5 -5
  24. data/docs/URL.md +33 -0
  25. data/docs/WellKnown.md +1 -3
  26. data/lib/ory-hydra-client.rb +9 -16
  27. data/lib/ory-hydra-client/api/admin_api.rb +47 -113
  28. data/lib/ory-hydra-client/api/public_api.rb +12 -12
  29. data/lib/ory-hydra-client/api_client.rb +7 -9
  30. data/lib/ory-hydra-client/api_error.rb +2 -2
  31. data/lib/ory-hydra-client/configuration.rb +2 -2
  32. data/lib/ory-hydra-client/models/accept_consent_request.rb +5 -12
  33. data/lib/ory-hydra-client/models/accept_login_request.rb +7 -4
  34. data/lib/ory-hydra-client/models/{plugin_config_rootfs.rb → attribute_type_and_value.rb} +21 -22
  35. data/lib/ory-hydra-client/models/certificate.rb +683 -0
  36. data/lib/ory-hydra-client/models/completed_request.rb +2 -7
  37. data/lib/ory-hydra-client/models/consent_request.rb +10 -10
  38. data/lib/ory-hydra-client/models/consent_request_session.rb +10 -6
  39. data/lib/ory-hydra-client/models/{plugin_config_network.rb → extension.rb} +37 -19
  40. data/lib/ory-hydra-client/models/flush_inactive_o_auth2_tokens_request.rb +2 -2
  41. data/lib/ory-hydra-client/models/generic_error.rb +2 -2
  42. data/lib/ory-hydra-client/models/health_not_ready_status.rb +2 -2
  43. data/lib/ory-hydra-client/models/health_status.rb +2 -2
  44. data/lib/ory-hydra-client/models/{plugin_config_user.rb → ip_net.rb} +23 -21
  45. data/lib/ory-hydra-client/models/json_web_key.rb +15 -3
  46. data/lib/ory-hydra-client/models/json_web_key_set.rb +3 -3
  47. data/lib/ory-hydra-client/models/json_web_key_set_generator_request.rb +3 -2
  48. data/lib/ory-hydra-client/models/login_request.rb +5 -38
  49. data/lib/ory-hydra-client/models/logout_request.rb +2 -2
  50. data/lib/ory-hydra-client/models/{plugin_settings.rb → name.rb} +61 -58
  51. data/lib/ory-hydra-client/models/o_auth2_client.rb +14 -15
  52. data/lib/ory-hydra-client/models/o_auth2_token_introspection.rb +9 -17
  53. data/lib/ory-hydra-client/models/oauth2_token_response.rb +8 -2
  54. data/lib/ory-hydra-client/models/oauth_token_response.rb +2 -2
  55. data/lib/ory-hydra-client/models/open_id_connect_context.rb +6 -4
  56. data/lib/ory-hydra-client/models/previous_consent_session.rb +6 -13
  57. data/lib/ory-hydra-client/models/reject_request.rb +7 -7
  58. data/lib/ory-hydra-client/models/{plugin_device.rb → url.rb} +77 -49
  59. data/lib/ory-hydra-client/models/userinfo_response.rb +3 -3
  60. data/lib/ory-hydra-client/models/version.rb +3 -2
  61. data/lib/ory-hydra-client/models/well_known.rb +3 -15
  62. data/lib/ory-hydra-client/version.rb +3 -3
  63. data/ory-hydra-client.gemspec +2 -2
  64. data/spec/models/{plugin_config_rootfs_spec.rb → attribute_type_and_value_spec.rb} +9 -9
  65. data/spec/models/certificate_spec.rb +293 -0
  66. data/spec/models/{plugin_interface_type_spec.rb → extension_spec.rb} +10 -10
  67. data/spec/models/{plugin_config_user_spec.rb → ip_net_spec.rb} +9 -9
  68. data/spec/models/{plugin_mount_spec.rb → name_spec.rb} +13 -19
  69. data/spec/models/url_spec.rb +89 -0
  70. metadata +43 -75
  71. data/docs/ContainerWaitOKBodyError.md +0 -17
  72. data/docs/PluginConfig.md +0 -47
  73. data/docs/PluginConfigArgs.md +0 -23
  74. data/docs/PluginConfigInterface.md +0 -19
  75. data/docs/PluginConfigLinux.md +0 -21
  76. data/docs/PluginConfigNetwork.md +0 -17
  77. data/docs/PluginConfigRootfs.md +0 -19
  78. data/docs/PluginConfigUser.md +0 -19
  79. data/docs/PluginDevice.md +0 -23
  80. data/docs/PluginEnv.md +0 -23
  81. data/docs/PluginInterfaceType.md +0 -21
  82. data/docs/PluginMount.md +0 -29
  83. data/docs/PluginSettings.md +0 -23
  84. data/docs/VolumeUsageData.md +0 -19
  85. data/lib/ory-hydra-client/models/container_wait_ok_body_error.rb +0 -208
  86. data/lib/ory-hydra-client/models/plugin_config.rb +0 -422
  87. data/lib/ory-hydra-client/models/plugin_config_args.rb +0 -262
  88. data/lib/ory-hydra-client/models/plugin_config_interface.rb +0 -230
  89. data/lib/ory-hydra-client/models/plugin_config_linux.rb +0 -247
  90. data/lib/ory-hydra-client/models/plugin_env.rb +0 -260
  91. data/lib/ory-hydra-client/models/plugin_interface_type.rb +0 -243
  92. data/lib/ory-hydra-client/models/plugin_mount.rb +0 -307
  93. data/lib/ory-hydra-client/models/volume_usage_data.rb +0 -228
  94. data/spec/models/container_wait_ok_body_error_spec.rb +0 -41
  95. data/spec/models/plugin_config_args_spec.rb +0 -59
  96. data/spec/models/plugin_config_interface_spec.rb +0 -47
  97. data/spec/models/plugin_config_linux_spec.rb +0 -53
  98. data/spec/models/plugin_config_network_spec.rb +0 -41
  99. data/spec/models/plugin_config_spec.rb +0 -131
  100. data/spec/models/plugin_device_spec.rb +0 -59
  101. data/spec/models/plugin_env_spec.rb +0 -59
  102. data/spec/models/plugin_settings_spec.rb +0 -59
  103. data/spec/models/volume_usage_data_spec.rb +0 -47
checksums.yaml CHANGED
@@ -1,7 +1,7 @@
1
1
  ---
2
2
  SHA256:
3
- metadata.gz: d25d2dd76c851c2eb8072e50ba83fc5e8fa405060c61fb8efd2b46f3bea7db9d
4
- data.tar.gz: dd054e8d57a2942297f1bb8bb6e00918b742c2fa142560335990156c2d92fd54
3
+ metadata.gz: f8c7448e2c33244322d453b4c89c01a551972e8cf34908f051738725cca9d8a2
4
+ data.tar.gz: e2a4d7ab554df404622c063f6edda5c6d6eb5841ed0acc65902e9f06a4beb403
5
5
  SHA512:
6
- metadata.gz: ec46aedeec5ef2ddb5918bf14226d47e225c353048e5331577c80ff9c317774488a289cc0c53c688c7e30e4efc3e7fdf97d58cd87a01ef5e7c0f731cbee5c72b
7
- data.tar.gz: 5d453e6e3f947c84b9f4d5a99cd67c3887539d3d6f7c7d5155dec2f8254f1d0886864edd6428d19b246bab5c3e122d5cd722a4188d1fb0281c84130f9421db11
6
+ metadata.gz: 344f8e55176eb4d822eaabe8de34e19e5664c680a1968808896330d9ebf95574924e35ac63a593be89676751fc8eda177d5e24d711b0661b03b10afeadcc4055
7
+ data.tar.gz: dc4f8ba62cc8440c94630cf8d4874ab3b559c49b67dafa405f7f0e2c97f84d84b064a5f0b4ec85c5089018588d8093425a06a98dbcac8348f28fb2ac146132ba
data/Gemfile CHANGED
@@ -3,7 +3,7 @@ source 'https://rubygems.org'
3
3
  gemspec
4
4
 
5
5
  group :development, :test do
6
- gem 'rake', '~> 13.0.1'
6
+ gem 'rake', '~> 12.0.0'
7
7
  gem 'pry-byebug'
8
8
  gem 'rubocop', '~> 0.66.0'
9
9
  end
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: v0.0.0-alpha.63
10
- - Package version: v0.0.0-alpha.63
9
+ - API version: latest
10
+ - Package version: v1.2.0-alpha.2
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-v0.0.0-alpha.63.gem
26
+ gem install ./ory-hydra-client-v1.2.0-alpha.2.gem
27
27
  ```
28
28
 
29
- (for development, run `gem install --dev ./ory-hydra-client-v0.0.0-alpha.63.gem` to install the development dependencies)
29
+ (for development, run `gem install --dev ./ory-hydra-client-v1.2.0-alpha.2.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', '~> v0.0.0-alpha.63'
35
+ gem 'ory-hydra-client', '~> v1.2.0-alpha.2'
36
36
 
37
37
  ### Install from Git
38
38
 
@@ -63,7 +63,7 @@ opts = {
63
63
  }
64
64
 
65
65
  begin
66
- #Accept a Consent Request
66
+ #Accept an consent request
67
67
  result = api_instance.accept_consent_request(consent_challenge, opts)
68
68
  p result
69
69
  rescue OryHydraClient::ApiError => e
@@ -78,42 +78,41 @@ All URIs are relative to *http://localhost*
78
78
 
79
79
  Class | Method | HTTP request | Description
80
80
  ------------ | ------------- | ------------- | -------------
81
- *OryHydraClient::AdminApi* | [**accept_consent_request**](docs/AdminApi.md#accept_consent_request) | **PUT** /oauth2/auth/requests/consent/accept | Accept a Consent Request
82
- *OryHydraClient::AdminApi* | [**accept_login_request**](docs/AdminApi.md#accept_login_request) | **PUT** /oauth2/auth/requests/login/accept | Accept a Login Request
83
- *OryHydraClient::AdminApi* | [**accept_logout_request**](docs/AdminApi.md#accept_logout_request) | **PUT** /oauth2/auth/requests/logout/accept | Accept a Logout Request
84
- *OryHydraClient::AdminApi* | [**create_json_web_key_set**](docs/AdminApi.md#create_json_web_key_set) | **POST** /keys/{set} | Generate a New JSON Web Key
85
- *OryHydraClient::AdminApi* | [**create_o_auth2_client**](docs/AdminApi.md#create_o_auth2_client) | **POST** /clients | Create an OAuth 2.0 Client
81
+ *OryHydraClient::AdminApi* | [**accept_consent_request**](docs/AdminApi.md#accept_consent_request) | **PUT** /oauth2/auth/requests/consent/accept | Accept an consent request
82
+ *OryHydraClient::AdminApi* | [**accept_login_request**](docs/AdminApi.md#accept_login_request) | **PUT** /oauth2/auth/requests/login/accept | Accept an login request
83
+ *OryHydraClient::AdminApi* | [**accept_logout_request**](docs/AdminApi.md#accept_logout_request) | **PUT** /oauth2/auth/requests/logout/accept | Accept a logout request
84
+ *OryHydraClient::AdminApi* | [**create_json_web_key_set**](docs/AdminApi.md#create_json_web_key_set) | **POST** /keys/{set} | Generate a new JSON Web Key
85
+ *OryHydraClient::AdminApi* | [**create_o_auth2_client**](docs/AdminApi.md#create_o_auth2_client) | **POST** /clients | Create an OAuth 2.0 client
86
86
  *OryHydraClient::AdminApi* | [**delete_json_web_key**](docs/AdminApi.md#delete_json_web_key) | **DELETE** /keys/{set}/{kid} | Delete a JSON Web Key
87
87
  *OryHydraClient::AdminApi* | [**delete_json_web_key_set**](docs/AdminApi.md#delete_json_web_key_set) | **DELETE** /keys/{set} | Delete a JSON Web Key Set
88
88
  *OryHydraClient::AdminApi* | [**delete_o_auth2_client**](docs/AdminApi.md#delete_o_auth2_client) | **DELETE** /clients/{id} | Deletes an OAuth 2.0 Client
89
- *OryHydraClient::AdminApi* | [**delete_o_auth2_token**](docs/AdminApi.md#delete_o_auth2_token) | **DELETE** /oauth2/tokens | Delete OAuth2 Access Tokens from a Client
90
89
  *OryHydraClient::AdminApi* | [**flush_inactive_o_auth2_tokens**](docs/AdminApi.md#flush_inactive_o_auth2_tokens) | **POST** /oauth2/flush | Flush Expired OAuth2 Access Tokens
91
- *OryHydraClient::AdminApi* | [**get_consent_request**](docs/AdminApi.md#get_consent_request) | **GET** /oauth2/auth/requests/consent | Get Consent Request Information
90
+ *OryHydraClient::AdminApi* | [**get_consent_request**](docs/AdminApi.md#get_consent_request) | **GET** /oauth2/auth/requests/consent | Get consent request information
92
91
  *OryHydraClient::AdminApi* | [**get_json_web_key**](docs/AdminApi.md#get_json_web_key) | **GET** /keys/{set}/{kid} | Fetch a JSON Web Key
93
92
  *OryHydraClient::AdminApi* | [**get_json_web_key_set**](docs/AdminApi.md#get_json_web_key_set) | **GET** /keys/{set} | Retrieve a JSON Web Key Set
94
- *OryHydraClient::AdminApi* | [**get_login_request**](docs/AdminApi.md#get_login_request) | **GET** /oauth2/auth/requests/login | Get a Login Request
95
- *OryHydraClient::AdminApi* | [**get_logout_request**](docs/AdminApi.md#get_logout_request) | **GET** /oauth2/auth/requests/logout | Get a Logout Request
93
+ *OryHydraClient::AdminApi* | [**get_login_request**](docs/AdminApi.md#get_login_request) | **GET** /oauth2/auth/requests/login | Get an login request
94
+ *OryHydraClient::AdminApi* | [**get_logout_request**](docs/AdminApi.md#get_logout_request) | **GET** /oauth2/auth/requests/logout | Get a logout request
96
95
  *OryHydraClient::AdminApi* | [**get_o_auth2_client**](docs/AdminApi.md#get_o_auth2_client) | **GET** /clients/{id} | Get an OAuth 2.0 Client.
97
- *OryHydraClient::AdminApi* | [**get_version**](docs/AdminApi.md#get_version) | **GET** /version | Get Service Version
98
- *OryHydraClient::AdminApi* | [**introspect_o_auth2_token**](docs/AdminApi.md#introspect_o_auth2_token) | **POST** /oauth2/introspect | Introspect OAuth2 Tokens
99
- *OryHydraClient::AdminApi* | [**is_instance_alive**](docs/AdminApi.md#is_instance_alive) | **GET** /health/alive | Check Alive Status
96
+ *OryHydraClient::AdminApi* | [**get_version**](docs/AdminApi.md#get_version) | **GET** /version | Get service version
97
+ *OryHydraClient::AdminApi* | [**introspect_o_auth2_token**](docs/AdminApi.md#introspect_o_auth2_token) | **POST** /oauth2/introspect | Introspect OAuth2 tokens
98
+ *OryHydraClient::AdminApi* | [**is_instance_alive**](docs/AdminApi.md#is_instance_alive) | **GET** /health/alive | Check alive status
100
99
  *OryHydraClient::AdminApi* | [**list_o_auth2_clients**](docs/AdminApi.md#list_o_auth2_clients) | **GET** /clients | List OAuth 2.0 Clients
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* | [**prometheus**](docs/AdminApi.md#prometheus) | **GET** /metrics/prometheus | Get Snapshot Metrics from the Hydra Service.
103
- *OryHydraClient::AdminApi* | [**reject_consent_request**](docs/AdminApi.md#reject_consent_request) | **PUT** /oauth2/auth/requests/consent/reject | Reject a Consent Request
104
- *OryHydraClient::AdminApi* | [**reject_login_request**](docs/AdminApi.md#reject_login_request) | **PUT** /oauth2/auth/requests/login/reject | Reject a Login Request
105
- *OryHydraClient::AdminApi* | [**reject_logout_request**](docs/AdminApi.md#reject_logout_request) | **PUT** /oauth2/auth/requests/logout/reject | Reject a Logout Request
106
- *OryHydraClient::AdminApi* | [**revoke_authentication_session**](docs/AdminApi.md#revoke_authentication_session) | **DELETE** /oauth2/auth/sessions/login | Invalidates All Login Sessions of a Certain User Invalidates a Subject's Authentication Session
107
- *OryHydraClient::AdminApi* | [**revoke_consent_sessions**](docs/AdminApi.md#revoke_consent_sessions) | **DELETE** /oauth2/auth/sessions/consent | Revokes Consent Sessions of a Subject for a Specific OAuth 2.0 Client
100
+ *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
101
+ *OryHydraClient::AdminApi* | [**prometheus**](docs/AdminApi.md#prometheus) | **GET** /metrics/prometheus | Get snapshot metrics from the Hydra service. If you're using k8s, you can then add annotations to your deployment like so:
102
+ *OryHydraClient::AdminApi* | [**reject_consent_request**](docs/AdminApi.md#reject_consent_request) | **PUT** /oauth2/auth/requests/consent/reject | Reject an consent request
103
+ *OryHydraClient::AdminApi* | [**reject_login_request**](docs/AdminApi.md#reject_login_request) | **PUT** /oauth2/auth/requests/login/reject | Reject a login request
104
+ *OryHydraClient::AdminApi* | [**reject_logout_request**](docs/AdminApi.md#reject_logout_request) | **PUT** /oauth2/auth/requests/logout/reject | Reject a logout request
105
+ *OryHydraClient::AdminApi* | [**revoke_authentication_session**](docs/AdminApi.md#revoke_authentication_session) | **DELETE** /oauth2/auth/sessions/login | Invalidates all login sessions of a certain user Invalidates a subject's authentication session
106
+ *OryHydraClient::AdminApi* | [**revoke_consent_sessions**](docs/AdminApi.md#revoke_consent_sessions) | **DELETE** /oauth2/auth/sessions/consent | Revokes consent sessions of a subject for a specific OAuth 2.0 Client
108
107
  *OryHydraClient::AdminApi* | [**update_json_web_key**](docs/AdminApi.md#update_json_web_key) | **PUT** /keys/{set}/{kid} | Update a JSON Web Key
109
108
  *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
109
  *OryHydraClient::AdminApi* | [**update_o_auth2_client**](docs/AdminApi.md#update_o_auth2_client) | **PUT** /clients/{id} | Update an OAuth 2.0 Client
111
- *OryHydraClient::PublicApi* | [**disconnect_user**](docs/PublicApi.md#disconnect_user) | **GET** /oauth2/sessions/logout | OpenID Connect Front-Backchannel Enabled Logout
110
+ *OryHydraClient::PublicApi* | [**disconnect_user**](docs/PublicApi.md#disconnect_user) | **GET** /oauth2/sessions/logout | OpenID Connect Front-Backchannel enabled Logout
112
111
  *OryHydraClient::PublicApi* | [**discover_open_id_configuration**](docs/PublicApi.md#discover_open_id_configuration) | **GET** /.well-known/openid-configuration | OpenID Connect Discovery
113
- *OryHydraClient::PublicApi* | [**is_instance_ready**](docs/PublicApi.md#is_instance_ready) | **GET** /health/ready | Check Readiness Status
114
- *OryHydraClient::PublicApi* | [**oauth2_token**](docs/PublicApi.md#oauth2_token) | **POST** /oauth2/token | The OAuth 2.0 Token Endpoint
115
- *OryHydraClient::PublicApi* | [**oauth_auth**](docs/PublicApi.md#oauth_auth) | **GET** /oauth2/auth | The OAuth 2.0 Authorize Endpoint
116
- *OryHydraClient::PublicApi* | [**revoke_o_auth2_token**](docs/PublicApi.md#revoke_o_auth2_token) | **POST** /oauth2/revoke | Revoke OAuth2 Tokens
112
+ *OryHydraClient::PublicApi* | [**is_instance_ready**](docs/PublicApi.md#is_instance_ready) | **GET** /health/ready | Check readiness status
113
+ *OryHydraClient::PublicApi* | [**oauth2_token**](docs/PublicApi.md#oauth2_token) | **POST** /oauth2/token | The OAuth 2.0 token endpoint
114
+ *OryHydraClient::PublicApi* | [**oauth_auth**](docs/PublicApi.md#oauth_auth) | **GET** /oauth2/auth | The OAuth 2.0 authorize endpoint
115
+ *OryHydraClient::PublicApi* | [**revoke_o_auth2_token**](docs/PublicApi.md#revoke_o_auth2_token) | **POST** /oauth2/revoke | Revoke OAuth2 tokens
117
116
  *OryHydraClient::PublicApi* | [**userinfo**](docs/PublicApi.md#userinfo) | **GET** /userinfo | OpenID Connect Userinfo
118
117
  *OryHydraClient::PublicApi* | [**well_known**](docs/PublicApi.md#well_known) | **GET** /.well-known/jwks.json | JSON Web Keys Discovery
119
118
 
@@ -122,40 +121,33 @@ Class | Method | HTTP request | Description
122
121
 
123
122
  - [OryHydraClient::AcceptConsentRequest](docs/AcceptConsentRequest.md)
124
123
  - [OryHydraClient::AcceptLoginRequest](docs/AcceptLoginRequest.md)
124
+ - [OryHydraClient::AttributeTypeAndValue](docs/AttributeTypeAndValue.md)
125
+ - [OryHydraClient::Certificate](docs/Certificate.md)
125
126
  - [OryHydraClient::CompletedRequest](docs/CompletedRequest.md)
126
127
  - [OryHydraClient::ConsentRequest](docs/ConsentRequest.md)
127
128
  - [OryHydraClient::ConsentRequestSession](docs/ConsentRequestSession.md)
128
- - [OryHydraClient::ContainerWaitOKBodyError](docs/ContainerWaitOKBodyError.md)
129
+ - [OryHydraClient::Extension](docs/Extension.md)
129
130
  - [OryHydraClient::FlushInactiveOAuth2TokensRequest](docs/FlushInactiveOAuth2TokensRequest.md)
130
131
  - [OryHydraClient::GenericError](docs/GenericError.md)
131
132
  - [OryHydraClient::HealthNotReadyStatus](docs/HealthNotReadyStatus.md)
132
133
  - [OryHydraClient::HealthStatus](docs/HealthStatus.md)
134
+ - [OryHydraClient::IPNet](docs/IPNet.md)
133
135
  - [OryHydraClient::JSONWebKey](docs/JSONWebKey.md)
134
136
  - [OryHydraClient::JSONWebKeySet](docs/JSONWebKeySet.md)
135
137
  - [OryHydraClient::JsonWebKeySetGeneratorRequest](docs/JsonWebKeySetGeneratorRequest.md)
136
138
  - [OryHydraClient::LoginRequest](docs/LoginRequest.md)
137
139
  - [OryHydraClient::LogoutRequest](docs/LogoutRequest.md)
140
+ - [OryHydraClient::Name](docs/Name.md)
138
141
  - [OryHydraClient::OAuth2Client](docs/OAuth2Client.md)
139
142
  - [OryHydraClient::OAuth2TokenIntrospection](docs/OAuth2TokenIntrospection.md)
140
143
  - [OryHydraClient::Oauth2TokenResponse](docs/Oauth2TokenResponse.md)
144
+ - [OryHydraClient::OauthTokenResponse](docs/OauthTokenResponse.md)
141
145
  - [OryHydraClient::OpenIDConnectContext](docs/OpenIDConnectContext.md)
142
- - [OryHydraClient::PluginConfig](docs/PluginConfig.md)
143
- - [OryHydraClient::PluginConfigArgs](docs/PluginConfigArgs.md)
144
- - [OryHydraClient::PluginConfigInterface](docs/PluginConfigInterface.md)
145
- - [OryHydraClient::PluginConfigLinux](docs/PluginConfigLinux.md)
146
- - [OryHydraClient::PluginConfigNetwork](docs/PluginConfigNetwork.md)
147
- - [OryHydraClient::PluginConfigRootfs](docs/PluginConfigRootfs.md)
148
- - [OryHydraClient::PluginConfigUser](docs/PluginConfigUser.md)
149
- - [OryHydraClient::PluginDevice](docs/PluginDevice.md)
150
- - [OryHydraClient::PluginEnv](docs/PluginEnv.md)
151
- - [OryHydraClient::PluginInterfaceType](docs/PluginInterfaceType.md)
152
- - [OryHydraClient::PluginMount](docs/PluginMount.md)
153
- - [OryHydraClient::PluginSettings](docs/PluginSettings.md)
154
146
  - [OryHydraClient::PreviousConsentSession](docs/PreviousConsentSession.md)
155
147
  - [OryHydraClient::RejectRequest](docs/RejectRequest.md)
148
+ - [OryHydraClient::URL](docs/URL.md)
156
149
  - [OryHydraClient::UserinfoResponse](docs/UserinfoResponse.md)
157
150
  - [OryHydraClient::Version](docs/Version.md)
158
- - [OryHydraClient::VolumeUsageData](docs/VolumeUsageData.md)
159
151
  - [OryHydraClient::WellKnown](docs/WellKnown.md)
160
152
 
161
153
 
@@ -171,7 +163,7 @@ Class | Method | HTTP request | Description
171
163
 
172
164
  - **Type**: OAuth
173
165
  - **Flow**: accessCode
174
- - **Authorization URL**: https://hydra.demo.ory.sh/oauth2/auth
166
+ - **Authorization URL**: /oauth2/auth
175
167
  - **Scopes**:
176
168
  - offline: A scope required when requesting refresh tokens (alias for `offline_access`)
177
169
  - offline_access: A scope required when requesting refresh tokens
@@ -4,9 +4,8 @@
4
4
 
5
5
  Name | Type | Description | Notes
6
6
  ------------ | ------------- | ------------- | -------------
7
- **grant_access_token_audience** | **Array<String>** | | [optional]
8
- **grant_scope** | **Array<String>** | | [optional]
9
- **handled_at** | **DateTime** | | [optional]
7
+ **grant_access_token_audience** | **Array<String>** | GrantedAudience sets the audience the user authorized the client to use. Should be a subset of `requested_access_token_audience`. | [optional]
8
+ **grant_scope** | **Array<String>** | GrantScope sets the scope the user authorized the client to use. Should be a subset of `requested_scope`. | [optional]
10
9
  **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]
11
10
  **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]
12
11
  **session** | [**ConsentRequestSession**](ConsentRequestSession.md) | | [optional]
@@ -18,7 +17,6 @@ require 'OryHydraClient'
18
17
 
19
18
  instance = OryHydraClient::AcceptConsentRequest.new(grant_access_token_audience: null,
20
19
  grant_scope: null,
21
- handled_at: null,
22
20
  remember: null,
23
21
  remember_for: null,
24
22
  session: null)
@@ -5,7 +5,7 @@
5
5
  Name | Type | Description | Notes
6
6
  ------------ | ------------- | ------------- | -------------
7
7
  **acr** | **String** | ACR sets the Authentication AuthorizationContext Class Reference value for this authentication session. You can use it to express that, for example, a user authenticated using two factor authentication. | [optional]
8
- **context** | [**Object**](.md) | | [optional]
8
+ **context** | **Hash<String, Object>** | Context is an optional object which can hold arbitrary data. The data will be made available when fetching the consent request under the \"context\" field. This is useful in scenarios where login and consent endpoints share data. | [optional]
9
9
  **force_subject_identifier** | **String** | ForceSubjectIdentifier forces the \"pairwise\" user ID of the end-user that authenticated. The \"pairwise\" user ID refers to the (Pairwise Identifier Algorithm)[http://openid.net/specs/openid-connect-core-1_0.html#PairwiseAlg] of the OpenID Connect specification. It allows you to set an obfuscated subject (\"user\") identifier that is unique to the client. Please note that this changes the user ID on endpoint /userinfo and sub claim of the ID Token. It does not change the sub claim in the OAuth 2.0 Introspection. Per default, ORY Hydra handles this value with its own algorithm. In case you want to set this yourself you can use this field. Please note that setting this field has no effect if `pairwise` is not configured in ORY Hydra or the OAuth 2.0 Client does not expect a pairwise identifier (set via `subject_type` key in the client's configuration). Please also be aware that ORY Hydra is unable to properly compute this value during authentication. This implies that you have to compute this value on every authentication process (probably depending on the client ID or some other unique value). If you fail to compute the proper value, then authentication processes which have id_token_hint set might fail. | [optional]
10
10
  **remember** | **Boolean** | Remember, if set to true, tells ORY Hydra to remember this user by telling the user agent (browser) to store a cookie with authentication data. If the same user performs another OAuth 2.0 Authorization Request, he/she will not be asked to log in again. | [optional]
11
11
  **remember_for** | **Integer** | RememberFor sets how long the authentication should be remembered for in seconds. If set to `0`, the authorization will be remembered for the duration of the browser session (using a session cookie). | [optional]
data/docs/AdminApi.md CHANGED
@@ -4,33 +4,32 @@ All URIs are relative to *http://localhost*
4
4
 
5
5
  Method | HTTP request | Description
6
6
  ------------- | ------------- | -------------
7
- [**accept_consent_request**](AdminApi.md#accept_consent_request) | **PUT** /oauth2/auth/requests/consent/accept | Accept a Consent Request
8
- [**accept_login_request**](AdminApi.md#accept_login_request) | **PUT** /oauth2/auth/requests/login/accept | Accept a Login Request
9
- [**accept_logout_request**](AdminApi.md#accept_logout_request) | **PUT** /oauth2/auth/requests/logout/accept | Accept a Logout Request
10
- [**create_json_web_key_set**](AdminApi.md#create_json_web_key_set) | **POST** /keys/{set} | Generate a New JSON Web Key
11
- [**create_o_auth2_client**](AdminApi.md#create_o_auth2_client) | **POST** /clients | Create an OAuth 2.0 Client
7
+ [**accept_consent_request**](AdminApi.md#accept_consent_request) | **PUT** /oauth2/auth/requests/consent/accept | Accept an consent request
8
+ [**accept_login_request**](AdminApi.md#accept_login_request) | **PUT** /oauth2/auth/requests/login/accept | Accept an login request
9
+ [**accept_logout_request**](AdminApi.md#accept_logout_request) | **PUT** /oauth2/auth/requests/logout/accept | Accept a logout request
10
+ [**create_json_web_key_set**](AdminApi.md#create_json_web_key_set) | **POST** /keys/{set} | Generate a new JSON Web Key
11
+ [**create_o_auth2_client**](AdminApi.md#create_o_auth2_client) | **POST** /clients | Create an OAuth 2.0 client
12
12
  [**delete_json_web_key**](AdminApi.md#delete_json_web_key) | **DELETE** /keys/{set}/{kid} | Delete a JSON Web Key
13
13
  [**delete_json_web_key_set**](AdminApi.md#delete_json_web_key_set) | **DELETE** /keys/{set} | Delete a JSON Web Key Set
14
14
  [**delete_o_auth2_client**](AdminApi.md#delete_o_auth2_client) | **DELETE** /clients/{id} | Deletes an OAuth 2.0 Client
15
- [**delete_o_auth2_token**](AdminApi.md#delete_o_auth2_token) | **DELETE** /oauth2/tokens | Delete OAuth2 Access Tokens from a Client
16
15
  [**flush_inactive_o_auth2_tokens**](AdminApi.md#flush_inactive_o_auth2_tokens) | **POST** /oauth2/flush | Flush Expired OAuth2 Access Tokens
17
- [**get_consent_request**](AdminApi.md#get_consent_request) | **GET** /oauth2/auth/requests/consent | Get Consent Request Information
16
+ [**get_consent_request**](AdminApi.md#get_consent_request) | **GET** /oauth2/auth/requests/consent | Get consent request information
18
17
  [**get_json_web_key**](AdminApi.md#get_json_web_key) | **GET** /keys/{set}/{kid} | Fetch a JSON Web Key
19
18
  [**get_json_web_key_set**](AdminApi.md#get_json_web_key_set) | **GET** /keys/{set} | Retrieve a JSON Web Key Set
20
- [**get_login_request**](AdminApi.md#get_login_request) | **GET** /oauth2/auth/requests/login | Get a Login Request
21
- [**get_logout_request**](AdminApi.md#get_logout_request) | **GET** /oauth2/auth/requests/logout | Get a Logout Request
19
+ [**get_login_request**](AdminApi.md#get_login_request) | **GET** /oauth2/auth/requests/login | Get an login request
20
+ [**get_logout_request**](AdminApi.md#get_logout_request) | **GET** /oauth2/auth/requests/logout | Get a logout request
22
21
  [**get_o_auth2_client**](AdminApi.md#get_o_auth2_client) | **GET** /clients/{id} | Get an OAuth 2.0 Client.
23
- [**get_version**](AdminApi.md#get_version) | **GET** /version | Get Service Version
24
- [**introspect_o_auth2_token**](AdminApi.md#introspect_o_auth2_token) | **POST** /oauth2/introspect | Introspect OAuth2 Tokens
25
- [**is_instance_alive**](AdminApi.md#is_instance_alive) | **GET** /health/alive | Check Alive Status
22
+ [**get_version**](AdminApi.md#get_version) | **GET** /version | Get service version
23
+ [**introspect_o_auth2_token**](AdminApi.md#introspect_o_auth2_token) | **POST** /oauth2/introspect | Introspect OAuth2 tokens
24
+ [**is_instance_alive**](AdminApi.md#is_instance_alive) | **GET** /health/alive | Check alive status
26
25
  [**list_o_auth2_clients**](AdminApi.md#list_o_auth2_clients) | **GET** /clients | List OAuth 2.0 Clients
27
- [**list_subject_consent_sessions**](AdminApi.md#list_subject_consent_sessions) | **GET** /oauth2/auth/sessions/consent | Lists All Consent Sessions of a Subject
28
- [**prometheus**](AdminApi.md#prometheus) | **GET** /metrics/prometheus | Get Snapshot Metrics from the Hydra Service.
29
- [**reject_consent_request**](AdminApi.md#reject_consent_request) | **PUT** /oauth2/auth/requests/consent/reject | Reject a Consent Request
30
- [**reject_login_request**](AdminApi.md#reject_login_request) | **PUT** /oauth2/auth/requests/login/reject | Reject a Login Request
31
- [**reject_logout_request**](AdminApi.md#reject_logout_request) | **PUT** /oauth2/auth/requests/logout/reject | Reject a Logout Request
32
- [**revoke_authentication_session**](AdminApi.md#revoke_authentication_session) | **DELETE** /oauth2/auth/sessions/login | Invalidates All Login Sessions of a Certain User Invalidates a Subject's Authentication Session
33
- [**revoke_consent_sessions**](AdminApi.md#revoke_consent_sessions) | **DELETE** /oauth2/auth/sessions/consent | Revokes Consent Sessions of a Subject for a Specific OAuth 2.0 Client
26
+ [**list_subject_consent_sessions**](AdminApi.md#list_subject_consent_sessions) | **GET** /oauth2/auth/sessions/consent | Lists all consent sessions of a subject
27
+ [**prometheus**](AdminApi.md#prometheus) | **GET** /metrics/prometheus | Get snapshot metrics from the Hydra service. If you're using k8s, you can then add annotations to your deployment like so:
28
+ [**reject_consent_request**](AdminApi.md#reject_consent_request) | **PUT** /oauth2/auth/requests/consent/reject | Reject an consent request
29
+ [**reject_login_request**](AdminApi.md#reject_login_request) | **PUT** /oauth2/auth/requests/login/reject | Reject a login request
30
+ [**reject_logout_request**](AdminApi.md#reject_logout_request) | **PUT** /oauth2/auth/requests/logout/reject | Reject a logout request
31
+ [**revoke_authentication_session**](AdminApi.md#revoke_authentication_session) | **DELETE** /oauth2/auth/sessions/login | Invalidates all login sessions of a certain user Invalidates a subject's authentication session
32
+ [**revoke_consent_sessions**](AdminApi.md#revoke_consent_sessions) | **DELETE** /oauth2/auth/sessions/consent | Revokes consent sessions of a subject for a specific OAuth 2.0 Client
34
33
  [**update_json_web_key**](AdminApi.md#update_json_web_key) | **PUT** /keys/{set}/{kid} | Update a JSON Web Key
35
34
  [**update_json_web_key_set**](AdminApi.md#update_json_web_key_set) | **PUT** /keys/{set} | Update a JSON Web Key Set
36
35
  [**update_o_auth2_client**](AdminApi.md#update_o_auth2_client) | **PUT** /clients/{id} | Update an OAuth 2.0 Client
@@ -41,7 +40,7 @@ Method | HTTP request | Description
41
40
 
42
41
  > CompletedRequest accept_consent_request(consent_challenge, opts)
43
42
 
44
- Accept a Consent Request
43
+ Accept an consent request
45
44
 
46
45
  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 authorized the OAuth 2.0 client to access resources on his/her behalf. The consent provider includes additional information, such as session data for access and ID tokens, and if the consent request should be used as basis for future requests. The response contains a redirect URL which the consent provider should redirect the user-agent to.
47
46
 
@@ -58,7 +57,7 @@ opts = {
58
57
  }
59
58
 
60
59
  begin
61
- #Accept a Consent Request
60
+ #Accept an consent request
62
61
  result = api_instance.accept_consent_request(consent_challenge, opts)
63
62
  p result
64
63
  rescue OryHydraClient::ApiError => e
@@ -92,7 +91,7 @@ No authorization required
92
91
 
93
92
  > CompletedRequest accept_login_request(login_challenge, opts)
94
93
 
95
- Accept a Login Request
94
+ Accept an login request
96
95
 
97
96
  When an authorization code, hybrid, or implicit OAuth 2.0 Flow is initiated, ORY Hydra asks the login provider (sometimes called \"identity provider\") to authenticate the subject and then tell ORY Hydra now about it. The login provider is an web-app you write and host, and it must be able to authenticate (\"show the subject a login screen\") a subject (in OAuth2 the proper name for subject is \"resource owner\"). The authentication challenge is appended to the login provider URL to which the subject's user-agent (browser) is redirected to. The login provider uses that challenge to fetch information on the OAuth2 request and then accept or reject the requested authentication process. This endpoint tells ORY Hydra that the subject has successfully authenticated and includes additional information such as the subject's ID and if ORY Hydra should remember the subject's subject agent for future authentication attempts by setting a cookie. The response contains a redirect URL which the login provider should redirect the user-agent to.
98
97
 
@@ -109,7 +108,7 @@ opts = {
109
108
  }
110
109
 
111
110
  begin
112
- #Accept a Login Request
111
+ #Accept an login request
113
112
  result = api_instance.accept_login_request(login_challenge, opts)
114
113
  p result
115
114
  rescue OryHydraClient::ApiError => e
@@ -143,7 +142,7 @@ No authorization required
143
142
 
144
143
  > CompletedRequest accept_logout_request(logout_challenge)
145
144
 
146
- Accept a Logout Request
145
+ Accept a logout request
147
146
 
148
147
  When a user or an application requests ORY Hydra to log out a user, this endpoint is used to confirm that logout request. No body is required. The response contains a redirect URL which the consent provider should redirect the user-agent to.
149
148
 
@@ -157,7 +156,7 @@ api_instance = OryHydraClient::AdminApi.new
157
156
  logout_challenge = 'logout_challenge_example' # String |
158
157
 
159
158
  begin
160
- #Accept a Logout Request
159
+ #Accept a logout request
161
160
  result = api_instance.accept_logout_request(logout_challenge)
162
161
  p result
163
162
  rescue OryHydraClient::ApiError => e
@@ -190,7 +189,7 @@ No authorization required
190
189
 
191
190
  > JSONWebKeySet create_json_web_key_set(set, opts)
192
191
 
193
- Generate a New JSON Web Key
192
+ Generate a new JSON Web Key
194
193
 
195
194
  This endpoint is capable of generating JSON Web Key Sets for you. There a different strategies available, such as symmetric cryptographic keys (HS256, HS512) and asymetric cryptographic keys (RS256, ECDSA). If the specified JSON Web Key Set does not exist, it will be created. A JSON Web Key (JWK) is a JavaScript Object Notation (JSON) data structure that represents a cryptographic key. A JWK Set is a JSON data structure that represents a set of JWKs. A JSON Web Key is identified by its set and key id. ORY Hydra uses this functionality to store cryptographic keys used for TLS and JSON Web Tokens (such as OpenID Connect ID tokens), and allows storing user-defined keys as well.
196
195
 
@@ -207,7 +206,7 @@ opts = {
207
206
  }
208
207
 
209
208
  begin
210
- #Generate a New JSON Web Key
209
+ #Generate a new JSON Web Key
211
210
  result = api_instance.create_json_web_key_set(set, opts)
212
211
  p result
213
212
  rescue OryHydraClient::ApiError => e
@@ -241,7 +240,7 @@ No authorization required
241
240
 
242
241
  > OAuth2Client create_o_auth2_client(body)
243
242
 
244
- Create an OAuth 2.0 Client
243
+ Create an OAuth 2.0 client
245
244
 
246
245
  Create a new OAuth 2.0 client If you pass `client_secret` the secret will be used, otherwise a random secret will be generated. The secret will be returned in the response and you will not be able to retrieve it later on. Write the secret down and keep it somwhere 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.
247
246
 
@@ -255,7 +254,7 @@ api_instance = OryHydraClient::AdminApi.new
255
254
  body = OryHydraClient::OAuth2Client.new # OAuth2Client |
256
255
 
257
256
  begin
258
- #Create an OAuth 2.0 Client
257
+ #Create an OAuth 2.0 client
259
258
  result = api_instance.create_o_auth2_client(body)
260
259
  p result
261
260
  rescue OryHydraClient::ApiError => e
@@ -424,52 +423,6 @@ No authorization required
424
423
  - **Accept**: application/json
425
424
 
426
425
 
427
- ## delete_o_auth2_token
428
-
429
- > delete_o_auth2_token(client_id)
430
-
431
- Delete OAuth2 Access Tokens from a Client
432
-
433
- This endpoint deletes OAuth2 access tokens issued for a client from the database
434
-
435
- ### Example
436
-
437
- ```ruby
438
- # load the gem
439
- require 'ory-hydra-client'
440
-
441
- api_instance = OryHydraClient::AdminApi.new
442
- client_id = 'client_id_example' # String |
443
-
444
- begin
445
- #Delete OAuth2 Access Tokens from a Client
446
- api_instance.delete_o_auth2_token(client_id)
447
- rescue OryHydraClient::ApiError => e
448
- puts "Exception when calling AdminApi->delete_o_auth2_token: #{e}"
449
- end
450
- ```
451
-
452
- ### Parameters
453
-
454
-
455
- Name | Type | Description | Notes
456
- ------------- | ------------- | ------------- | -------------
457
- **client_id** | **String**| |
458
-
459
- ### Return type
460
-
461
- nil (empty response body)
462
-
463
- ### Authorization
464
-
465
- No authorization required
466
-
467
- ### HTTP request headers
468
-
469
- - **Content-Type**: Not defined
470
- - **Accept**: application/json
471
-
472
-
473
426
  ## flush_inactive_o_auth2_tokens
474
427
 
475
428
  > flush_inactive_o_auth2_tokens(opts)
@@ -522,7 +475,7 @@ No authorization required
522
475
 
523
476
  > ConsentRequest get_consent_request(consent_challenge)
524
477
 
525
- Get Consent Request Information
478
+ Get consent request information
526
479
 
527
480
  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.
528
481
 
@@ -536,7 +489,7 @@ api_instance = OryHydraClient::AdminApi.new
536
489
  consent_challenge = 'consent_challenge_example' # String |
537
490
 
538
491
  begin
539
- #Get Consent Request Information
492
+ #Get consent request information
540
493
  result = api_instance.get_consent_request(consent_challenge)
541
494
  p result
542
495
  rescue OryHydraClient::ApiError => e
@@ -665,7 +618,7 @@ No authorization required
665
618
 
666
619
  > LoginRequest get_login_request(login_challenge)
667
620
 
668
- Get a Login Request
621
+ Get an login request
669
622
 
670
623
  When an authorization code, hybrid, or implicit OAuth 2.0 Flow is initiated, ORY Hydra asks the login provider (sometimes called \"identity provider\") to authenticate the subject and then tell ORY Hydra now about it. The login provider is an web-app you write and host, and it must be able to authenticate (\"show the subject a login screen\") a subject (in OAuth2 the proper name for subject is \"resource owner\"). The authentication challenge is appended to the login provider URL to which the subject's user-agent (browser) is redirected to. The login provider uses that challenge to fetch information on the OAuth2 request and then accept or reject the requested authentication process.
671
624
 
@@ -679,7 +632,7 @@ api_instance = OryHydraClient::AdminApi.new
679
632
  login_challenge = 'login_challenge_example' # String |
680
633
 
681
634
  begin
682
- #Get a Login Request
635
+ #Get an login request
683
636
  result = api_instance.get_login_request(login_challenge)
684
637
  p result
685
638
  rescue OryHydraClient::ApiError => e
@@ -712,7 +665,7 @@ No authorization required
712
665
 
713
666
  > LogoutRequest get_logout_request(logout_challenge)
714
667
 
715
- Get a Logout Request
668
+ Get a logout request
716
669
 
717
670
  Use this endpoint to fetch a logout request.
718
671
 
@@ -726,7 +679,7 @@ api_instance = OryHydraClient::AdminApi.new
726
679
  logout_challenge = 'logout_challenge_example' # String |
727
680
 
728
681
  begin
729
- #Get a Logout Request
682
+ #Get a logout request
730
683
  result = api_instance.get_logout_request(logout_challenge)
731
684
  p result
732
685
  rescue OryHydraClient::ApiError => e
@@ -806,7 +759,7 @@ No authorization required
806
759
 
807
760
  > Version get_version
808
761
 
809
- Get Service Version
762
+ Get service version
810
763
 
811
764
  This endpoint returns the service version typically notated using semantic versioning. If the service supports TLS Edge Termination, this endpoint does not require the `X-Forwarded-Proto` header to be set.
812
765
 
@@ -819,7 +772,7 @@ require 'ory-hydra-client'
819
772
  api_instance = OryHydraClient::AdminApi.new
820
773
 
821
774
  begin
822
- #Get Service Version
775
+ #Get service version
823
776
  result = api_instance.get_version
824
777
  p result
825
778
  rescue OryHydraClient::ApiError => e
@@ -849,7 +802,7 @@ No authorization required
849
802
 
850
803
  > OAuth2TokenIntrospection introspect_o_auth2_token(token, opts)
851
804
 
852
- Introspect OAuth2 Tokens
805
+ Introspect OAuth2 tokens
853
806
 
854
807
  The introspection endpoint allows to check if a token (both refresh and access) is active or not. An active token is neither expired nor revoked. If a token is active, additional information on the token will be included. You can set additional data for a token by setting `accessTokenExtra` during the consent flow. For more information [read this blog post](https://www.oauth.com/oauth2-servers/token-introspection-endpoint/).
855
808
 
@@ -858,6 +811,15 @@ The introspection endpoint allows to check if a token (both refresh and access)
858
811
  ```ruby
859
812
  # load the gem
860
813
  require 'ory-hydra-client'
814
+ # setup authorization
815
+ OryHydraClient.configure do |config|
816
+ # Configure HTTP basic authorization: basic
817
+ config.username = 'YOUR USERNAME'
818
+ config.password = 'YOUR PASSWORD'
819
+
820
+ # Configure OAuth2 access token for authorization: oauth2
821
+ config.access_token = 'YOUR ACCESS TOKEN'
822
+ end
861
823
 
862
824
  api_instance = OryHydraClient::AdminApi.new
863
825
  token = 'token_example' # String | The string value of the token. For access tokens, this is the \\\"access_token\\\" value returned from the token endpoint defined in OAuth 2.0. For refresh tokens, this is the \\\"refresh_token\\\" value returned.
@@ -866,7 +828,7 @@ opts = {
866
828
  }
867
829
 
868
830
  begin
869
- #Introspect OAuth2 Tokens
831
+ #Introspect OAuth2 tokens
870
832
  result = api_instance.introspect_o_auth2_token(token, opts)
871
833
  p result
872
834
  rescue OryHydraClient::ApiError => e
@@ -888,7 +850,7 @@ Name | Type | Description | Notes
888
850
 
889
851
  ### Authorization
890
852
 
891
- No authorization required
853
+ [basic](../README.md#basic), [oauth2](../README.md#oauth2)
892
854
 
893
855
  ### HTTP request headers
894
856
 
@@ -900,7 +862,7 @@ No authorization required
900
862
 
901
863
  > HealthStatus is_instance_alive
902
864
 
903
- Check Alive Status
865
+ Check alive status
904
866
 
905
867
  This endpoint returns a 200 status code when the HTTP server is up running. This status does currently not include checks whether the database connection is working. If the service supports TLS Edge Termination, this endpoint does not require the `X-Forwarded-Proto` header to be set. Be aware that if you are running multiple nodes of this service, the health status will never refer to the cluster state, only to a single instance.
906
868
 
@@ -913,7 +875,7 @@ require 'ory-hydra-client'
913
875
  api_instance = OryHydraClient::AdminApi.new
914
876
 
915
877
  begin
916
- #Check Alive Status
878
+ #Check alive status
917
879
  result = api_instance.is_instance_alive
918
880
  p result
919
881
  rescue OryHydraClient::ApiError => e
@@ -945,7 +907,7 @@ No authorization required
945
907
 
946
908
  List OAuth 2.0 Clients
947
909
 
948
- 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.
910
+ This endpoint lists all clients in the database, and never returns client secrets. 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.
949
911
 
950
912
  ### Example
951
913
 
@@ -955,7 +917,7 @@ require 'ory-hydra-client'
955
917
 
956
918
  api_instance = OryHydraClient::AdminApi.new
957
919
  opts = {
958
- limit: 56, # Integer | The maximum amount of policies returned, upper bound is 500 policies
920
+ limit: 56, # Integer | The maximum amount of policies returned.
959
921
  offset: 56 # Integer | The offset from where to start looking.
960
922
  }
961
923
 
@@ -973,7 +935,7 @@ end
973
935
 
974
936
  Name | Type | Description | Notes
975
937
  ------------- | ------------- | ------------- | -------------
976
- **limit** | **Integer**| The maximum amount of policies returned, upper bound is 500 policies | [optional]
938
+ **limit** | **Integer**| The maximum amount of policies returned. | [optional]
977
939
  **offset** | **Integer**| The offset from where to start looking. | [optional]
978
940
 
979
941
  ### Return type
@@ -994,9 +956,9 @@ No authorization required
994
956
 
995
957
  > Array&lt;PreviousConsentSession&gt; list_subject_consent_sessions(subject)
996
958
 
997
- Lists All Consent Sessions of a Subject
959
+ Lists all consent sessions of a subject
998
960
 
999
- This endpoint lists all subject's granted consent sessions, including client and granted scope. If the subject is unknown or has not granted any consent sessions yet, the endpoint returns an empty JSON array with status code 200 OK. The \"Link\" header is also included in successful responses, which contains one or more links for pagination, formatted like so: '<https://hydra-url/admin/oauth2/auth/sessions/consent?subject={user}&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.
961
+ This endpoint lists all subject's granted consent sessions, including client and granted scope. The \"Link\" header is also included in successful responses, which contains one or more links for pagination, formatted like so: '<https://hydra-url/admin/oauth2/auth/sessions/consent?subject={user}&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.
1000
962
 
1001
963
  ### Example
1002
964
 
@@ -1008,7 +970,7 @@ api_instance = OryHydraClient::AdminApi.new
1008
970
  subject = 'subject_example' # String |
1009
971
 
1010
972
  begin
1011
- #Lists All Consent Sessions of a Subject
973
+ #Lists all consent sessions of a subject
1012
974
  result = api_instance.list_subject_consent_sessions(subject)
1013
975
  p result
1014
976
  rescue OryHydraClient::ApiError => e
@@ -1041,9 +1003,9 @@ No authorization required
1041
1003
 
1042
1004
  > prometheus
1043
1005
 
1044
- Get Snapshot Metrics from the Hydra Service.
1006
+ Get snapshot metrics from the Hydra service. If you're using k8s, you can then add annotations to your deployment like so:
1045
1007
 
1046
- 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.
1008
+ ``` metadata: annotations: prometheus.io/port: \"4445\" prometheus.io/path: \"/metrics/prometheus\" ```
1047
1009
 
1048
1010
  ### Example
1049
1011
 
@@ -1054,7 +1016,7 @@ require 'ory-hydra-client'
1054
1016
  api_instance = OryHydraClient::AdminApi.new
1055
1017
 
1056
1018
  begin
1057
- #Get Snapshot Metrics from the Hydra Service.
1019
+ #Get snapshot metrics from the Hydra service. If you're using k8s, you can then add annotations to your deployment like so:
1058
1020
  api_instance.prometheus
1059
1021
  rescue OryHydraClient::ApiError => e
1060
1022
  puts "Exception when calling AdminApi->prometheus: #{e}"
@@ -1083,7 +1045,7 @@ No authorization required
1083
1045
 
1084
1046
  > CompletedRequest reject_consent_request(consent_challenge, opts)
1085
1047
 
1086
- Reject a Consent Request
1048
+ Reject an consent request
1087
1049
 
1088
1050
  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.
1089
1051
 
@@ -1100,7 +1062,7 @@ opts = {
1100
1062
  }
1101
1063
 
1102
1064
  begin
1103
- #Reject a Consent Request
1065
+ #Reject an consent request
1104
1066
  result = api_instance.reject_consent_request(consent_challenge, opts)
1105
1067
  p result
1106
1068
  rescue OryHydraClient::ApiError => e
@@ -1134,7 +1096,7 @@ No authorization required
1134
1096
 
1135
1097
  > CompletedRequest reject_login_request(login_challenge, opts)
1136
1098
 
1137
- Reject a Login Request
1099
+ Reject a login request
1138
1100
 
1139
1101
  When an authorization code, hybrid, or implicit OAuth 2.0 Flow is initiated, ORY Hydra asks the login provider (sometimes called \"identity provider\") to authenticate the subject and then tell ORY Hydra now about it. The login provider is an web-app you write and host, and it must be able to authenticate (\"show the subject a login screen\") a subject (in OAuth2 the proper name for subject is \"resource owner\"). The authentication challenge is appended to the login provider URL to which the subject's user-agent (browser) is redirected to. The login provider uses that challenge to fetch information on the OAuth2 request and then accept or reject the requested authentication process. This endpoint tells ORY Hydra that the subject has not authenticated and includes a reason why the authentication was be denied. The response contains a redirect URL which the login provider should redirect the user-agent to.
1140
1102
 
@@ -1151,7 +1113,7 @@ opts = {
1151
1113
  }
1152
1114
 
1153
1115
  begin
1154
- #Reject a Login Request
1116
+ #Reject a login request
1155
1117
  result = api_instance.reject_login_request(login_challenge, opts)
1156
1118
  p result
1157
1119
  rescue OryHydraClient::ApiError => e
@@ -1185,7 +1147,7 @@ No authorization required
1185
1147
 
1186
1148
  > reject_logout_request(logout_challenge, opts)
1187
1149
 
1188
- Reject a Logout Request
1150
+ Reject a logout request
1189
1151
 
1190
1152
  When a user or an application requests ORY Hydra to log out a user, this endpoint is used to deny that logout request. No body is required. The response is empty as the logout provider has to chose what action to perform next.
1191
1153
 
@@ -1202,7 +1164,7 @@ opts = {
1202
1164
  }
1203
1165
 
1204
1166
  begin
1205
- #Reject a Logout Request
1167
+ #Reject a logout request
1206
1168
  api_instance.reject_logout_request(logout_challenge, opts)
1207
1169
  rescue OryHydraClient::ApiError => e
1208
1170
  puts "Exception when calling AdminApi->reject_logout_request: #{e}"
@@ -1235,7 +1197,7 @@ No authorization required
1235
1197
 
1236
1198
  > revoke_authentication_session(subject)
1237
1199
 
1238
- Invalidates All Login Sessions of a Certain User Invalidates a Subject's Authentication Session
1200
+ Invalidates all login sessions of a certain user Invalidates a subject's authentication session
1239
1201
 
1240
1202
  This endpoint invalidates a subject's authentication session. After revoking the authentication session, the subject has to re-authenticate at ORY Hydra. This endpoint does not invalidate any tokens and does not work with OpenID Connect Front- or Back-channel logout.
1241
1203
 
@@ -1249,7 +1211,7 @@ api_instance = OryHydraClient::AdminApi.new
1249
1211
  subject = 'subject_example' # String |
1250
1212
 
1251
1213
  begin
1252
- #Invalidates All Login Sessions of a Certain User Invalidates a Subject's Authentication Session
1214
+ #Invalidates all login sessions of a certain user Invalidates a subject's authentication session
1253
1215
  api_instance.revoke_authentication_session(subject)
1254
1216
  rescue OryHydraClient::ApiError => e
1255
1217
  puts "Exception when calling AdminApi->revoke_authentication_session: #{e}"
@@ -1281,7 +1243,7 @@ No authorization required
1281
1243
 
1282
1244
  > revoke_consent_sessions(subject, opts)
1283
1245
 
1284
- Revokes Consent Sessions of a Subject for a Specific OAuth 2.0 Client
1246
+ Revokes consent sessions of a subject for a specific OAuth 2.0 Client
1285
1247
 
1286
1248
  This endpoint revokes a subject's granted consent sessions for a specific OAuth 2.0 Client and invalidates all associated OAuth 2.0 Access Tokens.
1287
1249
 
@@ -1294,12 +1256,11 @@ require 'ory-hydra-client'
1294
1256
  api_instance = OryHydraClient::AdminApi.new
1295
1257
  subject = 'subject_example' # String | The subject (Subject) who's consent sessions should be deleted.
1296
1258
  opts = {
1297
- client: 'client_example', # String | If set, deletes only those consent sessions by the Subject that have been granted to the specified OAuth 2.0 Client ID
1298
- all: true # Boolean | If set to `?all=true`, deletes all consent sessions by the Subject that have been granted.
1259
+ client: 'client_example' # String | If set, deletes only those consent sessions by the Subject that have been granted to the specified OAuth 2.0 Client ID
1299
1260
  }
1300
1261
 
1301
1262
  begin
1302
- #Revokes Consent Sessions of a Subject for a Specific OAuth 2.0 Client
1263
+ #Revokes consent sessions of a subject for a specific OAuth 2.0 Client
1303
1264
  api_instance.revoke_consent_sessions(subject, opts)
1304
1265
  rescue OryHydraClient::ApiError => e
1305
1266
  puts "Exception when calling AdminApi->revoke_consent_sessions: #{e}"
@@ -1313,7 +1274,6 @@ Name | Type | Description | Notes
1313
1274
  ------------- | ------------- | ------------- | -------------
1314
1275
  **subject** | **String**| The subject (Subject) who&#39;s consent sessions should be deleted. |
1315
1276
  **client** | **String**| If set, deletes only those consent sessions by the Subject that have been granted to the specified OAuth 2.0 Client ID | [optional]
1316
- **all** | **Boolean**| If set to &#x60;?all&#x3D;true&#x60;, deletes all consent sessions by the Subject that have been granted. | [optional]
1317
1277
 
1318
1278
  ### Return type
1319
1279