ory-kratos-client 0.1.1.alpha1 → 0.2.0.alpha2

Sign up to get free protection for your applications and to get access to all the features.
Files changed (39) hide show
  1. checksums.yaml +4 -4
  2. data/README.md +18 -12
  3. data/docs/AdminApi.md +68 -21
  4. data/docs/CommonApi.md +68 -21
  5. data/docs/CompleteSelfServiceBrowserSettingsStrategyProfileFlowPayload.md +19 -0
  6. data/docs/Form.md +1 -1
  7. data/docs/FormField.md +6 -6
  8. data/docs/GenericErrorPayload.md +1 -1
  9. data/docs/LoginRequest.md +2 -0
  10. data/docs/LoginRequestMethodConfig.md +1 -1
  11. data/docs/PublicApi.md +134 -44
  12. data/docs/RegistrationRequestMethodConfig.md +1 -1
  13. data/docs/RequestMethodConfig.md +23 -0
  14. data/docs/SettingsRequest.md +31 -0
  15. data/docs/SettingsRequestMethod.md +19 -0
  16. data/docs/VerifiableAddress.md +1 -1
  17. data/docs/VerificationRequest.md +1 -1
  18. data/lib/ory-kratos-client.rb +4 -2
  19. data/lib/ory-kratos-client/api/admin_api.rb +95 -35
  20. data/lib/ory-kratos-client/api/common_api.rb +95 -35
  21. data/lib/ory-kratos-client/api/public_api.rb +181 -65
  22. data/lib/ory-kratos-client/models/complete_self_service_browser_settings_strategy_profile_flow_payload.rb +222 -0
  23. data/lib/ory-kratos-client/models/form.rb +1 -1
  24. data/lib/ory-kratos-client/models/form_field.rb +6 -6
  25. data/lib/ory-kratos-client/models/generic_error_payload.rb +2 -3
  26. data/lib/ory-kratos-client/models/login_request.rb +11 -1
  27. data/lib/ory-kratos-client/models/login_request_method_config.rb +1 -1
  28. data/lib/ory-kratos-client/models/registration_request_method_config.rb +1 -1
  29. data/lib/ory-kratos-client/models/request_method_config.rb +256 -0
  30. data/lib/ory-kratos-client/models/settings_request.rb +313 -0
  31. data/lib/ory-kratos-client/models/settings_request_method.rb +216 -0
  32. data/lib/ory-kratos-client/models/verifiable_address.rb +0 -5
  33. data/lib/ory-kratos-client/models/verification_request.rb +1 -1
  34. data/lib/ory-kratos-client/version.rb +1 -1
  35. data/spec/models/complete_self_service_browser_settings_strategy_profile_flow_payload_spec.rb +47 -0
  36. data/spec/models/request_method_config_spec.rb +59 -0
  37. data/spec/models/settings_request_method_spec.rb +47 -0
  38. data/spec/models/settings_request_spec.rb +83 -0
  39. metadata +36 -20
data/docs/Form.md CHANGED
@@ -4,7 +4,7 @@
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\">). |
7
+ **action** | **String** | Action should be used as the form action URL `<form action=\"{{ .Action }}\" method=\"post\">`. |
8
8
  **errors** | [**Array<Error>**](Error.md) | Errors contains all form errors. These will be duplicates of the individual field errors. | [optional]
9
9
  **fields** | [**Array<FormField>**](FormField.md) | Fields contains multiple fields |
10
10
  **method** | **String** | Method is the form method (e.g. POST) |
data/docs/FormField.md CHANGED
@@ -4,13 +4,13 @@
4
4
 
5
5
  Name | Type | Description | Notes
6
6
  ------------ | ------------- | ------------- | -------------
7
- **disabled** | **Boolean** | Disabled is the equivalent of <input disabled=\"{{.Disabled}}\"> | [optional]
7
+ **disabled** | **Boolean** | Disabled is the equivalent of `<input disabled=\"{{.Disabled}}\">` | [optional]
8
8
  **errors** | [**Array<Error>**](Error.md) | Errors contains all validation errors this particular field has caused. | [optional]
