ory-kratos-client 0.3.0.alpha1 → 0.4.6.alpha1
Sign up to get free protection for your applications and to get access to all the features.
- checksums.yaml +4 -4
- data/Gemfile +1 -1
- data/README.md +14 -6
- data/docs/AdminApi.md +53 -5
- data/docs/CommonApi.md +53 -5
- data/docs/Form.md +2 -2
- data/docs/FormField.md +3 -3
- data/docs/GenericErrorPayload.md +1 -1
- data/docs/Identity.md +9 -7
- data/docs/LoginRequest.md +2 -0
- data/docs/LoginRequestMethodConfig.md +2 -2
- data/docs/Message.md +23 -0
- data/docs/PublicApi.md +153 -13
- data/docs/RecoveryAddress.md +21 -0
- data/docs/RecoveryRequest.md +31 -0
- data/docs/RecoveryRequestMethod.md +19 -0
- data/docs/RegistrationRequest.md +2 -0
- data/docs/RegistrationRequestMethodConfig.md +2 -2
- data/docs/RequestMethodConfig.md +2 -2
- data/docs/SettingsRequest.md +4 -2
- data/docs/VerificationRequest.md +2 -0
- data/lib/ory-kratos-client.rb +6 -3
- data/lib/ory-kratos-client/api/admin_api.rb +73 -10
- data/lib/ory-kratos-client/api/common_api.rb +73 -10
- data/lib/ory-kratos-client/api/health_api.rb +2 -2
- data/lib/ory-kratos-client/api/public_api.rb +198 -20
- data/lib/ory-kratos-client/api/version_api.rb +2 -2
- data/lib/ory-kratos-client/api_client.rb +9 -7
- data/lib/ory-kratos-client/api_error.rb +2 -2
- data/lib/ory-kratos-client/configuration.rb +2 -2
- data/lib/ory-kratos-client/models/complete_self_service_browser_settings_strategy_profile_flow_payload.rb +2 -2
- data/lib/ory-kratos-client/models/error_container.rb +2 -2
- data/lib/ory-kratos-client/models/form.rb +14 -15
- data/lib/ory-kratos-client/models/form_field.rb +11 -11
- data/lib/ory-kratos-client/models/generic_error.rb +2 -2
- data/lib/ory-kratos-client/models/generic_error_payload.rb +4 -6
- data/lib/ory-kratos-client/models/health_not_ready_status.rb +2 -2
- data/lib/ory-kratos-client/models/health_status.rb +2 -2
- data/lib/ory-kratos-client/models/identity.rb +48 -35
- data/lib/ory-kratos-client/models/login_request.rb +14 -3
- data/lib/ory-kratos-client/models/login_request_method.rb +2 -2
- data/lib/ory-kratos-client/models/login_request_method_config.rb +14 -15
- data/lib/ory-kratos-client/models/message.rb +233 -0
- data/lib/ory-kratos-client/models/provider_credentials_config.rb +2 -2
- data/lib/ory-kratos-client/models/recovery_address.rb +239 -0
- data/lib/ory-kratos-client/models/recovery_request.rb +309 -0
- data/lib/ory-kratos-client/models/recovery_request_method.rb +216 -0
- data/lib/ory-kratos-client/models/registration_request.rb +14 -3
- data/lib/ory-kratos-client/models/registration_request_method.rb +2 -2
- data/lib/ory-kratos-client/models/registration_request_method_config.rb +14 -15
- data/lib/ory-kratos-client/models/request_method_config.rb +14 -15
- data/lib/ory-kratos-client/models/session.rb +2 -2
- data/lib/ory-kratos-client/models/settings_request.rb +23 -13
- data/lib/ory-kratos-client/models/settings_request_method.rb +2 -2
- data/lib/ory-kratos-client/models/verifiable_address.rb +2 -2
- data/lib/ory-kratos-client/models/verification_request.rb +14 -3
- data/lib/ory-kratos-client/models/version.rb +2 -2
- data/lib/ory-kratos-client/version.rb +3 -3
- data/ory-kratos-client.gemspec +2 -2
- data/spec/models/message_spec.rb +59 -0
- data/spec/models/recovery_address_spec.rb +53 -0
- data/spec/models/recovery_request_method_spec.rb +47 -0
- data/spec/models/recovery_request_spec.rb +83 -0
- metadata +40 -24
checksums.yaml
CHANGED
@@ -1,7 +1,7 @@
|
|
1
1
|
---
|
2
2
|
SHA256:
|
3
|
-
metadata.gz:
|
4
|
-
data.tar.gz:
|
3
|
+
metadata.gz: a80384485d9c789723bfebb1208bd95ac304e49c2b48065f3df2d9f0a12fcd61
|
4
|
+
data.tar.gz: 9b46a2c9dfb7f397ac4ac0be992e09ea9b419234851a9bc6274168f06a293425
|
5
5
|
SHA512:
|
6
|
-
metadata.gz:
|
7
|
-
data.tar.gz:
|
6
|
+
metadata.gz: 98eb5eecfc598572526b52cf4cc3512eb65025f0bd7d146a2603b256501c96628a2a523dee93d793de4a7756eb4a8c19af6593540b5900423e16fc99093ae826
|
7
|
+
data.tar.gz: a7e3656b4af77df060ad9c7fc182eb0eba51d60a8664098ef53ef556dfd119b8579fa08578ea5e5524355c9db657a755c41c18c36e8ad55cad10f84c8a9ffeb0
|
data/Gemfile
CHANGED
data/README.md
CHANGED
@@ -6,8 +6,8 @@ Welcome to the ORY Kratos HTTP API documentation!
|
|
6
6
|
|
7
7
|
This SDK is automatically generated by the [OpenAPI Generator](https://openapi-generator.tech) project:
|
8
8
|
|
9
|
-
- API version:
|
10
|
-
- Package version: v0.
|
9
|
+
- API version: v0.4.6-alpha.1
|
10
|
+
- Package version: v0.4.6-alpha.1
|
11
11
|
- Build package: org.openapitools.codegen.languages.RubyClientCodegen
|
12
12
|
|
13
13
|
## Installation
|
@@ -23,16 +23,16 @@ gem build ory-kratos-client.gemspec
|
|
23
23
|
Then either install the gem locally:
|
24
24
|
|
25
25
|
```shell
|
26
|
-
gem install ./ory-kratos-client-v0.
|
26
|
+
gem install ./ory-kratos-client-v0.4.6-alpha.1.gem
|
27
27
|
```
|
28
28
|
|
29
|
-
(for development, run `gem install --dev ./ory-kratos-client-v0.
|
29
|
+
(for development, run `gem install --dev ./ory-kratos-client-v0.4.6-alpha.1.gem` to install the development dependencies)
|
30
30
|
|
31
31
|
or publish the gem to a gem hosting service, e.g. [RubyGems](https://rubygems.org/).
|
32
32
|
|
33
33
|
Finally add this to the Gemfile:
|
34
34
|
|
35
|
-
gem 'ory-kratos-client', '~> v0.
|
35
|
+
gem 'ory-kratos-client', '~> v0.4.6-alpha.1'
|
36
36
|
|
37
37
|
### Install from Git
|
38
38
|
|
@@ -80,6 +80,7 @@ Class | Method | HTTP request | Description
|
|
80
80
|
*OryHydraClient::AdminApi* | [**get_identity**](docs/AdminApi.md#get_identity) | **GET** /identities/{id} | Get an identity
|
81
81
|
*OryHydraClient::AdminApi* | [**get_schema**](docs/AdminApi.md#get_schema) | **GET** /schemas/{id} |
|
82
82
|
*OryHydraClient::AdminApi* | [**get_self_service_browser_login_request**](docs/AdminApi.md#get_self_service_browser_login_request) | **GET** /self-service/browser/flows/requests/login | Get the request context of browser-based login user flows
|
83
|
+
*OryHydraClient::AdminApi* | [**get_self_service_browser_recovery_request**](docs/AdminApi.md#get_self_service_browser_recovery_request) | **GET** /self-service/browser/flows/requests/recovery | Get the request context of browser-based recovery flows
|
83
84
|
*OryHydraClient::AdminApi* | [**get_self_service_browser_registration_request**](docs/AdminApi.md#get_self_service_browser_registration_request) | **GET** /self-service/browser/flows/requests/registration | Get the request context of browser-based registration user flows
|
84
85
|
*OryHydraClient::AdminApi* | [**get_self_service_browser_settings_request**](docs/AdminApi.md#get_self_service_browser_settings_request) | **GET** /self-service/browser/flows/requests/settings | Get the request context of browser-based settings flows
|
85
86
|
*OryHydraClient::AdminApi* | [**get_self_service_error**](docs/AdminApi.md#get_self_service_error) | **GET** /self-service/errors | Get user-facing self-service errors
|
@@ -88,18 +89,21 @@ Class | Method | HTTP request | Description
|
|
88
89
|
*OryHydraClient::AdminApi* | [**update_identity**](docs/AdminApi.md#update_identity) | **PUT** /identities/{id} | Update an identity
|
89
90
|
*OryHydraClient::CommonApi* | [**get_schema**](docs/CommonApi.md#get_schema) | **GET** /schemas/{id} |
|
90
91
|
*OryHydraClient::CommonApi* | [**get_self_service_browser_login_request**](docs/CommonApi.md#get_self_service_browser_login_request) | **GET** /self-service/browser/flows/requests/login | Get the request context of browser-based login user flows
|
92
|
+
*OryHydraClient::CommonApi* | [**get_self_service_browser_recovery_request**](docs/CommonApi.md#get_self_service_browser_recovery_request) | **GET** /self-service/browser/flows/requests/recovery | Get the request context of browser-based recovery flows
|
91
93
|
*OryHydraClient::CommonApi* | [**get_self_service_browser_registration_request**](docs/CommonApi.md#get_self_service_browser_registration_request) | **GET** /self-service/browser/flows/requests/registration | Get the request context of browser-based registration user flows
|
92
94
|
*OryHydraClient::CommonApi* | [**get_self_service_browser_settings_request**](docs/CommonApi.md#get_self_service_browser_settings_request) | **GET** /self-service/browser/flows/requests/settings | Get the request context of browser-based settings flows
|
93
95
|
*OryHydraClient::CommonApi* | [**get_self_service_error**](docs/CommonApi.md#get_self_service_error) | **GET** /self-service/errors | Get user-facing self-service errors
|
94
96
|
*OryHydraClient::CommonApi* | [**get_self_service_verification_request**](docs/CommonApi.md#get_self_service_verification_request) | **GET** /self-service/browser/flows/requests/verification | Get the request context of browser-based verification flows
|
95
97
|
*OryHydraClient::HealthApi* | [**is_instance_alive**](docs/HealthApi.md#is_instance_alive) | **GET** /health/alive | Check alive status
|
96
98
|
*OryHydraClient::HealthApi* | [**is_instance_ready**](docs/HealthApi.md#is_instance_ready) | **GET** /health/ready | Check readiness status
|
99
|
+
*OryHydraClient::PublicApi* | [**complete_self_service_browser_recovery_link_strategy_flow**](docs/PublicApi.md#complete_self_service_browser_recovery_link_strategy_flow) | **POST** /self-service/browser/flows/recovery/link | Complete the browser-based recovery flow using a recovery link
|
97
100
|
*OryHydraClient::PublicApi* | [**complete_self_service_browser_settings_oidc_settings_flow**](docs/PublicApi.md#complete_self_service_browser_settings_oidc_settings_flow) | **POST** /self-service/browser/flows/registration/strategies/oidc/settings/connections | Complete the browser-based settings flow for the OpenID Connect strategy
|
98
101
|
*OryHydraClient::PublicApi* | [**complete_self_service_browser_settings_password_strategy_flow**](docs/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
|
99
102
|
*OryHydraClient::PublicApi* | [**complete_self_service_browser_settings_profile_strategy_flow**](docs/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
|
100
103
|
*OryHydraClient::PublicApi* | [**complete_self_service_browser_verification_flow**](docs/PublicApi.md#complete_self_service_browser_verification_flow) | **POST** /self-service/browser/flows/verification/{via}/complete | Complete the browser-based verification flows
|
101
104
|
*OryHydraClient::PublicApi* | [**get_schema**](docs/PublicApi.md#get_schema) | **GET** /schemas/{id} |
|
102
105
|
*OryHydraClient::PublicApi* | [**get_self_service_browser_login_request**](docs/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
|
106
|
+
*OryHydraClient::PublicApi* | [**get_self_service_browser_recovery_request**](docs/PublicApi.md#get_self_service_browser_recovery_request) | **GET** /self-service/browser/flows/requests/recovery | Get the request context of browser-based recovery flows
|
103
107
|
*OryHydraClient::PublicApi* | [**get_self_service_browser_registration_request**](docs/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
|
104
108
|
*OryHydraClient::PublicApi* | [**get_self_service_browser_settings_request**](docs/PublicApi.md#get_self_service_browser_settings_request) | **GET** /self-service/browser/flows/requests/settings | Get the request context of browser-based settings flows
|
105
109
|
*OryHydraClient::PublicApi* | [**get_self_service_error**](docs/PublicApi.md#get_self_service_error) | **GET** /self-service/errors | Get user-facing self-service errors
|
@@ -108,6 +112,7 @@ Class | Method | HTTP request | Description
|
|
108
112
|
*OryHydraClient::PublicApi* | [**initialize_self_service_browser_logout_flow**](docs/PublicApi.md#initialize_self_service_browser_logout_flow) | **GET** /self-service/browser/flows/logout | Initialize Browser-Based Logout User Flow
|
109
113
|
*OryHydraClient::PublicApi* | [**initialize_self_service_browser_registration_flow**](docs/PublicApi.md#initialize_self_service_browser_registration_flow) | **GET** /self-service/browser/flows/registration | Initialize browser-based registration user flow
|
110
114
|
*OryHydraClient::PublicApi* | [**initialize_self_service_browser_verification_flow**](docs/PublicApi.md#initialize_self_service_browser_verification_flow) | **GET** /self-service/browser/flows/verification/init/{via} | Initialize browser-based verification flow
|
115
|
+
*OryHydraClient::PublicApi* | [**initialize_self_service_recovery_flow**](docs/PublicApi.md#initialize_self_service_recovery_flow) | **GET** /self-service/browser/flows/recovery | Initialize browser-based account recovery flow
|
111
116
|
*OryHydraClient::PublicApi* | [**initialize_self_service_settings_flow**](docs/PublicApi.md#initialize_self_service_settings_flow) | **GET** /self-service/browser/flows/settings | Initialize browser-based settings flow
|
112
117
|
*OryHydraClient::PublicApi* | [**self_service_browser_verify**](docs/PublicApi.md#self_service_browser_verify) | **GET** /self-service/browser/flows/verification/{via}/confirm/{code} | Complete the browser-based verification flows
|
113
118
|
*OryHydraClient::PublicApi* | [**whoami**](docs/PublicApi.md#whoami) | **GET** /sessions/whoami | Check who the current HTTP session belongs to
|
@@ -117,7 +122,6 @@ Class | Method | HTTP request | Description
|
|
117
122
|
## Documentation for Models
|
118
123
|
|
119
124
|
- [OryHydraClient::CompleteSelfServiceBrowserSettingsStrategyProfileFlowPayload](docs/CompleteSelfServiceBrowserSettingsStrategyProfileFlowPayload.md)
|
120
|
-
- [OryHydraClient::Error](docs/Error.md)
|
121
125
|
- [OryHydraClient::ErrorContainer](docs/ErrorContainer.md)
|
122
126
|
- [OryHydraClient::Form](docs/Form.md)
|
123
127
|
- [OryHydraClient::FormField](docs/FormField.md)
|
@@ -129,7 +133,11 @@ Class | Method | HTTP request | Description
|
|
129
133
|
- [OryHydraClient::LoginRequest](docs/LoginRequest.md)
|
130
134
|
- [OryHydraClient::LoginRequestMethod](docs/LoginRequestMethod.md)
|
131
135
|
- [OryHydraClient::LoginRequestMethodConfig](docs/LoginRequestMethodConfig.md)
|
136
|
+
- [OryHydraClient::Message](docs/Message.md)
|
132
137
|
- [OryHydraClient::ProviderCredentialsConfig](docs/ProviderCredentialsConfig.md)
|
138
|
+
- [OryHydraClient::RecoveryAddress](docs/RecoveryAddress.md)
|
139
|
+
- [OryHydraClient::RecoveryRequest](docs/RecoveryRequest.md)
|
140
|
+
- [OryHydraClient::RecoveryRequestMethod](docs/RecoveryRequestMethod.md)
|
133
141
|
- [OryHydraClient::RegistrationRequest](docs/RegistrationRequest.md)
|
134
142
|
- [OryHydraClient::RegistrationRequestMethod](docs/RegistrationRequestMethod.md)
|
135
143
|
- [OryHydraClient::RegistrationRequestMethodConfig](docs/RegistrationRequestMethodConfig.md)
|
data/docs/AdminApi.md
CHANGED
@@ -9,6 +9,7 @@ Method | HTTP request | Description
|
|
9
9
|
[**get_identity**](AdminApi.md#get_identity) | **GET** /identities/{id} | Get an identity
|
10
10
|
[**get_schema**](AdminApi.md#get_schema) | **GET** /schemas/{id} |
|
11
11
|
[**get_self_service_browser_login_request**](AdminApi.md#get_self_service_browser_login_request) | **GET** /self-service/browser/flows/requests/login | Get the request context of browser-based login user flows
|
12
|
+
[**get_self_service_browser_recovery_request**](AdminApi.md#get_self_service_browser_recovery_request) | **GET** /self-service/browser/flows/requests/recovery | Get the request context of browser-based recovery flows
|
12
13
|
[**get_self_service_browser_registration_request**](AdminApi.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
14
|
[**get_self_service_browser_settings_request**](AdminApi.md#get_self_service_browser_settings_request) | **GET** /self-service/browser/flows/requests/settings | Get the request context of browser-based settings flows
|
14
15
|
[**get_self_service_error**](AdminApi.md#get_self_service_error) | **GET** /self-service/errors | Get user-facing self-service errors
|
@@ -210,7 +211,7 @@ No authorization required
|
|
210
211
|
|
211
212
|
Get the request context of browser-based login user flows
|
212
213
|
|
213
|
-
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
|
214
|
+
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. 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).
|
214
215
|
|
215
216
|
### Example
|
216
217
|
|
@@ -251,13 +252,60 @@ No authorization required
|
|
251
252
|
- **Accept**: application/json
|
252
253
|
|
253
254
|
|
255
|
+
## get_self_service_browser_recovery_request
|
256
|
+
|
257
|
+
> RecoveryRequest get_self_service_browser_recovery_request(request)
|
258
|
+
|
259
|
+
Get the request context of browser-based recovery flows
|
260
|
+
|
261
|
+
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 Account Recovery Documentation](../self-service/flows/password-reset-account-recovery).
|
262
|
+
|
263
|
+
### Example
|
264
|
+
|
265
|
+
```ruby
|
266
|
+
# load the gem
|
267
|
+
require 'ory-kratos-client'
|
268
|
+
|
269
|
+
api_instance = OryHydraClient::AdminApi.new
|
270
|
+
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. `/recover?request=abcde`).
|
271
|
+
|
272
|
+
begin
|
273
|
+
#Get the request context of browser-based recovery flows
|
274
|
+
result = api_instance.get_self_service_browser_recovery_request(request)
|
275
|
+
p result
|
276
|
+
rescue OryHydraClient::ApiError => e
|
277
|
+
puts "Exception when calling AdminApi->get_self_service_browser_recovery_request: #{e}"
|
278
|
+
end
|
279
|
+
```
|
280
|
+
|
281
|
+
### Parameters
|
282
|
+
|
283
|
+
|
284
|
+
Name | Type | Description | Notes
|
285
|
+
------------- | ------------- | ------------- | -------------
|
286
|
+
**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. `/recover?request=abcde`). |
|
287
|
+
|
288
|
+
### Return type
|
289
|
+
|
290
|
+
[**RecoveryRequest**](RecoveryRequest.md)
|
291
|
+
|
292
|
+
### Authorization
|
293
|
+
|
294
|
+
No authorization required
|
295
|
+
|
296
|
+
### HTTP request headers
|
297
|
+
|
298
|
+
- **Content-Type**: Not defined
|
299
|
+
- **Accept**: application/json
|
300
|
+
|
301
|
+
|
254
302
|
## get_self_service_browser_registration_request
|
255
303
|
|
256
304
|
> RegistrationRequest get_self_service_browser_registration_request(request)
|
257
305
|
|
258
306
|
Get the request context of browser-based registration user flows
|
259
307
|
|
260
|
-
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
|
308
|
+
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. 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).
|
261
309
|
|
262
310
|
### Example
|
263
311
|
|
@@ -313,7 +361,7 @@ When accessing this endpoint through ORY Kratos' Public API, ensure that cookies
|
|
313
361
|
require 'ory-kratos-client'
|
314
362
|
|
315
363
|
api_instance = OryHydraClient::AdminApi.new
|
316
|
-
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. `/
|
364
|
+
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. `/settingss?request=abcde`).
|
317
365
|
|
318
366
|
begin
|
319
367
|
#Get the request context of browser-based settings flows
|
@@ -329,7 +377,7 @@ end
|
|
329
377
|
|
330
378
|
Name | Type | Description | Notes
|
331
379
|
------------- | ------------- | ------------- | -------------
|
332
|
-
**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. `/
|
380
|
+
**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. `/settingss?request=abcde`). |
|
333
381
|
|
334
382
|
### Return type
|
335
383
|
|
@@ -351,7 +399,7 @@ No authorization required
|
|
351
399
|
|
352
400
|
Get user-facing self-service errors
|
353
401
|
|
354
|
-
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
|
402
|
+
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. 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).
|
355
403
|
|
356
404
|
### Example
|
357
405
|
|
data/docs/CommonApi.md
CHANGED
@@ -6,6 +6,7 @@ Method | HTTP request | Description
|
|
6
6
|
------------- | ------------- | -------------
|
7
7
|
[**get_schema**](CommonApi.md#get_schema) | **GET** /schemas/{id} |
|
8
8
|
[**get_self_service_browser_login_request**](CommonApi.md#get_self_service_browser_login_request) | **GET** /self-service/browser/flows/requests/login | Get the request context of browser-based login user flows
|
9
|
+
[**get_self_service_browser_recovery_request**](CommonApi.md#get_self_service_browser_recovery_request) | **GET** /self-service/browser/flows/requests/recovery | Get the request context of browser-based recovery flows
|
9
10
|
[**get_self_service_browser_registration_request**](CommonApi.md#get_self_service_browser_registration_request) | **GET** /self-service/browser/flows/requests/registration | Get the request context of browser-based registration user flows
|
10
11
|
[**get_self_service_browser_settings_request**](CommonApi.md#get_self_service_browser_settings_request) | **GET** /self-service/browser/flows/requests/settings | Get the request context of browser-based settings flows
|
11
12
|
[**get_self_service_error**](CommonApi.md#get_self_service_error) | **GET** /self-service/errors | Get user-facing self-service errors
|
@@ -65,7 +66,7 @@ No authorization required
|
|
65
66
|
|
66
67
|
Get the request context of browser-based login user flows
|
67
68
|
|
68
|
-
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
|
69
|
+
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. 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).
|
69
70
|
|
70
71
|
### Example
|
71
72
|
|
@@ -106,13 +107,60 @@ No authorization required
|
|
106
107
|
- **Accept**: application/json
|
107
108
|
|
108
109
|
|
110
|
+
## get_self_service_browser_recovery_request
|
111
|
+
|
112
|
+
> RecoveryRequest get_self_service_browser_recovery_request(request)
|
113
|
+
|
114
|
+
Get the request context of browser-based recovery flows
|
115
|
+
|
116
|
+
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 Account Recovery Documentation](../self-service/flows/password-reset-account-recovery).
|
117
|
+
|
118
|
+
### Example
|
119
|
+
|
120
|
+
```ruby
|
121
|
+
# load the gem
|
122
|
+
require 'ory-kratos-client'
|
123
|
+
|
124
|
+
api_instance = OryHydraClient::CommonApi.new
|
125
|
+
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. `/recover?request=abcde`).
|
126
|
+
|
127
|
+
begin
|
128
|
+
#Get the request context of browser-based recovery flows
|
129
|
+
result = api_instance.get_self_service_browser_recovery_request(request)
|
130
|
+
p result
|
131
|
+
rescue OryHydraClient::ApiError => e
|
132
|
+
puts "Exception when calling CommonApi->get_self_service_browser_recovery_request: #{e}"
|
133
|
+
end
|
134
|
+
```
|
135
|
+
|
136
|
+
### Parameters
|
137
|
+
|
138
|
+
|
139
|
+
Name | Type | Description | Notes
|
140
|
+
------------- | ------------- | ------------- | -------------
|
141
|
+
**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. `/recover?request=abcde`). |
|
142
|
+
|
143
|
+
### Return type
|
144
|
+
|
145
|
+
[**RecoveryRequest**](RecoveryRequest.md)
|
146
|
+
|
147
|
+
### Authorization
|
148
|
+
|
149
|
+
No authorization required
|
150
|
+
|
151
|
+
### HTTP request headers
|
152
|
+
|
153
|
+
- **Content-Type**: Not defined
|
154
|
+
- **Accept**: application/json
|
155
|
+
|
156
|
+
|
109
157
|
## get_self_service_browser_registration_request
|
110
158
|
|
111
159
|
> RegistrationRequest get_self_service_browser_registration_request(request)
|
112
160
|
|
113
161
|
Get the request context of browser-based registration user flows
|
114
162
|
|
115
|
-
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
|
163
|
+
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. 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).
|
116
164
|
|
117
165
|
### Example
|
118
166
|
|
@@ -168,7 +216,7 @@ When accessing this endpoint through ORY Kratos' Public API, ensure that cookies
|
|
168
216
|
require 'ory-kratos-client'
|
169
217
|
|
170
218
|
api_instance = OryHydraClient::CommonApi.new
|
171
|
-
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. `/
|
219
|
+
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. `/settingss?request=abcde`).
|
172
220
|
|
173
221
|
begin
|
174
222
|
#Get the request context of browser-based settings flows
|
@@ -184,7 +232,7 @@ end
|
|
184
232
|
|
185
233
|
Name | Type | Description | Notes
|
186
234
|
------------- | ------------- | ------------- | -------------
|
187
|
-
**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. `/
|
235
|
+
**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. `/settingss?request=abcde`). |
|
188
236
|
|
189
237
|
### Return type
|
190
238
|
|
@@ -206,7 +254,7 @@ No authorization required
|
|
206
254
|
|
207
255
|
Get user-facing self-service errors
|
208
256
|
|
209
|
-
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
|
257
|
+
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. 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).
|
210
258
|
|
211
259
|
### Example
|
212
260
|
|
data/docs/Form.md
CHANGED
@@ -5,8 +5,8 @@
|
|
5
5
|
Name | Type | Description | Notes
|
6
6
|
------------ | ------------- | ------------- | -------------
|
7
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
8
|
**fields** | [**Array<FormField>**](FormField.md) | Fields contains multiple fields |
|
9
|
+
**messages** | [**Array<Message>**](Message.md) | | [optional]
|
10
10
|
**method** | **String** | Method is the form method (e.g. POST) |
|
11
11
|
|
12
12
|
## Code Sample
|
@@ -15,8 +15,8 @@ Name | Type | Description | Notes
|
|
15
15
|
require 'OryHydraClient'
|
16
16
|
|
17
17
|
instance = OryHydraClient::Form.new(action: null,
|
18
|
-
errors: null,
|
19
18
|
fields: null,
|
19
|
+
messages: null,
|
20
20
|
method: null)
|
21
21
|
```
|
22
22
|
|
data/docs/FormField.md
CHANGED
@@ -4,8 +4,8 @@
|
|
4
4
|
|
5
5
|
Name | Type | Description | Notes
|
6
6
|
------------ | ------------- | ------------- | -------------
|
7
|
-
**disabled** | **Boolean** | Disabled is the equivalent of `<input
|
8
|
-
**
|
7
|
+
**disabled** | **Boolean** | Disabled is the equivalent of `<input {{if .Disabled}}disabled{{end}}\">` | [optional]
|
8
|
+
**messages** | [**Array<Message>**](Message.md) | | [optional]
|
9
9
|
**name** | **String** | Name is the equivalent of `<input name=\"{{.Name}}\">` |
|
10
10
|
**pattern** | **String** | Pattern is the equivalent of `<input pattern=\"{{.Pattern}}\">` | [optional]
|
11
11
|
**required** | **Boolean** | Required is the equivalent of `<input required=\"{{.Required}}\">` | [optional]
|
@@ -18,7 +18,7 @@ Name | Type | Description | Notes
|
|
18
18
|
require 'OryHydraClient'
|
19
19
|
|
20
20
|
instance = OryHydraClient::FormField.new(disabled: null,
|
21
|
-
|
21
|
+
messages: null,
|
22
22
|
name: null,
|
23
23
|
pattern: null,
|
24
24
|
required: null,
|
data/docs/GenericErrorPayload.md
CHANGED
@@ -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** | **
|
9
|
+
**details** | [**Object**](.md) | | [optional]
|
10
10
|
**message** | **String** | | [optional]
|
11
11
|
**reason** | **String** | | [optional]
|
12
12
|
**request** | **String** | | [optional]
|
data/docs/Identity.md
CHANGED
@@ -4,22 +4,24 @@
|
|
4
4
|
|
5
5
|
Name | Type | Description | Notes
|
6
6
|
------------ | ------------- | ------------- | -------------
|
7
|
-
**addresses** | [**Array<VerifiableAddress>**](VerifiableAddress.md) | | [optional]
|
8
7
|
**id** | **String** | |
|
8
|
+
**recovery_addresses** | [**Array<RecoveryAddress>**](RecoveryAddress.md) | RecoveryAddresses contains all the addresses that can be used to recover an identity. | [optional]
|
9
|
+
**schema_id** | **String** | SchemaID is the ID of the JSON Schema to be used for validating the identity's traits. |
|
10
|
+
**schema_url** | **String** | SchemaURL is the URL of the endpoint where the identity's traits schema can be fetched from. format: url | [optional]
|
9
11
|
**traits** | [**Object**](.md) | |
|
10
|
-
**
|
11
|
-
**traits_schema_url** | **String** | TraitsSchemaURL is the URL of the endpoint where the identity's traits schema can be fetched from. format: url | [optional]
|
12
|
+
**verifiable_addresses** | [**Array<VerifiableAddress>**](VerifiableAddress.md) | VerifiableAddresses contains all the addresses that can be verified by the user. | [optional]
|
12
13
|
|
13
14
|
## Code Sample
|
14
15
|
|
15
16
|
```ruby
|
16
17
|
require 'OryHydraClient'
|
17
18
|
|
18
|
-
instance = OryHydraClient::Identity.new(
|
19
|
-
|
19
|
+
instance = OryHydraClient::Identity.new(id: null,
|
20
|
+
recovery_addresses: null,
|
21
|
+
schema_id: null,
|
22
|
+
schema_url: null,
|
20
23
|
traits: null,
|
21
|
-
|
22
|
-
traits_schema_url: null)
|
24
|
+
verifiable_addresses: null)
|
23
25
|
```
|
24
26
|
|
25
27
|
|
data/docs/LoginRequest.md
CHANGED
@@ -9,6 +9,7 @@ Name | Type | Description | Notes
|
|
9
9
|
**forced** | **Boolean** | Forced stores whether this login request should enforce reauthentication. | [optional]
|
10
10
|
**id** | **String** | |
|
11
11
|
**issued_at** | **DateTime** | IssuedAt is the time (UTC) when the request occurred. |
|
12
|
+
**messages** | [**Array<Message>**](Message.md) | | [optional]
|
12
13
|
**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. |
|
13
14
|
**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
15
|
|
@@ -22,6 +23,7 @@ instance = OryHydraClient::LoginRequest.new(active: null,
|
|
22
23
|
forced: null,
|
23
24
|
id: null,
|
24
25
|
issued_at: null,
|
26
|
+
messages: null,
|
25
27
|
methods: null,
|
26
28
|
request_url: null)
|
27
29
|
```
|
@@ -5,8 +5,8 @@
|
|
5
5
|
Name | Type | Description | Notes
|
6
6
|
------------ | ------------- | ------------- | -------------
|
7
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
8
|
**fields** | [**Array<FormField>**](FormField.md) | Fields contains multiple fields |
|
9
|
+
**messages** | [**Array<Message>**](Message.md) | | [optional]
|
10
10
|
**method** | **String** | Method is the form method (e.g. POST) |
|
11
11
|
**providers** | [**Array<FormField>**](FormField.md) | Providers is set for the \"oidc\" request method. | [optional]
|
12
12
|
|
@@ -16,8 +16,8 @@ Name | Type | Description | Notes
|
|
16
16
|
require 'OryHydraClient'
|
17
17
|
|
18
18
|
instance = OryHydraClient::LoginRequestMethodConfig.new(action: null,
|
19
|
-
errors: null,
|
20
19
|
fields: null,
|
20
|
+
messages: null,
|
21
21
|
method: null,
|
22
22
|
providers: null)
|
23
23
|
```
|
data/docs/Message.md
ADDED
@@ -0,0 +1,23 @@
|
|
1
|
+
# OryHydraClient::Message
|
2
|
+
|
3
|
+
## Properties
|
4
|
+
|
5
|
+
Name | Type | Description | Notes
|
6
|
+
------------ | ------------- | ------------- | -------------
|
7
|
+
**context** | [**Object**](.md) | | [optional]
|
8
|
+
**id** | **Integer** | | [optional]
|
9
|
+
**text** | **String** | | [optional]
|
10
|
+
**type** | **String** | | [optional]
|
11
|
+
|
12
|
+
## Code Sample
|
13
|
+
|
14
|
+
```ruby
|
15
|
+
require 'OryHydraClient'
|
16
|
+
|
17
|
+
instance = OryHydraClient::Message.new(context: null,
|
18
|
+
id: null,
|
19
|
+
text: null,
|
20
|
+
type: null)
|
21
|
+
```
|
22
|
+
|
23
|
+
|