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
data/docs/PublicApi.md
CHANGED
@@ -4,12 +4,14 @@ All URIs are relative to *http://localhost*
|
|
4
4
|
|
5
5
|
Method | HTTP request | Description
|
6
6
|
------------- | ------------- | -------------
|
7
|
+
[**complete_self_service_browser_recovery_link_strategy_flow**](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
|
7
8
|
[**complete_self_service_browser_settings_oidc_settings_flow**](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
|
8
9
|
[**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
|
9
10
|
[**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
|
10
11
|
[**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
|
11
12
|
[**get_schema**](PublicApi.md#get_schema) | **GET** /schemas/{id} |
|
12
13
|
[**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
|
14
|
+
[**get_self_service_browser_recovery_request**](PublicApi.md#get_self_service_browser_recovery_request) | **GET** /self-service/browser/flows/requests/recovery | Get the request context of browser-based recovery flows
|
13
15
|
[**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
|
14
16
|
[**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
|
15
17
|
[**get_self_service_error**](PublicApi.md#get_self_service_error) | **GET** /self-service/errors | Get user-facing self-service errors
|
@@ -18,12 +20,55 @@ Method | HTTP request | Description
|
|
18
20
|
[**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
|
19
21
|
[**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
|
20
22
|
[**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
|
23
|
+
[**initialize_self_service_recovery_flow**](PublicApi.md#initialize_self_service_recovery_flow) | **GET** /self-service/browser/flows/recovery | Initialize browser-based account recovery flow
|
21
24
|
[**initialize_self_service_settings_flow**](PublicApi.md#initialize_self_service_settings_flow) | **GET** /self-service/browser/flows/settings | Initialize browser-based settings flow
|
22
25
|
[**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
|
23
26
|
[**whoami**](PublicApi.md#whoami) | **GET** /sessions/whoami | Check who the current HTTP session belongs to
|
24
27
|
|
25
28
|
|
26
29
|
|
30
|
+
## complete_self_service_browser_recovery_link_strategy_flow
|
31
|
+
|
32
|
+
> complete_self_service_browser_recovery_link_strategy_flow
|
33
|
+
|
34
|
+
Complete the browser-based recovery flow using a recovery link
|
35
|
+
|
36
|
+
> 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 Account Recovery Documentation](../self-service/flows/password-reset-account-recovery).
|
37
|
+
|
38
|
+
### Example
|
39
|
+
|
40
|
+
```ruby
|
41
|
+
# load the gem
|
42
|
+
require 'ory-kratos-client'
|
43
|
+
|
44
|
+
api_instance = OryHydraClient::PublicApi.new
|
45
|
+
|
46
|
+
begin
|
47
|
+
#Complete the browser-based recovery flow using a recovery link
|
48
|
+
api_instance.complete_self_service_browser_recovery_link_strategy_flow
|
49
|
+
rescue OryHydraClient::ApiError => e
|
50
|
+
puts "Exception when calling PublicApi->complete_self_service_browser_recovery_link_strategy_flow: #{e}"
|
51
|
+
end
|
52
|
+
```
|
53
|
+
|
54
|
+
### Parameters
|
55
|
+
|
56
|
+
This endpoint does not need any parameter.
|
57
|
+
|
58
|
+
### Return type
|
59
|
+
|
60
|
+
nil (empty response body)
|
61
|
+
|
62
|
+
### Authorization
|
63
|
+
|
64
|
+
No authorization required
|
65
|
+
|
66
|
+
### HTTP request headers
|
67
|
+
|
68
|
+
- **Content-Type**: Not defined
|
69
|
+
- **Accept**: application/json
|
70
|
+
|
71
|
+
|
27
72
|
## complete_self_service_browser_settings_oidc_settings_flow
|
28
73
|
|
29
74
|
> complete_self_service_browser_settings_oidc_settings_flow
|
@@ -256,7 +301,7 @@ No authorization required
|
|
256
301
|
|
257
302
|
Get the request context of browser-based login user flows
|
258
303
|
|
259
|
-
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
|
304
|
+
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).
|
260
305
|
|
261
306
|
### Example
|
262
307
|
|
@@ -297,13 +342,60 @@ No authorization required
|
|
297
342
|
- **Accept**: application/json
|
298
343
|
|
299
344
|
|
345
|
+
## get_self_service_browser_recovery_request
|
346
|
+
|
347
|
+
> RecoveryRequest get_self_service_browser_recovery_request(request)
|
348
|
+
|
349
|
+
Get the request context of browser-based recovery flows
|
350
|
+
|
351
|
+
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).
|
352
|
+
|
353
|
+
### Example
|
354
|
+
|
355
|
+
```ruby
|
356
|
+
# load the gem
|
357
|
+
require 'ory-kratos-client'
|
358
|
+
|
359
|
+
api_instance = OryHydraClient::PublicApi.new
|
360
|
+
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`).
|
361
|
+
|
362
|
+
begin
|
363
|
+
#Get the request context of browser-based recovery flows
|
364
|
+
result = api_instance.get_self_service_browser_recovery_request(request)
|
365
|
+
p result
|
366
|
+
rescue OryHydraClient::ApiError => e
|
367
|
+
puts "Exception when calling PublicApi->get_self_service_browser_recovery_request: #{e}"
|
368
|
+
end
|
369
|
+
```
|
370
|
+
|
371
|
+
### Parameters
|
372
|
+
|
373
|
+
|
374
|
+
Name | Type | Description | Notes
|
375
|
+
------------- | ------------- | ------------- | -------------
|
376
|
+
**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`). |
|
377
|
+
|
378
|
+
### Return type
|
379
|
+
|
380
|
+
[**RecoveryRequest**](RecoveryRequest.md)
|
381
|
+
|
382
|
+
### Authorization
|
383
|
+
|
384
|
+
No authorization required
|
385
|
+
|
386
|
+
### HTTP request headers
|
387
|
+
|
388
|
+
- **Content-Type**: Not defined
|
389
|
+
- **Accept**: application/json
|
390
|
+
|
391
|
+
|
300
392
|
## get_self_service_browser_registration_request
|
301
393
|
|
302
394
|
> RegistrationRequest get_self_service_browser_registration_request(request)
|
303
395
|
|
304
396
|
Get the request context of browser-based registration user flows
|
305
397
|
|
306
|
-
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
|
398
|
+
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).
|
307
399
|
|
308
400
|
### Example
|
309
401
|
|
@@ -359,7 +451,7 @@ When accessing this endpoint through ORY Kratos' Public API, ensure that cookies
|
|
359
451
|
require 'ory-kratos-client'
|
360
452
|
|
361
453
|
api_instance = OryHydraClient::PublicApi.new
|
362
|
-
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. `/
|
454
|
+
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`).
|
363
455
|
|
364
456
|
begin
|
365
457
|
#Get the request context of browser-based settings flows
|
@@ -375,7 +467,7 @@ end
|
|
375
467
|
|
376
468
|
Name | Type | Description | Notes
|
377
469
|
------------- | ------------- | ------------- | -------------
|
378
|
-
**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. `/
|
470
|
+
**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`). |
|
379
471
|
|
380
472
|
### Return type
|
381
473
|
|
@@ -397,7 +489,7 @@ No authorization required
|
|
397
489
|
|
398
490
|
Get user-facing self-service errors
|
399
491
|
|
400
|
-
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
|
492
|
+
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).
|
401
493
|
|
402
494
|
### Example
|
403
495
|
|
@@ -489,11 +581,11 @@ No authorization required
|
|
489
581
|
|
490
582
|
## initialize_self_service_browser_login_flow
|
491
583
|
|
492
|
-
> initialize_self_service_browser_login_flow
|
584
|
+
> initialize_self_service_browser_login_flow(opts)
|
493
585
|
|
494
586
|
Initialize browser-based login user flow
|
495
587
|
|
496
|
-
This endpoint initializes a browser-based user login flow. Once initialized, the browser will be redirected to `
|
588
|
+
This endpoint initializes a browser-based user login flow. Once initialized, the browser will be redirected to `selfservice.flows.login.ui_url` with the request ID set as a query parameter. If a valid user session exists already, the browser will be redirected to `urls.default_redirect_url`. > This endpoint is NOT INTENDED for API clients and only works with browsers (Chrome, Firefox, ...). More information can be found at [ORY Kratos User Login and User Registration Documentation](https://www.ory.sh/docs/next/kratos/self-service/flows/user-login-user-registration).
|
497
589
|
|
498
590
|
### Example
|
499
591
|
|
@@ -502,10 +594,13 @@ This endpoint initializes a browser-based user login flow. Once initialized, the
|
|
502
594
|
require 'ory-kratos-client'
|
503
595
|
|
504
596
|
api_instance = OryHydraClient::PublicApi.new
|
597
|
+
opts = {
|
598
|
+
refresh: true # Boolean | Refresh a login session If set to true, this will refresh an existing login session by asking the user to sign in again. This will reset the authenticated_at time of the session.
|
599
|
+
}
|
505
600
|
|
506
601
|
begin
|
507
602
|
#Initialize browser-based login user flow
|
508
|
-
api_instance.initialize_self_service_browser_login_flow
|
603
|
+
api_instance.initialize_self_service_browser_login_flow(opts)
|
509
604
|
rescue OryHydraClient::ApiError => e
|
510
605
|
puts "Exception when calling PublicApi->initialize_self_service_browser_login_flow: #{e}"
|
511
606
|
end
|
@@ -513,7 +608,10 @@ end
|
|
513
608
|
|
514
609
|
### Parameters
|
515
610
|
|
516
|
-
|
611
|
+
|
612
|
+
Name | Type | Description | Notes
|
613
|
+
------------- | ------------- | ------------- | -------------
|
614
|
+
**refresh** | **Boolean**| Refresh a login session If set to true, this will refresh an existing login session by asking the user to sign in again. This will reset the authenticated_at time of the session. | [optional]
|
517
615
|
|
518
616
|
### Return type
|
519
617
|
|
@@ -577,7 +675,7 @@ No authorization required
|
|
577
675
|
|
578
676
|
Initialize browser-based registration user flow
|
579
677
|
|
580
|
-
This endpoint initializes a browser-based user registration flow. Once initialized, the browser will be redirected to `
|
678
|
+
This endpoint initializes a browser-based user registration flow. Once initialized, the browser will be redirected to `selfservice.flows.registration.ui_url` with the request ID set as a query parameter. If a valid user session exists already, the browser will be redirected to `urls.default_redirect_url`. > This endpoint is NOT INTENDED for API clients and only works with browsers (Chrome, Firefox, ...). More information can be found at [ORY Kratos User Login and User Registration Documentation](https://www.ory.sh/docs/next/kratos/self-service/flows/user-login-user-registration).
|
581
679
|
|
582
680
|
### Example
|
583
681
|
|
@@ -619,7 +717,7 @@ No authorization required
|
|
619
717
|
|
620
718
|
Initialize browser-based verification flow
|
621
719
|
|
622
|
-
This endpoint initializes a browser-based verification flow. Once initialized, the browser will be redirected to `
|
720
|
+
This endpoint initializes a browser-based verification flow. Once initialized, the browser will be redirected to `selfservice.flows.settings.ui_url` 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).
|
623
721
|
|
624
722
|
### Example
|
625
723
|
|
@@ -659,13 +757,55 @@ No authorization required
|
|
659
757
|
- **Accept**: application/json
|
660
758
|
|
661
759
|
|
760
|
+
## initialize_self_service_recovery_flow
|
761
|
+
|
762
|
+
> initialize_self_service_recovery_flow
|
763
|
+
|
764
|
+
Initialize browser-based account recovery flow
|
765
|
+
|
766
|
+
This endpoint initializes a browser-based account recovery flow. Once initialized, the browser will be redirected to `selfservice.flows.recovery.ui_url` with the request ID set as a query parameter. If a valid user session exists, the request is aborted. > This endpoint is NOT INTENDED for API clients and only works with browsers (Chrome, Firefox, ...). More information can be found at [ORY Kratos Account Recovery Documentation](../self-service/flows/password-reset-account-recovery).
|
767
|
+
|
768
|
+
### Example
|
769
|
+
|
770
|
+
```ruby
|
771
|
+
# load the gem
|
772
|
+
require 'ory-kratos-client'
|
773
|
+
|
774
|
+
api_instance = OryHydraClient::PublicApi.new
|
775
|
+
|
776
|
+
begin
|
777
|
+
#Initialize browser-based account recovery flow
|
778
|
+
api_instance.initialize_self_service_recovery_flow
|
779
|
+
rescue OryHydraClient::ApiError => e
|
780
|
+
puts "Exception when calling PublicApi->initialize_self_service_recovery_flow: #{e}"
|
781
|
+
end
|
782
|
+
```
|
783
|
+
|
784
|
+
### Parameters
|
785
|
+
|
786
|
+
This endpoint does not need any parameter.
|
787
|
+
|
788
|
+
### Return type
|
789
|
+
|
790
|
+
nil (empty response body)
|
791
|
+
|
792
|
+
### Authorization
|
793
|
+
|
794
|
+
No authorization required
|
795
|
+
|
796
|
+
### HTTP request headers
|
797
|
+
|
798
|
+
- **Content-Type**: Not defined
|
799
|
+
- **Accept**: application/json
|
800
|
+
|
801
|
+
|
662
802
|
## initialize_self_service_settings_flow
|
663
803
|
|
664
804
|
> initialize_self_service_settings_flow
|
665
805
|
|
666
806
|
Initialize browser-based settings flow
|
667
807
|
|
668
|
-
This endpoint initializes a browser-based settings flow. Once initialized, the browser will be redirected to `
|
808
|
+
This endpoint initializes a browser-based settings flow. Once initialized, the browser will be redirected to `selfservice.flows.settings.ui_url` with the request ID set as a query parameter. If no valid user session exists, a login flow will be initialized. > This endpoint is NOT INTENDED for API clients and only works with browsers (Chrome, Firefox, ...). More information can be found at [ORY Kratos User Settings & Profile Management Documentation](../self-service/flows/user-settings).
|
669
809
|
|
670
810
|
### Example
|
671
811
|
|
@@ -755,7 +895,7 @@ No authorization required
|
|
755
895
|
|
756
896
|
Check who the current HTTP session belongs to
|
757
897
|
|
758
|
-
Uses the HTTP Headers in the GET request to determine (e.g. by using checking the cookies) who is authenticated. Returns a session object or 401 if the credentials are invalid or no credentials were sent. This endpoint is useful for reverse proxies and API Gateways.
|
898
|
+
Uses the HTTP Headers in the GET request to determine (e.g. by using checking the cookies) who is authenticated. Returns a session object in the body or 401 if the credentials are invalid or no credentials were sent. Additionally when the request it successful it adds the user ID to the 'X-Kratos-Authenticated-Identity-Id' header in the response. This endpoint is useful for reverse proxies and API Gateways.
|
759
899
|
|
760
900
|
### Example
|
761
901
|
|
@@ -0,0 +1,21 @@
|
|
1
|
+
# OryHydraClient::RecoveryAddress
|
2
|
+
|
3
|
+
## Properties
|
4
|
+
|
5
|
+
Name | Type | Description | Notes
|
6
|
+
------------ | ------------- | ------------- | -------------
|
7
|
+
**id** | **String** | |
|
8
|
+
**value** | **String** | |
|
9
|
+
**via** | **String** | |
|
10
|
+
|
11
|
+
## Code Sample
|
12
|
+
|
13
|
+
```ruby
|
14
|
+
require 'OryHydraClient'
|
15
|
+
|
16
|
+
instance = OryHydraClient::RecoveryAddress.new(id: null,
|
17
|
+
value: null,
|
18
|
+
via: null)
|
19
|
+
```
|
20
|
+
|
21
|
+
|
@@ -0,0 +1,31 @@
|
|
1
|
+
# OryHydraClient::RecoveryRequest
|
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
|
+
**issued_at** | **DateTime** | IssuedAt is the time (UTC) when the request occurred. |
|
11
|
+
**messages** | [**Array<Message>**](Message.md) | | [optional]
|
12
|
+
**methods** | [**Hash<String, RecoveryRequestMethod>**](RecoveryRequestMethod.md) | Methods contains context for all account recovery 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
|
+
**state** | **String** | |
|
15
|
+
|
16
|
+
## Code Sample
|
17
|
+
|
18
|
+
```ruby
|
19
|
+
require 'OryHydraClient'
|
20
|
+
|
21
|
+
instance = OryHydraClient::RecoveryRequest.new(active: null,
|
22
|
+
expires_at: null,
|
23
|
+
id: null,
|
24
|
+
issued_at: null,
|
25
|
+
messages: null,
|
26
|
+
methods: null,
|
27
|
+
request_url: null,
|
28
|
+
state: null)
|
29
|
+
```
|
30
|
+
|
31
|
+
|
@@ -0,0 +1,19 @@
|
|
1
|
+
# OryHydraClient::RecoveryRequestMethod
|
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::RecoveryRequestMethod.new(config: null,
|
16
|
+
method: null)
|
17
|
+
```
|
18
|
+
|
19
|
+
|
data/docs/RegistrationRequest.md
CHANGED
@@ -8,6 +8,7 @@ Name | Type | Description | Notes
|
|
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
9
|
**id** | **String** | |
|
10
10
|
**issued_at** | **DateTime** | IssuedAt is the time (UTC) when the request occurred. |
|
11
|
+
**messages** | [**Array<Message>**](Message.md) | | [optional]
|
11
12
|
**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
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. |
|
13
14
|
|
@@ -20,6 +21,7 @@ instance = OryHydraClient::RegistrationRequest.new(active: null,
|
|
20
21
|
expires_at: null,
|
21
22
|
id: null,
|
22
23
|
issued_at: null,
|
24
|
+
messages: null,
|
23
25
|
methods: null,
|
24
26
|
request_url: null)
|
25
27
|
```
|
@@ -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::RegistrationRequestMethodConfig.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/RequestMethodConfig.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::RequestMethodConfig.new(action: null,
|
18
|
-
errors: null,
|
19
18
|
fields: null,
|
19
|
+
messages: null,
|
20
20
|
method: null)
|
21
21
|
```
|
22
22
|
|
data/docs/SettingsRequest.md
CHANGED
@@ -9,9 +9,10 @@ Name | Type | Description | Notes
|
|
9
9
|
**id** | **String** | |
|
10
10
|
**identity** | [**Identity**](Identity.md) | |
|
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, 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
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
|
+
**state** | **String** | |
|
15
16
|
|
16
17
|
## Code Sample
|
17
18
|
|
@@ -23,9 +24,10 @@ instance = OryHydraClient::SettingsRequest.new(active: null,
|
|
23
24
|
id: null,
|
24
25
|
identity: null,
|
25
26
|
issued_at: null,
|
27
|
+
messages: null,
|
26
28
|
methods: null,
|
27
29
|
request_url: null,
|
28
|
-
|
30
|
+
state: null)
|
29
31
|
```
|
30
32
|
|
31
33
|
|
data/docs/VerificationRequest.md
CHANGED
@@ -8,6 +8,7 @@ Name | Type | Description | Notes
|
|
8
8
|
**form** | [**Form**](Form.md) | | [optional]
|
9
9
|
**id** | **String** | | [optional]
|
10
10
|
**issued_at** | **DateTime** | IssuedAt is the time (UTC) when the request occurred. | [optional]
|
11
|
+
**messages** | [**Array<Message>**](Message.md) | | [optional]
|
11
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]
|
12
13
|
**success** | **Boolean** | Success, if true, implies that the request was completed successfully. | [optional]
|
13
14
|
**via** | **String** | | [optional]
|
@@ -21,6 +22,7 @@ instance = OryHydraClient::VerificationRequest.new(expires_at: null,
|
|
21
22
|
form: null,
|
22
23
|
id: null,
|
23
24
|
issued_at: null,
|
25
|
+
messages: null,
|
24
26
|
request_url: null,
|
25
27
|
success: null,
|
26
28
|
via: null)
|