9
- **name** | **String** | Name is the equivalent of <input name=\"{{.Name}}\"> |
10
- **pattern** | **String** | Pattern is the equivalent of <input pattern=\"{{.Pattern}}\"> | [optional]
11
- **required** | **Boolean** | Required is the equivalent of <input required=\"{{.Required}}\"> |
12
- **type** | **String** | Type is the equivalent of <input type=\"{{.Type}}\"> |
13
- **value** | [**Object**](.md) | Value is the equivalent of <input value=\"{{.Value}}\"> | [optional]
9
+ **name** | **String** | Name is the equivalent of `<input name=\"{{.Name}}\">` |
10
+ **pattern** | **String** | Pattern is the equivalent of `<input pattern=\"{{.Pattern}}\">` | [optional]
11
+ **required** | **Boolean** | Required is the equivalent of `<input required=\"{{.Required}}\">` |
12
+ **type** | **String** | Type is the equivalent of `<input type=\"{{.Type}}\">` |
13
+ **value** | [**Object**](.md) | Value is the equivalent of `<input value=\"{{.Value}}\">` | [optional]
14
14
 
15
15
  ## Code Sample
16
16
 
@@ -6,7 +6,7 @@ Name | Type | Description | Notes
6
6
  ------------ | ------------- | ------------- | -------------
7
7
  **code** | **Integer** | Code represents the error status code (404, 403, 401, ...). | [optional]
8
8
  **debug** | **String** | Debug contains debug information. This is usually not available and has to be enabled. | [optional]
9
- **details** | **Array<Hash<String, Object>>** | | [optional]
9
+ **details** | **Hash<String, Object>** | | [optional]
10
10
  **message** | **String** | | [optional]
11
11
  **reason** | **String** | | [optional]
12
12
  **request** | **String** | | [optional]
data/docs/LoginRequest.md CHANGED
@@ -6,6 +6,7 @@ Name | Type | Description | Notes
6
6
  ------------ | ------------- | ------------- | -------------
7
7
  **active** | **String** | and so on. | [optional]
8
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
+ **forced** | **Boolean** | Forced stores whether this login request should enforce reauthentication. | [optional]
9
10
  **id** | **String** | |
10
11
  **issued_at** | **DateTime** | IssuedAt is the time (UTC) when the request occurred. |
11
12
  **methods** | [**Hash<String, LoginRequestMethod>**](LoginRequestMethod.md) | Methods contains context for all enabled login methods. If a login request has been processed, but for example the password is incorrect, this will contain error messages. |
@@ -18,6 +19,7 @@ require 'OryHydraClient'
18
19
 
