ory-hydra-client 0.0.0.alpha39
Sign up to get free protection for your applications and to get access to all the features.
- checksums.yaml +7 -0
- data/Gemfile +9 -0
- data/README.md +165 -0
- data/Rakefile +10 -0
- data/docs/AcceptConsentRequest.md +25 -0
- data/docs/AcceptLoginRequest.md +27 -0
- data/docs/AdminApi.md +1443 -0
- data/docs/CompletedRequest.md +17 -0
- data/docs/ConsentRequest.md +39 -0
- data/docs/ConsentRequestSession.md +19 -0
- data/docs/FlushInactiveOAuth2TokensRequest.md +17 -0
- data/docs/GenericError.md +23 -0
- data/docs/HealthNotReadyStatus.md +17 -0
- data/docs/HealthStatus.md +17 -0
- data/docs/JSONWebKey.md +49 -0
- data/docs/JSONWebKeySet.md +17 -0
- data/docs/JsonWebKeySetGeneratorRequest.md +21 -0
- data/docs/LoginRequest.md +33 -0
- data/docs/LogoutRequest.md +23 -0
- data/docs/OAuth2Client.md +79 -0
- data/docs/OAuth2TokenIntrospection.md +41 -0
- data/docs/Oauth2TokenResponse.md +27 -0
- data/docs/OauthTokenResponse.md +27 -0
- data/docs/OpenIDConnectContext.md +25 -0
- data/docs/PreviousConsentSession.md +27 -0
- data/docs/PublicApi.md +398 -0
- data/docs/RejectRequest.md +25 -0
- data/docs/UserinfoResponse.md +53 -0
- data/docs/Version.md +17 -0
- data/docs/WellKnown.md +65 -0
- data/lib/ory-hydra-client.rb +65 -0
- data/lib/ory-hydra-client/api/admin_api.rb +1879 -0
- data/lib/ory-hydra-client/api/public_api.rb +498 -0
- data/lib/ory-hydra-client/api_client.rb +386 -0
- data/lib/ory-hydra-client/api_error.rb +57 -0
- data/lib/ory-hydra-client/configuration.rb +255 -0
- data/lib/ory-hydra-client/models/accept_consent_request.rb +250 -0
- data/lib/ory-hydra-client/models/accept_login_request.rb +264 -0
- data/lib/ory-hydra-client/models/completed_request.rb +207 -0
- data/lib/ory-hydra-client/models/consent_request.rb +321 -0
- data/lib/ory-hydra-client/models/consent_request_session.rb +221 -0
- data/lib/ory-hydra-client/models/flush_inactive_o_auth2_tokens_request.rb +207 -0
- data/lib/ory-hydra-client/models/generic_error.rb +243 -0
- data/lib/ory-hydra-client/models/health_not_ready_status.rb +209 -0
- data/lib/ory-hydra-client/models/health_status.rb +207 -0
- data/lib/ory-hydra-client/models/json_web_key.rb +377 -0
- data/lib/ory-hydra-client/models/json_web_key_set.rb +209 -0
- data/lib/ory-hydra-client/models/json_web_key_set_generator_request.rb +242 -0
- data/lib/ory-hydra-client/models/login_request.rb +289 -0
- data/lib/ory-hydra-client/models/logout_request.rb +237 -0
- data/lib/ory-hydra-client/models/o_auth2_client.rb +551 -0
- data/lib/ory-hydra-client/models/o_auth2_token_introspection.rb +337 -0
- data/lib/ory-hydra-client/models/oauth2_token_response.rb +252 -0
- data/lib/ory-hydra-client/models/oauth_token_response.rb +258 -0
- data/lib/ory-hydra-client/models/open_id_connect_context.rb +253 -0
- data/lib/ory-hydra-client/models/previous_consent_session.rb +260 -0
- data/lib/ory-hydra-client/models/reject_request.rb +242 -0
- data/lib/ory-hydra-client/models/userinfo_response.rb +388 -0
- data/lib/ory-hydra-client/models/version.rb +207 -0
- data/lib/ory-hydra-client/models/well_known.rb +501 -0
- data/lib/ory-hydra-client/version.rb +15 -0
- data/ory-hydra-client.gemspec +39 -0
- data/spec/api/admin_api_spec.rb +395 -0
- data/spec/api/public_api_spec.rb +129 -0
- data/spec/api_client_spec.rb +226 -0
- data/spec/configuration_spec.rb +42 -0
- data/spec/models/accept_consent_request_spec.rb +65 -0
- data/spec/models/accept_login_request_spec.rb +71 -0
- data/spec/models/completed_request_spec.rb +41 -0
- data/spec/models/consent_request_session_spec.rb +47 -0
- data/spec/models/consent_request_spec.rb +107 -0
- data/spec/models/flush_inactive_o_auth2_tokens_request_spec.rb +41 -0
- data/spec/models/generic_error_spec.rb +59 -0
- data/spec/models/health_not_ready_status_spec.rb +41 -0
- data/spec/models/health_status_spec.rb +41 -0
- data/spec/models/json_web_key_set_generator_request_spec.rb +53 -0
- data/spec/models/json_web_key_set_spec.rb +41 -0
- data/spec/models/json_web_key_spec.rb +137 -0
- data/spec/models/login_request_spec.rb +89 -0
- data/spec/models/logout_request_spec.rb +59 -0
- data/spec/models/o_auth2_client_spec.rb +227 -0
- data/spec/models/o_auth2_token_introspection_spec.rb +113 -0
- data/spec/models/oauth2_token_response_spec.rb +71 -0
- data/spec/models/oauth_token_response_spec.rb +71 -0
- data/spec/models/open_id_connect_context_spec.rb +65 -0
- data/spec/models/previous_consent_session_spec.rb +71 -0
- data/spec/models/reject_request_spec.rb +65 -0
- data/spec/models/userinfo_response_spec.rb +149 -0
- data/spec/models/version_spec.rb +41 -0
- data/spec/models/well_known_spec.rb +185 -0
- data/spec/spec_helper.rb +111 -0
- metadata +223 -0
@@ -0,0 +1,15 @@
|
|
1
|
+
=begin
|
2
|
+
#ORY Hydra
|
3
|
+
|
4
|
+
#Welcome to the ORY Hydra HTTP API documentation. You will find documentation for all HTTP APIs here.
|
5
|
+
|
6
|
+
The version of the OpenAPI document: 0.0.0.alpha39
|
7
|
+
|
8
|
+
Generated by: https://openapi-generator.tech
|
9
|
+
OpenAPI Generator version: 4.2.2
|
10
|
+
|
11
|
+
=end
|
12
|
+
|
13
|
+
module OryHydraClient
|
14
|
+
VERSION = '0.0.0.alpha39'
|
15
|
+
end
|
@@ -0,0 +1,39 @@
|
|
1
|
+
# -*- encoding: utf-8 -*-
|
2
|
+
|
3
|
+
=begin
|
4
|
+
#ORY Hydra
|
5
|
+
|
6
|
+
#Welcome to the ORY Hydra HTTP API documentation. You will find documentation for all HTTP APIs here.
|
7
|
+
|
8
|
+
The version of the OpenAPI document: v0.0.0-alpha.39
|
9
|
+
|
10
|
+
Generated by: https://openapi-generator.tech
|
11
|
+
OpenAPI Generator version: 4.2.2
|
12
|
+
|
13
|
+
=end
|
14
|
+
|
15
|
+
$:.push File.expand_path("../lib", __FILE__)
|
16
|
+
require "ory-hydra-client/version"
|
17
|
+
|
18
|
+
Gem::Specification.new do |s|
|
19
|
+
s.name = "ory-hydra-client"
|
20
|
+
s.version = OryHydraClient::VERSION
|
21
|
+
s.platform = Gem::Platform::RUBY
|
22
|
+
s.authors = ["ORY GmbH"]
|
23
|
+
s.email = ["opensource@ory.sh"]
|
24
|
+
s.homepage = "https://www.ory.sh"
|
25
|
+
s.summary = "ORY Hydra Ruby Gem"
|
26
|
+
s.description = "Welcome to the ORY Hydra HTTP API documentation. You will find documentation for all HTTP APIs here."
|
27
|
+
s.license = 'Apache-2.0'
|
28
|
+
s.required_ruby_version = ">= 1.9"
|
29
|
+
|
30
|
+
s.add_runtime_dependency 'typhoeus', '~> 1.0', '>= 1.0.1'
|
31
|
+
s.add_runtime_dependency 'json', '~> 2.1', '>= 2.1.0'
|
32
|
+
|
33
|
+
s.add_development_dependency 'rspec', '~> 3.6', '>= 3.6.0'
|
34
|
+
|
35
|
+
s.files = `find *`.split("\n").uniq.sort.select { |f| !f.empty? }
|
36
|
+
s.test_files = `find spec/*`.split("\n")
|
37
|
+
s.executables = []
|
38
|
+
s.require_paths = ["lib"]
|
39
|
+
end
|
@@ -0,0 +1,395 @@
|
|
1
|
+
=begin
|
2
|
+
#ORY Hydra
|
3
|
+
|
4
|
+
#Welcome to the ORY Hydra HTTP API documentation. You will find documentation for all HTTP APIs here.
|
5
|
+
|
6
|
+
The version of the OpenAPI document: v0.0.0-alpha.1
|
7
|
+
|
8
|
+
Generated by: https://openapi-generator.tech
|
9
|
+
OpenAPI Generator version: 4.2.2
|
10
|
+
|
11
|
+
=end
|
12
|
+
|
13
|
+
require 'spec_helper'
|
14
|
+
require 'json'
|
15
|
+
|
16
|
+
# Unit tests for OryHydraClient::AdminApi
|
17
|
+
# Automatically generated by openapi-generator (https://openapi-generator.tech)
|
18
|
+
# Please update as you see appropriate
|
19
|
+
describe 'AdminApi' do
|
20
|
+
before do
|
21
|
+
# run before each test
|
22
|
+
@api_instance = OryHydraClient::AdminApi.new
|
23
|
+
end
|
24
|
+
|
25
|
+
after do
|
26
|
+
# run after each test
|
27
|
+
end
|
28
|
+
|
29
|
+
describe 'test an instance of AdminApi' do
|
30
|
+
it 'should create an instance of AdminApi' do
|
31
|
+
expect(@api_instance).to be_instance_of(OryHydraClient::AdminApi)
|
32
|
+
end
|
33
|
+
end
|
34
|
+
|
35
|
+
# unit tests for accept_consent_request
|
36
|
+
# Accept an consent request
|
37
|
+
# 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.
|
38
|
+
# @param consent_challenge
|
39
|
+
# @param [Hash] opts the optional parameters
|
40
|
+
# @option opts [AcceptConsentRequest] :body
|
41
|
+
# @return [CompletedRequest]
|
42
|
+
describe 'accept_consent_request test' do
|
43
|
+
it 'should work' do
|
44
|
+
# assertion here. ref: https://www.relishapp.com/rspec/rspec-expectations/docs/built-in-matchers
|
45
|
+
end
|
46
|
+
end
|
47
|
+
|
48
|
+
# unit tests for accept_login_request
|
49
|
+
# Accept an login request
|
50
|
+
# 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.
|
51
|
+
# @param login_challenge
|
52
|
+
# @param [Hash] opts the optional parameters
|
53
|
+
# @option opts [AcceptLoginRequest] :body
|
54
|
+
# @return [CompletedRequest]
|
55
|
+
describe 'accept_login_request test' do
|
56
|
+
it 'should work' do
|
57
|
+
# assertion here. ref: https://www.relishapp.com/rspec/rspec-expectations/docs/built-in-matchers
|
58
|
+
end
|
59
|
+
end
|
60
|
+
|
61
|
+
# unit tests for accept_logout_request
|
62
|
+
# Accept a logout request
|
63
|
+
# 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.
|
64
|
+
# @param logout_challenge
|
65
|
+
# @param [Hash] opts the optional parameters
|
66
|
+
# @return [CompletedRequest]
|
67
|
+
describe 'accept_logout_request test' do
|
68
|
+
it 'should work' do
|
69
|
+
# assertion here. ref: https://www.relishapp.com/rspec/rspec-expectations/docs/built-in-matchers
|
70
|
+
end
|
71
|
+
end
|
72
|
+
|
73
|
+
# unit tests for create_json_web_key_set
|
74
|
+
# Generate a new JSON Web Key
|
75
|
+
# 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.
|
76
|
+
# @param set The set
|
77
|
+
# @param [Hash] opts the optional parameters
|
78
|
+
# @option opts [JsonWebKeySetGeneratorRequest] :body
|
79
|
+
# @return [JSONWebKeySet]
|
80
|
+
describe 'create_json_web_key_set test' do
|
81
|
+
it 'should work' do
|
82
|
+
# assertion here. ref: https://www.relishapp.com/rspec/rspec-expectations/docs/built-in-matchers
|
83
|
+
end
|
84
|
+
end
|
85
|
+
|
86
|
+
# unit tests for create_o_auth2_client
|
87
|
+
# Create an OAuth 2.0 client
|
88
|
+
# 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.
|
89
|
+
# @param body
|
90
|
+
# @param [Hash] opts the optional parameters
|
91
|
+
# @return [OAuth2Client]
|
92
|
+
describe 'create_o_auth2_client test' do
|
93
|
+
it 'should work' do
|
94
|
+
# assertion here. ref: https://www.relishapp.com/rspec/rspec-expectations/docs/built-in-matchers
|
95
|
+
end
|
96
|
+
end
|
97
|
+
|
98
|
+
# unit tests for delete_json_web_key
|
99
|
+
# Delete a JSON Web Key
|
100
|
+
# Use this endpoint to delete a single JSON Web Key. 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.
|
101
|
+
# @param kid The kid of the desired key
|
102
|
+
# @param set The set
|
103
|
+
# @param [Hash] opts the optional parameters
|
104
|
+
# @return [nil]
|
105
|
+
describe 'delete_json_web_key test' do
|
106
|
+
it 'should work' do
|
107
|
+
# assertion here. ref: https://www.relishapp.com/rspec/rspec-expectations/docs/built-in-matchers
|
108
|
+
end
|
109
|
+
end
|
110
|
+
|
111
|
+
# unit tests for delete_json_web_key_set
|
112
|
+
# Delete a JSON Web Key Set
|
113
|
+
# Use this endpoint to delete a complete JSON Web Key Set and all the keys in that set. 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.
|
114
|
+
# @param set The set
|
115
|
+
# @param [Hash] opts the optional parameters
|
116
|
+
# @return [nil]
|
117
|
+
describe 'delete_json_web_key_set test' do
|
118
|
+
it 'should work' do
|
119
|
+
# assertion here. ref: https://www.relishapp.com/rspec/rspec-expectations/docs/built-in-matchers
|
120
|
+
end
|
121
|
+
end
|
122
|
+
|
123
|
+
# unit tests for delete_o_auth2_client
|
124
|
+
# Deletes an OAuth 2.0 Client
|
125
|
+
# Delete an existing OAuth 2.0 Client by its ID. 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.
|
126
|
+
# @param id The id of the OAuth 2.0 Client.
|
127
|
+
# @param [Hash] opts the optional parameters
|
128
|
+
# @return [nil]
|
129
|
+
describe 'delete_o_auth2_client test' do
|
130
|
+
it 'should work' do
|
131
|
+
# assertion here. ref: https://www.relishapp.com/rspec/rspec-expectations/docs/built-in-matchers
|
132
|
+
end
|
133
|
+
end
|
134
|
+
|
135
|
+
# unit tests for flush_inactive_o_auth2_tokens
|
136
|
+
# Flush Expired OAuth2 Access Tokens
|
137
|
+
# This endpoint flushes expired OAuth2 access tokens from the database. You can set a time after which no tokens will be not be touched, in case you want to keep recent tokens for auditing. Refresh tokens can not be flushed as they are deleted automatically when performing the refresh flow.
|
138
|
+
# @param [Hash] opts the optional parameters
|
139
|
+
# @option opts [FlushInactiveOAuth2TokensRequest] :body
|
140
|
+
# @return [nil]
|
141
|
+
describe 'flush_inactive_o_auth2_tokens test' do
|
142
|
+
it 'should work' do
|
143
|
+
# assertion here. ref: https://www.relishapp.com/rspec/rspec-expectations/docs/built-in-matchers
|
144
|
+
end
|
145
|
+
end
|
146
|
+
|
147
|
+
# unit tests for get_consent_request
|
148
|
+
# Get consent request information
|
149
|
+
# 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.
|
150
|
+
# @param consent_challenge
|
151
|
+
# @param [Hash] opts the optional parameters
|
152
|
+
# @return [ConsentRequest]
|
153
|
+
describe 'get_consent_request test' do
|
154
|
+
it 'should work' do
|
155
|
+
# assertion here. ref: https://www.relishapp.com/rspec/rspec-expectations/docs/built-in-matchers
|
156
|
+
end
|
157
|
+
end
|
158
|
+
|
159
|
+
# unit tests for get_json_web_key
|
160
|
+
# Fetch a JSON Web Key
|
161
|
+
# This endpoint returns a singular JSON Web Key, identified by the set and the specific key ID (kid).
|
162
|
+
# @param kid The kid of the desired key
|
163
|
+
# @param set The set
|
164
|
+
# @param [Hash] opts the optional parameters
|
165
|
+
# @return [JSONWebKeySet]
|
166
|
+
describe 'get_json_web_key test' do
|
167
|
+
it 'should work' do
|
168
|
+
# assertion here. ref: https://www.relishapp.com/rspec/rspec-expectations/docs/built-in-matchers
|
169
|
+
end
|
170
|
+
end
|
171
|
+
|
172
|
+
# unit tests for get_json_web_key_set
|
173
|
+
# Retrieve a JSON Web Key Set
|
174
|
+
# This endpoint can be used to retrieve JWK Sets stored in ORY Hydra. 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.
|
175
|
+
# @param set The set
|
176
|
+
# @param [Hash] opts the optional parameters
|
177
|
+
# @return [JSONWebKeySet]
|
178
|
+
describe 'get_json_web_key_set test' do
|
179
|
+
it 'should work' do
|
180
|
+
# assertion here. ref: https://www.relishapp.com/rspec/rspec-expectations/docs/built-in-matchers
|
181
|
+
end
|
182
|
+
end
|
183
|
+
|
184
|
+
# unit tests for get_login_request
|
185
|
+
# Get an login request
|
186
|
+
# 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.
|
187
|
+
# @param login_challenge
|
188
|
+
# @param [Hash] opts the optional parameters
|
189
|
+
# @return [LoginRequest]
|
190
|
+
describe 'get_login_request test' do
|
191
|
+
it 'should work' do
|
192
|
+
# assertion here. ref: https://www.relishapp.com/rspec/rspec-expectations/docs/built-in-matchers
|
193
|
+
end
|
194
|
+
end
|
195
|
+
|
196
|
+
# unit tests for get_logout_request
|
197
|
+
# Get a logout request
|
198
|
+
# Use this endpoint to fetch a logout request.
|
199
|
+
# @param logout_challenge
|
200
|
+
# @param [Hash] opts the optional parameters
|
201
|
+
# @return [LogoutRequest]
|
202
|
+
describe 'get_logout_request test' do
|
203
|
+
it 'should work' do
|
204
|
+
# assertion here. ref: https://www.relishapp.com/rspec/rspec-expectations/docs/built-in-matchers
|
205
|
+
end
|
206
|
+
end
|
207
|
+
|
208
|
+
# unit tests for get_o_auth2_client
|
209
|
+
# Get an OAuth 2.0 Client.
|
210
|
+
# Get an OAUth 2.0 client by its ID. This endpoint never returns passwords. 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.
|
211
|
+
# @param id The id of the OAuth 2.0 Client.
|
212
|
+
# @param [Hash] opts the optional parameters
|
213
|
+
# @return [OAuth2Client]
|
214
|
+
describe 'get_o_auth2_client test' do
|
215
|
+
it 'should work' do
|
216
|
+
# assertion here. ref: https://www.relishapp.com/rspec/rspec-expectations/docs/built-in-matchers
|
217
|
+
end
|
218
|
+
end
|
219
|
+
|
220
|
+
# unit tests for get_version
|
221
|
+
# Get service version
|
222
|
+
# 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. 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.
|
223
|
+
# @param [Hash] opts the optional parameters
|
224
|
+
# @return [Version]
|
225
|
+
describe 'get_version test' do
|
226
|
+
it 'should work' do
|
227
|
+
# assertion here. ref: https://www.relishapp.com/rspec/rspec-expectations/docs/built-in-matchers
|
228
|
+
end
|
229
|
+
end
|
230
|
+
|
231
|
+
# unit tests for introspect_o_auth2_token
|
232
|
+
# Introspect OAuth2 tokens
|
233
|
+
# 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/).
|
234
|
+
# @param token 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.
|
235
|
+
# @param [Hash] opts the optional parameters
|
236
|
+
# @option opts [String] :scope An optional, space separated list of required scopes. If the access token was not granted one of the scopes, the result of active will be false.
|
237
|
+
# @return [OAuth2TokenIntrospection]
|
238
|
+
describe 'introspect_o_auth2_token test' do
|
239
|
+
it 'should work' do
|
240
|
+
# assertion here. ref: https://www.relishapp.com/rspec/rspec-expectations/docs/built-in-matchers
|
241
|
+
end
|
242
|
+
end
|
243
|
+
|
244
|
+
# unit tests for is_instance_alive
|
245
|
+
# Check alive status
|
246
|
+
# 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.
|
247
|
+
# @param [Hash] opts the optional parameters
|
248
|
+
# @return [HealthStatus]
|
249
|
+
describe 'is_instance_alive test' do
|
250
|
+
it 'should work' do
|
251
|
+
# assertion here. ref: https://www.relishapp.com/rspec/rspec-expectations/docs/built-in-matchers
|
252
|
+
end
|
253
|
+
end
|
254
|
+
|
255
|
+
# unit tests for list_o_auth2_clients
|
256
|
+
# List OAuth 2.0 Clients
|
257
|
+
# 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.
|
258
|
+
# @param [Hash] opts the optional parameters
|
259
|
+
# @option opts [Integer] :limit The maximum amount of policies returned.
|
260
|
+
# @option opts [Integer] :offset The offset from where to start looking.
|
261
|
+
# @return [Array<OAuth2Client>]
|
262
|
+
describe 'list_o_auth2_clients test' do
|
263
|
+
it 'should work' do
|
264
|
+
# assertion here. ref: https://www.relishapp.com/rspec/rspec-expectations/docs/built-in-matchers
|
265
|
+
end
|
266
|
+
end
|
267
|
+
|
268
|
+
# unit tests for list_subject_consent_sessions
|
269
|
+
# Lists all consent sessions of a subject
|
270
|
+
# 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.
|
271
|
+
# @param subject
|
272
|
+
# @param [Hash] opts the optional parameters
|
273
|
+
# @return [Array<PreviousConsentSession>]
|
274
|
+
describe 'list_subject_consent_sessions test' do
|
275
|
+
it 'should work' do
|
276
|
+
# assertion here. ref: https://www.relishapp.com/rspec/rspec-expectations/docs/built-in-matchers
|
277
|
+
end
|
278
|
+
end
|
279
|
+
|
280
|
+
# unit tests for prometheus
|
281
|
+
# Get snapshot metrics from the Hydra service. If you're using k8s, you can then add annotations to your deployment like so:
|
282
|
+
# ``` metadata: annotations: prometheus.io/port: \"4445\" prometheus.io/path: \"/metrics/prometheus\" ```
|
283
|
+
# @param [Hash] opts the optional parameters
|
284
|
+
# @return [nil]
|
285
|
+
describe 'prometheus test' do
|
286
|
+
it 'should work' do
|
287
|
+
# assertion here. ref: https://www.relishapp.com/rspec/rspec-expectations/docs/built-in-matchers
|
288
|
+
end
|
289
|
+
end
|
290
|
+
|
291
|
+
# unit tests for reject_consent_request
|
292
|
+
# Reject an consent request
|
293
|
+
# 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.
|
294
|
+
# @param consent_challenge
|
295
|
+
# @param [Hash] opts the optional parameters
|
296
|
+
# @option opts [RejectRequest] :body
|
297
|
+
# @return [CompletedRequest]
|
298
|
+
describe 'reject_consent_request test' do
|
299
|
+
it 'should work' do
|
300
|
+
# assertion here. ref: https://www.relishapp.com/rspec/rspec-expectations/docs/built-in-matchers
|
301
|
+
end
|
302
|
+
end
|
303
|
+
|
304
|
+
# unit tests for reject_login_request
|
305
|
+
# Reject a login request
|
306
|
+
# 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.
|
307
|
+
# @param login_challenge
|
308
|
+
# @param [Hash] opts the optional parameters
|
309
|
+
# @option opts [RejectRequest] :body
|
310
|
+
# @return [CompletedRequest]
|
311
|
+
describe 'reject_login_request test' do
|
312
|
+
it 'should work' do
|
313
|
+
# assertion here. ref: https://www.relishapp.com/rspec/rspec-expectations/docs/built-in-matchers
|
314
|
+
end
|
315
|
+
end
|
316
|
+
|
317
|
+
# unit tests for reject_logout_request
|
318
|
+
# Reject a logout request
|
319
|
+
# 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.
|
320
|
+
# @param logout_challenge
|
321
|
+
# @param [Hash] opts the optional parameters
|
322
|
+
# @option opts [RejectRequest] :body
|
323
|
+
# @return [nil]
|
324
|
+
describe 'reject_logout_request test' do
|
325
|
+
it 'should work' do
|
326
|
+
# assertion here. ref: https://www.relishapp.com/rspec/rspec-expectations/docs/built-in-matchers
|
327
|
+
end
|
328
|
+
end
|
329
|
+
|
330
|
+
# unit tests for revoke_authentication_session
|
331
|
+
# Invalidates all login sessions of a certain user Invalidates a subject's authentication session
|
332
|
+
# 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.
|
333
|
+
# @param subject
|
334
|
+
# @param [Hash] opts the optional parameters
|
335
|
+
# @return [nil]
|
336
|
+
describe 'revoke_authentication_session test' do
|
337
|
+
it 'should work' do
|
338
|
+
# assertion here. ref: https://www.relishapp.com/rspec/rspec-expectations/docs/built-in-matchers
|
339
|
+
end
|
340
|
+
end
|
341
|
+
|
342
|
+
# unit tests for revoke_consent_sessions
|
343
|
+
# Revokes consent sessions of a subject for a specific OAuth 2.0 Client
|
344
|
+
# 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.
|
345
|
+
# @param subject The subject (Subject) who's consent sessions should be deleted.
|
346
|
+
# @param [Hash] opts the optional parameters
|
347
|
+
# @option opts [String] :client If set, deletes only those consent sessions by the Subject that have been granted to the specified OAuth 2.0 Client ID
|
348
|
+
# @return [nil]
|
349
|
+
describe 'revoke_consent_sessions test' do
|
350
|
+
it 'should work' do
|
351
|
+
# assertion here. ref: https://www.relishapp.com/rspec/rspec-expectations/docs/built-in-matchers
|
352
|
+
end
|
353
|
+
end
|
354
|
+
|
355
|
+
# unit tests for update_json_web_key
|
356
|
+
# Update a JSON Web Key
|
357
|
+
# Use this method if you do not want to let Hydra generate the JWKs for you, but instead save your own. 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.
|
358
|
+
# @param kid The kid of the desired key
|
359
|
+
# @param set The set
|
360
|
+
# @param [Hash] opts the optional parameters
|
361
|
+
# @option opts [JSONWebKey] :body
|
362
|
+
# @return [JSONWebKey]
|
363
|
+
describe 'update_json_web_key test' do
|
364
|
+
it 'should work' do
|
365
|
+
# assertion here. ref: https://www.relishapp.com/rspec/rspec-expectations/docs/built-in-matchers
|
366
|
+
end
|
367
|
+
end
|
368
|
+
|
369
|
+
# unit tests for update_json_web_key_set
|
370
|
+
# Update a JSON Web Key Set
|
371
|
+
# Use this method if you do not want to let Hydra generate the JWKs for you, but instead save your own. 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.
|
372
|
+
# @param set The set
|
373
|
+
# @param [Hash] opts the optional parameters
|
374
|
+
# @option opts [JSONWebKeySet] :body
|
375
|
+
# @return [JSONWebKeySet]
|
376
|
+
describe 'update_json_web_key_set test' do
|
377
|
+
it 'should work' do
|
378
|
+
# assertion here. ref: https://www.relishapp.com/rspec/rspec-expectations/docs/built-in-matchers
|
379
|
+
end
|
380
|
+
end
|
381
|
+
|
382
|
+
# unit tests for update_o_auth2_client
|
383
|
+
# Update an OAuth 2.0 Client
|
384
|
+
# Update an existing OAuth 2.0 Client. If you pass `client_secret` the secret will be updated and returned via the API. This is the only time you will be able to retrieve the client secret, so write it down and keep it 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.
|
385
|
+
# @param id
|
386
|
+
# @param body
|
387
|
+
# @param [Hash] opts the optional parameters
|
388
|
+
# @return [OAuth2Client]
|
389
|
+
describe 'update_o_auth2_client test' do
|
390
|
+
it 'should work' do
|
391
|
+
# assertion here. ref: https://www.relishapp.com/rspec/rspec-expectations/docs/built-in-matchers
|
392
|
+
end
|
393
|
+
end
|
394
|
+
|
395
|
+
end
|