ory-kratos-client 0.1.0.alpha5 → 0.3.0.alpha1
Sign up to get free protection for your applications and to get access to all the features.
- checksums.yaml +4 -4
- data/README.md +27 -11
- data/docs/AdminApi.md +116 -21
- data/docs/CommonApi.md +116 -21
- data/docs/CompleteSelfServiceBrowserSettingsStrategyProfileFlowPayload.md +19 -0
- data/docs/Form.md +3 -3
- data/docs/FormField.md +7 -7
- data/docs/GenericErrorPayload.md +1 -1
- data/docs/Identity.md +4 -2
- data/docs/LoginRequest.md +7 -5
- data/docs/LoginRequestMethod.md +2 -2
- data/docs/LoginRequestMethodConfig.md +10 -1
- data/docs/ProfileManagementRequest.md +7 -7
- data/docs/ProviderCredentialsConfig.md +19 -0
- data/docs/PublicApi.md +365 -39
- data/docs/RegistrationRequest.md +5 -5
- data/docs/RegistrationRequestMethodConfig.md +10 -1
- data/docs/RequestMethodConfig.md +23 -0
- data/docs/Session.md +5 -5
- data/docs/SettingsRequest.md +31 -0
- data/docs/SettingsRequestMethod.md +19 -0
- data/docs/VerifiableAddress.md +27 -0
- data/docs/VerificationRequest.md +29 -0
- data/lib/ory-kratos-client.rb +8 -3
- data/lib/ory-kratos-client/api/admin_api.rb +159 -36
- data/lib/ory-kratos-client/api/common_api.rb +159 -36
- data/lib/ory-kratos-client/api/health_api.rb +1 -1
- data/lib/ory-kratos-client/api/public_api.rb +493 -59
- data/lib/ory-kratos-client/api/version_api.rb +1 -1
- data/lib/ory-kratos-client/api_client.rb +1 -1
- data/lib/ory-kratos-client/api_error.rb +1 -1
- data/lib/ory-kratos-client/configuration.rb +1 -1
- data/lib/ory-kratos-client/models/complete_self_service_browser_profile_management_flow_payload.rb +1 -1
- data/lib/ory-kratos-client/models/complete_self_service_browser_settings_strategy_profile_flow_payload.rb +222 -0
- data/lib/ory-kratos-client/models/error.rb +1 -1
- data/lib/ory-kratos-client/models/error_container.rb +1 -1
- data/lib/ory-kratos-client/models/form.rb +17 -2
- data/lib/ory-kratos-client/models/form_field.rb +18 -9
- data/lib/ory-kratos-client/models/generic_error.rb +1 -1
- data/lib/ory-kratos-client/models/generic_error_payload.rb +3 -4
- data/lib/ory-kratos-client/models/health_not_ready_status.rb +1 -1
- data/lib/ory-kratos-client/models/health_status.rb +1 -1
- data/lib/ory-kratos-client/models/identity.rb +18 -2
- data/lib/ory-kratos-client/models/login_request.rb +37 -2
- data/lib/ory-kratos-client/models/login_request_method.rb +11 -1
- data/lib/ory-kratos-client/models/login_request_method_config.rb +74 -3
- data/lib/ory-kratos-client/models/profile_management_request.rb +36 -1
- data/lib/ory-kratos-client/models/provider_credentials_config.rb +215 -0
- data/lib/ory-kratos-client/models/registration_request.rb +26 -1
- data/lib/ory-kratos-client/models/registration_request_method.rb +1 -1
- data/lib/ory-kratos-client/models/registration_request_method_config.rb +74 -3
- data/lib/ory-kratos-client/models/request_method_config.rb +256 -0
- data/lib/ory-kratos-client/models/session.rb +26 -1
- data/lib/ory-kratos-client/models/settings_request.rb +313 -0
- data/lib/ory-kratos-client/models/settings_request_method.rb +216 -0
- data/lib/ory-kratos-client/models/verifiable_address.rb +276 -0
- data/lib/ory-kratos-client/models/verification_request.rb +265 -0
- data/lib/ory-kratos-client/models/version.rb +1 -1
- data/lib/ory-kratos-client/version.rb +2 -2
- data/ory-kratos-client.gemspec +1 -1
- data/spec/models/complete_self_service_browser_settings_strategy_profile_flow_payload_spec.rb +47 -0
- data/spec/models/provider_credentials_config_spec.rb +47 -0
- data/spec/models/request_method_config_spec.rb +59 -0
- data/spec/models/settings_request_method_spec.rb +47 -0
- data/spec/models/settings_request_spec.rb +83 -0
- data/spec/models/verifiable_address_spec.rb +71 -0
- data/spec/models/verification_request_spec.rb +77 -0
- metadata +43 -15
@@ -6,7 +6,7 @@
|
|
6
6
|
The version of the OpenAPI document: latest
|
7
7
|
|
8
8
|
Generated by: https://openapi-generator.tech
|
9
|
-
OpenAPI Generator version: 4.2.
|
9
|
+
OpenAPI Generator version: 4.2.3
|
10
10
|
|
11
11
|
=end
|
12
12
|
|
@@ -19,6 +19,66 @@ module OryHydraClient
|
|
19
19
|
def initialize(api_client = ApiClient.default)
|
20
20
|
@api_client = api_client
|
21
21
|
end
|
22
|
+
# Get a traits schema definition
|
23
|
+
# @param id [String] ID must be set to the ID of schema you want to get
|
24
|
+
# @param [Hash] opts the optional parameters
|
25
|
+
# @return [Object]
|
26
|
+
def get_schema(id, opts = {})
|
27
|
+
data, _status_code, _headers = get_schema_with_http_info(id, opts)
|
28
|
+
data
|
29
|
+
end
|
30
|
+
|
31
|
+
# Get a traits schema definition
|
32
|
+
# @param id [String] ID must be set to the ID of schema you want to get
|
33
|
+
# @param [Hash] opts the optional parameters
|
34
|
+
# @return [Array<(Object, Integer, Hash)>] Object data, response status code and response headers
|
35
|
+
def get_schema_with_http_info(id, opts = {})
|
36
|
+
if @api_client.config.debugging
|
37
|
+
@api_client.config.logger.debug 'Calling API: CommonApi.get_schema ...'
|
38
|
+
end
|
39
|
+
# verify the required parameter 'id' is set
|
40
|
+
if @api_client.config.client_side_validation && id.nil?
|
41
|
+
fail ArgumentError, "Missing the required parameter 'id' when calling CommonApi.get_schema"
|
42
|
+
end
|
43
|
+
# resource path
|
44
|
+
local_var_path = '/schemas/{id}'.sub('{' + 'id' + '}', CGI.escape(id.to_s))
|
45
|
+
|
46
|
+
# query parameters
|
47
|
+
query_params = opts[:query_params] || {}
|
48
|
+
|
49
|
+
# header parameters
|
50
|
+
header_params = opts[:header_params] || {}
|
51
|
+
# HTTP header 'Accept' (if needed)
|
52
|
+
header_params['Accept'] = @api_client.select_header_accept(['application/json'])
|
53
|
+
|
54
|
+
# form parameters
|
55
|
+
form_params = opts[:form_params] || {}
|
56
|
+
|
57
|
+
# http body (model)
|
58
|
+
post_body = opts[:body]
|
59
|
+
|
60
|
+
# return_type
|
61
|
+
return_type = opts[:return_type] || 'Object'
|
62
|
+
|
63
|
+
# auth_names
|
64
|
+
auth_names = opts[:auth_names] || []
|
65
|
+
|
66
|
+
new_options = opts.merge(
|
67
|
+
:header_params => header_params,
|
68
|
+
:query_params => query_params,
|
69
|
+
:form_params => form_params,
|
70
|
+
:body => post_body,
|
71
|
+
:auth_names => auth_names,
|
72
|
+
:return_type => return_type
|
73
|
+
)
|
74
|
+
|
75
|
+
data, status_code, headers = @api_client.call_api(:GET, local_var_path, new_options)
|
76
|
+
if @api_client.config.debugging
|
77
|
+
@api_client.config.logger.debug "API called: CommonApi#get_schema\nData: #{data.inspect}\nStatus code: #{status_code}\nHeaders: #{headers}"
|
78
|
+
end
|
79
|
+
return data, status_code, headers
|
80
|
+
end
|
81
|
+
|
22
82
|
# Get the request context of browser-based login user flows
|
23
83
|
# This endpoint returns a login request's context with, for example, error details and other information. When accessing this endpoint through ORY Kratos' Public API, ensure that cookies are set as they are required for CSRF to work. To prevent token scanning attacks, the public endpoint does not return 404 status codes to prevent scanning attacks. More information can be found at [ORY Kratos User Login and User Registration Documentation](https://www.ory.sh/docs/next/kratos/self-service/flows/user-login-user-registration).
|
24
84
|
# @param request [String] Request is the Login Request ID The value for this parameter comes from `request` URL Query parameter sent to your application (e.g. `/login?request=abcde`).
|
@@ -82,31 +142,31 @@ module OryHydraClient
|
|
82
142
|
return data, status_code, headers
|
83
143
|
end
|
84
144
|
|
85
|
-
# Get the request context of browser-based
|
86
|
-
# When accessing this endpoint through ORY Kratos' Public API, ensure that cookies are set as they are required for
|
87
|
-
# @param request [String] Request is the
|
145
|
+
# Get the request context of browser-based registration user flows
|
146
|
+
# This endpoint returns a registration request's context with, for example, error details and other information. When accessing this endpoint through ORY Kratos' Public API, ensure that cookies are set as they are required for CSRF to work. To prevent token scanning attacks, the public endpoint does not return 404 status codes to prevent scanning attacks. More information can be found at [ORY Kratos User Login and User Registration Documentation](https://www.ory.sh/docs/next/kratos/self-service/flows/user-login-user-registration).
|
147
|
+
# @param request [String] Request is the Registration Request ID The value for this parameter comes from `request` URL Query parameter sent to your application (e.g. `/registration?request=abcde`).
|
88
148
|
# @param [Hash] opts the optional parameters
|
89
|
-
# @return [
|
90
|
-
def
|
91
|
-
data, _status_code, _headers =
|
149
|
+
# @return [RegistrationRequest]
|
150
|
+
def get_self_service_browser_registration_request(request, opts = {})
|
151
|
+
data, _status_code, _headers = get_self_service_browser_registration_request_with_http_info(request, opts)
|
92
152
|
data
|
93
153
|
end
|
94
154
|
|
95
|
-
# Get the request context of browser-based
|
96
|
-
# When accessing this endpoint through ORY Kratos' Public API, ensure that cookies are set as they are required for
|
97
|
-
# @param request [String] Request is the
|
155
|
+
# Get the request context of browser-based registration user flows
|
156
|
+
# This endpoint returns a registration request's context with, for example, error details and other information. When accessing this endpoint through ORY Kratos' Public API, ensure that cookies are set as they are required for CSRF to work. To prevent token scanning attacks, the public endpoint does not return 404 status codes to prevent scanning attacks. More information can be found at [ORY Kratos User Login and User Registration Documentation](https://www.ory.sh/docs/next/kratos/self-service/flows/user-login-user-registration).
|
157
|
+
# @param request [String] Request is the Registration Request ID The value for this parameter comes from `request` URL Query parameter sent to your application (e.g. `/registration?request=abcde`).
|
98
158
|
# @param [Hash] opts the optional parameters
|
99
|
-
# @return [Array<(
|
100
|
-
def
|
159
|
+
# @return [Array<(RegistrationRequest, Integer, Hash)>] RegistrationRequest data, response status code and response headers
|
160
|
+
def get_self_service_browser_registration_request_with_http_info(request, opts = {})
|
101
161
|
if @api_client.config.debugging
|
102
|
-
@api_client.config.logger.debug 'Calling API: CommonApi.
|
162
|
+
@api_client.config.logger.debug 'Calling API: CommonApi.get_self_service_browser_registration_request ...'
|
103
163
|
end
|
104
164
|
# verify the required parameter 'request' is set
|
105
165
|
if @api_client.config.client_side_validation && request.nil?
|
106
|
-
fail ArgumentError, "Missing the required parameter 'request' when calling CommonApi.
|
166
|
+
fail ArgumentError, "Missing the required parameter 'request' when calling CommonApi.get_self_service_browser_registration_request"
|
107
167
|
end
|
108
168
|
# resource path
|
109
|
-
local_var_path = '/self-service/browser/flows/requests/
|
169
|
+
local_var_path = '/self-service/browser/flows/requests/registration'
|
110
170
|
|
111
171
|
# query parameters
|
112
172
|
query_params = opts[:query_params] || {}
|
@@ -124,7 +184,7 @@ module OryHydraClient
|
|
124
184
|
post_body = opts[:body]
|
125
185
|
|
126
186
|
# return_type
|
127
|
-
return_type = opts[:return_type] || '
|
187
|
+
return_type = opts[:return_type] || 'RegistrationRequest'
|
128
188
|
|
129
189
|
# auth_names
|
130
190
|
auth_names = opts[:auth_names] || []
|
@@ -140,36 +200,36 @@ module OryHydraClient
|
|
140
200
|
|
141
201
|
data, status_code, headers = @api_client.call_api(:GET, local_var_path, new_options)
|
142
202
|
if @api_client.config.debugging
|
143
|
-
@api_client.config.logger.debug "API called: CommonApi#
|
203
|
+
@api_client.config.logger.debug "API called: CommonApi#get_self_service_browser_registration_request\nData: #{data.inspect}\nStatus code: #{status_code}\nHeaders: #{headers}"
|
144
204
|
end
|
145
205
|
return data, status_code, headers
|
146
206
|
end
|
147
207
|
|
148
|
-
# Get the request context of browser-based
|
149
|
-
#
|
150
|
-
# @param request [String] Request is the
|
208
|
+
# Get the request context of browser-based settings flows
|
209
|
+
# When accessing this endpoint through ORY Kratos' Public API, ensure that cookies are set as they are required for checking the auth session. To prevent scanning attacks, the public endpoint does not return 404 status codes but instead 403 or 500. More information can be found at [ORY Kratos User Settings & Profile Management Documentation](../self-service/flows/user-settings).
|
210
|
+
# @param request [String] Request is the Login Request ID The value for this parameter comes from `request` URL Query parameter sent to your application (e.g. `/login?request=abcde`).
|
151
211
|
# @param [Hash] opts the optional parameters
|
152
|
-
# @return [
|
153
|
-
def
|
154
|
-
data, _status_code, _headers =
|
212
|
+
# @return [SettingsRequest]
|
213
|
+
def get_self_service_browser_settings_request(request, opts = {})
|
214
|
+
data, _status_code, _headers = get_self_service_browser_settings_request_with_http_info(request, opts)
|
155
215
|
data
|
156
216
|
end
|
157
217
|
|
158
|
-
# Get the request context of browser-based
|
159
|
-
#
|
160
|
-
# @param request [String] Request is the
|
218
|
+
# Get the request context of browser-based settings flows
|
219
|
+
# When accessing this endpoint through ORY Kratos' Public API, ensure that cookies are set as they are required for checking the auth session. To prevent scanning attacks, the public endpoint does not return 404 status codes but instead 403 or 500. More information can be found at [ORY Kratos User Settings & Profile Management Documentation](../self-service/flows/user-settings).
|
220
|
+
# @param request [String] Request is the Login Request ID The value for this parameter comes from `request` URL Query parameter sent to your application (e.g. `/login?request=abcde`).
|
161
221
|
# @param [Hash] opts the optional parameters
|
162
|
-
# @return [Array<(
|
163
|
-
def
|
222
|
+
# @return [Array<(SettingsRequest, Integer, Hash)>] SettingsRequest data, response status code and response headers
|
223
|
+
def get_self_service_browser_settings_request_with_http_info(request, opts = {})
|
164
224
|
if @api_client.config.debugging
|
165
|
-
@api_client.config.logger.debug 'Calling API: CommonApi.
|
225
|
+
@api_client.config.logger.debug 'Calling API: CommonApi.get_self_service_browser_settings_request ...'
|
166
226
|
end
|
167
227
|
# verify the required parameter 'request' is set
|
168
228
|
if @api_client.config.client_side_validation && request.nil?
|
169
|
-
fail ArgumentError, "Missing the required parameter 'request' when calling CommonApi.
|
229
|
+
fail ArgumentError, "Missing the required parameter 'request' when calling CommonApi.get_self_service_browser_settings_request"
|
170
230
|
end
|
171
231
|
# resource path
|
172
|
-
local_var_path = '/self-service/browser/flows/requests/
|
232
|
+
local_var_path = '/self-service/browser/flows/requests/settings'
|
173
233
|
|
174
234
|
# query parameters
|
175
235
|
query_params = opts[:query_params] || {}
|
@@ -187,7 +247,7 @@ module OryHydraClient
|
|
187
247
|
post_body = opts[:body]
|
188
248
|
|
189
249
|
# return_type
|
190
|
-
return_type = opts[:return_type] || '
|
250
|
+
return_type = opts[:return_type] || 'SettingsRequest'
|
191
251
|
|
192
252
|
# auth_names
|
193
253
|
auth_names = opts[:auth_names] || []
|
@@ -203,7 +263,7 @@ module OryHydraClient
|
|
203
263
|
|
204
264
|
data, status_code, headers = @api_client.call_api(:GET, local_var_path, new_options)
|
205
265
|
if @api_client.config.debugging
|
206
|
-
@api_client.config.logger.debug "API called: CommonApi#
|
266
|
+
@api_client.config.logger.debug "API called: CommonApi#get_self_service_browser_settings_request\nData: #{data.inspect}\nStatus code: #{status_code}\nHeaders: #{headers}"
|
207
267
|
end
|
208
268
|
return data, status_code, headers
|
209
269
|
end
|
@@ -211,7 +271,7 @@ module OryHydraClient
|
|
211
271
|
# Get user-facing self-service errors
|
212
272
|
# This endpoint returns the error associated with a user-facing self service errors. When accessing this endpoint through ORY Kratos' Public API, ensure that cookies are set as they are required for CSRF to work. To prevent token scanning attacks, the public endpoint does not return 404 status codes to prevent scanning attacks. More information can be found at [ORY Kratos User User Facing Error Documentation](https://www.ory.sh/docs/kratos/self-service/flows/user-facing-errors).
|
213
273
|
# @param [Hash] opts the optional parameters
|
214
|
-
# @option opts [String] :
|
274
|
+
# @option opts [String] :error
|
215
275
|
# @return [ErrorContainer]
|
216
276
|
def get_self_service_error(opts = {})
|
217
277
|
data, _status_code, _headers = get_self_service_error_with_http_info(opts)
|
@@ -221,7 +281,7 @@ module OryHydraClient
|
|
221
281
|
# Get user-facing self-service errors
|
222
282
|
# This endpoint returns the error associated with a user-facing self service errors. When accessing this endpoint through ORY Kratos' Public API, ensure that cookies are set as they are required for CSRF to work. To prevent token scanning attacks, the public endpoint does not return 404 status codes to prevent scanning attacks. More information can be found at [ORY Kratos User User Facing Error Documentation](https://www.ory.sh/docs/kratos/self-service/flows/user-facing-errors).
|
223
283
|
# @param [Hash] opts the optional parameters
|
224
|
-
# @option opts [String] :
|
284
|
+
# @option opts [String] :error
|
225
285
|
# @return [Array<(ErrorContainer, Integer, Hash)>] ErrorContainer data, response status code and response headers
|
226
286
|
def get_self_service_error_with_http_info(opts = {})
|
227
287
|
if @api_client.config.debugging
|
@@ -232,7 +292,7 @@ module OryHydraClient
|
|
232
292
|
|
233
293
|
# query parameters
|
234
294
|
query_params = opts[:query_params] || {}
|
235
|
-
query_params[:'
|
295
|
+
query_params[:'error'] = opts[:'error'] if !opts[:'error'].nil?
|
236
296
|
|
237
297
|
# header parameters
|
238
298
|
header_params = opts[:header_params] || {}
|
@@ -266,5 +326,68 @@ module OryHydraClient
|
|
266
326
|
end
|
267
327
|
return data, status_code, headers
|
268
328
|
end
|
329
|
+
|
330
|
+
# Get the request context of browser-based verification flows
|
331
|
+
# When accessing this endpoint through ORY Kratos' Public API, ensure that cookies are set as they are required for checking the auth session. To prevent scanning attacks, the public endpoint does not return 404 status codes but instead 403 or 500. More information can be found at [ORY Kratos Email and Phone Verification Documentation](https://www.ory.sh/docs/kratos/selfservice/flows/verify-email-account-activation).
|
332
|
+
# @param request [String] Request is the Request ID The value for this parameter comes from `request` URL Query parameter sent to your application (e.g. `/verify?request=abcde`).
|
333
|
+
# @param [Hash] opts the optional parameters
|
334
|
+
# @return [VerificationRequest]
|
335
|
+
def get_self_service_verification_request(request, opts = {})
|
336
|
+
data, _status_code, _headers = get_self_service_verification_request_with_http_info(request, opts)
|
337
|
+
data
|
338
|
+
end
|
339
|
+
|
340
|
+
# Get the request context of browser-based verification flows
|
341
|
+
# When accessing this endpoint through ORY Kratos' Public API, ensure that cookies are set as they are required for checking the auth session. To prevent scanning attacks, the public endpoint does not return 404 status codes but instead 403 or 500. More information can be found at [ORY Kratos Email and Phone Verification Documentation](https://www.ory.sh/docs/kratos/selfservice/flows/verify-email-account-activation).
|
342
|
+
# @param request [String] Request is the Request ID The value for this parameter comes from `request` URL Query parameter sent to your application (e.g. `/verify?request=abcde`).
|
343
|
+
# @param [Hash] opts the optional parameters
|
344
|
+
# @return [Array<(VerificationRequest, Integer, Hash)>] VerificationRequest data, response status code and response headers
|
345
|
+
def get_self_service_verification_request_with_http_info(request, opts = {})
|
346
|
+
if @api_client.config.debugging
|
347
|
+
@api_client.config.logger.debug 'Calling API: CommonApi.get_self_service_verification_request ...'
|
348
|
+
end
|
349
|
+
# verify the required parameter 'request' is set
|
350
|
+
if @api_client.config.client_side_validation && request.nil?
|
351
|
+
fail ArgumentError, "Missing the required parameter 'request' when calling CommonApi.get_self_service_verification_request"
|
352
|
+
end
|
353
|
+
# resource path
|
354
|
+
local_var_path = '/self-service/browser/flows/requests/verification'
|
355
|
+
|
356
|
+
# query parameters
|
357
|
+
query_params = opts[:query_params] || {}
|
358
|
+
query_params[:'request'] = request
|
359
|
+
|
360
|
+
# header parameters
|
361
|
+
header_params = opts[:header_params] || {}
|
362
|
+
# HTTP header 'Accept' (if needed)
|
363
|
+
header_params['Accept'] = @api_client.select_header_accept(['application/json'])
|
364
|
+
|
365
|
+
# form parameters
|
366
|
+
form_params = opts[:form_params] || {}
|
367
|
+
|
368
|
+
# http body (model)
|
369
|
+
post_body = opts[:body]
|
370
|
+
|
371
|
+
# return_type
|
372
|
+
return_type = opts[:return_type] || 'VerificationRequest'
|
373
|
+
|
374
|
+
# auth_names
|
375
|
+
auth_names = opts[:auth_names] || []
|
376
|
+
|
377
|
+
new_options = opts.merge(
|
378
|
+
:header_params => header_params,
|
379
|
+
:query_params => query_params,
|
380
|
+
:form_params => form_params,
|
381
|
+
:body => post_body,
|
382
|
+
:auth_names => auth_names,
|
383
|
+
:return_type => return_type
|
384
|
+
)
|
385
|
+
|
386
|
+
data, status_code, headers = @api_client.call_api(:GET, local_var_path, new_options)
|
387
|
+
if @api_client.config.debugging
|
388
|
+
@api_client.config.logger.debug "API called: CommonApi#get_self_service_verification_request\nData: #{data.inspect}\nStatus code: #{status_code}\nHeaders: #{headers}"
|
389
|
+
end
|
390
|
+
return data, status_code, headers
|
391
|
+
end
|
269
392
|
end
|
270
393
|
end
|
@@ -6,7 +6,7 @@
|
|
6
6
|
The version of the OpenAPI document: latest
|
7
7
|
|
8
8
|
Generated by: https://openapi-generator.tech
|
9
|
-
OpenAPI Generator version: 4.2.
|
9
|
+
OpenAPI Generator version: 4.2.3
|
10
10
|
|
11
11
|
=end
|
12
12
|
|
@@ -19,37 +19,149 @@ module OryHydraClient
|
|
19
19
|
def initialize(api_client = ApiClient.default)
|
20
20
|
@api_client = api_client
|
21
21
|
end
|
22
|
-
# Complete the browser-based
|
23
|
-
# This endpoint completes a browser-based
|
22
|
+
# Complete the browser-based settings flow for the OpenID Connect strategy
|
23
|
+
# This endpoint completes a browser-based settings flow. This is usually achieved by POSTing data to this endpoint. > This endpoint is NOT INTENDED for API clients and only works with browsers (Chrome, Firefox, ...) and HTML Forms. More information can be found at [ORY Kratos User Settings & Profile Management Documentation](../self-service/flows/user-settings).
|
24
|
+
# @param [Hash] opts the optional parameters
|
25
|
+
# @return [nil]
|
26
|
+
def complete_self_service_browser_settings_oidc_settings_flow(opts = {})
|
27
|
+
complete_self_service_browser_settings_oidc_settings_flow_with_http_info(opts)
|
28
|
+
nil
|
29
|
+
end
|
30
|
+
|
31
|
+
# Complete the browser-based settings flow for the OpenID Connect strategy
|
32
|
+
# This endpoint completes a browser-based settings flow. This is usually achieved by POSTing data to this endpoint. > This endpoint is NOT INTENDED for API clients and only works with browsers (Chrome, Firefox, ...) and HTML Forms. More information can be found at [ORY Kratos User Settings & Profile Management Documentation](../self-service/flows/user-settings).
|
33
|
+
# @param [Hash] opts the optional parameters
|
34
|
+
# @return [Array<(nil, Integer, Hash)>] nil, response status code and response headers
|
35
|
+
def complete_self_service_browser_settings_oidc_settings_flow_with_http_info(opts = {})
|
36
|
+
if @api_client.config.debugging
|
37
|
+
@api_client.config.logger.debug 'Calling API: PublicApi.complete_self_service_browser_settings_oidc_settings_flow ...'
|
38
|
+
end
|
39
|
+
# resource path
|
40
|
+
local_var_path = '/self-service/browser/flows/registration/strategies/oidc/settings/connections'
|
41
|
+
|
42
|
+
# query parameters
|
43
|
+
query_params = opts[:query_params] || {}
|
44
|
+
|
45
|
+
# header parameters
|
46
|
+
header_params = opts[:header_params] || {}
|
47
|
+
# HTTP header 'Accept' (if needed)
|
48
|
+
header_params['Accept'] = @api_client.select_header_accept(['application/json'])
|
49
|
+
|
50
|
+
# form parameters
|
51
|
+
form_params = opts[:form_params] || {}
|
52
|
+
|
53
|
+
# http body (model)
|
54
|
+
post_body = opts[:body]
|
55
|
+
|
56
|
+
# return_type
|
57
|
+
return_type = opts[:return_type]
|
58
|
+
|
59
|
+
# auth_names
|
60
|
+
auth_names = opts[:auth_names] || []
|
61
|
+
|
62
|
+
new_options = opts.merge(
|
63
|
+
:header_params => header_params,
|
64
|
+
:query_params => query_params,
|
65
|
+
:form_params => form_params,
|
66
|
+
:body => post_body,
|
67
|
+
:auth_names => auth_names,
|
68
|
+
:return_type => return_type
|
69
|
+
)
|
70
|
+
|
71
|
+
data, status_code, headers = @api_client.call_api(:POST, local_var_path, new_options)
|
72
|
+
if @api_client.config.debugging
|
73
|
+
@api_client.config.logger.debug "API called: PublicApi#complete_self_service_browser_settings_oidc_settings_flow\nData: #{data.inspect}\nStatus code: #{status_code}\nHeaders: #{headers}"
|
74
|
+
end
|
75
|
+
return data, status_code, headers
|
76
|
+
end
|
77
|
+
|
78
|
+
# Complete the browser-based settings flow for the password strategy
|
79
|
+
# This endpoint completes a browser-based settings flow. This is usually achieved by POSTing data to this endpoint. > This endpoint is NOT INTENDED for API clients and only works with browsers (Chrome, Firefox, ...) and HTML Forms. More information can be found at [ORY Kratos User Settings & Profile Management Documentation](../self-service/flows/user-settings).
|
80
|
+
# @param [Hash] opts the optional parameters
|
81
|
+
# @return [nil]
|
82
|
+
def complete_self_service_browser_settings_password_strategy_flow(opts = {})
|
83
|
+
complete_self_service_browser_settings_password_strategy_flow_with_http_info(opts)
|
84
|
+
nil
|
85
|
+
end
|
86
|
+
|
87
|
+
# Complete the browser-based settings flow for the password strategy
|
88
|
+
# This endpoint completes a browser-based settings flow. This is usually achieved by POSTing data to this endpoint. > This endpoint is NOT INTENDED for API clients and only works with browsers (Chrome, Firefox, ...) and HTML Forms. More information can be found at [ORY Kratos User Settings & Profile Management Documentation](../self-service/flows/user-settings).
|
89
|
+
# @param [Hash] opts the optional parameters
|
90
|
+
# @return [Array<(nil, Integer, Hash)>] nil, response status code and response headers
|
91
|
+
def complete_self_service_browser_settings_password_strategy_flow_with_http_info(opts = {})
|
92
|
+
if @api_client.config.debugging
|
93
|
+
@api_client.config.logger.debug 'Calling API: PublicApi.complete_self_service_browser_settings_password_strategy_flow ...'
|
94
|
+
end
|
95
|
+
# resource path
|
96
|
+
local_var_path = '/self-service/browser/flows/settings/strategies/password'
|
97
|
+
|
98
|
+
# query parameters
|
99
|
+
query_params = opts[:query_params] || {}
|
100
|
+
|
101
|
+
# header parameters
|
102
|
+
header_params = opts[:header_params] || {}
|
103
|
+
# HTTP header 'Accept' (if needed)
|
104
|
+
header_params['Accept'] = @api_client.select_header_accept(['application/json'])
|
105
|
+
|
106
|
+
# form parameters
|
107
|
+
form_params = opts[:form_params] || {}
|
108
|
+
|
109
|
+
# http body (model)
|
110
|
+
post_body = opts[:body]
|
111
|
+
|
112
|
+
# return_type
|
113
|
+
return_type = opts[:return_type]
|
114
|
+
|
115
|
+
# auth_names
|
116
|
+
auth_names = opts[:auth_names] || []
|
117
|
+
|
118
|
+
new_options = opts.merge(
|
119
|
+
:header_params => header_params,
|
120
|
+
:query_params => query_params,
|
121
|
+
:form_params => form_params,
|
122
|
+
:body => post_body,
|
123
|
+
:auth_names => auth_names,
|
124
|
+
:return_type => return_type
|
125
|
+
)
|
126
|
+
|
127
|
+
data, status_code, headers = @api_client.call_api(:POST, local_var_path, new_options)
|
128
|
+
if @api_client.config.debugging
|
129
|
+
@api_client.config.logger.debug "API called: PublicApi#complete_self_service_browser_settings_password_strategy_flow\nData: #{data.inspect}\nStatus code: #{status_code}\nHeaders: #{headers}"
|
130
|
+
end
|
131
|
+
return data, status_code, headers
|
132
|
+
end
|
133
|
+
|
134
|
+
# Complete the browser-based settings flow for profile data
|
135
|
+
# This endpoint completes a browser-based settings flow. This is usually achieved by POSTing data to this endpoint. If the provided profile data is valid against the Identity's Traits JSON Schema, the data will be updated and the browser redirected to `url.settings_ui` for further steps. > This endpoint is NOT INTENDED for API clients and only works with browsers (Chrome, Firefox, ...) and HTML Forms. More information can be found at [ORY Kratos User Settings & Profile Management Documentation](../self-service/flows/user-settings).
|
24
136
|
# @param request [String] Request is the request ID.
|
25
|
-
# @param body [
|
137
|
+
# @param body [CompleteSelfServiceBrowserSettingsStrategyProfileFlowPayload]
|
26
138
|
# @param [Hash] opts the optional parameters
|
27
139
|
# @return [nil]
|
28
|
-
def
|
29
|
-
|
140
|
+
def complete_self_service_browser_settings_profile_strategy_flow(request, body, opts = {})
|
141
|
+
complete_self_service_browser_settings_profile_strategy_flow_with_http_info(request, body, opts)
|
30
142
|
nil
|
31
143
|
end
|
32
144
|
|
33
|
-
# Complete the browser-based profile
|
34
|
-
# This endpoint completes a browser-based
|
145
|
+
# Complete the browser-based settings flow for profile data
|
146
|
+
# This endpoint completes a browser-based settings flow. This is usually achieved by POSTing data to this endpoint. If the provided profile data is valid against the Identity's Traits JSON Schema, the data will be updated and the browser redirected to `url.settings_ui` for further steps. > This endpoint is NOT INTENDED for API clients and only works with browsers (Chrome, Firefox, ...) and HTML Forms. More information can be found at [ORY Kratos User Settings & Profile Management Documentation](../self-service/flows/user-settings).
|
35
147
|
# @param request [String] Request is the request ID.
|
36
|
-
# @param body [
|
148
|
+
# @param body [CompleteSelfServiceBrowserSettingsStrategyProfileFlowPayload]
|
37
149
|
# @param [Hash] opts the optional parameters
|
38
150
|
# @return [Array<(nil, Integer, Hash)>] nil, response status code and response headers
|
39
|
-
def
|
151
|
+
def complete_self_service_browser_settings_profile_strategy_flow_with_http_info(request, body, opts = {})
|
40
152
|
if @api_client.config.debugging
|
41
|
-
@api_client.config.logger.debug 'Calling API: PublicApi.
|
153
|
+
@api_client.config.logger.debug 'Calling API: PublicApi.complete_self_service_browser_settings_profile_strategy_flow ...'
|
42
154
|
end
|
43
155
|
# verify the required parameter 'request' is set
|
44
156
|
if @api_client.config.client_side_validation && request.nil?
|
45
|
-
fail ArgumentError, "Missing the required parameter 'request' when calling PublicApi.
|
157
|
+
fail ArgumentError, "Missing the required parameter 'request' when calling PublicApi.complete_self_service_browser_settings_profile_strategy_flow"
|
46
158
|
end
|
47
159
|
# verify the required parameter 'body' is set
|
48
160
|
if @api_client.config.client_side_validation && body.nil?
|
49
|
-
fail ArgumentError, "Missing the required parameter 'body' when calling PublicApi.
|
161
|
+
fail ArgumentError, "Missing the required parameter 'body' when calling PublicApi.complete_self_service_browser_settings_profile_strategy_flow"
|
50
162
|
end
|
51
163
|
# resource path
|
52
|
-
local_var_path = '/self-service/browser/flows/profile
|
164
|
+
local_var_path = '/self-service/browser/flows/settings/strategies/profile'
|
53
165
|
|
54
166
|
# query parameters
|
55
167
|
query_params = opts[:query_params] || {}
|
@@ -85,36 +197,42 @@ module OryHydraClient
|
|
85
197
|
|
86
198
|
data, status_code, headers = @api_client.call_api(:POST, local_var_path, new_options)
|
87
199
|
if @api_client.config.debugging
|
88
|
-
@api_client.config.logger.debug "API called: PublicApi#
|
200
|
+
@api_client.config.logger.debug "API called: PublicApi#complete_self_service_browser_settings_profile_strategy_flow\nData: #{data.inspect}\nStatus code: #{status_code}\nHeaders: #{headers}"
|
89
201
|
end
|
90
202
|
return data, status_code, headers
|
91
203
|
end
|
92
204
|
|
93
|
-
#
|
94
|
-
# This endpoint
|
95
|
-
# @param request [String] Request is the
|
205
|
+
# Complete the browser-based verification flows
|
206
|
+
# This endpoint completes a browser-based verification flow. This is usually achieved by POSTing data to this endpoint. If the provided data is valid against the Identity's Traits JSON Schema, the data will be updated and the browser redirected to `url.settings_ui` for further steps. > This endpoint is NOT INTENDED for API clients and only works with browsers (Chrome, Firefox, ...) and HTML Forms. More information can be found at [ORY Kratos Email and Phone Verification Documentation](https://www.ory.sh/docs/kratos/selfservice/flows/verify-email-account-activation).
|
207
|
+
# @param request [String] Request is the Request ID The value for this parameter comes from `request` URL Query parameter sent to your application (e.g. `/verify?request=abcde`).
|
208
|
+
# @param via [String] What to verify Currently only \"email\" is supported.
|
96
209
|
# @param [Hash] opts the optional parameters
|
97
|
-
# @return [
|
98
|
-
def
|
99
|
-
|
100
|
-
|
210
|
+
# @return [nil]
|
211
|
+
def complete_self_service_browser_verification_flow(request, via, opts = {})
|
212
|
+
complete_self_service_browser_verification_flow_with_http_info(request, via, opts)
|
213
|
+
nil
|
101
214
|
end
|
102
215
|
|
103
|
-
#
|
104
|
-
# This endpoint
|
105
|
-
# @param request [String] Request is the
|
216
|
+
# Complete the browser-based verification flows
|
217
|
+
# This endpoint completes a browser-based verification flow. This is usually achieved by POSTing data to this endpoint. If the provided data is valid against the Identity's Traits JSON Schema, the data will be updated and the browser redirected to `url.settings_ui` for further steps. > This endpoint is NOT INTENDED for API clients and only works with browsers (Chrome, Firefox, ...) and HTML Forms. More information can be found at [ORY Kratos Email and Phone Verification Documentation](https://www.ory.sh/docs/kratos/selfservice/flows/verify-email-account-activation).
|
218
|
+
# @param request [String] Request is the Request ID The value for this parameter comes from `request` URL Query parameter sent to your application (e.g. `/verify?request=abcde`).
|
219
|
+
# @param via [String] What to verify Currently only \"email\" is supported.
|
106
220
|
# @param [Hash] opts the optional parameters
|
107
|
-
# @return [Array<(
|
108
|
-
def
|
221
|
+
# @return [Array<(nil, Integer, Hash)>] nil, response status code and response headers
|
222
|
+
def complete_self_service_browser_verification_flow_with_http_info(request, via, opts = {})
|
109
223
|
if @api_client.config.debugging
|
110
|
-
@api_client.config.logger.debug 'Calling API: PublicApi.
|
224
|
+
@api_client.config.logger.debug 'Calling API: PublicApi.complete_self_service_browser_verification_flow ...'
|
111
225
|
end
|
112
226
|
# verify the required parameter 'request' is set
|
113
227
|
if @api_client.config.client_side_validation && request.nil?
|
114
|
-
fail ArgumentError, "Missing the required parameter 'request' when calling PublicApi.
|
228
|
+
fail ArgumentError, "Missing the required parameter 'request' when calling PublicApi.complete_self_service_browser_verification_flow"
|
229
|
+
end
|
230
|
+
# verify the required parameter 'via' is set
|
231
|
+
if @api_client.config.client_side_validation && via.nil?
|
232
|
+
fail ArgumentError, "Missing the required parameter 'via' when calling PublicApi.complete_self_service_browser_verification_flow"
|
115
233
|
end
|
116
234
|
# resource path
|
117
|
-
local_var_path = '/self-service/browser/flows/
|
235
|
+
local_var_path = '/self-service/browser/flows/verification/{via}/complete'.sub('{' + 'via' + '}', CGI.escape(via.to_s))
|
118
236
|
|
119
237
|
# query parameters
|
120
238
|
query_params = opts[:query_params] || {}
|
@@ -132,7 +250,67 @@ module OryHydraClient
|
|
132
250
|
post_body = opts[:body]
|
133
251
|
|
134
252
|
# return_type
|
135
|
-
return_type = opts[:return_type]
|
253
|
+
return_type = opts[:return_type]
|
254
|
+
|
255
|
+
# auth_names
|
256
|
+
auth_names = opts[:auth_names] || []
|
257
|
+
|
258
|
+
new_options = opts.merge(
|
259
|
+
:header_params => header_params,
|
260
|
+
:query_params => query_params,
|
261
|
+
:form_params => form_params,
|
262
|
+
:body => post_body,
|
263
|
+
:auth_names => auth_names,
|
264
|
+
:return_type => return_type
|
265
|
+
)
|
266
|
+
|
267
|
+
data, status_code, headers = @api_client.call_api(:POST, local_var_path, new_options)
|
268
|
+
if @api_client.config.debugging
|
269
|
+
@api_client.config.logger.debug "API called: PublicApi#complete_self_service_browser_verification_flow\nData: #{data.inspect}\nStatus code: #{status_code}\nHeaders: #{headers}"
|
270
|
+
end
|
271
|
+
return data, status_code, headers
|
272
|
+
end
|
273
|
+
|
274
|
+
# Get a traits schema definition
|
275
|
+
# @param id [String] ID must be set to the ID of schema you want to get
|
276
|
+
# @param [Hash] opts the optional parameters
|
277
|
+
# @return [Object]
|
278
|
+
def get_schema(id, opts = {})
|
279
|
+
data, _status_code, _headers = get_schema_with_http_info(id, opts)
|
280
|
+
data
|
281
|
+
end
|
282
|
+
|
283
|
+
# Get a traits schema definition
|
284
|
+
# @param id [String] ID must be set to the ID of schema you want to get
|
285
|
+
# @param [Hash] opts the optional parameters
|
286
|
+
# @return [Array<(Object, Integer, Hash)>] Object data, response status code and response headers
|
287
|
+
def get_schema_with_http_info(id, opts = {})
|
288
|
+
if @api_client.config.debugging
|
289
|
+
@api_client.config.logger.debug 'Calling API: PublicApi.get_schema ...'
|
290
|
+
end
|
291
|
+
# verify the required parameter 'id' is set
|
292
|
+
if @api_client.config.client_side_validation && id.nil?
|
293
|
+
fail ArgumentError, "Missing the required parameter 'id' when calling PublicApi.get_schema"
|
294
|
+
end
|
295
|
+
# resource path
|
296
|
+
local_var_path = '/schemas/{id}'.sub('{' + 'id' + '}', CGI.escape(id.to_s))
|
297
|
+
|
298
|
+
# query parameters
|
299
|
+
query_params = opts[:query_params] || {}
|
300
|
+
|
301
|
+
# header parameters
|
302
|
+
header_params = opts[:header_params] || {}
|
303
|
+
# HTTP header 'Accept' (if needed)
|
304
|
+
header_params['Accept'] = @api_client.select_header_accept(['application/json'])
|
305
|
+
|
306
|
+
# form parameters
|
307
|
+
form_params = opts[:form_params] || {}
|
308
|
+
|
309
|
+
# http body (model)
|
310
|
+
post_body = opts[:body]
|
311
|
+
|
312
|
+
# return_type
|
313
|
+
return_type = opts[:return_type] || 'Object'
|
136
314
|
|
137
315
|
# auth_names
|
138
316
|
auth_names = opts[:auth_names] || []
|
@@ -148,36 +326,36 @@ module OryHydraClient
|
|
148
326
|
|
149
327
|
data, status_code, headers = @api_client.call_api(:GET, local_var_path, new_options)
|
150
328
|
if @api_client.config.debugging
|
151
|
-
@api_client.config.logger.debug "API called: PublicApi#
|
329
|
+
@api_client.config.logger.debug "API called: PublicApi#get_schema\nData: #{data.inspect}\nStatus code: #{status_code}\nHeaders: #{headers}"
|
152
330
|
end
|
153
331
|
return data, status_code, headers
|
154
332
|
end
|
155
333
|
|
156
|
-
# Get the request context of browser-based
|
157
|
-
# When accessing this endpoint through ORY Kratos' Public API, ensure that cookies are set as they are required for
|
334
|
+
# Get the request context of browser-based login user flows
|
335
|
+
# This endpoint returns a login request's context with, for example, error details and other information. When accessing this endpoint through ORY Kratos' Public API, ensure that cookies are set as they are required for CSRF to work. To prevent token scanning attacks, the public endpoint does not return 404 status codes to prevent scanning attacks. More information can be found at [ORY Kratos User Login and User Registration Documentation](https://www.ory.sh/docs/next/kratos/self-service/flows/user-login-user-registration).
|
158
336
|
# @param request [String] Request is the Login Request ID The value for this parameter comes from `request` URL Query parameter sent to your application (e.g. `/login?request=abcde`).
|
159
337
|
# @param [Hash] opts the optional parameters
|
160
|
-
# @return [
|
161
|
-
def
|
162
|
-
data, _status_code, _headers =
|
338
|
+
# @return [LoginRequest]
|
339
|
+
def get_self_service_browser_login_request(request, opts = {})
|
340
|
+
data, _status_code, _headers = get_self_service_browser_login_request_with_http_info(request, opts)
|
163
341
|
data
|
164
342
|
end
|
165
343
|
|
166
|
-
# Get the request context of browser-based
|
167
|
-
# When accessing this endpoint through ORY Kratos' Public API, ensure that cookies are set as they are required for
|
344
|
+
# Get the request context of browser-based login user flows
|
345
|
+
# This endpoint returns a login request's context with, for example, error details and other information. When accessing this endpoint through ORY Kratos' Public API, ensure that cookies are set as they are required for CSRF to work. To prevent token scanning attacks, the public endpoint does not return 404 status codes to prevent scanning attacks. More information can be found at [ORY Kratos User Login and User Registration Documentation](https://www.ory.sh/docs/next/kratos/self-service/flows/user-login-user-registration).
|
168
346
|
# @param request [String] Request is the Login Request ID The value for this parameter comes from `request` URL Query parameter sent to your application (e.g. `/login?request=abcde`).
|
169
347
|
# @param [Hash] opts the optional parameters
|
170
|
-
# @return [Array<(
|
171
|
-
def
|
348
|
+
# @return [Array<(LoginRequest, Integer, Hash)>] LoginRequest data, response status code and response headers
|
349
|
+
def get_self_service_browser_login_request_with_http_info(request, opts = {})
|
172
350
|
if @api_client.config.debugging
|
173
|
-
@api_client.config.logger.debug 'Calling API: PublicApi.
|
351
|
+
@api_client.config.logger.debug 'Calling API: PublicApi.get_self_service_browser_login_request ...'
|
174
352
|
end
|
175
353
|
# verify the required parameter 'request' is set
|
176
354
|
if @api_client.config.client_side_validation && request.nil?
|
177
|
-
fail ArgumentError, "Missing the required parameter 'request' when calling PublicApi.
|
355
|
+
fail ArgumentError, "Missing the required parameter 'request' when calling PublicApi.get_self_service_browser_login_request"
|
178
356
|
end
|
179
357
|
# resource path
|
180
|
-
local_var_path = '/self-service/browser/flows/requests/
|
358
|
+
local_var_path = '/self-service/browser/flows/requests/login'
|
181
359
|
|
182
360
|
# query parameters
|
183
361
|
query_params = opts[:query_params] || {}
|
@@ -195,7 +373,7 @@ module OryHydraClient
|
|
195
373
|
post_body = opts[:body]
|
196
374
|
|
197
375
|
# return_type
|
198
|
-
return_type = opts[:return_type] || '
|
376
|
+
return_type = opts[:return_type] || 'LoginRequest'
|
199
377
|
|
200
378
|
# auth_names
|
201
379
|
auth_names = opts[:auth_names] || []
|
@@ -211,7 +389,7 @@ module OryHydraClient
|
|
211
389
|
|
212
390
|
data, status_code, headers = @api_client.call_api(:GET, local_var_path, new_options)
|
213
391
|
if @api_client.config.debugging
|
214
|
-
@api_client.config.logger.debug "API called: PublicApi#
|
392
|
+
@api_client.config.logger.debug "API called: PublicApi#get_self_service_browser_login_request\nData: #{data.inspect}\nStatus code: #{status_code}\nHeaders: #{headers}"
|
215
393
|
end
|
216
394
|
return data, status_code, headers
|
217
395
|
end
|
@@ -279,10 +457,73 @@ module OryHydraClient
|
|
279
457
|
return data, status_code, headers
|
280
458
|
end
|
281
459
|
|
460
|
+
# Get the request context of browser-based settings flows
|
461
|
+
# When accessing this endpoint through ORY Kratos' Public API, ensure that cookies are set as they are required for checking the auth session. To prevent scanning attacks, the public endpoint does not return 404 status codes but instead 403 or 500. More information can be found at [ORY Kratos User Settings & Profile Management Documentation](../self-service/flows/user-settings).
|
462
|
+
# @param request [String] Request is the Login Request ID The value for this parameter comes from `request` URL Query parameter sent to your application (e.g. `/login?request=abcde`).
|
463
|
+
# @param [Hash] opts the optional parameters
|
464
|
+
# @return [SettingsRequest]
|
465
|
+
def get_self_service_browser_settings_request(request, opts = {})
|
466
|
+
data, _status_code, _headers = get_self_service_browser_settings_request_with_http_info(request, opts)
|
467
|
+
data
|
468
|
+
end
|
469
|
+
|
470
|
+
# Get the request context of browser-based settings flows
|
471
|
+
# When accessing this endpoint through ORY Kratos' Public API, ensure that cookies are set as they are required for checking the auth session. To prevent scanning attacks, the public endpoint does not return 404 status codes but instead 403 or 500. More information can be found at [ORY Kratos User Settings & Profile Management Documentation](../self-service/flows/user-settings).
|
472
|
+
# @param request [String] Request is the Login Request ID The value for this parameter comes from `request` URL Query parameter sent to your application (e.g. `/login?request=abcde`).
|
473
|
+
# @param [Hash] opts the optional parameters
|
474
|
+
# @return [Array<(SettingsRequest, Integer, Hash)>] SettingsRequest data, response status code and response headers
|
475
|
+
def get_self_service_browser_settings_request_with_http_info(request, opts = {})
|
476
|
+
if @api_client.config.debugging
|
477
|
+
@api_client.config.logger.debug 'Calling API: PublicApi.get_self_service_browser_settings_request ...'
|
478
|
+
end
|
479
|
+
# verify the required parameter 'request' is set
|
480
|
+
if @api_client.config.client_side_validation && request.nil?
|
481
|
+
fail ArgumentError, "Missing the required parameter 'request' when calling PublicApi.get_self_service_browser_settings_request"
|
482
|
+
end
|
483
|
+
# resource path
|
484
|
+
local_var_path = '/self-service/browser/flows/requests/settings'
|
485
|
+
|
486
|
+
# query parameters
|
487
|
+
query_params = opts[:query_params] || {}
|
488
|
+
query_params[:'request'] = request
|
489
|
+
|
490
|
+
# header parameters
|
491
|
+
header_params = opts[:header_params] || {}
|
492
|
+
# HTTP header 'Accept' (if needed)
|
493
|
+
header_params['Accept'] = @api_client.select_header_accept(['application/json'])
|
494
|
+
|
495
|
+
# form parameters
|
496
|
+
form_params = opts[:form_params] || {}
|
497
|
+
|
498
|
+
# http body (model)
|
499
|
+
post_body = opts[:body]
|
500
|
+
|
501
|
+
# return_type
|
502
|
+
return_type = opts[:return_type] || 'SettingsRequest'
|
503
|
+
|
504
|
+
# auth_names
|
505
|
+
auth_names = opts[:auth_names] || []
|
506
|
+
|
507
|
+
new_options = opts.merge(
|
508
|
+
:header_params => header_params,
|
509
|
+
:query_params => query_params,
|
510
|
+
:form_params => form_params,
|
511
|
+
:body => post_body,
|
512
|
+
:auth_names => auth_names,
|
513
|
+
:return_type => return_type
|
514
|
+
)
|
515
|
+
|
516
|
+
data, status_code, headers = @api_client.call_api(:GET, local_var_path, new_options)
|
517
|
+
if @api_client.config.debugging
|
518
|
+
@api_client.config.logger.debug "API called: PublicApi#get_self_service_browser_settings_request\nData: #{data.inspect}\nStatus code: #{status_code}\nHeaders: #{headers}"
|
519
|
+
end
|
520
|
+
return data, status_code, headers
|
521
|
+
end
|
522
|
+
|
282
523
|
# Get user-facing self-service errors
|
283
524
|
# This endpoint returns the error associated with a user-facing self service errors. When accessing this endpoint through ORY Kratos' Public API, ensure that cookies are set as they are required for CSRF to work. To prevent token scanning attacks, the public endpoint does not return 404 status codes to prevent scanning attacks. More information can be found at [ORY Kratos User User Facing Error Documentation](https://www.ory.sh/docs/kratos/self-service/flows/user-facing-errors).
|
284
525
|
# @param [Hash] opts the optional parameters
|
285
|
-
# @option opts [String] :
|
526
|
+
# @option opts [String] :error
|
286
527
|
# @return [ErrorContainer]
|
287
528
|
def get_self_service_error(opts = {})
|
288
529
|
data, _status_code, _headers = get_self_service_error_with_http_info(opts)
|
@@ -292,7 +533,7 @@ module OryHydraClient
|
|
292
533
|
# Get user-facing self-service errors
|
293
534
|
# This endpoint returns the error associated with a user-facing self service errors. When accessing this endpoint through ORY Kratos' Public API, ensure that cookies are set as they are required for CSRF to work. To prevent token scanning attacks, the public endpoint does not return 404 status codes to prevent scanning attacks. More information can be found at [ORY Kratos User User Facing Error Documentation](https://www.ory.sh/docs/kratos/self-service/flows/user-facing-errors).
|
294
535
|
# @param [Hash] opts the optional parameters
|
295
|
-
# @option opts [String] :
|
536
|
+
# @option opts [String] :error
|
296
537
|
# @return [Array<(ErrorContainer, Integer, Hash)>] ErrorContainer data, response status code and response headers
|
297
538
|
def get_self_service_error_with_http_info(opts = {})
|
298
539
|
if @api_client.config.debugging
|
@@ -303,7 +544,7 @@ module OryHydraClient
|
|
303
544
|
|
304
545
|
# query parameters
|
305
546
|
query_params = opts[:query_params] || {}
|
306
|
-
query_params[:'
|
547
|
+
query_params[:'error'] = opts[:'error'] if !opts[:'error'].nil?
|
307
548
|
|
308
549
|
# header parameters
|
309
550
|
header_params = opts[:header_params] || {}
|
@@ -338,6 +579,69 @@ module OryHydraClient
|
|
338
579
|
return data, status_code, headers
|
339
580
|
end
|
340
581
|
|
582
|
+
# Get the request context of browser-based verification flows
|
583
|
+
# When accessing this endpoint through ORY Kratos' Public API, ensure that cookies are set as they are required for checking the auth session. To prevent scanning attacks, the public endpoint does not return 404 status codes but instead 403 or 500. More information can be found at [ORY Kratos Email and Phone Verification Documentation](https://www.ory.sh/docs/kratos/selfservice/flows/verify-email-account-activation).
|
584
|
+
# @param request [String] Request is the Request ID The value for this parameter comes from `request` URL Query parameter sent to your application (e.g. `/verify?request=abcde`).
|
585
|
+
# @param [Hash] opts the optional parameters
|
586
|
+
# @return [VerificationRequest]
|
587
|
+
def get_self_service_verification_request(request, opts = {})
|
588
|
+
data, _status_code, _headers = get_self_service_verification_request_with_http_info(request, opts)
|
589
|
+
data
|
590
|
+
end
|
591
|
+
|
592
|
+
# Get the request context of browser-based verification flows
|
593
|
+
# When accessing this endpoint through ORY Kratos' Public API, ensure that cookies are set as they are required for checking the auth session. To prevent scanning attacks, the public endpoint does not return 404 status codes but instead 403 or 500. More information can be found at [ORY Kratos Email and Phone Verification Documentation](https://www.ory.sh/docs/kratos/selfservice/flows/verify-email-account-activation).
|
594
|
+
# @param request [String] Request is the Request ID The value for this parameter comes from `request` URL Query parameter sent to your application (e.g. `/verify?request=abcde`).
|
595
|
+
# @param [Hash] opts the optional parameters
|
596
|
+
# @return [Array<(VerificationRequest, Integer, Hash)>] VerificationRequest data, response status code and response headers
|
597
|
+
def get_self_service_verification_request_with_http_info(request, opts = {})
|
598
|
+
if @api_client.config.debugging
|
599
|
+
@api_client.config.logger.debug 'Calling API: PublicApi.get_self_service_verification_request ...'
|
600
|
+
end
|
601
|
+
# verify the required parameter 'request' is set
|
602
|
+
if @api_client.config.client_side_validation && request.nil?
|
603
|
+
fail ArgumentError, "Missing the required parameter 'request' when calling PublicApi.get_self_service_verification_request"
|
604
|
+
end
|
605
|
+
# resource path
|
606
|
+
local_var_path = '/self-service/browser/flows/requests/verification'
|
607
|
+
|
608
|
+
# query parameters
|
609
|
+
query_params = opts[:query_params] || {}
|
610
|
+
query_params[:'request'] = request
|
611
|
+
|
612
|
+
# header parameters
|
613
|
+
header_params = opts[:header_params] || {}
|
614
|
+
# HTTP header 'Accept' (if needed)
|
615
|
+
header_params['Accept'] = @api_client.select_header_accept(['application/json'])
|
616
|
+
|
617
|
+
# form parameters
|
618
|
+
form_params = opts[:form_params] || {}
|
619
|
+
|
620
|
+
# http body (model)
|
621
|
+
post_body = opts[:body]
|
622
|
+
|
623
|
+
# return_type
|
624
|
+
return_type = opts[:return_type] || 'VerificationRequest'
|
625
|
+
|
626
|
+
# auth_names
|
627
|
+
auth_names = opts[:auth_names] || []
|
628
|
+
|
629
|
+
new_options = opts.merge(
|
630
|
+
:header_params => header_params,
|
631
|
+
:query_params => query_params,
|
632
|
+
:form_params => form_params,
|
633
|
+
:body => post_body,
|
634
|
+
:auth_names => auth_names,
|
635
|
+
:return_type => return_type
|
636
|
+
)
|
637
|
+
|
638
|
+
data, status_code, headers = @api_client.call_api(:GET, local_var_path, new_options)
|
639
|
+
if @api_client.config.debugging
|
640
|
+
@api_client.config.logger.debug "API called: PublicApi#get_self_service_verification_request\nData: #{data.inspect}\nStatus code: #{status_code}\nHeaders: #{headers}"
|
641
|
+
end
|
642
|
+
return data, status_code, headers
|
643
|
+
end
|
644
|
+
|
341
645
|
# Initialize browser-based login user flow
|
342
646
|
# This endpoint initializes a browser-based user login flow. Once initialized, the browser will be redirected to `urls.login_ui` with the request ID set as a query parameter. If a valid user session exists already, the browser will be redirected to `urls.default_redirect_url`. > This endpoint is NOT INTENDED for API clients and only works with browsers (Chrome, Firefox, ...). More information can be found at [ORY Kratos User Login and User Registration Documentation](https://www.ory.sh/docs/next/kratos/self-service/flows/user-login-user-registration).
|
343
647
|
# @param [Hash] opts the optional parameters
|
@@ -506,25 +810,155 @@ module OryHydraClient
|
|
506
810
|
return data, status_code, headers
|
507
811
|
end
|
508
812
|
|
509
|
-
# Initialize browser-based
|
510
|
-
# This endpoint initializes a browser-based
|
813
|
+
# Initialize browser-based verification flow
|
814
|
+
# This endpoint initializes a browser-based verification flow. Once initialized, the browser will be redirected to `urls.settings_ui` with the request ID set as a query parameter. If no valid user session exists, a login flow will be initialized. > This endpoint is NOT INTENDED for API clients and only works with browsers (Chrome, Firefox, ...). More information can be found at [ORY Kratos Email and Phone Verification Documentation](https://www.ory.sh/docs/kratos/selfservice/flows/verify-email-account-activation).
|
815
|
+
# @param via [String] What to verify Currently only \"email\" is supported.
|
511
816
|
# @param [Hash] opts the optional parameters
|
512
817
|
# @return [nil]
|
513
|
-
def
|
514
|
-
|
818
|
+
def initialize_self_service_browser_verification_flow(via, opts = {})
|
819
|
+
initialize_self_service_browser_verification_flow_with_http_info(via, opts)
|
515
820
|
nil
|
516
821
|
end
|
517
822
|
|
518
|
-
# Initialize browser-based
|
519
|
-
# This endpoint initializes a browser-based
|
823
|
+
# Initialize browser-based verification flow
|
824
|
+
# This endpoint initializes a browser-based verification flow. Once initialized, the browser will be redirected to `urls.settings_ui` with the request ID set as a query parameter. If no valid user session exists, a login flow will be initialized. > This endpoint is NOT INTENDED for API clients and only works with browsers (Chrome, Firefox, ...). More information can be found at [ORY Kratos Email and Phone Verification Documentation](https://www.ory.sh/docs/kratos/selfservice/flows/verify-email-account-activation).
|
825
|
+
# @param via [String] What to verify Currently only \"email\" is supported.
|
520
826
|
# @param [Hash] opts the optional parameters
|
521
827
|
# @return [Array<(nil, Integer, Hash)>] nil, response status code and response headers
|
522
|
-
def
|
828
|
+
def initialize_self_service_browser_verification_flow_with_http_info(via, opts = {})
|
523
829
|
if @api_client.config.debugging
|
524
|
-
@api_client.config.logger.debug 'Calling API: PublicApi.
|
830
|
+
@api_client.config.logger.debug 'Calling API: PublicApi.initialize_self_service_browser_verification_flow ...'
|
831
|
+
end
|
832
|
+
# verify the required parameter 'via' is set
|
833
|
+
if @api_client.config.client_side_validation && via.nil?
|
834
|
+
fail ArgumentError, "Missing the required parameter 'via' when calling PublicApi.initialize_self_service_browser_verification_flow"
|
835
|
+
end
|
836
|
+
# resource path
|
837
|
+
local_var_path = '/self-service/browser/flows/verification/init/{via}'.sub('{' + 'via' + '}', CGI.escape(via.to_s))
|
838
|
+
|
839
|
+
# query parameters
|
840
|
+
query_params = opts[:query_params] || {}
|
841
|
+
|
842
|
+
# header parameters
|
843
|
+
header_params = opts[:header_params] || {}
|
844
|
+
# HTTP header 'Accept' (if needed)
|
845
|
+
header_params['Accept'] = @api_client.select_header_accept(['application/json'])
|
846
|
+
|
847
|
+
# form parameters
|
848
|
+
form_params = opts[:form_params] || {}
|
849
|
+
|
850
|
+
# http body (model)
|
851
|
+
post_body = opts[:body]
|
852
|
+
|
853
|
+
# return_type
|
854
|
+
return_type = opts[:return_type]
|
855
|
+
|
856
|
+
# auth_names
|
857
|
+
auth_names = opts[:auth_names] || []
|
858
|
+
|
859
|
+
new_options = opts.merge(
|
860
|
+
:header_params => header_params,
|
861
|
+
:query_params => query_params,
|
862
|
+
:form_params => form_params,
|
863
|
+
:body => post_body,
|
864
|
+
:auth_names => auth_names,
|
865
|
+
:return_type => return_type
|
866
|
+
)
|
867
|
+
|
868
|
+
data, status_code, headers = @api_client.call_api(:GET, local_var_path, new_options)
|
869
|
+
if @api_client.config.debugging
|
870
|
+
@api_client.config.logger.debug "API called: PublicApi#initialize_self_service_browser_verification_flow\nData: #{data.inspect}\nStatus code: #{status_code}\nHeaders: #{headers}"
|
871
|
+
end
|
872
|
+
return data, status_code, headers
|
873
|
+
end
|
874
|
+
|
875
|
+
# Initialize browser-based settings flow
|
876
|
+
# This endpoint initializes a browser-based settings flow. Once initialized, the browser will be redirected to `urls.settings_ui` with the request ID set as a query parameter. If no valid user session exists, a login flow will be initialized. > This endpoint is NOT INTENDED for API clients and only works with browsers (Chrome, Firefox, ...). More information can be found at [ORY Kratos User Settings & Profile Management Documentation](../self-service/flows/user-settings).
|
877
|
+
# @param [Hash] opts the optional parameters
|
878
|
+
# @return [nil]
|
879
|
+
def initialize_self_service_settings_flow(opts = {})
|
880
|
+
initialize_self_service_settings_flow_with_http_info(opts)
|
881
|
+
nil
|
882
|
+
end
|
883
|
+
|
884
|
+
# Initialize browser-based settings flow
|
885
|
+
# This endpoint initializes a browser-based settings flow. Once initialized, the browser will be redirected to `urls.settings_ui` with the request ID set as a query parameter. If no valid user session exists, a login flow will be initialized. > This endpoint is NOT INTENDED for API clients and only works with browsers (Chrome, Firefox, ...). More information can be found at [ORY Kratos User Settings & Profile Management Documentation](../self-service/flows/user-settings).
|
886
|
+
# @param [Hash] opts the optional parameters
|
887
|
+
# @return [Array<(nil, Integer, Hash)>] nil, response status code and response headers
|
888
|
+
def initialize_self_service_settings_flow_with_http_info(opts = {})
|
889
|
+
if @api_client.config.debugging
|
890
|
+
@api_client.config.logger.debug 'Calling API: PublicApi.initialize_self_service_settings_flow ...'
|
891
|
+
end
|
892
|
+
# resource path
|
893
|
+
local_var_path = '/self-service/browser/flows/settings'
|
894
|
+
|
895
|
+
# query parameters
|
896
|
+
query_params = opts[:query_params] || {}
|
897
|
+
|
898
|
+
# header parameters
|
899
|
+
header_params = opts[:header_params] || {}
|
900
|
+
# HTTP header 'Accept' (if needed)
|
901
|
+
header_params['Accept'] = @api_client.select_header_accept(['application/json'])
|
902
|
+
|
903
|
+
# form parameters
|
904
|
+
form_params = opts[:form_params] || {}
|
905
|
+
|
906
|
+
# http body (model)
|
907
|
+
post_body = opts[:body]
|
908
|
+
|
909
|
+
# return_type
|
910
|
+
return_type = opts[:return_type]
|
911
|
+
|
912
|
+
# auth_names
|
913
|
+
auth_names = opts[:auth_names] || []
|
914
|
+
|
915
|
+
new_options = opts.merge(
|
916
|
+
:header_params => header_params,
|
917
|
+
:query_params => query_params,
|
918
|
+
:form_params => form_params,
|
919
|
+
:body => post_body,
|
920
|
+
:auth_names => auth_names,
|
921
|
+
:return_type => return_type
|
922
|
+
)
|
923
|
+
|
924
|
+
data, status_code, headers = @api_client.call_api(:GET, local_var_path, new_options)
|
925
|
+
if @api_client.config.debugging
|
926
|
+
@api_client.config.logger.debug "API called: PublicApi#initialize_self_service_settings_flow\nData: #{data.inspect}\nStatus code: #{status_code}\nHeaders: #{headers}"
|
927
|
+
end
|
928
|
+
return data, status_code, headers
|
929
|
+
end
|
930
|
+
|
931
|
+
# Complete the browser-based verification flows
|
932
|
+
# This endpoint completes a browser-based verification flow. > This endpoint is NOT INTENDED for API clients and only works with browsers (Chrome, Firefox, ...) and HTML Forms. More information can be found at [ORY Kratos Email and Phone Verification Documentation](https://www.ory.sh/docs/kratos/selfservice/flows/verify-email-account-activation).
|
933
|
+
# @param code [String]
|
934
|
+
# @param via [String] What to verify Currently only \"email\" is supported.
|
935
|
+
# @param [Hash] opts the optional parameters
|
936
|
+
# @return [nil]
|
937
|
+
def self_service_browser_verify(code, via, opts = {})
|
938
|
+
self_service_browser_verify_with_http_info(code, via, opts)
|
939
|
+
nil
|
940
|
+
end
|
941
|
+
|
942
|
+
# Complete the browser-based verification flows
|
943
|
+
# This endpoint completes a browser-based verification flow. > This endpoint is NOT INTENDED for API clients and only works with browsers (Chrome, Firefox, ...) and HTML Forms. More information can be found at [ORY Kratos Email and Phone Verification Documentation](https://www.ory.sh/docs/kratos/selfservice/flows/verify-email-account-activation).
|
944
|
+
# @param code [String]
|
945
|
+
# @param via [String] What to verify Currently only \"email\" is supported.
|
946
|
+
# @param [Hash] opts the optional parameters
|
947
|
+
# @return [Array<(nil, Integer, Hash)>] nil, response status code and response headers
|
948
|
+
def self_service_browser_verify_with_http_info(code, via, opts = {})
|
949
|
+
if @api_client.config.debugging
|
950
|
+
@api_client.config.logger.debug 'Calling API: PublicApi.self_service_browser_verify ...'
|
951
|
+
end
|
952
|
+
# verify the required parameter 'code' is set
|
953
|
+
if @api_client.config.client_side_validation && code.nil?
|
954
|
+
fail ArgumentError, "Missing the required parameter 'code' when calling PublicApi.self_service_browser_verify"
|
955
|
+
end
|
956
|
+
# verify the required parameter 'via' is set
|
957
|
+
if @api_client.config.client_side_validation && via.nil?
|
958
|
+
fail ArgumentError, "Missing the required parameter 'via' when calling PublicApi.self_service_browser_verify"
|
525
959
|
end
|
526
960
|
# resource path
|
527
|
-
local_var_path = '/self-service/browser/flows/
|
961
|
+
local_var_path = '/self-service/browser/flows/verification/{via}/confirm/{code}'.sub('{' + 'code' + '}', CGI.escape(code.to_s)).sub('{' + 'via' + '}', CGI.escape(via.to_s))
|
528
962
|
|
529
963
|
# query parameters
|
530
964
|
query_params = opts[:query_params] || {}
|
@@ -557,7 +991,7 @@ module OryHydraClient
|
|
557
991
|
|
558
992
|
data, status_code, headers = @api_client.call_api(:GET, local_var_path, new_options)
|
559
993
|
if @api_client.config.debugging
|
560
|
-
@api_client.config.logger.debug "API called: PublicApi#
|
994
|
+
@api_client.config.logger.debug "API called: PublicApi#self_service_browser_verify\nData: #{data.inspect}\nStatus code: #{status_code}\nHeaders: #{headers}"
|
561
995
|
end
|
562
996
|
return data, status_code, headers
|
563
997
|
end
|