ory-hydra-client 1.7.0 → 1.7.3
Sign up to get free protection for your applications and to get access to all the features.
- checksums.yaml +4 -4
- data/README.md +28 -28
- data/docs/AdminApi.md +52 -61
- data/docs/PublicApi.md +15 -15
- data/lib/ory-hydra-client.rb +1 -1
- data/lib/ory-hydra-client/api/admin_api.rb +36 -36
- data/lib/ory-hydra-client/api/public_api.rb +11 -11
- data/lib/ory-hydra-client/api_client.rb +1 -1
- data/lib/ory-hydra-client/api_error.rb +1 -1
- data/lib/ory-hydra-client/configuration.rb +1 -1
- data/lib/ory-hydra-client/models/accept_consent_request.rb +1 -1
- data/lib/ory-hydra-client/models/accept_login_request.rb +1 -1
- data/lib/ory-hydra-client/models/completed_request.rb +1 -1
- data/lib/ory-hydra-client/models/consent_request.rb +1 -1
- data/lib/ory-hydra-client/models/consent_request_session.rb +1 -1
- data/lib/ory-hydra-client/models/container_wait_ok_body_error.rb +1 -1
- data/lib/ory-hydra-client/models/flush_inactive_o_auth2_tokens_request.rb +1 -1
- data/lib/ory-hydra-client/models/generic_error.rb +1 -1
- data/lib/ory-hydra-client/models/health_not_ready_status.rb +1 -1
- data/lib/ory-hydra-client/models/health_status.rb +1 -1
- data/lib/ory-hydra-client/models/json_web_key.rb +1 -1
- data/lib/ory-hydra-client/models/json_web_key_set.rb +1 -1
- data/lib/ory-hydra-client/models/json_web_key_set_generator_request.rb +1 -1
- data/lib/ory-hydra-client/models/login_request.rb +1 -1
- data/lib/ory-hydra-client/models/logout_request.rb +1 -1
- data/lib/ory-hydra-client/models/o_auth2_client.rb +1 -1
- data/lib/ory-hydra-client/models/o_auth2_token_introspection.rb +1 -1
- data/lib/ory-hydra-client/models/oauth2_token_response.rb +1 -1
- data/lib/ory-hydra-client/models/open_id_connect_context.rb +1 -1
- data/lib/ory-hydra-client/models/plugin_config.rb +1 -1
- data/lib/ory-hydra-client/models/plugin_config_args.rb +1 -1
- data/lib/ory-hydra-client/models/plugin_config_interface.rb +1 -1
- data/lib/ory-hydra-client/models/plugin_config_linux.rb +1 -1
- data/lib/ory-hydra-client/models/plugin_config_network.rb +1 -1
- data/lib/ory-hydra-client/models/plugin_config_rootfs.rb +1 -1
- data/lib/ory-hydra-client/models/plugin_config_user.rb +1 -1
- data/lib/ory-hydra-client/models/plugin_device.rb +1 -1
- data/lib/ory-hydra-client/models/plugin_env.rb +1 -1
- data/lib/ory-hydra-client/models/plugin_interface_type.rb +1 -1
- data/lib/ory-hydra-client/models/plugin_mount.rb +1 -1
- data/lib/ory-hydra-client/models/plugin_settings.rb +1 -1
- data/lib/ory-hydra-client/models/previous_consent_session.rb +1 -1
- data/lib/ory-hydra-client/models/reject_request.rb +1 -1
- data/lib/ory-hydra-client/models/userinfo_response.rb +1 -1
- data/lib/ory-hydra-client/models/version.rb +1 -1
- data/lib/ory-hydra-client/models/volume_usage_data.rb +1 -1
- data/lib/ory-hydra-client/models/well_known.rb +1 -1
- data/lib/ory-hydra-client/version.rb +2 -2
- data/ory-hydra-client.gemspec +1 -1
- metadata +33 -33
checksums.yaml
CHANGED
@@ -1,7 +1,7 @@
|
|
1
1
|
---
|
2
2
|
SHA256:
|
3
|
-
metadata.gz:
|
4
|
-
data.tar.gz:
|
3
|
+
metadata.gz: 41491de32ca872a6f72ddf79c598106fb85010898cd9221a73813d97ee1909ee
|
4
|
+
data.tar.gz: fc3dd66ab7e999338131fc8b1a6835e0f6ebb4179b59a4cf35fa65308b9d120f
|
5
5
|
SHA512:
|
6
|
-
metadata.gz:
|
7
|
-
data.tar.gz:
|
6
|
+
metadata.gz: 9659870bd816b287dfc871e0f8c231e8e9cdc3b85ec559c47b7e703337056f305f73c331cf402c4bc8704626f93705bd57833408e638307af031c617493dcbd3
|
7
|
+
data.tar.gz: b50ea3198b3023c5e4e56cec13438dffe77b8ae490fef53b4b6cea4c7afdd05ccb5e83d597fa10eab81f98db466cc69e26e35d4f1210caa938306ed24e38b966
|
data/README.md
CHANGED
@@ -6,8 +6,8 @@ Welcome to the ORY Hydra HTTP API documentation. You will find documentation for
|
|
6
6
|
|
7
7
|
This SDK is automatically generated by the [OpenAPI Generator](https://openapi-generator.tech) project:
|
8
8
|
|
9
|
-
- API version: v1.7.
|
10
|
-
- Package version: v1.7.
|
9
|
+
- API version: v1.7.3
|
10
|
+
- Package version: v1.7.3
|
11
11
|
- Build package: org.openapitools.codegen.languages.RubyClientCodegen
|
12
12
|
|
13
13
|
## Installation
|
@@ -23,16 +23,16 @@ gem build ory-hydra-client.gemspec
|
|
23
23
|
Then either install the gem locally:
|
24
24
|
|
25
25
|
```shell
|
26
|
-
gem install ./ory-hydra-client-v1.7.
|
26
|
+
gem install ./ory-hydra-client-v1.7.3.gem
|
27
27
|
```
|
28
28
|
|
29
|
-
(for development, run `gem install --dev ./ory-hydra-client-v1.7.
|
29
|
+
(for development, run `gem install --dev ./ory-hydra-client-v1.7.3.gem` to install the development dependencies)
|
30
30
|
|
31
31
|
or publish the gem to a gem hosting service, e.g. [RubyGems](https://rubygems.org/).
|
32
32
|
|
33
33
|
Finally add this to the Gemfile:
|
34
34
|
|
35
|
-
gem 'ory-hydra-client', '~> v1.7.
|
35
|
+
gem 'ory-hydra-client', '~> v1.7.3'
|
36
36
|
|
37
37
|
### Install from Git
|
38
38
|
|
@@ -63,7 +63,7 @@ opts = {
|
|
63
63
|
}
|
64
64
|
|
65
65
|
begin
|
66
|
-
#Accept a
|
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,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
|
82
|
-
*OryHydraClient::AdminApi* | [**accept_login_request**](docs/AdminApi.md#accept_login_request) | **PUT** /oauth2/auth/requests/login/accept | Accept a
|
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
89
|
*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
|
90
|
+
*OryHydraClient::AdminApi* | [**get_consent_request**](docs/AdminApi.md#get_consent_request) | **GET** /oauth2/auth/requests/consent | Get Consent Request Information
|
91
91
|
*OryHydraClient::AdminApi* | [**get_json_web_key**](docs/AdminApi.md#get_json_web_key) | **GET** /keys/{set}/{kid} | Fetch a JSON Web Key
|
92
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
|
93
|
-
*OryHydraClient::AdminApi* | [**get_login_request**](docs/AdminApi.md#get_login_request) | **GET** /oauth2/auth/requests/login | Get a
|
94
|
-
*OryHydraClient::AdminApi* | [**get_logout_request**](docs/AdminApi.md#get_logout_request) | **GET** /oauth2/auth/requests/logout | Get a
|
93
|
+
*OryHydraClient::AdminApi* | [**get_login_request**](docs/AdminApi.md#get_login_request) | **GET** /oauth2/auth/requests/login | Get a Login Request
|
94
|
+
*OryHydraClient::AdminApi* | [**get_logout_request**](docs/AdminApi.md#get_logout_request) | **GET** /oauth2/auth/requests/logout | Get a Logout Request
|
95
95
|
*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
|
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
|
99
99
|
*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
|
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
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 a
|
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
|
102
|
+
*OryHydraClient::AdminApi* | [**reject_consent_request**](docs/AdminApi.md#reject_consent_request) | **PUT** /oauth2/auth/requests/consent/reject | Reject a 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
|
107
107
|
*OryHydraClient::AdminApi* | [**update_json_web_key**](docs/AdminApi.md#update_json_web_key) | **PUT** /keys/{set}/{kid} | Update a JSON Web Key
|
108
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
|
109
109
|
*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
|
110
|
+
*OryHydraClient::PublicApi* | [**disconnect_user**](docs/PublicApi.md#disconnect_user) | **GET** /oauth2/sessions/logout | OpenID Connect Front-Backchannel Enabled Logout
|
111
111
|
*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
|
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
|
116
116
|
*OryHydraClient::PublicApi* | [**userinfo**](docs/PublicApi.md#userinfo) | **GET** /userinfo | OpenID Connect Userinfo
|
117
117
|
*OryHydraClient::PublicApi* | [**well_known**](docs/PublicApi.md#well_known) | **GET** /.well-known/jwks.json | JSON Web Keys Discovery
|
118
118
|
|
data/docs/AdminApi.md
CHANGED
@@ -4,32 +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
|
8
|
-
[**accept_login_request**](AdminApi.md#accept_login_request) | **PUT** /oauth2/auth/requests/login/accept | Accept a
|
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
15
|
[**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
|
16
|
+
[**get_consent_request**](AdminApi.md#get_consent_request) | **GET** /oauth2/auth/requests/consent | Get Consent Request Information
|
17
17
|
[**get_json_web_key**](AdminApi.md#get_json_web_key) | **GET** /keys/{set}/{kid} | Fetch a JSON Web Key
|
18
18
|
[**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 a
|
20
|
-
[**get_logout_request**](AdminApi.md#get_logout_request) | **GET** /oauth2/auth/requests/logout | Get a
|
19
|
+
[**get_login_request**](AdminApi.md#get_login_request) | **GET** /oauth2/auth/requests/login | Get a Login Request
|
20
|
+
[**get_logout_request**](AdminApi.md#get_logout_request) | **GET** /oauth2/auth/requests/logout | Get a Logout Request
|
21
21
|
[**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
|
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
|
25
25
|
[**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
|
26
|
+
[**list_subject_consent_sessions**](AdminApi.md#list_subject_consent_sessions) | **GET** /oauth2/auth/sessions/consent | Lists All Consent Sessions of a Subject
|
27
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 a
|
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
|
28
|
+
[**reject_consent_request**](AdminApi.md#reject_consent_request) | **PUT** /oauth2/auth/requests/consent/reject | Reject a 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
|
33
33
|
[**update_json_web_key**](AdminApi.md#update_json_web_key) | **PUT** /keys/{set}/{kid} | Update a JSON Web Key
|
34
34
|
[**update_json_web_key_set**](AdminApi.md#update_json_web_key_set) | **PUT** /keys/{set} | Update a JSON Web Key Set
|
35
35
|
[**update_o_auth2_client**](AdminApi.md#update_o_auth2_client) | **PUT** /clients/{id} | Update an OAuth 2.0 Client
|
@@ -40,7 +40,7 @@ Method | HTTP request | Description
|
|
40
40
|
|
41
41
|
> CompletedRequest accept_consent_request(consent_challenge, opts)
|
42
42
|
|
43
|
-
Accept a
|
43
|
+
Accept a Consent Request
|
44
44
|
|
45
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.
|
46
46
|
|
@@ -57,7 +57,7 @@ opts = {
|
|
57
57
|
}
|
58
58
|
|
59
59
|
begin
|
60
|
-
#Accept a
|
60
|
+
#Accept a Consent Request
|
61
61
|
result = api_instance.accept_consent_request(consent_challenge, opts)
|
62
62
|
p result
|
63
63
|
rescue OryHydraClient::ApiError => e
|
@@ -91,7 +91,7 @@ No authorization required
|
|
91
91
|
|
92
92
|
> CompletedRequest accept_login_request(login_challenge, opts)
|
93
93
|
|
94
|
-
Accept a
|
94
|
+
Accept a Login Request
|
95
95
|
|
96
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.
|
97
97
|
|
@@ -108,7 +108,7 @@ opts = {
|
|
108
108
|
}
|
109
109
|
|
110
110
|
begin
|
111
|
-
#Accept a
|
111
|
+
#Accept a Login Request
|
112
112
|
result = api_instance.accept_login_request(login_challenge, opts)
|
113
113
|
p result
|
114
114
|
rescue OryHydraClient::ApiError => e
|
@@ -142,7 +142,7 @@ No authorization required
|
|
142
142
|
|
143
143
|
> CompletedRequest accept_logout_request(logout_challenge)
|
144
144
|
|
145
|
-
Accept a
|
145
|
+
Accept a Logout Request
|
146
146
|
|
147
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.
|
148
148
|
|
@@ -156,7 +156,7 @@ api_instance = OryHydraClient::AdminApi.new
|
|
156
156
|
logout_challenge = 'logout_challenge_example' # String |
|
157
157
|
|
158
158
|
begin
|
159
|
-
#Accept a
|
159
|
+
#Accept a Logout Request
|
160
160
|
result = api_instance.accept_logout_request(logout_challenge)
|
161
161
|
p result
|
162
162
|
rescue OryHydraClient::ApiError => e
|
@@ -189,7 +189,7 @@ No authorization required
|
|
189
189
|
|
190
190
|
> JSONWebKeySet create_json_web_key_set(set, opts)
|
191
191
|
|
192
|
-
Generate a
|
192
|
+
Generate a New JSON Web Key
|
193
193
|
|
194
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.
|
195
195
|
|
@@ -206,7 +206,7 @@ opts = {
|
|
206
206
|
}
|
207
207
|
|
208
208
|
begin
|
209
|
-
#Generate a
|
209
|
+
#Generate a New JSON Web Key
|
210
210
|
result = api_instance.create_json_web_key_set(set, opts)
|
211
211
|
p result
|
212
212
|
rescue OryHydraClient::ApiError => e
|
@@ -240,7 +240,7 @@ No authorization required
|
|
240
240
|
|
241
241
|
> OAuth2Client create_o_auth2_client(body)
|
242
242
|
|
243
|
-
Create an OAuth 2.0
|
243
|
+
Create an OAuth 2.0 Client
|
244
244
|
|
245
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.
|
246
246
|
|
@@ -254,7 +254,7 @@ api_instance = OryHydraClient::AdminApi.new
|
|
254
254
|
body = OryHydraClient::OAuth2Client.new # OAuth2Client |
|
255
255
|
|
256
256
|
begin
|
257
|
-
#Create an OAuth 2.0
|
257
|
+
#Create an OAuth 2.0 Client
|
258
258
|
result = api_instance.create_o_auth2_client(body)
|
259
259
|
p result
|
260
260
|
rescue OryHydraClient::ApiError => e
|
@@ -475,7 +475,7 @@ No authorization required
|
|
475
475
|
|
476
476
|
> ConsentRequest get_consent_request(consent_challenge)
|
477
477
|
|
478
|
-
Get
|
478
|
+
Get Consent Request Information
|
479
479
|
|
480
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.
|
481
481
|
|
@@ -489,7 +489,7 @@ api_instance = OryHydraClient::AdminApi.new
|
|
489
489
|
consent_challenge = 'consent_challenge_example' # String |
|
490
490
|
|
491
491
|
begin
|
492
|
-
#Get
|
492
|
+
#Get Consent Request Information
|
493
493
|
result = api_instance.get_consent_request(consent_challenge)
|
494
494
|
p result
|
495
495
|
rescue OryHydraClient::ApiError => e
|
@@ -618,7 +618,7 @@ No authorization required
|
|
618
618
|
|
619
619
|
> LoginRequest get_login_request(login_challenge)
|
620
620
|
|
621
|
-
Get a
|
621
|
+
Get a Login Request
|
622
622
|
|
623
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.
|
624
624
|
|
@@ -632,7 +632,7 @@ api_instance = OryHydraClient::AdminApi.new
|
|
632
632
|
login_challenge = 'login_challenge_example' # String |
|
633
633
|
|
634
634
|
begin
|
635
|
-
#Get a
|
635
|
+
#Get a Login Request
|
636
636
|
result = api_instance.get_login_request(login_challenge)
|
637
637
|
p result
|
638
638
|
rescue OryHydraClient::ApiError => e
|
@@ -665,7 +665,7 @@ No authorization required
|
|
665
665
|
|
666
666
|
> LogoutRequest get_logout_request(logout_challenge)
|
667
667
|
|
668
|
-
Get a
|
668
|
+
Get a Logout Request
|
669
669
|
|
670
670
|
Use this endpoint to fetch a logout request.
|
671
671
|
|
@@ -679,7 +679,7 @@ api_instance = OryHydraClient::AdminApi.new
|
|
679
679
|
logout_challenge = 'logout_challenge_example' # String |
|
680
680
|
|
681
681
|
begin
|
682
|
-
#Get a
|
682
|
+
#Get a Logout Request
|
683
683
|
result = api_instance.get_logout_request(logout_challenge)
|
684
684
|
p result
|
685
685
|
rescue OryHydraClient::ApiError => e
|
@@ -759,7 +759,7 @@ No authorization required
|
|
759
759
|
|
760
760
|
> Version get_version
|
761
761
|
|
762
|
-
Get
|
762
|
+
Get Service Version
|
763
763
|
|
764
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.
|
765
765
|
|
@@ -772,7 +772,7 @@ require 'ory-hydra-client'
|
|
772
772
|
api_instance = OryHydraClient::AdminApi.new
|
773
773
|
|
774
774
|
begin
|
775
|
-
#Get
|
775
|
+
#Get Service Version
|
776
776
|
result = api_instance.get_version
|
777
777
|
p result
|
778
778
|
rescue OryHydraClient::ApiError => e
|
@@ -802,7 +802,7 @@ No authorization required
|
|
802
802
|
|
803
803
|
> OAuth2TokenIntrospection introspect_o_auth2_token(token, opts)
|
804
804
|
|
805
|
-
Introspect OAuth2
|
805
|
+
Introspect OAuth2 Tokens
|
806
806
|
|
807
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/).
|
808
808
|
|
@@ -811,15 +811,6 @@ The introspection endpoint allows to check if a token (both refresh and access)
|
|
811
811
|
```ruby
|
812
812
|
# load the gem
|
813
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
|
823
814
|
|
824
815
|
api_instance = OryHydraClient::AdminApi.new
|
825
816
|
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 +819,7 @@ opts = {
|
|
828
819
|
}
|
829
820
|
|
830
821
|
begin
|
831
|
-
#Introspect OAuth2
|
822
|
+
#Introspect OAuth2 Tokens
|
832
823
|
result = api_instance.introspect_o_auth2_token(token, opts)
|
833
824
|
p result
|
834
825
|
rescue OryHydraClient::ApiError => e
|
@@ -850,7 +841,7 @@ Name | Type | Description | Notes
|
|
850
841
|
|
851
842
|
### Authorization
|
852
843
|
|
853
|
-
|
844
|
+
No authorization required
|
854
845
|
|
855
846
|
### HTTP request headers
|
856
847
|
|
@@ -862,7 +853,7 @@ Name | Type | Description | Notes
|
|
862
853
|
|
863
854
|
> HealthStatus is_instance_alive
|
864
855
|
|
865
|
-
Check
|
856
|
+
Check Alive Status
|
866
857
|
|
867
858
|
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
859
|
|
@@ -875,7 +866,7 @@ require 'ory-hydra-client'
|
|
875
866
|
api_instance = OryHydraClient::AdminApi.new
|
876
867
|
|
877
868
|
begin
|
878
|
-
#Check
|
869
|
+
#Check Alive Status
|
879
870
|
result = api_instance.is_instance_alive
|
880
871
|
p result
|
881
872
|
rescue OryHydraClient::ApiError => e
|
@@ -956,7 +947,7 @@ No authorization required
|
|
956
947
|
|
957
948
|
> Array<PreviousConsentSession> list_subject_consent_sessions(subject)
|
958
949
|
|
959
|
-
Lists
|
950
|
+
Lists All Consent Sessions of a Subject
|
960
951
|
|
961
952
|
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
953
|
|
@@ -970,7 +961,7 @@ api_instance = OryHydraClient::AdminApi.new
|
|
970
961
|
subject = 'subject_example' # String |
|
971
962
|
|
972
963
|
begin
|
973
|
-
#Lists
|
964
|
+
#Lists All Consent Sessions of a Subject
|
974
965
|
result = api_instance.list_subject_consent_sessions(subject)
|
975
966
|
p result
|
976
967
|
rescue OryHydraClient::ApiError => e
|
@@ -1045,7 +1036,7 @@ No authorization required
|
|
1045
1036
|
|
1046
1037
|
> CompletedRequest reject_consent_request(consent_challenge, opts)
|
1047
1038
|
|
1048
|
-
Reject a
|
1039
|
+
Reject a Consent Request
|
1049
1040
|
|
1050
1041
|
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
1042
|
|
@@ -1062,7 +1053,7 @@ opts = {
|
|
1062
1053
|
}
|
1063
1054
|
|
1064
1055
|
begin
|
1065
|
-
#Reject a
|
1056
|
+
#Reject a Consent Request
|
1066
1057
|
result = api_instance.reject_consent_request(consent_challenge, opts)
|
1067
1058
|
p result
|
1068
1059
|
rescue OryHydraClient::ApiError => e
|
@@ -1096,7 +1087,7 @@ No authorization required
|
|
1096
1087
|
|
1097
1088
|
> CompletedRequest reject_login_request(login_challenge, opts)
|
1098
1089
|
|
1099
|
-
Reject a
|
1090
|
+
Reject a Login Request
|
1100
1091
|
|
1101
1092
|
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
1093
|
|
@@ -1113,7 +1104,7 @@ opts = {
|
|
1113
1104
|
}
|
1114
1105
|
|
1115
1106
|
begin
|
1116
|
-
#Reject a
|
1107
|
+
#Reject a Login Request
|
1117
1108
|
result = api_instance.reject_login_request(login_challenge, opts)
|
1118
1109
|
p result
|
1119
1110
|
rescue OryHydraClient::ApiError => e
|
@@ -1147,7 +1138,7 @@ No authorization required
|
|
1147
1138
|
|
1148
1139
|
> reject_logout_request(logout_challenge, opts)
|
1149
1140
|
|
1150
|
-
Reject a
|
1141
|
+
Reject a Logout Request
|
1151
1142
|
|
1152
1143
|
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
1144
|
|
@@ -1164,7 +1155,7 @@ opts = {
|
|
1164
1155
|
}
|
1165
1156
|
|
1166
1157
|
begin
|
1167
|
-
#Reject a
|
1158
|
+
#Reject a Logout Request
|
1168
1159
|
api_instance.reject_logout_request(logout_challenge, opts)
|
1169
1160
|
rescue OryHydraClient::ApiError => e
|
1170
1161
|
puts "Exception when calling AdminApi->reject_logout_request: #{e}"
|
@@ -1197,7 +1188,7 @@ No authorization required
|
|
1197
1188
|
|
1198
1189
|
> revoke_authentication_session(subject)
|
1199
1190
|
|
1200
|
-
Invalidates
|
1191
|
+
Invalidates All Login Sessions of a Certain User Invalidates a Subject's Authentication Session
|
1201
1192
|
|
1202
1193
|
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
1194
|
|
@@ -1211,7 +1202,7 @@ api_instance = OryHydraClient::AdminApi.new
|
|
1211
1202
|
subject = 'subject_example' # String |
|
1212
1203
|
|
1213
1204
|
begin
|
1214
|
-
#Invalidates
|
1205
|
+
#Invalidates All Login Sessions of a Certain User Invalidates a Subject's Authentication Session
|
1215
1206
|
api_instance.revoke_authentication_session(subject)
|
1216
1207
|
rescue OryHydraClient::ApiError => e
|
1217
1208
|
puts "Exception when calling AdminApi->revoke_authentication_session: #{e}"
|
@@ -1243,7 +1234,7 @@ No authorization required
|
|
1243
1234
|
|
1244
1235
|
> revoke_consent_sessions(subject, opts)
|
1245
1236
|
|
1246
|
-
Revokes
|
1237
|
+
Revokes Consent Sessions of a Subject for a Specific OAuth 2.0 Client
|
1247
1238
|
|
1248
1239
|
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
1240
|
|
@@ -1261,7 +1252,7 @@ opts = {
|
|
1261
1252
|
}
|
1262
1253
|
|
1263
1254
|
begin
|
1264
|
-
#Revokes
|
1255
|
+
#Revokes Consent Sessions of a Subject for a Specific OAuth 2.0 Client
|
1265
1256
|
api_instance.revoke_consent_sessions(subject, opts)
|
1266
1257
|
rescue OryHydraClient::ApiError => e
|
1267
1258
|
puts "Exception when calling AdminApi->revoke_consent_sessions: #{e}"
|