ory-kratos-client 0.1.0.alpha5 → 0.1.0.alpha6

Sign up to get free protection for your applications and to get access to all the features.
Files changed (52) hide show
  1. checksums.yaml +4 -4
  2. data/README.md +12 -4
  3. data/docs/AdminApi.md +48 -0
  4. data/docs/CommonApi.md +48 -0
  5. data/docs/Form.md +3 -3
  6. data/docs/FormField.md +4 -4
  7. data/docs/Identity.md +4 -2
  8. data/docs/LoginRequest.md +5 -5
  9. data/docs/LoginRequestMethod.md +2 -2
  10. data/docs/LoginRequestMethodConfig.md +10 -1
  11. data/docs/ProfileManagementRequest.md +7 -7
  12. data/docs/PublicApi.md +189 -0
  13. data/docs/RegistrationRequest.md +6 -6
  14. data/docs/RegistrationRequestMethodConfig.md +10 -1
  15. data/docs/Session.md +5 -5
  16. data/docs/VerifiableAddress.md +27 -0
  17. data/docs/VerificationRequest.md +29 -0
  18. data/lib/ory-kratos-client.rb +3 -1
  19. data/lib/ory-kratos-client/api/admin_api.rb +64 -1
  20. data/lib/ory-kratos-client/api/common_api.rb +64 -1
  21. data/lib/ory-kratos-client/api/health_api.rb +1 -1
  22. data/lib/ory-kratos-client/api/public_api.rb +251 -1
  23. data/lib/ory-kratos-client/api/version_api.rb +1 -1
  24. data/lib/ory-kratos-client/api_client.rb +1 -1
  25. data/lib/ory-kratos-client/api_error.rb +1 -1
  26. data/lib/ory-kratos-client/configuration.rb +1 -1
  27. data/lib/ory-kratos-client/models/complete_self_service_browser_profile_management_flow_payload.rb +1 -1
  28. data/lib/ory-kratos-client/models/error.rb +1 -1
  29. data/lib/ory-kratos-client/models/error_container.rb +1 -1
  30. data/lib/ory-kratos-client/models/form.rb +16 -1
  31. data/lib/ory-kratos-client/models/form_field.rb +17 -2
  32. data/lib/ory-kratos-client/models/generic_error.rb +1 -1
  33. data/lib/ory-kratos-client/models/generic_error_payload.rb +1 -1
  34. data/lib/ory-kratos-client/models/health_not_ready_status.rb +1 -1
  35. data/lib/ory-kratos-client/models/health_status.rb +1 -1
  36. data/lib/ory-kratos-client/models/identity.rb +18 -2
  37. data/lib/ory-kratos-client/models/login_request.rb +26 -1
  38. data/lib/ory-kratos-client/models/login_request_method.rb +11 -1
  39. data/lib/ory-kratos-client/models/login_request_method_config.rb +74 -3
  40. data/lib/ory-kratos-client/models/profile_management_request.rb +36 -1
  41. data/lib/ory-kratos-client/models/registration_request.rb +31 -1
  42. data/lib/ory-kratos-client/models/registration_request_method.rb +1 -1
  43. data/lib/ory-kratos-client/models/registration_request_method_config.rb +74 -3
  44. data/lib/ory-kratos-client/models/session.rb +26 -1
  45. data/lib/ory-kratos-client/models/verifiable_address.rb +281 -0
  46. data/lib/ory-kratos-client/models/verification_request.rb +265 -0
  47. data/lib/ory-kratos-client/models/version.rb +1 -1
  48. data/lib/ory-kratos-client/version.rb +2 -2
  49. data/ory-kratos-client.gemspec +1 -1
  50. data/spec/models/verifiable_address_spec.rb +71 -0
  51. data/spec/models/verification_request_spec.rb +77 -0
  52. metadata +28 -20
@@ -4,12 +4,12 @@
4
4
 
5
5
  Name | Type | Description | Notes
6
6
  ------------ | ------------- | ------------- | -------------
