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.
Files changed (68) hide show
  1. checksums.yaml +4 -4
  2. data/README.md +27 -11
  3. data/docs/AdminApi.md +116 -21
  4. data/docs/CommonApi.md +116 -21
  5. data/docs/CompleteSelfServiceBrowserSettingsStrategyProfileFlowPayload.md +19 -0
  6. data/docs/Form.md +3 -3
  7. data/docs/FormField.md +7 -7
  8. data/docs/GenericErrorPayload.md +1 -1
  9. data/docs/Identity.md +4 -2
  10. data/docs/LoginRequest.md +7 -5
  11. data/docs/LoginRequestMethod.md +2 -2
  12. data/docs/LoginRequestMethodConfig.md +10 -1
  13. data/docs/ProfileManagementRequest.md +7 -7
  14. data/docs/ProviderCredentialsConfig.md +19 -0
  15. data/docs/PublicApi.md +365 -39
  16. data/docs/RegistrationRequest.md +5 -5
  17. data/docs/RegistrationRequestMethodConfig.md +10 -1
  18. data/docs/RequestMethodConfig.md +23 -0
  19. data/docs/Session.md +5 -5
  20. data/docs/SettingsRequest.md +31 -0
  21. data/docs/SettingsRequestMethod.md +19 -0
  22. data/docs/VerifiableAddress.md +27 -0
  23. data/docs/VerificationRequest.md +29 -0
  24. data/lib/ory-kratos-client.rb +8 -3
  25. data/lib/ory-kratos-client/api/admin_api.rb +159 -36
  26. data/lib/ory-kratos-client/api/common_api.rb +159 -36
  27. data/lib/ory-kratos-client/api/health_api.rb +1 -1
  28. data/lib/ory-kratos-client/api/public_api.rb +493 -59
  29. data/lib/ory-kratos-client/api/version_api.rb +1 -1
  30. data/lib/ory-kratos-client/api_client.rb +1 -1
  31. data/lib/ory-kratos-client/api_error.rb +1 -1
  32. data/lib/ory-kratos-client/configuration.rb +1 -1
  33. data/lib/ory-kratos-client/models/complete_self_service_browser_profile_management_flow_payload.rb +1 -1
  34. data/lib/ory-kratos-client/models/complete_self_service_browser_settings_strategy_profile_flow_payload.rb +222 -0
  35. data/lib/ory-kratos-client/models/error.rb +1 -1
  36. data/lib/ory-kratos-client/models/error_container.rb +1 -1
  37. data/lib/ory-kratos-client/models/form.rb +17 -2
  38. data/lib/ory-kratos-client/models/form_field.rb +18 -9
  39. data/lib/ory-kratos-client/models/generic_error.rb +1 -1
  40. data/lib/ory-kratos-client/models/generic_error_payload.rb +3 -4
  41. data/lib/ory-kratos-client/models/health_not_ready_status.rb +1 -1
  42. data/lib/ory-kratos-client/models/health_status.rb +1 -1
  43. data/lib/ory-kratos-client/models/identity.rb +18 -2
  44. data/lib/ory-kratos-client/models/login_request.rb +37 -2
  45. data/lib/ory-kratos-client/models/login_request_method.rb +11 -1
  46. data/lib/ory-kratos-client/models/login_request_method_config.rb +74 -3
  47. data/lib/ory-kratos-client/models/profile_management_request.rb +36 -1
  48. data/lib/ory-kratos-client/models/provider_credentials_config.rb +215 -0
  49. data/lib/ory-kratos-client/models/registration_request.rb +26 -1
  50. data/lib/ory-kratos-client/models/registration_request_method.rb +1 -1
  51. data/lib/ory-kratos-client/models/registration_request_method_config.rb +74 -3
  52. data/lib/ory-kratos-client/models/request_method_config.rb +256 -0
  53. data/lib/ory-kratos-client/models/session.rb +26 -1
  54. data/lib/ory-kratos-client/models/settings_request.rb +313 -0
  55. data/lib/ory-kratos-client/models/settings_request_method.rb +216 -0
  56. data/lib/ory-kratos-client/models/verifiable_address.rb +276 -0
  57. data/lib/ory-kratos-client/models/verification_request.rb +265 -0
  58. data/lib/ory-kratos-client/models/version.rb +1 -1
  59. data/lib/ory-kratos-client/version.rb +2 -2
  60. data/ory-kratos-client.gemspec +1 -1
  61. data/spec/models/complete_self_service_browser_settings_strategy_profile_flow_payload_spec.rb +47 -0
  62. data/spec/models/provider_credentials_config_spec.rb +47 -0
  63. data/spec/models/request_method_config_spec.rb +59 -0
  64. data/spec/models/settings_request_method_spec.rb +47 -0
  65. data/spec/models/settings_request_spec.rb +83 -0
  66. data/spec/models/verifiable_address_spec.rb +71 -0
  67. data/spec/models/verification_request_spec.rb +77 -0
  68. metadata +43 -15
