ory-hydra-client 0.0.0.alpha56 → 0.0.0.alpha63
Sign up to get free protection for your applications and to get access to all the features.
- checksums.yaml +4 -4
- data/Gemfile +1 -1
- data/README.md +46 -32
- data/docs/AcceptConsentRequest.md +4 -2
- data/docs/AcceptLoginRequest.md +1 -1
- data/docs/AdminApi.md +111 -71
- data/docs/CompletedRequest.md +1 -1
- data/docs/ConsentRequest.md +4 -4
- data/docs/ConsentRequestSession.md +2 -2
- data/docs/ContainerWaitOKBodyError.md +17 -0
- data/docs/LoginRequest.md +7 -7
- data/docs/OAuth2Client.md +13 -11
- data/docs/OAuth2TokenIntrospection.md +5 -3
- data/docs/OpenIDConnectContext.md +1 -1
- data/docs/PluginConfig.md +47 -0
- data/docs/PluginConfigArgs.md +23 -0
- data/docs/PluginConfigInterface.md +19 -0
- data/docs/PluginConfigLinux.md +21 -0
- data/docs/PluginConfigNetwork.md +17 -0
- data/docs/PluginConfigRootfs.md +19 -0
- data/docs/PluginConfigUser.md +19 -0
- data/docs/PluginDevice.md +23 -0
- data/docs/PluginEnv.md +23 -0
- data/docs/PluginInterfaceType.md +21 -0
- data/docs/PluginMount.md +29 -0
- data/docs/PluginSettings.md +23 -0
- data/docs/PreviousConsentSession.md +4 -2
- data/docs/PublicApi.md +16 -16
- data/docs/RejectRequest.md +5 -5
- data/docs/VolumeUsageData.md +19 -0
- data/docs/WellKnown.md +3 -1
- data/lib/ory-hydra-client.rb +16 -3
- data/lib/ory-hydra-client/api/admin_api.rb +115 -49
- data/lib/ory-hydra-client/api/public_api.rb +14 -14
- data/lib/ory-hydra-client/api_client.rb +9 -7
- data/lib/ory-hydra-client/api_error.rb +2 -2
- data/lib/ory-hydra-client/configuration.rb +2 -2
- data/lib/ory-hydra-client/models/accept_consent_request.rb +12 -5
- data/lib/ory-hydra-client/models/accept_login_request.rb +4 -7
- data/lib/ory-hydra-client/models/completed_request.rb +7 -2
- data/lib/ory-hydra-client/models/consent_request.rb +10 -10
- data/lib/ory-hydra-client/models/consent_request_session.rb +6 -10
- data/lib/ory-hydra-client/models/container_wait_ok_body_error.rb +208 -0
- data/lib/ory-hydra-client/models/flush_inactive_o_auth2_tokens_request.rb +2 -2
- data/lib/ory-hydra-client/models/generic_error.rb +2 -2
- data/lib/ory-hydra-client/models/health_not_ready_status.rb +2 -2
- data/lib/ory-hydra-client/models/health_status.rb +2 -2
- data/lib/ory-hydra-client/models/json_web_key.rb +3 -2
- data/lib/ory-hydra-client/models/json_web_key_set.rb +3 -2
- data/lib/ory-hydra-client/models/json_web_key_set_generator_request.rb +2 -2
- data/lib/ory-hydra-client/models/login_request.rb +38 -5
- data/lib/ory-hydra-client/models/logout_request.rb +2 -2
- data/lib/ory-hydra-client/models/o_auth2_client.rb +17 -18
- data/lib/ory-hydra-client/models/o_auth2_token_introspection.rb +17 -9
- data/lib/ory-hydra-client/models/oauth2_token_response.rb +2 -2
- data/lib/ory-hydra-client/models/open_id_connect_context.rb +4 -6
- data/lib/ory-hydra-client/models/plugin_config.rb +422 -0
- data/lib/ory-hydra-client/models/plugin_config_args.rb +262 -0
- data/lib/ory-hydra-client/models/plugin_config_interface.rb +230 -0
- data/lib/ory-hydra-client/models/plugin_config_linux.rb +247 -0
- data/lib/ory-hydra-client/models/plugin_config_network.rb +213 -0
- data/lib/ory-hydra-client/models/plugin_config_rootfs.rb +220 -0
- data/lib/ory-hydra-client/models/plugin_config_user.rb +218 -0
- data/lib/ory-hydra-client/models/plugin_device.rb +260 -0
- data/lib/ory-hydra-client/models/plugin_env.rb +260 -0
- data/lib/ory-hydra-client/models/plugin_interface_type.rb +243 -0
- data/lib/ory-hydra-client/models/plugin_mount.rb +307 -0
- data/lib/ory-hydra-client/models/plugin_settings.rb +265 -0
- data/lib/ory-hydra-client/models/previous_consent_session.rb +12 -5
- data/lib/ory-hydra-client/models/reject_request.rb +7 -2
- data/lib/ory-hydra-client/models/userinfo_response.rb +2 -2
- data/lib/ory-hydra-client/models/version.rb +2 -2
- data/lib/ory-hydra-client/models/volume_usage_data.rb +228 -0
- data/lib/ory-hydra-client/models/well_known.rb +15 -3
- data/lib/ory-hydra-client/version.rb +3 -3
- data/ory-hydra-client.gemspec +2 -2
- data/spec/models/container_wait_ok_body_error_spec.rb +41 -0
- data/spec/models/plugin_config_args_spec.rb +59 -0
- data/spec/models/plugin_config_interface_spec.rb +47 -0
- data/spec/models/plugin_config_linux_spec.rb +53 -0
- data/spec/models/plugin_config_network_spec.rb +41 -0
- data/spec/models/plugin_config_rootfs_spec.rb +47 -0
- data/spec/models/plugin_config_spec.rb +131 -0
- data/spec/models/plugin_config_user_spec.rb +47 -0
- data/spec/models/plugin_device_spec.rb +59 -0
- data/spec/models/plugin_env_spec.rb +59 -0
- data/spec/models/plugin_interface_type_spec.rb +53 -0
- data/spec/models/plugin_mount_spec.rb +77 -0
- data/spec/models/plugin_settings_spec.rb +59 -0
- data/spec/models/volume_usage_data_spec.rb +47 -0
- metadata +73 -17
checksums.yaml
CHANGED
@@ -1,7 +1,7 @@
|
|
1
1
|
---
|
2
2
|
SHA256:
|
3
|
-
metadata.gz:
|
4
|
-
data.tar.gz:
|
3
|
+
metadata.gz: d25d2dd76c851c2eb8072e50ba83fc5e8fa405060c61fb8efd2b46f3bea7db9d
|
4
|
+
data.tar.gz: dd054e8d57a2942297f1bb8bb6e00918b742c2fa142560335990156c2d92fd54
|
5
5
|
SHA512:
|
6
|
-
metadata.gz:
|
7
|
-
data.tar.gz:
|
6
|
+
metadata.gz: ec46aedeec5ef2ddb5918bf14226d47e225c353048e5331577c80ff9c317774488a289cc0c53c688c7e30e4efc3e7fdf97d58cd87a01ef5e7c0f731cbee5c72b
|
7
|
+
data.tar.gz: 5d453e6e3f947c84b9f4d5a99cd67c3887539d3d6f7c7d5155dec2f8254f1d0886864edd6428d19b246bab5c3e122d5cd722a4188d1fb0281c84130f9421db11
|
data/Gemfile
CHANGED
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.
|
10
|
-
- Package version: v0.0.0-alpha.
|
9
|
+
- API version: v0.0.0-alpha.63
|
10
|
+
- Package version: v0.0.0-alpha.63
|
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.
|
26
|
+
gem install ./ory-hydra-client-v0.0.0-alpha.63.gem
|
27
27
|
```
|
28
28
|
|
29
|
-
(for development, run `gem install --dev ./ory-hydra-client-v0.0.0-alpha.
|
29
|
+
(for development, run `gem install --dev ./ory-hydra-client-v0.0.0-alpha.63.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.
|
35
|
+
gem 'ory-hydra-client', '~> v0.0.0-alpha.63'
|
36
36
|
|
37
37
|
### Install from Git
|
38
38
|
|
@@ -63,7 +63,7 @@ opts = {
|
|
63
63
|
}
|
64
64
|
|
65
65
|
begin
|
66
|
-
#Accept
|
66
|
+
#Accept a Consent Request
|
67
67
|
result = api_instance.accept_consent_request(consent_challenge, opts)
|
68
68
|
p result
|
69
69
|
rescue OryHydraClient::ApiError => e
|
@@ -78,41 +78,42 @@ 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
|
82
|
-
*OryHydraClient::AdminApi* | [**accept_login_request**](docs/AdminApi.md#accept_login_request) | **PUT** /oauth2/auth/requests/login/accept | Accept
|
83
|
-
*OryHydraClient::AdminApi* | [**accept_logout_request**](docs/AdminApi.md#accept_logout_request) | **PUT** /oauth2/auth/requests/logout/accept | Accept a
|
84
|
-
*OryHydraClient::AdminApi* | [**create_json_web_key_set**](docs/AdminApi.md#create_json_web_key_set) | **POST** /keys/{set} | Generate a
|
85
|
-
*OryHydraClient::AdminApi* | [**create_o_auth2_client**](docs/AdminApi.md#create_o_auth2_client) | **POST** /clients | Create an OAuth 2.0
|
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
|
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
|
89
90
|
*OryHydraClient::AdminApi* | [**flush_inactive_o_auth2_tokens**](docs/AdminApi.md#flush_inactive_o_auth2_tokens) | **POST** /oauth2/flush | Flush Expired OAuth2 Access Tokens
|
90
|
-
*OryHydraClient::AdminApi* | [**get_consent_request**](docs/AdminApi.md#get_consent_request) | **GET** /oauth2/auth/requests/consent | Get
|
91
|
+
*OryHydraClient::AdminApi* | [**get_consent_request**](docs/AdminApi.md#get_consent_request) | **GET** /oauth2/auth/requests/consent | Get Consent Request Information
|
91
92
|
*OryHydraClient::AdminApi* | [**get_json_web_key**](docs/AdminApi.md#get_json_web_key) | **GET** /keys/{set}/{kid} | Fetch a JSON Web Key
|
92
93
|
*OryHydraClient::AdminApi* | [**get_json_web_key_set**](docs/AdminApi.md#get_json_web_key_set) | **GET** /keys/{set} | Retrieve a JSON Web Key Set
|
93
|
-
*OryHydraClient::AdminApi* | [**get_login_request**](docs/AdminApi.md#get_login_request) | **GET** /oauth2/auth/requests/login | Get
|
94
|
-
*OryHydraClient::AdminApi* | [**get_logout_request**](docs/AdminApi.md#get_logout_request) | **GET** /oauth2/auth/requests/logout | Get a
|
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
|
95
96
|
*OryHydraClient::AdminApi* | [**get_o_auth2_client**](docs/AdminApi.md#get_o_auth2_client) | **GET** /clients/{id} | Get an OAuth 2.0 Client.
|
96
|
-
*OryHydraClient::AdminApi* | [**get_version**](docs/AdminApi.md#get_version) | **GET** /version | Get
|
97
|
-
*OryHydraClient::AdminApi* | [**introspect_o_auth2_token**](docs/AdminApi.md#introspect_o_auth2_token) | **POST** /oauth2/introspect | Introspect OAuth2
|
98
|
-
*OryHydraClient::AdminApi* | [**is_instance_alive**](docs/AdminApi.md#is_instance_alive) | **GET** /health/alive | Check
|
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
|
99
100
|
*OryHydraClient::AdminApi* | [**list_o_auth2_clients**](docs/AdminApi.md#list_o_auth2_clients) | **GET** /clients | List OAuth 2.0 Clients
|
100
|
-
*OryHydraClient::AdminApi* | [**list_subject_consent_sessions**](docs/AdminApi.md#list_subject_consent_sessions) | **GET** /oauth2/auth/sessions/consent | Lists
|
101
|
-
*OryHydraClient::AdminApi* | [**prometheus**](docs/AdminApi.md#prometheus) | **GET** /metrics/prometheus | Get
|
102
|
-
*OryHydraClient::AdminApi* | [**reject_consent_request**](docs/AdminApi.md#reject_consent_request) | **PUT** /oauth2/auth/requests/consent/reject | Reject
|
103
|
-
*OryHydraClient::AdminApi* | [**reject_login_request**](docs/AdminApi.md#reject_login_request) | **PUT** /oauth2/auth/requests/login/reject | Reject a
|
104
|
-
*OryHydraClient::AdminApi* | [**reject_logout_request**](docs/AdminApi.md#reject_logout_request) | **PUT** /oauth2/auth/requests/logout/reject | Reject a
|
105
|
-
*OryHydraClient::AdminApi* | [**revoke_authentication_session**](docs/AdminApi.md#revoke_authentication_session) | **DELETE** /oauth2/auth/sessions/login | Invalidates
|
106
|
-
*OryHydraClient::AdminApi* | [**revoke_consent_sessions**](docs/AdminApi.md#revoke_consent_sessions) | **DELETE** /oauth2/auth/sessions/consent | Revokes
|
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
|
107
108
|
*OryHydraClient::AdminApi* | [**update_json_web_key**](docs/AdminApi.md#update_json_web_key) | **PUT** /keys/{set}/{kid} | Update a JSON Web Key
|
108
109
|
*OryHydraClient::AdminApi* | [**update_json_web_key_set**](docs/AdminApi.md#update_json_web_key_set) | **PUT** /keys/{set} | Update a JSON Web Key Set
|
109
110
|
*OryHydraClient::AdminApi* | [**update_o_auth2_client**](docs/AdminApi.md#update_o_auth2_client) | **PUT** /clients/{id} | Update an OAuth 2.0 Client
|
110
|
-
*OryHydraClient::PublicApi* | [**disconnect_user**](docs/PublicApi.md#disconnect_user) | **GET** /oauth2/sessions/logout | OpenID Connect Front-Backchannel
|
111
|
+
*OryHydraClient::PublicApi* | [**disconnect_user**](docs/PublicApi.md#disconnect_user) | **GET** /oauth2/sessions/logout | OpenID Connect Front-Backchannel Enabled Logout
|
111
112
|
*OryHydraClient::PublicApi* | [**discover_open_id_configuration**](docs/PublicApi.md#discover_open_id_configuration) | **GET** /.well-known/openid-configuration | OpenID Connect Discovery
|
112
|
-
*OryHydraClient::PublicApi* | [**is_instance_ready**](docs/PublicApi.md#is_instance_ready) | **GET** /health/ready | Check
|
113
|
-
*OryHydraClient::PublicApi* | [**oauth2_token**](docs/PublicApi.md#oauth2_token) | **POST** /oauth2/token | The OAuth 2.0
|
114
|
-
*OryHydraClient::PublicApi* | [**oauth_auth**](docs/PublicApi.md#oauth_auth) | **GET** /oauth2/auth | The OAuth 2.0
|
115
|
-
*OryHydraClient::PublicApi* | [**revoke_o_auth2_token**](docs/PublicApi.md#revoke_o_auth2_token) | **POST** /oauth2/revoke | Revoke OAuth2
|
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
|
116
117
|
*OryHydraClient::PublicApi* | [**userinfo**](docs/PublicApi.md#userinfo) | **GET** /userinfo | OpenID Connect Userinfo
|
117
118
|
*OryHydraClient::PublicApi* | [**well_known**](docs/PublicApi.md#well_known) | **GET** /.well-known/jwks.json | JSON Web Keys Discovery
|
118
119
|
|
@@ -124,6 +125,7 @@ Class | Method | HTTP request | Description
|
|
124
125
|
- [OryHydraClient::CompletedRequest](docs/CompletedRequest.md)
|
125
126
|
- [OryHydraClient::ConsentRequest](docs/ConsentRequest.md)
|
126
127
|
- [OryHydraClient::ConsentRequestSession](docs/ConsentRequestSession.md)
|
128
|
+
- [OryHydraClient::ContainerWaitOKBodyError](docs/ContainerWaitOKBodyError.md)
|
127
129
|
- [OryHydraClient::FlushInactiveOAuth2TokensRequest](docs/FlushInactiveOAuth2TokensRequest.md)
|
128
130
|
- [OryHydraClient::GenericError](docs/GenericError.md)
|
129
131
|
- [OryHydraClient::HealthNotReadyStatus](docs/HealthNotReadyStatus.md)
|
@@ -136,12 +138,24 @@ Class | Method | HTTP request | Description
|
|
136
138
|
- [OryHydraClient::OAuth2Client](docs/OAuth2Client.md)
|
137
139
|
- [OryHydraClient::OAuth2TokenIntrospection](docs/OAuth2TokenIntrospection.md)
|
138
140
|
- [OryHydraClient::Oauth2TokenResponse](docs/Oauth2TokenResponse.md)
|
139
|
-
- [OryHydraClient::OauthTokenResponse](docs/OauthTokenResponse.md)
|
140
141
|
- [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)
|
141
154
|
- [OryHydraClient::PreviousConsentSession](docs/PreviousConsentSession.md)
|
142
155
|
- [OryHydraClient::RejectRequest](docs/RejectRequest.md)
|
143
156
|
- [OryHydraClient::UserinfoResponse](docs/UserinfoResponse.md)
|
144
157
|
- [OryHydraClient::Version](docs/Version.md)
|
158
|
+
- [OryHydraClient::VolumeUsageData](docs/VolumeUsageData.md)
|
145
159
|
- [OryHydraClient::WellKnown](docs/WellKnown.md)
|
146
160
|
|
147
161
|
|
@@ -157,9 +171,9 @@ Class | Method | HTTP request | Description
|
|
157
171
|
|
158
172
|
- **Type**: OAuth
|
159
173
|
- **Flow**: accessCode
|
160
|
-
- **Authorization URL**: /oauth2/auth
|
174
|
+
- **Authorization URL**: https://hydra.demo.ory.sh/oauth2/auth
|
161
175
|
- **Scopes**:
|
162
|
-
- offline: A scope required when requesting refresh tokens (alias for `
|
176
|
+
- offline: A scope required when requesting refresh tokens (alias for `offline_access`)
|
163
177
|
- offline_access: A scope required when requesting refresh tokens
|
164
178
|
- openid: Request an OpenID Connect ID Token
|
165
179
|
|
@@ -4,8 +4,9 @@
|
|
4
4
|
|
5
5
|
Name | Type | Description | Notes
|
6
6
|
------------ | ------------- | ------------- | -------------
|
7
|
-
**grant_access_token_audience** | **Array<String>** |
|
8
|
-
**grant_scope** | **Array<String>** |
|
7
|
+
**grant_access_token_audience** | **Array<String>** | | [optional]
|
8
|
+
**grant_scope** | **Array<String>** | | [optional]
|
9
|
+
**handled_at** | **DateTime** | | [optional]
|
9
10
|
**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]
|
10
11
|
**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]
|
11
12
|
**session** | [**ConsentRequestSession**](ConsentRequestSession.md) | | [optional]
|
@@ -17,6 +18,7 @@ require 'OryHydraClient'
|
|
17
18
|
|
18
19
|
instance = OryHydraClient::AcceptConsentRequest.new(grant_access_token_audience: null,
|
19
20
|
grant_scope: null,
|
21
|
+
handled_at: null,
|
20
22
|
remember: null,
|
21
23
|
remember_for: null,
|
22
24
|
session: null)
|
data/docs/AcceptLoginRequest.md
CHANGED
@@ -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** | **
|
8
|
+
**context** | [**Object**](.md) | | [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,32 +4,33 @@ 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
|
8
|
-
[**accept_login_request**](AdminApi.md#accept_login_request) | **PUT** /oauth2/auth/requests/login/accept | Accept
|
9
|
-
[**accept_logout_request**](AdminApi.md#accept_logout_request) | **PUT** /oauth2/auth/requests/logout/accept | Accept a
|
10
|
-
[**create_json_web_key_set**](AdminApi.md#create_json_web_key_set) | **POST** /keys/{set} | Generate a
|
11
|
-
[**create_o_auth2_client**](AdminApi.md#create_o_auth2_client) | **POST** /clients | Create an OAuth 2.0
|
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
|
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
|
15
16
|
[**flush_inactive_o_auth2_tokens**](AdminApi.md#flush_inactive_o_auth2_tokens) | **POST** /oauth2/flush | Flush Expired OAuth2 Access Tokens
|
16
|
-
[**get_consent_request**](AdminApi.md#get_consent_request) | **GET** /oauth2/auth/requests/consent | Get
|
17
|
+
[**get_consent_request**](AdminApi.md#get_consent_request) | **GET** /oauth2/auth/requests/consent | Get Consent Request Information
|
17
18
|
[**get_json_web_key**](AdminApi.md#get_json_web_key) | **GET** /keys/{set}/{kid} | Fetch a JSON Web Key
|
18
19
|
[**get_json_web_key_set**](AdminApi.md#get_json_web_key_set) | **GET** /keys/{set} | Retrieve a JSON Web Key Set
|
19
|
-
[**get_login_request**](AdminApi.md#get_login_request) | **GET** /oauth2/auth/requests/login | Get
|
20
|
-
[**get_logout_request**](AdminApi.md#get_logout_request) | **GET** /oauth2/auth/requests/logout | Get a
|
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
|
21
22
|
[**get_o_auth2_client**](AdminApi.md#get_o_auth2_client) | **GET** /clients/{id} | Get an OAuth 2.0 Client.
|
22
|
-
[**get_version**](AdminApi.md#get_version) | **GET** /version | Get
|
23
|
-
[**introspect_o_auth2_token**](AdminApi.md#introspect_o_auth2_token) | **POST** /oauth2/introspect | Introspect OAuth2
|
24
|
-
[**is_instance_alive**](AdminApi.md#is_instance_alive) | **GET** /health/alive | Check
|
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
|
25
26
|
[**list_o_auth2_clients**](AdminApi.md#list_o_auth2_clients) | **GET** /clients | List OAuth 2.0 Clients
|
26
|
-
[**list_subject_consent_sessions**](AdminApi.md#list_subject_consent_sessions) | **GET** /oauth2/auth/sessions/consent | Lists
|
27
|
-
[**prometheus**](AdminApi.md#prometheus) | **GET** /metrics/prometheus | Get
|
28
|
-
[**reject_consent_request**](AdminApi.md#reject_consent_request) | **PUT** /oauth2/auth/requests/consent/reject | Reject
|
29
|
-
[**reject_login_request**](AdminApi.md#reject_login_request) | **PUT** /oauth2/auth/requests/login/reject | Reject a
|
30
|
-
[**reject_logout_request**](AdminApi.md#reject_logout_request) | **PUT** /oauth2/auth/requests/logout/reject | Reject a
|
31
|
-
[**revoke_authentication_session**](AdminApi.md#revoke_authentication_session) | **DELETE** /oauth2/auth/sessions/login | Invalidates
|
32
|
-
[**revoke_consent_sessions**](AdminApi.md#revoke_consent_sessions) | **DELETE** /oauth2/auth/sessions/consent | Revokes
|
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
|
33
34
|
[**update_json_web_key**](AdminApi.md#update_json_web_key) | **PUT** /keys/{set}/{kid} | Update a JSON Web Key
|
34
35
|
[**update_json_web_key_set**](AdminApi.md#update_json_web_key_set) | **PUT** /keys/{set} | Update a JSON Web Key Set
|
35
36
|
[**update_o_auth2_client**](AdminApi.md#update_o_auth2_client) | **PUT** /clients/{id} | Update an OAuth 2.0 Client
|
@@ -40,7 +41,7 @@ Method | HTTP request | Description
|
|
40
41
|
|
41
42
|
> CompletedRequest accept_consent_request(consent_challenge, opts)
|
42
43
|
|
43
|
-
Accept
|
44
|
+
Accept a Consent Request
|
44
45
|
|
45
46
|
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.
|
46
47
|
|
@@ -57,7 +58,7 @@ opts = {
|
|
57
58
|
}
|
58
59
|
|
59
60
|
begin
|
60
|
-
#Accept
|
61
|
+
#Accept a Consent Request
|
61
62
|
result = api_instance.accept_consent_request(consent_challenge, opts)
|
62
63
|
p result
|
63
64
|
rescue OryHydraClient::ApiError => e
|
@@ -91,7 +92,7 @@ No authorization required
|
|
91
92
|
|
92
93
|
> CompletedRequest accept_login_request(login_challenge, opts)
|
93
94
|
|
94
|
-
Accept
|
95
|
+
Accept a Login Request
|
95
96
|
|
96
97
|
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.
|
97
98
|
|
@@ -108,7 +109,7 @@ opts = {
|
|
108
109
|
}
|
109
110
|
|
110
111
|
begin
|
111
|
-
#Accept
|
112
|
+
#Accept a Login Request
|
112
113
|
result = api_instance.accept_login_request(login_challenge, opts)
|
113
114
|
p result
|
114
115
|
rescue OryHydraClient::ApiError => e
|
@@ -142,7 +143,7 @@ No authorization required
|
|
142
143
|
|
143
144
|
> CompletedRequest accept_logout_request(logout_challenge)
|
144
145
|
|
145
|
-
Accept a
|
146
|
+
Accept a Logout Request
|
146
147
|
|
147
148
|
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.
|
148
149
|
|
@@ -156,7 +157,7 @@ api_instance = OryHydraClient::AdminApi.new
|
|
156
157
|
logout_challenge = 'logout_challenge_example' # String |
|
157
158
|
|
158
159
|
begin
|
159
|
-
#Accept a
|
160
|
+
#Accept a Logout Request
|
160
161
|
result = api_instance.accept_logout_request(logout_challenge)
|
161
162
|
p result
|
162
163
|
rescue OryHydraClient::ApiError => e
|
@@ -189,7 +190,7 @@ No authorization required
|
|
189
190
|
|
190
191
|
> JSONWebKeySet create_json_web_key_set(set, opts)
|
191
192
|
|
192
|
-
Generate a
|
193
|
+
Generate a New JSON Web Key
|
193
194
|
|
194
195
|
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.
|
195
196
|
|
@@ -206,7 +207,7 @@ opts = {
|
|
206
207
|
}
|
207
208
|
|
208
209
|
begin
|
209
|
-
#Generate a
|
210
|
+
#Generate a New JSON Web Key
|
210
211
|
result = api_instance.create_json_web_key_set(set, opts)
|
211
212
|
p result
|
212
213
|
rescue OryHydraClient::ApiError => e
|
@@ -240,7 +241,7 @@ No authorization required
|
|
240
241
|
|
241
242
|
> OAuth2Client create_o_auth2_client(body)
|
242
243
|
|
243
|
-
Create an OAuth 2.0
|
244
|
+
Create an OAuth 2.0 Client
|
244
245
|
|
245
246
|
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.
|
246
247
|
|
@@ -254,7 +255,7 @@ api_instance = OryHydraClient::AdminApi.new
|
|
254
255
|
body = OryHydraClient::OAuth2Client.new # OAuth2Client |
|
255
256
|
|
256
257
|
begin
|
257
|
-
#Create an OAuth 2.0
|
258
|
+
#Create an OAuth 2.0 Client
|
258
259
|
result = api_instance.create_o_auth2_client(body)
|
259
260
|
p result
|
260
261
|
rescue OryHydraClient::ApiError => e
|
@@ -423,6 +424,52 @@ No authorization required
|
|
423
424
|
- **Accept**: application/json
|
424
425
|
|
425
426
|
|
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
|
+
|
426
473
|
## flush_inactive_o_auth2_tokens
|
427
474
|
|
428
475
|
> flush_inactive_o_auth2_tokens(opts)
|
@@ -475,7 +522,7 @@ No authorization required
|
|
475
522
|
|
476
523
|
> ConsentRequest get_consent_request(consent_challenge)
|
477
524
|
|
478
|
-
Get
|
525
|
+
Get Consent Request Information
|
479
526
|
|
480
527
|
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.
|
481
528
|
|
@@ -489,7 +536,7 @@ api_instance = OryHydraClient::AdminApi.new
|
|
489
536
|
consent_challenge = 'consent_challenge_example' # String |
|
490
537
|
|
491
538
|
begin
|
492
|
-
#Get
|
539
|
+
#Get Consent Request Information
|
493
540
|
result = api_instance.get_consent_request(consent_challenge)
|
494
541
|
p result
|
495
542
|
rescue OryHydraClient::ApiError => e
|
@@ -618,7 +665,7 @@ No authorization required
|
|
618
665
|
|
619
666
|
> LoginRequest get_login_request(login_challenge)
|
620
667
|
|
621
|
-
Get
|
668
|
+
Get a Login Request
|
622
669
|
|
623
670
|
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.
|
624
671
|
|
@@ -632,7 +679,7 @@ api_instance = OryHydraClient::AdminApi.new
|
|
632
679
|
login_challenge = 'login_challenge_example' # String |
|
633
680
|
|
634
681
|
begin
|
635
|
-
#Get
|
682
|
+
#Get a Login Request
|
636
683
|
result = api_instance.get_login_request(login_challenge)
|
637
684
|
p result
|
638
685
|
rescue OryHydraClient::ApiError => e
|
@@ -665,7 +712,7 @@ No authorization required
|
|
665
712
|
|
666
713
|
> LogoutRequest get_logout_request(logout_challenge)
|
667
714
|
|
668
|
-
Get a
|
715
|
+
Get a Logout Request
|
669
716
|
|
670
717
|
Use this endpoint to fetch a logout request.
|
671
718
|
|
@@ -679,7 +726,7 @@ api_instance = OryHydraClient::AdminApi.new
|
|
679
726
|
logout_challenge = 'logout_challenge_example' # String |
|
680
727
|
|
681
728
|
begin
|
682
|
-
#Get a
|
729
|
+
#Get a Logout Request
|
683
730
|
result = api_instance.get_logout_request(logout_challenge)
|
684
731
|
p result
|
685
732
|
rescue OryHydraClient::ApiError => e
|
@@ -759,9 +806,9 @@ No authorization required
|
|
759
806
|
|
760
807
|
> Version get_version
|
761
808
|
|
762
|
-
Get
|
809
|
+
Get Service Version
|
763
810
|
|
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.
|
811
|
+
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.
|
765
812
|
|
766
813
|
### Example
|
767
814
|
|
@@ -772,7 +819,7 @@ require 'ory-hydra-client'
|
|
772
819
|
api_instance = OryHydraClient::AdminApi.new
|
773
820
|
|
774
821
|
begin
|
775
|
-
#Get
|
822
|
+
#Get Service Version
|
776
823
|
result = api_instance.get_version
|
777
824
|
p result
|
778
825
|
rescue OryHydraClient::ApiError => e
|
@@ -802,7 +849,7 @@ No authorization required
|
|
802
849
|
|
803
850
|
> OAuth2TokenIntrospection introspect_o_auth2_token(token, opts)
|
804
851
|
|
805
|
-
Introspect OAuth2
|
852
|
+
Introspect OAuth2 Tokens
|
806
853
|
|
807
854
|
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/).
|
808
855
|
|
@@ -811,15 +858,6 @@ The introspection endpoint allows to check if a token (both refresh and access)
|
|
811
858
|
```ruby
|
812
859
|
# load the gem
|
813
860
|
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
|
823
861
|
|
824
862
|
api_instance = OryHydraClient::AdminApi.new
|
825
863
|
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.
|
@@ -828,7 +866,7 @@ opts = {
|
|
828
866
|
}
|
829
867
|
|
830
868
|
begin
|
831
|
-
#Introspect OAuth2
|
869
|
+
#Introspect OAuth2 Tokens
|
832
870
|
result = api_instance.introspect_o_auth2_token(token, opts)
|
833
871
|
p result
|
834
872
|
rescue OryHydraClient::ApiError => e
|
@@ -850,7 +888,7 @@ Name | Type | Description | Notes
|
|
850
888
|
|
851
889
|
### Authorization
|
852
890
|
|
853
|
-
|
891
|
+
No authorization required
|
854
892
|
|
855
893
|
### HTTP request headers
|
856
894
|
|
@@ -862,7 +900,7 @@ Name | Type | Description | Notes
|
|
862
900
|
|
863
901
|
> HealthStatus is_instance_alive
|
864
902
|
|
865
|
-
Check
|
903
|
+
Check Alive Status
|
866
904
|
|
867
905
|
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.
|
868
906
|
|
@@ -875,7 +913,7 @@ require 'ory-hydra-client'
|
|
875
913
|
api_instance = OryHydraClient::AdminApi.new
|
876
914
|
|
877
915
|
begin
|
878
|
-
#Check
|
916
|
+
#Check Alive Status
|
879
917
|
result = api_instance.is_instance_alive
|
880
918
|
p result
|
881
919
|
rescue OryHydraClient::ApiError => e
|
@@ -907,7 +945,7 @@ No authorization required
|
|
907
945
|
|
908
946
|
List OAuth 2.0 Clients
|
909
947
|
|
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.
|
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.
|
911
949
|
|
912
950
|
### Example
|
913
951
|
|
@@ -917,7 +955,7 @@ require 'ory-hydra-client'
|
|
917
955
|
|
918
956
|
api_instance = OryHydraClient::AdminApi.new
|
919
957
|
opts = {
|
920
|
-
limit: 56, # Integer | The maximum amount of policies returned
|
958
|
+
limit: 56, # Integer | The maximum amount of policies returned, upper bound is 500 policies
|
921
959
|
offset: 56 # Integer | The offset from where to start looking.
|
922
960
|
}
|
923
961
|
|
@@ -935,7 +973,7 @@ end
|
|
935
973
|
|
936
974
|
Name | Type | Description | Notes
|
937
975
|
------------- | ------------- | ------------- | -------------
|
938
|
-
**limit** | **Integer**| The maximum amount of policies returned
|
976
|
+
**limit** | **Integer**| The maximum amount of policies returned, upper bound is 500 policies | [optional]
|
939
977
|
**offset** | **Integer**| The offset from where to start looking. | [optional]
|
940
978
|
|
941
979
|
### Return type
|
@@ -956,9 +994,9 @@ No authorization required
|
|
956
994
|
|
957
995
|
> Array<PreviousConsentSession> list_subject_consent_sessions(subject)
|
958
996
|
|
959
|
-
Lists
|
997
|
+
Lists All Consent Sessions of a Subject
|
960
998
|
|
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.
|
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.
|
962
1000
|
|
963
1001
|
### Example
|
964
1002
|
|
@@ -970,7 +1008,7 @@ api_instance = OryHydraClient::AdminApi.new
|
|
970
1008
|
subject = 'subject_example' # String |
|
971
1009
|
|
972
1010
|
begin
|
973
|
-
#Lists
|
1011
|
+
#Lists All Consent Sessions of a Subject
|
974
1012
|
result = api_instance.list_subject_consent_sessions(subject)
|
975
1013
|
p result
|
976
1014
|
rescue OryHydraClient::ApiError => e
|
@@ -1003,9 +1041,9 @@ No authorization required
|
|
1003
1041
|
|
1004
1042
|
> prometheus
|
1005
1043
|
|
1006
|
-
Get
|
1044
|
+
Get Snapshot Metrics from the Hydra Service.
|
1007
1045
|
|
1008
|
-
``` metadata: annotations: prometheus.io/port: \"4445\" prometheus.io/path: \"/metrics/prometheus\" ```
|
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.
|
1009
1047
|
|
1010
1048
|
### Example
|
1011
1049
|
|
@@ -1016,7 +1054,7 @@ require 'ory-hydra-client'
|
|
1016
1054
|
api_instance = OryHydraClient::AdminApi.new
|
1017
1055
|
|
1018
1056
|
begin
|
1019
|
-
#Get
|
1057
|
+
#Get Snapshot Metrics from the Hydra Service.
|
1020
1058
|
api_instance.prometheus
|
1021
1059
|
rescue OryHydraClient::ApiError => e
|
1022
1060
|
puts "Exception when calling AdminApi->prometheus: #{e}"
|
@@ -1045,7 +1083,7 @@ No authorization required
|
|
1045
1083
|
|
1046
1084
|
> CompletedRequest reject_consent_request(consent_challenge, opts)
|
1047
1085
|
|
1048
|
-
Reject
|
1086
|
+
Reject a Consent Request
|
1049
1087
|
|
1050
1088
|
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.
|
1051
1089
|
|
@@ -1062,7 +1100,7 @@ opts = {
|
|
1062
1100
|
}
|
1063
1101
|
|
1064
1102
|
begin
|
1065
|
-
#Reject
|
1103
|
+
#Reject a Consent Request
|
1066
1104
|
result = api_instance.reject_consent_request(consent_challenge, opts)
|
1067
1105
|
p result
|
1068
1106
|
rescue OryHydraClient::ApiError => e
|
@@ -1096,7 +1134,7 @@ No authorization required
|
|
1096
1134
|
|
1097
1135
|
> CompletedRequest reject_login_request(login_challenge, opts)
|
1098
1136
|
|
1099
|
-
Reject a
|
1137
|
+
Reject a Login Request
|
1100
1138
|
|
1101
1139
|
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.
|
1102
1140
|
|
@@ -1113,7 +1151,7 @@ opts = {
|
|
1113
1151
|
}
|
1114
1152
|
|
1115
1153
|
begin
|
1116
|
-
#Reject a
|
1154
|
+
#Reject a Login Request
|
1117
1155
|
result = api_instance.reject_login_request(login_challenge, opts)
|
1118
1156
|
p result
|
1119
1157
|
rescue OryHydraClient::ApiError => e
|
@@ -1147,7 +1185,7 @@ No authorization required
|
|
1147
1185
|
|
1148
1186
|
> reject_logout_request(logout_challenge, opts)
|
1149
1187
|
|
1150
|
-
Reject a
|
1188
|
+
Reject a Logout Request
|
1151
1189
|
|
1152
1190
|
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.
|
1153
1191
|
|
@@ -1164,7 +1202,7 @@ opts = {
|
|
1164
1202
|
}
|
1165
1203
|
|
1166
1204
|
begin
|
1167
|
-
#Reject a
|
1205
|
+
#Reject a Logout Request
|
1168
1206
|
api_instance.reject_logout_request(logout_challenge, opts)
|
1169
1207
|
rescue OryHydraClient::ApiError => e
|
1170
1208
|
puts "Exception when calling AdminApi->reject_logout_request: #{e}"
|
@@ -1197,7 +1235,7 @@ No authorization required
|
|
1197
1235
|
|
1198
1236
|
> revoke_authentication_session(subject)
|
1199
1237
|
|
1200
|
-
Invalidates
|
1238
|
+
Invalidates All Login Sessions of a Certain User Invalidates a Subject's Authentication Session
|
1201
1239
|
|
1202
1240
|
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.
|
1203
1241
|
|
@@ -1211,7 +1249,7 @@ api_instance = OryHydraClient::AdminApi.new
|
|
1211
1249
|
subject = 'subject_example' # String |
|
1212
1250
|
|
1213
1251
|
begin
|
1214
|
-
#Invalidates
|
1252
|
+
#Invalidates All Login Sessions of a Certain User Invalidates a Subject's Authentication Session
|
1215
1253
|
api_instance.revoke_authentication_session(subject)
|
1216
1254
|
rescue OryHydraClient::ApiError => e
|
1217
1255
|
puts "Exception when calling AdminApi->revoke_authentication_session: #{e}"
|
@@ -1243,7 +1281,7 @@ No authorization required
|
|
1243
1281
|
|
1244
1282
|
> revoke_consent_sessions(subject, opts)
|
1245
1283
|
|
1246
|
-
Revokes
|
1284
|
+
Revokes Consent Sessions of a Subject for a Specific OAuth 2.0 Client
|
1247
1285
|
|
1248
1286
|
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.
|
1249
1287
|
|
@@ -1256,11 +1294,12 @@ require 'ory-hydra-client'
|
|
1256
1294
|
api_instance = OryHydraClient::AdminApi.new
|
1257
1295
|
subject = 'subject_example' # String | The subject (Subject) who's consent sessions should be deleted.
|
1258
1296
|
opts = {
|
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
|
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.
|
1260
1299
|
}
|
1261
1300
|
|
1262
1301
|
begin
|
1263
|
-
#Revokes
|
1302
|
+
#Revokes Consent Sessions of a Subject for a Specific OAuth 2.0 Client
|
1264
1303
|
api_instance.revoke_consent_sessions(subject, opts)
|
1265
1304
|
rescue OryHydraClient::ApiError => e
|
1266
1305
|
puts "Exception when calling AdminApi->revoke_consent_sessions: #{e}"
|
@@ -1274,6 +1313,7 @@ Name | Type | Description | Notes
|
|
1274
1313
|
------------- | ------------- | ------------- | -------------
|
1275
1314
|
**subject** | **String**| The subject (Subject) who's consent sessions should be deleted. |
|
1276
1315
|
**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 `?all=true`, deletes all consent sessions by the Subject that have been granted. | [optional]
|
1277
1317
|
|
1278
1318
|
### Return type
|
1279
1319
|
|