7
- **active** | **String** | and so on. | [optional]
8
- **expires_at** | **DateTime** | ExpiresAt is the time (UTC) when the request expires. If the user still wishes to log in, a new request has to be initiated. | [optional]
9
- **id** | **String** | | [optional]
10
- **issued_at** | **DateTime** | IssuedAt is the time (UTC) when the request occurred. | [optional]
11
- **methods** | [**Hash<String, RegistrationRequestMethod>**](RegistrationRequestMethod.md) | Methods contains context for all enabled registration methods. If a registration request has been processed, but for example the password is incorrect, this will contain error messages. | [optional]
12
- **request_url** | **String** | RequestURL is the initial URL that was requested from ORY Kratos. It can be used to forward information contained in the URL's path or query for example. | [optional]
7
+ **active** | **String** | and so on. |
8
+ **expires_at** | **DateTime** | ExpiresAt is the time (UTC) when the request expires. If the user still wishes to log in, a new request has to be initiated. |
9
+ **id** | **String** | |
10
+ **issued_at** | **DateTime** | IssuedAt is the time (UTC) when the request occurred. |
11
+ **methods** | [**Hash<String, RegistrationRequestMethod>**](RegistrationRequestMethod.md) | Methods contains context for all enabled registration methods. If a registration request has been processed, but for example the password is incorrect, this will contain error messages. |
12
+ **request_url** | **String** | RequestURL is the initial URL that was requested from ORY Kratos. It can be used to forward information contained in the URL's path or query for example. |
13
13
 
14
14
  ## Code Sample
15
15
 
@@ -4,13 +4,22 @@
4
4
 
5
5
  Name | Type | Description | Notes
6
6
  ------------ | ------------- | ------------- | -------------