19
20
  instance = OryHydraClient::LoginRequest.new(active: null,
20
21
  expires_at: null,
22
+ forced: null,
21
23
  id: null,
22
24
  issued_at: null,
23
25
  methods: null,
@@ -4,7 +4,7 @@
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\">). |
7
+ **action** | **String** | Action should be used as the form action URL `<form action=\"{{ .Action }}\" method=\"post\">`. |
8
8
  **errors** | [**Array<Error>**](Error.md) | Errors contains all form errors. These will be duplicates of the individual field errors. | [optional]
9
9
  **fields** | [**Array<FormField>**](FormField.md) | Fields contains multiple fields |
10
10
  **method** | **String** | Method is the form method (e.g. POST) |
data/docs/PublicApi.md CHANGED
@@ -4,30 +4,74 @@ All URIs are relative to *http://localhost*
4
4
 
5
5
  Method | HTTP request | Description
6
6
  ------------- | ------------- | -------------
7
- [**complete_self_service_browser_profile_management_flow**](PublicApi.md#complete_self_service_browser_profile_management_flow) | **POST** /self-service/browser/flows/profile/update | Complete the browser-based profile management flows
8
- [**complete_self_service_browser_verification_flow**](PublicApi.md#complete_self_service_browser_verification_flow) | **POST** /self-service/browser/flows/verification/{via}/complete | Complete the browser-based profile management flows
7
+ [**complete_self_service_browser_settings_password_strategy_flow**](PublicApi.md#complete_self_service_browser_settings_password_strategy_flow) | **POST** /self-service/browser/flows/settings/strategies/password | Complete the browser-based settings flow for the password strategy
8
+ [**complete_self_service_browser_settings_profile_strategy_flow**](PublicApi.md#complete_self_service_browser_settings_profile_strategy_flow) | **POST** /self-service/browser/flows/settings/strategies/profile | Complete the browser-based settings flow for profile data
9
+ [**complete_self_service_browser_verification_flow**](PublicApi.md#complete_self_service_browser_verification_flow) | **POST** /self-service/browser/flows/verification/{via}/complete | Complete the browser-based verification flows
10
+ [**get_schema**](PublicApi.md#get_schema) | **GET** /schemas/{id} |
9
11
  [**get_self_service_browser_login_request**](PublicApi.md#get_self_service_browser_login_request) | **GET** /self-service/browser/flows/requests/login | Get the request context of browser-based login user flows
10
- [**get_self_service_browser_profile_management_request**](PublicApi.md#get_self_service_browser_profile_management_request) | **GET** /self-service/browser/flows/requests/profile | Get the request context of browser-based profile management flows
11
12
  [**get_self_service_browser_registration_request**](PublicApi.md#get_self_service_browser_registration_request) | **GET** /self-service/browser/flows/requests/registration | Get the request context of browser-based registration user flows
13
+ [**get_self_service_browser_settings_request**](PublicApi.md#get_self_service_browser_settings_request) | **GET** /self-service/browser/flows/requests/settings | Get the request context of browser-based settings flows
12
14
  [**get_self_service_error**](PublicApi.md#get_self_service_error) | **GET** /self-service/errors | Get user-facing self-service errors
13
15
  [**get_self_service_verification_request**](PublicApi.md#get_self_service_verification_request) | **GET** /self-service/browser/flows/requests/verification | Get the request context of browser-based verification flows
14
16
  [**initialize_self_service_browser_login_flow**](PublicApi.md#initialize_self_service_browser_login_flow) | **GET** /self-service/browser/flows/login | Initialize browser-based login user flow
15
17
  [**initialize_self_service_browser_logout_flow**](PublicApi.md#initialize_self_service_browser_logout_flow) | **GET** /self-service/browser/flows/logout | Initialize Browser-Based Logout User Flow
16
18
  [**initialize_self_service_browser_registration_flow**](PublicApi.md#initialize_self_service_browser_registration_flow) | **GET** /self-service/browser/flows/registration | Initialize browser-based registration user flow
17
19
  [**initialize_self_service_browser_verification_flow**](PublicApi.md#initialize_self_service_browser_verification_flow) | **GET** /self-service/browser/flows/verification/init/{via} | Initialize browser-based verification flow
18
- [**initialize_self_service_profile_management_flow**](PublicApi.md#initialize_self_service_profile_management_flow) | **GET** /self-service/browser/flows/profile | Initialize browser-based profile management flow
20
+ [**initialize_self_service_settings_flow**](PublicApi.md#initialize_self_service_settings_flow) | **GET** /self-service/browser/flows/settings | Initialize browser-based settings flow
19
21
  [**self_service_browser_verify**](PublicApi.md#self_service_browser_verify) | **GET** /self-service/browser/flows/verification/{via}/confirm/{code} | Complete the browser-based verification flows
20
22
  [**whoami**](PublicApi.md#whoami) | **GET** /sessions/whoami | Check who the current HTTP session belongs to
21
23
 
22
24
 
23
25
 
24
- ## complete_self_service_browser_profile_management_flow
26
+ ## complete_self_service_browser_settings_password_strategy_flow
25
27
 
26
- > complete_self_service_browser_profile_management_flow(request, body)
28
+ > complete_self_service_browser_settings_password_strategy_flow
27
29
 
28
- Complete the browser-based profile management flows
30
+ Complete the browser-based settings flow for the password strategy
29
31
 
30
- 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 Profile Management Documentation](https://www.ory.sh/docs/next/kratos/self-service/flows/user-profile-management).
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](https://www.ory.sh/docs/next/kratos/self-service/flows/user-settings-profile-management).
33
+
34
+ ### Example
35
+
36
+ ```ruby
37
+ # load the gem
38
+ require 'ory-kratos-client'
39
+
40
+ api_instance = OryHydraClient::PublicApi.new
41
+
42
+ begin
43
+ #Complete the browser-based settings flow for the password strategy
44
+ api_instance.complete_self_service_browser_settings_password_strategy_flow
45
+ rescue OryHydraClient::ApiError => e
46
+ puts "Exception when calling PublicApi->complete_self_service_browser_settings_password_strategy_flow: #{e}"
47
+ end
48
+ ```
49
+
50
+ ### Parameters
51
+
52
+ This endpoint does not need any parameter.
53
+
54
+ ### Return type
55
+
56
+ nil (empty response body)
57
+
58
+ ### Authorization
59
+
60
+ No authorization required
61
+
62
+ ### HTTP request headers
63
+
64
+ - **Content-Type**: Not defined
65
+ - **Accept**: application/json
66
+
67
+
68
+ ## complete_self_service_browser_settings_profile_strategy_flow
69
+
70
+ > complete_self_service_browser_settings_profile_strategy_flow(request, body)
71
+
72
+ Complete the browser-based settings flow for profile data
73
+
74
+ 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](https://www.ory.sh/docs/next/kratos/self-service/flows/user-settings-profile-management).
31
75
 
32
76
  ### Example
33
77
 
@@ -37,13 +81,13 @@ require 'ory-kratos-client'
37
81
 
38
82
  api_instance = OryHydraClient::PublicApi.new
39
83
  request = 'request_example' # String | Request is the request ID.
40
- body = OryHydraClient::CompleteSelfServiceBrowserProfileManagementFlowPayload.new # CompleteSelfServiceBrowserProfileManagementFlowPayload |
84
+ body = OryHydraClient::CompleteSelfServiceBrowserSettingsStrategyProfileFlowPayload.new # CompleteSelfServiceBrowserSettingsStrategyProfileFlowPayload |
41
85
 
42
86
  begin
43
- #Complete the browser-based profile management flows
44
- api_instance.complete_self_service_browser_profile_management_flow(request, body)
87
+ #Complete the browser-based settings flow for profile data
88
+ api_instance.complete_self_service_browser_settings_profile_strategy_flow(request, body)
45
89
  rescue OryHydraClient::ApiError => e
46
- puts "Exception when calling PublicApi->complete_self_service_browser_profile_management_flow: #{e}"
90
+ puts "Exception when calling PublicApi->complete_self_service_browser_settings_profile_strategy_flow: #{e}"
47
91
  end
48
92
  ```
49
93
 
@@ -53,7 +97,7 @@ end
53
97
  Name | Type | Description | Notes
54
98
  ------------- | ------------- | ------------- | -------------
55
99
  **request** | **String**| Request is the request ID. |
56
- **body** | [**CompleteSelfServiceBrowserProfileManagementFlowPayload**](CompleteSelfServiceBrowserProfileManagementFlowPayload.md)| |
100
+ **body** | [**CompleteSelfServiceBrowserSettingsStrategyProfileFlowPayload**](CompleteSelfServiceBrowserSettingsStrategyProfileFlowPayload.md)| |
57
101
 
58
102
  ### Return type
59
103
 
@@ -73,9 +117,9 @@ No authorization required
73
117
 
74
118
  > complete_self_service_browser_verification_flow(request, via)
75
119
 
76
- Complete the browser-based profile management flows
120
+ Complete the browser-based verification flows
77
121
 
78
- 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).
122
+ 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).
79
123
 
80
124
  ### Example
81
125
 
@@ -88,7 +132,7 @@ request = 'request_example' # String | Request is the Request ID The value for
88
132
  via = 'via_example' # String | What to verify Currently only \"email\" is supported.
89
133
 
90
134
  begin
91
- #Complete the browser-based profile management flows
135
+ #Complete the browser-based verification flows
92
136
  api_instance.complete_self_service_browser_verification_flow(request, via)
93
137
  rescue OryHydraClient::ApiError => e
94
138
  puts "Exception when calling PublicApi->complete_self_service_browser_verification_flow: #{e}"
@@ -117,13 +161,13 @@ No authorization required
117
161
  - **Accept**: application/json
118
162
 
119
163
 
120
- ## get_self_service_browser_login_request
164
+ ## get_schema
121
165
 
122
- > LoginRequest get_self_service_browser_login_request(request)
166
+ > Object get_schema(id)
123
167
 
124
- Get the request context of browser-based login user flows
125
168
 
126
- 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).
169
+
170
+ Get a traits schema definition
127
171
 
128
172
  ### Example
129
173
 
@@ -132,14 +176,13 @@ This endpoint returns a login request's context with, for example, error details
132
176
  require 'ory-kratos-client'
133
177
 
134
178
  api_instance = OryHydraClient::PublicApi.new
135
- request = 'request_example' # 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`).
179
+ id = 'id_example' # String | ID must be set to the ID of schema you want to get
136
180
 
137
181
  begin
138
- #Get the request context of browser-based login user flows
139
- result = api_instance.get_self_service_browser_login_request(request)
182
+ result = api_instance.get_schema(id)
140
183
  p result
141
184
  rescue OryHydraClient::ApiError => e
142
- puts "Exception when calling PublicApi->get_self_service_browser_login_request: #{e}"
185
+ puts "Exception when calling PublicApi->get_schema: #{e}"
143
186
  end
144
187
  ```
145
188
 
@@ -148,11 +191,11 @@ end
148
191
 
149
192
  Name | Type | Description | Notes
150
193
  ------------- | ------------- | ------------- | -------------
151
- **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`). |
194
+ **id** | **String**| ID must be set to the ID of schema you want to get |
152
195
 
153
196
  ### Return type
154
197
 
155
- [**LoginRequest**](LoginRequest.md)
198
+ **Object**
156
199
 
157
200
  ### Authorization
158
201
 
@@ -164,13 +207,13 @@ No authorization required
164
207
  - **Accept**: application/json
165
208
 
166
209
 
167
- ## get_self_service_browser_profile_management_request
210
+ ## get_self_service_browser_login_request
168
211
 
169
- > ProfileManagementRequest get_self_service_browser_profile_management_request(request)
212
+ > LoginRequest get_self_service_browser_login_request(request)
170
213
 
171
- Get the request context of browser-based profile management flows
214
+ Get the request context of browser-based login user flows
172
215
 
173
- 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).
216
+ 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).
174
217
 
175
218
  ### Example
176
219
 
@@ -182,11 +225,11 @@ api_instance = OryHydraClient::PublicApi.new
182
225
  request = 'request_example' # 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`).
183
226
 
184
227
  begin
185
- #Get the request context of browser-based profile management flows
186
- result = api_instance.get_self_service_browser_profile_management_request(request)
228
+ #Get the request context of browser-based login user flows
229
+ result = api_instance.get_self_service_browser_login_request(request)
187
230
  p result
188
231
  rescue OryHydraClient::ApiError => e
189
- puts "Exception when calling PublicApi->get_self_service_browser_profile_management_request: #{e}"
232
+ puts "Exception when calling PublicApi->get_self_service_browser_login_request: #{e}"
190
233
  end
191
234
  ```
192
235
 
@@ -199,7 +242,7 @@ Name | Type | Description | Notes
199
242
 
200
243
  ### Return type
201
244
 
202
- [**ProfileManagementRequest**](ProfileManagementRequest.md)
245
+ [**LoginRequest**](LoginRequest.md)
203
246
 
204
247
  ### Authorization
205
248
 
@@ -258,6 +301,53 @@ No authorization required
258
301
  - **Accept**: application/json
259
302
 
260
303
 
304
+ ## get_self_service_browser_settings_request
305
+
306
+ > SettingsRequest get_self_service_browser_settings_request(request)
307
+
308
+ Get the request context of browser-based settings flows
309
+
310
+ 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](https://www.ory.sh/docs/next/kratos/self-service/flows/user-settings-profile-management).
311
+
312
+ ### Example
313
+
314
+ ```ruby
315
+ # load the gem
316
+ require 'ory-kratos-client'
317
+
318
+ api_instance = OryHydraClient::PublicApi.new
319
+ request = 'request_example' # 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`).
320
+
321
+ begin
322
+ #Get the request context of browser-based settings flows
323
+ result = api_instance.get_self_service_browser_settings_request(request)
324
+ p result
325
+ rescue OryHydraClient::ApiError => e
326
+ puts "Exception when calling PublicApi->get_self_service_browser_settings_request: #{e}"
327
+ end
328
+ ```
329
+
330
+ ### Parameters
331
+
332
+
333
+ Name | Type | Description | Notes
334
+ ------------- | ------------- | ------------- | -------------
335
+ **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`). |
336
+
337
+ ### Return type
338
+
339
+ [**SettingsRequest**](SettingsRequest.md)
340
+
341
+ ### Authorization
342
+
343
+ No authorization required
344
+
345
+ ### HTTP request headers
346
+
347
+ - **Content-Type**: Not defined
348
+ - **Accept**: application/json
349
+
350
+
261
351
  ## get_self_service_error
262
352
 
263
353
  > ErrorContainer get_self_service_error(opts)
@@ -274,7 +364,7 @@ require 'ory-kratos-client'
274
364
 
275
365
  api_instance = OryHydraClient::PublicApi.new
276
366
  opts = {
277
- id: 'id_example' # String |
367
+ error: 'error_example' # String |
278
368
  }
279
369
 
280
370
  begin
@@ -291,7 +381,7 @@ end
291
381
 
292
382
  Name | Type | Description | Notes
293
383
  ------------- | ------------- | ------------- | -------------
294
- **id** | **String**| | [optional]
384
+ **error** | **String**| | [optional]
295
385
 
296
386
  ### Return type
297
387
 
@@ -486,7 +576,7 @@ No authorization required
486
576
 
487
577
  Initialize browser-based verification flow
488
578
 
489
- 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).
579
+ 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).
490
580
 
491
581
  ### Example
492
582
 
@@ -526,13 +616,13 @@ No authorization required
526
616
  - **Accept**: application/json
527
617
 
528
618
 
529
- ## initialize_self_service_profile_management_flow
619
+ ## initialize_self_service_settings_flow
530
620
 
531
- > initialize_self_service_profile_management_flow
621
+ > initialize_self_service_settings_flow
532
622
 
533
- Initialize browser-based profile management flow
623
+ Initialize browser-based settings flow
534
624
 
535
- 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).
625
+ 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](https://www.ory.sh/docs/next/kratos/self-service/flows/user-settings-profile-management).
536
626
 
537
627
  ### Example
538
628
 
@@ -543,10 +633,10 @@ require 'ory-kratos-client'
543
633
  api_instance = OryHydraClient::PublicApi.new
544
634
 
545
635
  begin
546
- #Initialize browser-based profile management flow
547
- api_instance.initialize_self_service_profile_management_flow
636
+ #Initialize browser-based settings flow
637
+ api_instance.initialize_self_service_settings_flow
548
638
  rescue OryHydraClient::ApiError => e
549
- puts "Exception when calling PublicApi->initialize_self_service_profile_management_flow: #{e}"
639
+ puts "Exception when calling PublicApi->initialize_self_service_settings_flow: #{e}"
550
640
  end
551
641
  ```
552
642
 
@@ -4,7 +4,7 @@
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\">). |
7
+ **action** | **String** | Action should be used as the form action URL `<form action=\"{{ .Action }}\" method=\"post\">`. |
8
8
  **errors** | [**Array<Error>**](Error.md) | Errors contains all form errors. These will be duplicates of the individual field errors. | [optional]
9
9
  **fields** | [**Array<FormField>**](FormField.md) | Fields contains multiple fields |
10
10
  **method** | **String** | Method is the form method (e.g. POST) |
@@ -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
+
@@ -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
+