@@ -5,11 +5,11 @@
5
5
  Name | Type | Description | Notes
6
6
  ------------ | ------------- | ------------- | -------------
7
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]
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
 
@@ -0,0 +1,23 @@
1
+ # OryHydraClient::RequestMethodConfig
2
+
3
+ ## Properties
4
+
5
+ Name | Type | Description | Notes
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
+
12
+ ## Code Sample
13
+
14
+ ```ruby
15
+ require 'OryHydraClient'
16
+
17
+ instance = OryHydraClient::RequestMethodConfig.new(action: null,
18
+ errors: null,
19
+ fields: null,
20
+ method: null)
21
+ ```
22
+
23
+
@@ -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,31 @@
1
+ # OryHydraClient::SettingsRequest
2
+
3
+ ## Properties
4
+
5
+ Name | Type | Description | Notes
6
+ ------------ | ------------- | ------------- | -------------
7
+ **active** | **String** | Active, if set, contains the registration method that is being used. It is initially not set. | [optional]
8
+ **expires_at** | **DateTime** | ExpiresAt is the time (UTC) when the request expires. If the user still wishes to update the setting, a new request has to be initiated. |
9
+ **id** | **String** | |
10
+ **identity** | [**Identity**](Identity.md) | |
11
+ **issued_at** | **DateTime** | IssuedAt is the time (UTC) when the request occurred. |
12
+ **methods** | [**Hash<String, SettingsRequestMethod>**](SettingsRequestMethod.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. |
13
+ **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. |
14
+ **update_successful** | **Boolean** | UpdateSuccessful, if true, indicates that the settings request has been updated successfully with the provided data. Done will stay true when repeatedly checking. If set to true, done will revert back to false only when a request with invalid (e.g. \"please use a valid phone number\") data was sent. |
15
+
16
+ ## Code Sample
17
+
18
+ ```ruby
19
+ require 'OryHydraClient'
20
+
21
+ instance = OryHydraClient::SettingsRequest.new(active: null,
22
+ expires_at: null,
23
+ id: null,
24
+ identity: null,
25
+ issued_at: null,
26
+ methods: null,
27
+ request_url: null,
28
+ update_successful: null)
29
+ ```
30
+
31
+
@@ -0,0 +1,19 @@
1
+ # OryHydraClient::SettingsRequestMethod
2
+
3
+ ## Properties
4
+
5
+ Name | Type | Description | Notes
6
+ ------------ | ------------- | ------------- | -------------
7
+ **config** | [**RequestMethodConfig**](RequestMethodConfig.md) | | [optional]
8
+ **method** | **String** | Method contains the request credentials type. | [optional]
9
+
10
+ ## Code Sample
11
+
12
+ ```ruby
13
+ require 'OryHydraClient'
14
+
15
+ instance = OryHydraClient::SettingsRequestMethod.new(config: null,
16
+ method: null)
17
+ ```
18
+
19
+
@@ -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** | | [optional]
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 verify the address, 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
 
@@ -17,7 +17,7 @@ require 'ory-kratos-client/version'
17
17
  require 'ory-kratos-client/configuration'
18
18
 
19
19
  # Models
20
- require 'ory-kratos-client/models/complete_self_service_browser_profile_management_flow_payload'
20
+ require 'ory-kratos-client/models/complete_self_service_browser_settings_strategy_profile_flow_payload'
21
21
  require 'ory-kratos-client/models/error'
22
22
  require 'ory-kratos-client/models/error_container'
23
23
  require 'ory-kratos-client/models/form'
@@ -30,11 +30,16 @@ require 'ory-kratos-client/models/identity'
30
30
  require 'ory-kratos-client/models/login_request'
31
31
  require 'ory-kratos-client/models/login_request_method'
32
32
  require 'ory-kratos-client/models/login_request_method_config'
33
- require 'ory-kratos-client/models/profile_management_request'
33
+ require 'ory-kratos-client/models/provider_credentials_config'
34
34
  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
+ require 'ory-kratos-client/models/request_method_config'
37
38
  require 'ory-kratos-client/models/session'
39
+ require 'ory-kratos-client/models/settings_request'
40
+ require 'ory-kratos-client/models/settings_request_method'
41
+ require 'ory-kratos-client/models/verifiable_address'
42
+ require 'ory-kratos-client/models/verification_request'
38
43
  require 'ory-kratos-client/models/version'
39
44
 
40
45
  # 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
 
@@ -207,6 +207,66 @@ module OryHydraClient
207
207
  return data, status_code, headers
208
208
  end
209
209
 
210
+ # Get a traits schema definition
211
+ # @param id [String] ID must be set to the ID of schema you want to get
212
+ # @param [Hash] opts the optional parameters
213
+ # @return [Object]
214
+ def get_schema(id, opts = {})
215
+ data, _status_code, _headers = get_schema_with_http_info(id, opts)
216
+ data
217
+ end
218
+
219
+ # Get a traits schema definition
220
+ # @param id [String] ID must be set to the ID of schema you want to get
221
+ # @param [Hash] opts the optional parameters
222
+ # @return [Array<(Object, Integer, Hash)>] Object data, response status code and response headers
223
+ def get_schema_with_http_info(id, opts = {})
224
+ if @api_client.config.debugging
225
+ @api_client.config.logger.debug 'Calling API: AdminApi.get_schema ...'
226
+ end
227
+ # verify the required parameter 'id' is set
228
+ if @api_client.config.client_side_validation && id.nil?
229
+ fail ArgumentError, "Missing the required parameter 'id' when calling AdminApi.get_schema"
230
+ end
231
+ # resource path
232
+ local_var_path = '/schemas/{id}'.sub('{' + 'id' + '}', CGI.escape(id.to_s))
233
+
234
+ # query parameters
235
+ query_params = opts[:query_params] || {}
236
+
237
+ # header parameters
238
+ header_params = opts[:header_params] || {}
239
+ # HTTP header 'Accept' (if needed)
240
+ header_params['Accept'] = @api_client.select_header_accept(['application/json'])
241
+
242
+ # form parameters
243
+ form_params = opts[:form_params] || {}
244
+
245
+ # http body (model)
246
+ post_body = opts[:body]
247
+
248
+ # return_type
249
+ return_type = opts[:return_type] || 'Object'
250
+
251
+ # auth_names
252
+ auth_names = opts[:auth_names] || []
253
+
254
+ new_options = opts.merge(
255
+ :header_params => header_params,
256
+ :query_params => query_params,
257
+ :form_params => form_params,
258
+ :body => post_body,
259
+ :auth_names => auth_names,
260
+ :return_type => return_type
261
+ )
262
+
263
+ data, status_code, headers = @api_client.call_api(:GET, local_var_path, new_options)
264
+ if @api_client.config.debugging
265
+ @api_client.config.logger.debug "API called: AdminApi#get_schema\nData: #{data.inspect}\nStatus code: #{status_code}\nHeaders: #{headers}"
266
+ end
267
+ return data, status_code, headers
268
+ end
269
+
210
270
  # Get the request context of browser-based login user flows
211
271
  # 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).
212
272
  # @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;).
@@ -270,31 +330,31 @@ module OryHydraClient
270
330
  return data, status_code, headers
271
331
  end
272
332
 
273
- # Get the request context of browser-based profile management flows
274
- # 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 Profile Management Documentation](https://www.ory.sh/docs/next/kratos/self-service/flows/user-profile-management).
275
- # @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;).
333
+ # Get the request context of browser-based registration user flows
334
+ # 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).
335
+ # @param request [String] Request is the Registration Request ID The value for this parameter comes from &#x60;request&#x60; URL Query parameter sent to your application (e.g. &#x60;/registration?request&#x3D;abcde&#x60;).
276
336
  # @param [Hash] opts the optional parameters
277
- # @return [ProfileManagementRequest]
278
- def get_self_service_browser_profile_management_request(request, opts = {})
279
- data, _status_code, _headers = get_self_service_browser_profile_management_request_with_http_info(request, opts)
337
+ # @return [RegistrationRequest]
338
+ def get_self_service_browser_registration_request(request, opts = {})
339
+ data, _status_code, _headers = get_self_service_browser_registration_request_with_http_info(request, opts)
280
340
  data
281
341
  end
282
342
 
283
- # Get the request context of browser-based profile management flows
284
- # 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 Profile Management Documentation](https://www.ory.sh/docs/next/kratos/self-service/flows/user-profile-management).
285
- # @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;).
343
+ # Get the request context of browser-based registration user flows
344
+ # This endpoint returns a registration request&#39;s context with, for example, error details and other information. When accessing this endpoint through ORY Kratos&#39; 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).
345
+ # @param request [String] Request is the Registration Request ID The value for this parameter comes from &#x60;request&#x60; URL Query parameter sent to your application (e.g. &#x60;/registration?request&#x3D;abcde&#x60;).
286
346
  # @param [Hash] opts the optional parameters
287
- # @return [Array<(ProfileManagementRequest, Integer, Hash)>] ProfileManagementRequest data, response status code and response headers
288
- def get_self_service_browser_profile_management_request_with_http_info(request, opts = {})
347
+ # @return [Array<(RegistrationRequest, Integer, Hash)>] RegistrationRequest data, response status code and response headers
348
+ def get_self_service_browser_registration_request_with_http_info(request, opts = {})
289
349
  if @api_client.config.debugging
290
- @api_client.config.logger.debug 'Calling API: AdminApi.get_self_service_browser_profile_management_request ...'
350
+ @api_client.config.logger.debug 'Calling API: AdminApi.get_self_service_browser_registration_request ...'
291
351
  end
292
352
  # verify the required parameter 'request' is set
293
353
  if @api_client.config.client_side_validation && request.nil?
294
- fail ArgumentError, "Missing the required parameter 'request' when calling AdminApi.get_self_service_browser_profile_management_request"
354
+ fail ArgumentError, "Missing the required parameter 'request' when calling AdminApi.get_self_service_browser_registration_request"
295
355
  end
296
356
  # resource path
297
- local_var_path = '/self-service/browser/flows/requests/profile'
357
+ local_var_path = '/self-service/browser/flows/requests/registration'
298
358
 
299
359
  # query parameters
300
360
  query_params = opts[:query_params] || {}
@@ -312,7 +372,7 @@ module OryHydraClient
312
372
  post_body = opts[:body]
313
373
 
314
374
  # return_type
315
- return_type = opts[:return_type] || 'ProfileManagementRequest'
375
+ return_type = opts[:return_type] || 'RegistrationRequest'
316
376
 
317
377
  # auth_names
318
378
  auth_names = opts[:auth_names] || []
@@ -328,36 +388,36 @@ module OryHydraClient
328
388
 
329
389
  data, status_code, headers = @api_client.call_api(:GET, local_var_path, new_options)
330
390
  if @api_client.config.debugging
331
- @api_client.config.logger.debug "API called: AdminApi#get_self_service_browser_profile_management_request\nData: #{data.inspect}\nStatus code: #{status_code}\nHeaders: #{headers}"
391
+ @api_client.config.logger.debug "API called: AdminApi#get_self_service_browser_registration_request\nData: #{data.inspect}\nStatus code: #{status_code}\nHeaders: #{headers}"
332
392
  end
333
393
  return data, status_code, headers
334
394
  end
335
395
 
336
- # Get the request context of browser-based registration user flows
337
- # 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).
338
- # @param request [String] Request is the Registration Request ID The value for this parameter comes from &#x60;request&#x60; URL Query parameter sent to your application (e.g. &#x60;/registration?request&#x3D;abcde&#x60;).
396
+ # Get the request context of browser-based settings flows
397
+ # 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).
398
+ # @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;).
339
399
  # @param [Hash] opts the optional parameters
340
- # @return [RegistrationRequest]
341
- def get_self_service_browser_registration_request(request, opts = {})
342
- data, _status_code, _headers = get_self_service_browser_registration_request_with_http_info(request, opts)
400
+ # @return [SettingsRequest]
401
+ def get_self_service_browser_settings_request(request, opts = {})
402
+ data, _status_code, _headers = get_self_service_browser_settings_request_with_http_info(request, opts)
343
403
  data
344
404
  end
345
405
 
346
- # Get the request context of browser-based registration user flows
347
- # This endpoint returns a registration request&#39;s context with, for example, error details and other information. When accessing this endpoint through ORY Kratos&#39; 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).
348
- # @param request [String] Request is the Registration Request ID The value for this parameter comes from &#x60;request&#x60; URL Query parameter sent to your application (e.g. &#x60;/registration?request&#x3D;abcde&#x60;).
406
+ # Get the request context of browser-based settings flows
407
+ # 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 User Settings &amp; Profile Management Documentation](../self-service/flows/user-settings).
408
+ # @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;).
349
409
  # @param [Hash] opts the optional parameters
350
- # @return [Array<(RegistrationRequest, Integer, Hash)>] RegistrationRequest data, response status code and response headers
351
- def get_self_service_browser_registration_request_with_http_info(request, opts = {})
410
+ # @return [Array<(SettingsRequest, Integer, Hash)>] SettingsRequest data, response status code and response headers
411
+ def get_self_service_browser_settings_request_with_http_info(request, opts = {})
352
412
  if @api_client.config.debugging
353
- @api_client.config.logger.debug 'Calling API: AdminApi.get_self_service_browser_registration_request ...'
413
+ @api_client.config.logger.debug 'Calling API: AdminApi.get_self_service_browser_settings_request ...'
354
414
  end
355
415
  # verify the required parameter 'request' is set
356
416
  if @api_client.config.client_side_validation && request.nil?
357
- fail ArgumentError, "Missing the required parameter 'request' when calling AdminApi.get_self_service_browser_registration_request"
417
+ fail ArgumentError, "Missing the required parameter 'request' when calling AdminApi.get_self_service_browser_settings_request"
358
418
  end
359
419
  # resource path
360
- local_var_path = '/self-service/browser/flows/requests/registration'
420
+ local_var_path = '/self-service/browser/flows/requests/settings'
361
421
 
362
422
  # query parameters
363
423
  query_params = opts[:query_params] || {}
@@ -375,7 +435,7 @@ module OryHydraClient
375
435
  post_body = opts[:body]
376
436
 
377
437
  # return_type
378
- return_type = opts[:return_type] || 'RegistrationRequest'
438
+ return_type = opts[:return_type] || 'SettingsRequest'
379
439
 
380
440
  # auth_names
381
441
  auth_names = opts[:auth_names] || []
@@ -391,7 +451,7 @@ module OryHydraClient
391
451
 
392
452
  data, status_code, headers = @api_client.call_api(:GET, local_var_path, new_options)
393
453
  if @api_client.config.debugging
394
- @api_client.config.logger.debug "API called: AdminApi#get_self_service_browser_registration_request\nData: #{data.inspect}\nStatus code: #{status_code}\nHeaders: #{headers}"
454
+ @api_client.config.logger.debug "API called: AdminApi#get_self_service_browser_settings_request\nData: #{data.inspect}\nStatus code: #{status_code}\nHeaders: #{headers}"
395
455
  end
396
456
  return data, status_code, headers
397
457
  end
@@ -399,7 +459,7 @@ module OryHydraClient
399
459
  # Get user-facing self-service errors
400
460
  # 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).
401
461
  # @param [Hash] opts the optional parameters
402
- # @option opts [String] :id
462
+ # @option opts [String] :error
403
463
  # @return [ErrorContainer]
404
464
  def get_self_service_error(opts = {})
405
465
  data, _status_code, _headers = get_self_service_error_with_http_info(opts)
@@ -409,7 +469,7 @@ module OryHydraClient
409
469
  # Get user-facing self-service errors
410
470
  # This endpoint returns the error associated with a user-facing self service errors. When accessing this endpoint through ORY Kratos&#39; 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).
411
471
  # @param [Hash] opts the optional parameters
412
- # @option opts [String] :id
472
+ # @option opts [String] :error
413
473
  # @return [Array<(ErrorContainer, Integer, Hash)>] ErrorContainer data, response status code and response headers
414
474
  def get_self_service_error_with_http_info(opts = {})
415
475
  if @api_client.config.debugging
@@ -420,7 +480,7 @@ module OryHydraClient
420
480
 
421
481
  # query parameters
422
482
  query_params = opts[:query_params] || {}
423
- query_params[:'id'] = opts[:'id'] if !opts[:'id'].nil?
483
+ query_params[:'error'] = opts[:'error'] if !opts[:'error'].nil?
424
484
 
425
485
  # header parameters
426
486
  header_params = opts[:header_params] || {}
@@ -455,6 +515,69 @@ module OryHydraClient
455
515
  return data, status_code, headers
456
516
  end
457
517
 
518
+ # Get the request context of browser-based verification flows
519
+ # 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).
520
+ # @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;).
521
+ # @param [Hash] opts the optional parameters
522
+ # @return [VerificationRequest]
523
+ def get_self_service_verification_request(request, opts = {})
524
+ data, _status_code, _headers = get_self_service_verification_request_with_http_info(request, opts)
525
+ data
526
+ end
527
+
528
+ # Get the request context of browser-based verification flows
529
+ # 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).
530
+ # @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;).
531
+ # @param [Hash] opts the optional parameters
532
+ # @return [Array<(VerificationRequest, Integer, Hash)>] VerificationRequest data, response status code and response headers
533
+ def get_self_service_verification_request_with_http_info(request, opts = {})
534
+ if @api_client.config.debugging
535
+ @api_client.config.logger.debug 'Calling API: AdminApi.get_self_service_verification_request ...'
536
+ end
537
+ # verify the required parameter 'request' is set
538
+ if @api_client.config.client_side_validation && request.nil?
539
+ fail ArgumentError, "Missing the required parameter 'request' when calling AdminApi.get_self_service_verification_request"
540
+ end
541
+ # resource path
542
+ local_var_path = '/self-service/browser/flows/requests/verification'
543
+
544
+ # query parameters
545
+ query_params = opts[:query_params] || {}
546
+ query_params[:'request'] = request
547
+
548
+ # header parameters
549
+ header_params = opts[:header_params] || {}
550
+ # HTTP header 'Accept' (if needed)
551
+ header_params['Accept'] = @api_client.select_header_accept(['application/json'])
552
+
553
+ # form parameters
554
+ form_params = opts[:form_params] || {}
555
+
556
+ # http body (model)
557
+ post_body = opts[:body]
558
+
559
+ # return_type
560
+ return_type = opts[:return_type] || 'VerificationRequest'
561
+
562
+ # auth_names
563
+ auth_names = opts[:auth_names] || []
564
+
565
+ new_options = opts.merge(
566
+ :header_params => header_params,
567
+ :query_params => query_params,
568
+ :form_params => form_params,
569
+ :body => post_body,
570
+ :auth_names => auth_names,
571
+ :return_type => return_type
572
+ )
573
+
574
+ data, status_code, headers = @api_client.call_api(:GET, local_var_path, new_options)
575
+ if @api_client.config.debugging
576
+ @api_client.config.logger.debug "API called: AdminApi#get_self_service_verification_request\nData: #{data.inspect}\nStatus code: #{status_code}\nHeaders: #{headers}"
577
+ end
578
+ return data, status_code, headers
579
+ end
580
+
458
581
  # List all identities in the system
459
582
  # 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
583
  # @param [Hash] opts the optional parameters