7
+ **action** | **String** | Action should be used as the form action URL (<form action=\"{{ .Action }}\" method=\"post\">). |
8
+ **errors** | [**Array<Error>**](Error.md) | Errors contains all form errors. These will be duplicates of the individual field errors. | [optional]
9
+ **fields** | [**Array<FormField>**](FormField.md) | Fields contains multiple fields |
10
+ **method** | **String** | Method is the form method (e.g. POST) |
11
+ **providers** | [**Array<FormField>**](FormField.md) | Providers is set for the \"oidc\" request method. | [optional]
7
12
 
8
13
  ## Code Sample
9
14
 
10
15
  ```ruby
11
16
  require 'OryHydraClient'
12
17
 
13
- instance = OryHydraClient::RegistrationRequestMethodConfig.new()
18
+ instance = OryHydraClient::RegistrationRequestMethodConfig.new(action: null,
19
+ errors: null,
20
+ fields: null,
21
+ method: null,
22
+ providers: null)
14
23
  ```
15
24
 
16
25
 
data/docs/Session.md CHANGED
@@ -4,11 +4,11 @@
4
4
 
5
5
  Name | Type | Description | Notes
6
6
  ------------ | ------------- | ------------- | -------------
7
- **authenticated_at** | **DateTime** | | [optional]
8
- **expires_at** | **DateTime** | | [optional]
9
- **identity** | [**Identity**](Identity.md) | | [optional]
10
- **issued_at** | **DateTime** | | [optional]
11
- **sid** | **String** | | [optional]
7
+ **authenticated_at** | **DateTime** | |
8
+ **expires_at** | **DateTime** | |
9
+ **identity** | [**Identity**](Identity.md) | |
10
+ **issued_at** | **DateTime** | |
11
+ **sid** | **String** | |
12
12
 
13
13
  ## Code Sample
14
14
 
@@ -0,0 +1,27 @@
1
+ # OryHydraClient::VerifiableAddress
2
+
3
+ ## Properties
4
+
5
+ Name | Type | Description | Notes
6
+ ------------ | ------------- | ------------- | -------------
7
+ **expires_at** | **DateTime** | |
8
+ **id** | **String** | |
9
+ **value** | **String** | |
10
+ **verified** | **Boolean** | |
11
+ **verified_at** | **DateTime** | |
12
+ **via** | **String** | |
13
+
14
+ ## Code Sample
15
+
16
+ ```ruby
17
+ require 'OryHydraClient'
18
+
19
+ instance = OryHydraClient::VerifiableAddress.new(expires_at: null,
20
+ id: null,
21
+ value: null,
22
+ verified: null,
23
+ verified_at: null,
24
+ via: null)
25
+ ```
26
+
27
+
@@ -0,0 +1,29 @@
1
+ # OryHydraClient::VerificationRequest
2
+
3
+ ## Properties
4
+
5
+ Name | Type | Description | Notes
6
+ ------------ | ------------- | ------------- | -------------
7
+ **expires_at** | **DateTime** | ExpiresAt is the time (UTC) when the request expires. If the user still wishes to update the profile, a new request has to be initiated. | [optional]
8
+ **form** | [**Form**](Form.md) | | [optional]
9
+ **id** | **String** | | [optional]
10
+ **issued_at** | **DateTime** | IssuedAt is the time (UTC) when the request occurred. | [optional]
11
+ **request_url** | **String** | RequestURL is the initial URL that was requested from ORY Kratos. It can be used to forward information contained in the URL's path or query for example. | [optional]
12
+ **success** | **Boolean** | Success, if true, implies that the request was completed successfully. | [optional]
13
+ **via** | **String** | | [optional]
14
+
15
+ ## Code Sample
16
+
17
+ ```ruby
18
+ require 'OryHydraClient'
19
+
20
+ instance = OryHydraClient::VerificationRequest.new(expires_at: null,
21
+ form: null,
22
+ id: null,
23
+ issued_at: null,
24
+ request_url: null,
25
+ success: null,
26
+ via: null)
27
+ ```
28
+
29
+
@@ -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.2
9
+ OpenAPI Generator version: 4.2.3
10
10
 
11
11
  =end
12
12
 
@@ -35,6 +35,8 @@ require 'ory-kratos-client/models/registration_request'
35
35
  require 'ory-kratos-client/models/registration_request_method'
36
36
  require 'ory-kratos-client/models/registration_request_method_config'
37
37
  require 'ory-kratos-client/models/session'
38
+ require 'ory-kratos-client/models/verifiable_address'
39
+ require 'ory-kratos-client/models/verification_request'
38
40
  require 'ory-kratos-client/models/version'
39
41
 
40
42
  # APIs
@@ -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.2
9
+ OpenAPI Generator version: 4.2.3
10
10
 
11
11
  =end
12
12
 
@@ -455,6 +455,69 @@ module OryHydraClient
455
455
  return data, status_code, headers
456
456
  end
457
457
 
458
+ # Get the request context of browser-based verification flows
459
+ # 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).
460
+ # @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`).
461
+ # @param [Hash] opts the optional parameters
462
+ # @return [VerificationRequest]
463
+ def get_self_service_verification_request(request, opts = {})
464
+ data, _status_code, _headers = get_self_service_verification_request_with_http_info(request, opts)
465
+ data
466
+ end
467
+
468
+ # Get the request context of browser-based verification flows
469
+ # 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).
470
+ # @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`).
471
+ # @param [Hash] opts the optional parameters
472
+ # @return [Array<(VerificationRequest, Integer, Hash)>] VerificationRequest data, response status code and response headers
473
+ def get_self_service_verification_request_with_http_info(request, opts = {})
474
+ if @api_client.config.debugging
475
+ @api_client.config.logger.debug 'Calling API: AdminApi.get_self_service_verification_request ...'
476
+ end
477
+ # verify the required parameter 'request' is set
478
+ if @api_client.config.client_side_validation && request.nil?
479
+ fail ArgumentError, "Missing the required parameter 'request' when calling AdminApi.get_self_service_verification_request"
480
+ end
481
+ # resource path
482
+ local_var_path = '/self-service/browser/flows/requests/verification'
483
+
484
+ # query parameters
485
+ query_params = opts[:query_params] || {}
486
+ query_params[:'request'] = request
487
+
488
+ # header parameters
489
+ header_params = opts[:header_params] || {}
490
+ # HTTP header 'Accept' (if needed)
491
+ header_params['Accept'] = @api_client.select_header_accept(['application/json'])
492
+
493
+ # form parameters
494
+ form_params = opts[:form_params] || {}
495
+
496
+ # http body (model)
497
+ post_body = opts[:body]
498
+
499
+ # return_type
500
+ return_type = opts[:return_type] || 'VerificationRequest'
501
+
502
+ # auth_names
503
+ auth_names = opts[:auth_names] || []
504
+
505
+ new_options = opts.merge(
506
+ :header_params => header_params,
507
+ :query_params => query_params,
508
+ :form_params => form_params,
509
+ :body => post_body,
510
+ :auth_names => auth_names,
511
+ :return_type => return_type
512
+ )
513
+
514
+ data, status_code, headers = @api_client.call_api(:GET, local_var_path, new_options)
515
+ if @api_client.config.debugging
516
+ @api_client.config.logger.debug "API called: AdminApi#get_self_service_verification_request\nData: #{data.inspect}\nStatus code: #{status_code}\nHeaders: #{headers}"
517
+ end
518
+ return data, status_code, headers
519
+ end
520
+
458
521
  # List all identities in the system
459
522
  # This endpoint returns a login request's context with, for example, error details and other information. Learn how identities work in [ORY Kratos' User And Identity Model Documentation](https://www.ory.sh/docs/next/kratos/concepts/identity-user-model).
460
523
  # @param [Hash] opts the optional parameters
@@ -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.2
9
+ OpenAPI Generator version: 4.2.3
10
10
 
11
11
  =end
12
12
 
@@ -266,5 +266,68 @@ module OryHydraClient
266
266
  end
267
267
  return data, status_code, headers
268
268
  end
269
+
270
+ # Get the request context of browser-based verification flows
271
+ # 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).
272
+ # @param request [String] Request is the Request ID The value for this parameter comes from &#x60;request&#x60; URL Query parameter sent to your application (e.g. &#x60;/verify?request&#x3D;abcde&#x60;).
273
+ # @param [Hash] opts the optional parameters
274
+ # @return [VerificationRequest]
275
+ def get_self_service_verification_request(request, opts = {})
276
+ data, _status_code, _headers = get_self_service_verification_request_with_http_info(request, opts)
277
+ data
278
+ end
279
+
280
+ # Get the request context of browser-based verification flows
281
+ # When accessing this endpoint through ORY Kratos&#39; 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).
282
+ # @param request [String] Request is the Request ID The value for this parameter comes from &#x60;request&#x60; URL Query parameter sent to your application (e.g. &#x60;/verify?request&#x3D;abcde&#x60;).
283
+ # @param [Hash] opts the optional parameters
284
+ # @return [Array<(VerificationRequest, Integer, Hash)>] VerificationRequest data, response status code and response headers
285
+ def get_self_service_verification_request_with_http_info(request, opts = {})
286
+ if @api_client.config.debugging
287
+ @api_client.config.logger.debug 'Calling API: CommonApi.get_self_service_verification_request ...'
288
+ end
289
+ # verify the required parameter 'request' is set
290
+ if @api_client.config.client_side_validation && request.nil?
291
+ fail ArgumentError, "Missing the required parameter 'request' when calling CommonApi.get_self_service_verification_request"
292
+ end
293
+ # resource path
294
+ local_var_path = '/self-service/browser/flows/requests/verification'
295
+
296
+ # query parameters
297
+ query_params = opts[:query_params] || {}
298
+ query_params[:'request'] = request
299
+
300
+ # header parameters
301
+ header_params = opts[:header_params] || {}
302
+ # HTTP header 'Accept' (if needed)
303
+ header_params['Accept'] = @api_client.select_header_accept(['application/json'])
304
+
305
+ # form parameters
306
+ form_params = opts[:form_params] || {}
307
+
308
+ # http body (model)
309
+ post_body = opts[:body]
310
+
311
+ # return_type
312
+ return_type = opts[:return_type] || 'VerificationRequest'
313
+
314
+ # auth_names
315
+ auth_names = opts[:auth_names] || []
316
+
317
+ new_options = opts.merge(
318
+ :header_params => header_params,
319
+ :query_params => query_params,
320
+ :form_params => form_params,
321
+ :body => post_body,
322
+ :auth_names => auth_names,
323
+ :return_type => return_type
324
+ )
325
+
326
+ data, status_code, headers = @api_client.call_api(:GET, local_var_path, new_options)
327
+ if @api_client.config.debugging
328
+ @api_client.config.logger.debug "API called: CommonApi#get_self_service_verification_request\nData: #{data.inspect}\nStatus code: #{status_code}\nHeaders: #{headers}"
329
+ end
330
+ return data, status_code, headers
331
+ end
269
332
  end
270
333
  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.2
9
+ OpenAPI Generator version: 4.2.3
10
10
 
11
11
  =end
12
12
 
@@ -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.2
9
+ OpenAPI Generator version: 4.2.3
10
10
 
11
11
  =end
12
12
 
@@ -90,6 +90,69 @@ module OryHydraClient
90
90
  return data, status_code, headers
91
91
  end
92
92
 
93
+ # Complete the browser-based profile management flows
94
+ # This endpoint completes a browser-based profile management 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.profile_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).
95
+ # @param request [String] Request is the Request ID The value for this parameter comes from &#x60;request&#x60; URL Query parameter sent to your application (e.g. &#x60;/verify?request&#x3D;abcde&#x60;).
96
+ # @param [Hash] opts the optional parameters
97
+ # @return [nil]
98
+ def complete_self_service_browser_verification_flow(request, opts = {})
99
+ complete_self_service_browser_verification_flow_with_http_info(request, opts)
100
+ nil
101
+ end
102
+
103
+ # Complete the browser-based profile management flows
104
+ # This endpoint completes a browser-based profile management flow. This is usually achieved by POSTing data to this endpoint. If the provided profile data is valid against the Identity&#39;s Traits JSON Schema, the data will be updated and the browser redirected to &#x60;url.profile_ui&#x60; for further steps. &gt; 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).
105
+ # @param request [String] Request is the Request ID The value for this parameter comes from &#x60;request&#x60; URL Query parameter sent to your application (e.g. &#x60;/verify?request&#x3D;abcde&#x60;).
106
+ # @param [Hash] opts the optional parameters
107
+ # @return [Array<(nil, Integer, Hash)>] nil, response status code and response headers
108
+ def complete_self_service_browser_verification_flow_with_http_info(request, opts = {})
109
+ if @api_client.config.debugging
110
+ @api_client.config.logger.debug 'Calling API: PublicApi.complete_self_service_browser_verification_flow ...'
111
+ end
112
+ # verify the required parameter 'request' is set
113
+ if @api_client.config.client_side_validation && request.nil?
114
+ fail ArgumentError, "Missing the required parameter 'request' when calling PublicApi.complete_self_service_browser_verification_flow"
115
+ end
116
+ # resource path
117
+ local_var_path = '/self-service/browser/flows/verification/complete'
118
+
119
+ # query parameters
120
+ query_params = opts[:query_params] || {}
121
+ query_params[:'request'] = request
122
+
123
+ # header parameters
124
+ header_params = opts[:header_params] || {}
125
+ # HTTP header 'Accept' (if needed)
126
+ header_params['Accept'] = @api_client.select_header_accept(['application/json'])
127
+
128
+ # form parameters
129
+ form_params = opts[:form_params] || {}
130
+
131
+ # http body (model)
132
+ post_body = opts[:body]
133
+
134
+ # return_type
135
+ return_type = opts[:return_type]
136
+
137
+ # auth_names
138
+ auth_names = opts[:auth_names] || []
139
+
140
+ new_options = opts.merge(
141
+ :header_params => header_params,
142
+ :query_params => query_params,
143
+ :form_params => form_params,
144
+ :body => post_body,
145
+ :auth_names => auth_names,
146
+ :return_type => return_type
147
+ )
148
+
149
+ data, status_code, headers = @api_client.call_api(:POST, local_var_path, new_options)
150
+ if @api_client.config.debugging
151
+ @api_client.config.logger.debug "API called: PublicApi#complete_self_service_browser_verification_flow\nData: #{data.inspect}\nStatus code: #{status_code}\nHeaders: #{headers}"
152
+ end
153
+ return data, status_code, headers
154
+ end
155
+
93
156
  # Get the request context of browser-based login user flows
94
157
  # 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).
95
158
  # @param request [String] Request is the Login Request ID The value for this parameter comes from &#x60;request&#x60; URL Query parameter sent to your application (e.g. &#x60;/login?request&#x3D;abcde&#x60;).
@@ -338,6 +401,69 @@ module OryHydraClient
338
401
  return data, status_code, headers
339
402
  end
340
403
 
404
+ # Get the request context of browser-based verification flows
405
+ # 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).
406
+ # @param request [String] Request is the Request ID The value for this parameter comes from &#x60;request&#x60; URL Query parameter sent to your application (e.g. &#x60;/verify?request&#x3D;abcde&#x60;).
407
+ # @param [Hash] opts the optional parameters
408
+ # @return [VerificationRequest]
409
+ def get_self_service_verification_request(request, opts = {})
410
+ data, _status_code, _headers = get_self_service_verification_request_with_http_info(request, opts)
411
+ data
412
+ end
413
+
414
+ # Get the request context of browser-based verification flows
415
+ # When accessing this endpoint through ORY Kratos&#39; 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).
416
+ # @param request [String] Request is the Request ID The value for this parameter comes from &#x60;request&#x60; URL Query parameter sent to your application (e.g. &#x60;/verify?request&#x3D;abcde&#x60;).
417
+ # @param [Hash] opts the optional parameters
418
+ # @return [Array<(VerificationRequest, Integer, Hash)>] VerificationRequest data, response status code and response headers
419
+ def get_self_service_verification_request_with_http_info(request, opts = {})
420
+ if @api_client.config.debugging
421
+ @api_client.config.logger.debug 'Calling API: PublicApi.get_self_service_verification_request ...'
422
+ end
423
+ # verify the required parameter 'request' is set
424
+ if @api_client.config.client_side_validation && request.nil?
425
+ fail ArgumentError, "Missing the required parameter 'request' when calling PublicApi.get_self_service_verification_request"
426
+ end
427
+ # resource path
428
+ local_var_path = '/self-service/browser/flows/requests/verification'
429
+
430
+ # query parameters
431
+ query_params = opts[:query_params] || {}
432
+ query_params[:'request'] = request
433
+
434
+ # header parameters
435
+ header_params = opts[:header_params] || {}
436
+ # HTTP header 'Accept' (if needed)
437
+ header_params['Accept'] = @api_client.select_header_accept(['application/json'])
438
+
439
+ # form parameters
440
+ form_params = opts[:form_params] || {}
441
+
442
+ # http body (model)
443
+ post_body = opts[:body]
444
+
445
+ # return_type
446
+ return_type = opts[:return_type] || 'VerificationRequest'
447
+
448
+ # auth_names
449
+ auth_names = opts[:auth_names] || []
450
+
451
+ new_options = opts.merge(
452
+ :header_params => header_params,
453
+ :query_params => query_params,
454
+ :form_params => form_params,
455
+ :body => post_body,
456
+ :auth_names => auth_names,
457
+ :return_type => return_type
458
+ )
459
+
460
+ data, status_code, headers = @api_client.call_api(:GET, local_var_path, new_options)
461
+ if @api_client.config.debugging
462
+ @api_client.config.logger.debug "API called: PublicApi#get_self_service_verification_request\nData: #{data.inspect}\nStatus code: #{status_code}\nHeaders: #{headers}"
463
+ end
464
+ return data, status_code, headers
465
+ end
466
+
341
467
  # Initialize browser-based login user flow
342
468
  # 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
469
  # @param [Hash] opts the optional parameters
@@ -506,6 +632,68 @@ module OryHydraClient
506
632
  return data, status_code, headers
507
633
  end
508
634
 
635
+ # Initialize browser-based verification flow
636
+ # This endpoint initializes a browser-based profile management flow. Once initialized, the browser will be redirected to `urls.profile_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).
637
+ # @param via [String] What to verify Currently only \&quot;email\&quot; is supported.
638
+ # @param [Hash] opts the optional parameters
639
+ # @return [nil]
640
+ def initialize_self_service_browser_verification_flow(via, opts = {})
641
+ initialize_self_service_browser_verification_flow_with_http_info(via, opts)
642
+ nil
643
+ end
644
+
645
+ # Initialize browser-based verification flow
646
+ # This endpoint initializes a browser-based profile management flow. Once initialized, the browser will be redirected to &#x60;urls.profile_ui&#x60; with the request ID set as a query parameter. If no valid user session exists, a login flow will be initialized. &gt; 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).
647
+ # @param via [String] What to verify Currently only \&quot;email\&quot; is supported.
648
+ # @param [Hash] opts the optional parameters
649
+ # @return [Array<(nil, Integer, Hash)>] nil, response status code and response headers
650
+ def initialize_self_service_browser_verification_flow_with_http_info(via, opts = {})
651
+ if @api_client.config.debugging
652
+ @api_client.config.logger.debug 'Calling API: PublicApi.initialize_self_service_browser_verification_flow ...'
653
+ end
654
+ # verify the required parameter 'via' is set
655
+ if @api_client.config.client_side_validation && via.nil?
656
+ fail ArgumentError, "Missing the required parameter 'via' when calling PublicApi.initialize_self_service_browser_verification_flow"
657
+ end
658
+ # resource path
659
+ local_var_path = '/self-service/browser/flows/verification/init/{via}'.sub('{' + 'via' + '}', CGI.escape(via.to_s))
660
+
661
+ # query parameters
662
+ query_params = opts[:query_params] || {}
663
+
664
+ # header parameters
665
+ header_params = opts[:header_params] || {}
666
+ # HTTP header 'Accept' (if needed)
667
+ header_params['Accept'] = @api_client.select_header_accept(['application/json'])
668
+
669
+ # form parameters
670
+ form_params = opts[:form_params] || {}
671
+
672
+ # http body (model)
673
+ post_body = opts[:body]
674
+
675
+ # return_type
676
+ return_type = opts[:return_type]
677
+
678
+ # auth_names
679
+ auth_names = opts[:auth_names] || []
680
+
681
+ new_options = opts.merge(
682
+ :header_params => header_params,
683
+ :query_params => query_params,
684
+ :form_params => form_params,
685
+ :body => post_body,
686
+ :auth_names => auth_names,
687
+ :return_type => return_type
688
+ )
689
+
690
+ data, status_code, headers = @api_client.call_api(:GET, local_var_path, new_options)
691
+ if @api_client.config.debugging
692
+ @api_client.config.logger.debug "API called: PublicApi#initialize_self_service_browser_verification_flow\nData: #{data.inspect}\nStatus code: #{status_code}\nHeaders: #{headers}"
693
+ end
694
+ return data, status_code, headers
695
+ end
696
+
509
697
  # Initialize browser-based profile management flow
510
698
  # This endpoint initializes a browser-based profile management flow. Once initialized, the browser will be redirected to `urls.profile_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 Profile Management Documentation](https://www.ory.sh/docs/next/kratos/self-service/flows/user-profile-management).
511
699
  # @param [Hash] opts the optional parameters
@@ -562,6 +750,68 @@ module OryHydraClient
562
750
  return data, status_code, headers
563
751
  end
564
752
 
753
+ # Complete the browser-based verification flows
754
+ # 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).
755
+ # @param code [String]
756
+ # @param [Hash] opts the optional parameters
757
+ # @return [nil]
758
+ def self_service_browser_verify(code, opts = {})
759
+ self_service_browser_verify_with_http_info(code, opts)
760
+ nil
761
+ end
762
+
763
+ # Complete the browser-based verification flows
764
+ # This endpoint completes a browser-based verification flow. &gt; 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).
765
+ # @param code [String]
766
+ # @param [Hash] opts the optional parameters
767
+ # @return [Array<(nil, Integer, Hash)>] nil, response status code and response headers
768
+ def self_service_browser_verify_with_http_info(code, opts = {})
769
+ if @api_client.config.debugging
770
+ @api_client.config.logger.debug 'Calling API: PublicApi.self_service_browser_verify ...'
771
+ end
772
+ # verify the required parameter 'code' is set
773
+ if @api_client.config.client_side_validation && code.nil?
774
+ fail ArgumentError, "Missing the required parameter 'code' when calling PublicApi.self_service_browser_verify"
775
+ end
776
+ # resource path
777
+ local_var_path = '/self-service/browser/flows/verification/confirm/{code}'.sub('{' + 'code' + '}', CGI.escape(code.to_s))
778
+
779
+ # query parameters
780
+ query_params = opts[:query_params] || {}
781
+
782
+ # header parameters
783
+ header_params = opts[:header_params] || {}
784
+ # HTTP header 'Accept' (if needed)
785
+ header_params['Accept'] = @api_client.select_header_accept(['application/json'])
786
+
787
+ # form parameters
788
+ form_params = opts[:form_params] || {}
789
+
790
+ # http body (model)
791
+ post_body = opts[:body]
792
+
793
+ # return_type
794
+ return_type = opts[:return_type]
795
+
796
+ # auth_names
797
+ auth_names = opts[:auth_names] || []
798
+
799
+ new_options = opts.merge(
800
+ :header_params => header_params,
801
+ :query_params => query_params,
802
+ :form_params => form_params,
803
+ :body => post_body,
804
+ :auth_names => auth_names,
805
+ :return_type => return_type
806
+ )
807
+
808
+ data, status_code, headers = @api_client.call_api(:GET, local_var_path, new_options)
809
+ if @api_client.config.debugging
810
+ @api_client.config.logger.debug "API called: PublicApi#self_service_browser_verify\nData: #{data.inspect}\nStatus code: #{status_code}\nHeaders: #{headers}"
811
+ end
812
+ return data, status_code, headers
813
+ end
814
+
565
815
  # Check who the current HTTP session belongs to
566
816
  # Uses the HTTP Headers in the GET request to determine (e.g. by using checking the cookies) who is authenticated. Returns a session object or 401 if the credentials are invalid or no credentials were sent. This endpoint is useful for reverse proxies and API Gateways.
567
817
  # @param [Hash] opts the optional parameters