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

Sign up to get free protection for your applications and to get access to all the features.
Files changed (52) hide show
  1. checksums.yaml +4 -4
  2. data/README.md +12 -4
  3. data/docs/AdminApi.md +48 -0
  4. data/docs/CommonApi.md +48 -0
  5. data/docs/Form.md +3 -3
  6. data/docs/FormField.md +4 -4
  7. data/docs/Identity.md +4 -2
  8. data/docs/LoginRequest.md +5 -5
  9. data/docs/LoginRequestMethod.md +2 -2
  10. data/docs/LoginRequestMethodConfig.md +10 -1
  11. data/docs/ProfileManagementRequest.md +7 -7
  12. data/docs/PublicApi.md +189 -0
  13. data/docs/RegistrationRequest.md +6 -6
  14. data/docs/RegistrationRequestMethodConfig.md +10 -1
  15. data/docs/Session.md +5 -5
  16. data/docs/VerifiableAddress.md +27 -0
  17. data/docs/VerificationRequest.md +29 -0
  18. data/lib/ory-kratos-client.rb +3 -1
  19. data/lib/ory-kratos-client/api/admin_api.rb +64 -1
  20. data/lib/ory-kratos-client/api/common_api.rb +64 -1
  21. data/lib/ory-kratos-client/api/health_api.rb +1 -1
  22. data/lib/ory-kratos-client/api/public_api.rb +251 -1
  23. data/lib/ory-kratos-client/api/version_api.rb +1 -1
  24. data/lib/ory-kratos-client/api_client.rb +1 -1
  25. data/lib/ory-kratos-client/api_error.rb +1 -1
  26. data/lib/ory-kratos-client/configuration.rb +1 -1
  27. data/lib/ory-kratos-client/models/complete_self_service_browser_profile_management_flow_payload.rb +1 -1
  28. data/lib/ory-kratos-client/models/error.rb +1 -1
  29. data/lib/ory-kratos-client/models/error_container.rb +1 -1
  30. data/lib/ory-kratos-client/models/form.rb +16 -1
  31. data/lib/ory-kratos-client/models/form_field.rb +17 -2
  32. data/lib/ory-kratos-client/models/generic_error.rb +1 -1
  33. data/lib/ory-kratos-client/models/generic_error_payload.rb +1 -1
  34. data/lib/ory-kratos-client/models/health_not_ready_status.rb +1 -1
  35. data/lib/ory-kratos-client/models/health_status.rb +1 -1
  36. data/lib/ory-kratos-client/models/identity.rb +18 -2
  37. data/lib/ory-kratos-client/models/login_request.rb +26 -1
  38. data/lib/ory-kratos-client/models/login_request_method.rb +11 -1
  39. data/lib/ory-kratos-client/models/login_request_method_config.rb +74 -3
  40. data/lib/ory-kratos-client/models/profile_management_request.rb +36 -1
  41. data/lib/ory-kratos-client/models/registration_request.rb +31 -1
  42. data/lib/ory-kratos-client/models/registration_request_method.rb +1 -1
  43. data/lib/ory-kratos-client/models/registration_request_method_config.rb +74 -3
  44. data/lib/ory-kratos-client/models/session.rb +26 -1
  45. data/lib/ory-kratos-client/models/verifiable_address.rb +281 -0
  46. data/lib/ory-kratos-client/models/verification_request.rb +265 -0
  47. data/lib/ory-kratos-client/models/version.rb +1 -1
  48. data/lib/ory-kratos-client/version.rb +2 -2
  49. data/ory-kratos-client.gemspec +1 -1
  50. data/spec/models/verifiable_address_spec.rb +71 -0
  51. data/spec/models/verification_request_spec.rb +77 -0
  52. metadata +28 -20
checksums.yaml CHANGED
@@ -1,7 +1,7 @@
1
1
  ---
2
2
  SHA256:
3
- metadata.gz: 5ea2266dd0b6d17b807ea0b086a8e305cda7fa6831e6a16f41858b2bae005a05
4
- data.tar.gz: 285a3d1abd7a2df22419445b6d44c942d4eb024f4c3a65b09b973a259c6b4b8d
3
+ metadata.gz: 35721bdd1388e22b36f1c986b502e87ffb51ff21ba90f4d46ed24162df4e70d7
4
+ data.tar.gz: e8d402dca0c629d4f0999b12536569a12f93fd2e7d7beea63d285c9a8a8f9b81
5
5
  SHA512:
6
- metadata.gz: b920ecb4b08d3480e20e8f0a664bb5b67b8407d08667b0d7ac12f8db7a623de348fa4a7c71d6291effa8f674ffeaca6ac8312741afbcbd4a141d6e7f9d39bb08
7
- data.tar.gz: 9e82815b89cfec90f99b09ec1442b669d6c7bb6d9c363dedd5cf74432dd76b830b1206e685110878a5d0a522073c3bef5b790e1d2f24efd965b428f7ab607722
6
+ metadata.gz: 12a9ef39ce270eebd5210c3bdc0956f1fb80634a60cad964469d452e41c5e560539822c0284cc4308b42091b2fc4ec0ebee9e4e09ffcc2a0ccf6e8fd78b93e81
7
+ data.tar.gz: 7816d5332cae05f8af5f4d8dcbe968e875cc4a497dd7c51989fae5ba1ccf0e5a6fa7d2abb2ee62b2fe5bae706d6e7beee589e863ad064dd5ee41ceadbc95e455
data/README.md CHANGED
@@ -7,7 +7,7 @@ Welcome to the ORY Kratos HTTP API documentation!
7
7
  This SDK is automatically generated by the [OpenAPI Generator](https://openapi-generator.tech) project:
8
8
 
9
9
  - API version: latest
10
- - Package version: v0.1.0-alpha.5
10
+ - Package version: v0.1.0-alpha.6
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.1.0-alpha.5.gem
26
+ gem install ./ory-kratos-client-v0.1.0-alpha.6.gem
27
27
  ```
28
28
 
29
- (for development, run `gem install --dev ./ory-kratos-client-v0.1.0-alpha.5.gem` to install the development dependencies)
29
+ (for development, run `gem install --dev ./ory-kratos-client-v0.1.0-alpha.6.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.1.0-alpha.5'
35
+ gem 'ory-kratos-client', '~> v0.1.0-alpha.6'
36
36
 
37
37
  ### Install from Git
38
38
 
@@ -82,23 +82,29 @@ Class | Method | HTTP request | Description
82
82
  *OryHydraClient::AdminApi* | [**get_self_service_browser_profile_management_request**](docs/AdminApi.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
83
83
  *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
84
  *OryHydraClient::AdminApi* | [**get_self_service_error**](docs/AdminApi.md#get_self_service_error) | **GET** /self-service/errors | Get user-facing self-service errors
85
+ *OryHydraClient::AdminApi* | [**get_self_service_verification_request**](docs/AdminApi.md#get_self_service_verification_request) | **GET** /self-service/browser/flows/requests/verification | Get the request context of browser-based verification flows
85
86
  *OryHydraClient::AdminApi* | [**list_identities**](docs/AdminApi.md#list_identities) | **GET** /identities | List all identities in the system
86
87
  *OryHydraClient::AdminApi* | [**update_identity**](docs/AdminApi.md#update_identity) | **PUT** /identities/{id} | Update an identity
87
88
  *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
88
89
  *OryHydraClient::CommonApi* | [**get_self_service_browser_profile_management_request**](docs/CommonApi.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
89
90
  *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
90
91
  *OryHydraClient::CommonApi* | [**get_self_service_error**](docs/CommonApi.md#get_self_service_error) | **GET** /self-service/errors | Get user-facing self-service errors
92
+ *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
91
93
  *OryHydraClient::HealthApi* | [**is_instance_alive**](docs/HealthApi.md#is_instance_alive) | **GET** /health/alive | Check alive status
92
94
  *OryHydraClient::HealthApi* | [**is_instance_ready**](docs/HealthApi.md#is_instance_ready) | **GET** /health/ready | Check readiness status
93
95
  *OryHydraClient::PublicApi* | [**complete_self_service_browser_profile_management_flow**](docs/PublicApi.md#complete_self_service_browser_profile_management_flow) | **POST** /self-service/browser/flows/profile/update | Complete the browser-based profile management flows
96
+ *OryHydraClient::PublicApi* | [**complete_self_service_browser_verification_flow**](docs/PublicApi.md#complete_self_service_browser_verification_flow) | **POST** /self-service/browser/flows/verification/complete | Complete the browser-based profile management flows
94
97
  *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
95
98
  *OryHydraClient::PublicApi* | [**get_self_service_browser_profile_management_request**](docs/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
96
99
  *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
97
100
  *OryHydraClient::PublicApi* | [**get_self_service_error**](docs/PublicApi.md#get_self_service_error) | **GET** /self-service/errors | Get user-facing self-service errors
101
+ *OryHydraClient::PublicApi* | [**get_self_service_verification_request**](docs/PublicApi.md#get_self_service_verification_request) | **GET** /self-service/browser/flows/requests/verification | Get the request context of browser-based verification flows
98
102
  *OryHydraClient::PublicApi* | [**initialize_self_service_browser_login_flow**](docs/PublicApi.md#initialize_self_service_browser_login_flow) | **GET** /self-service/browser/flows/login | Initialize browser-based login user flow
99
103
  *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
100
104
  *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
105
+ *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
101
106
  *OryHydraClient::PublicApi* | [**initialize_self_service_profile_management_flow**](docs/PublicApi.md#initialize_self_service_profile_management_flow) | **GET** /self-service/browser/flows/profile | Initialize browser-based profile management flow
107
+ *OryHydraClient::PublicApi* | [**self_service_browser_verify**](docs/PublicApi.md#self_service_browser_verify) | **GET** /self-service/browser/flows/verification/confirm/{code} | Complete the browser-based verification flows
102
108
  *OryHydraClient::PublicApi* | [**whoami**](docs/PublicApi.md#whoami) | **GET** /sessions/whoami | Check who the current HTTP session belongs to
103
109
  *OryHydraClient::VersionApi* | [**get_version**](docs/VersionApi.md#get_version) | **GET** /version | Get service version
104
110
 
@@ -123,6 +129,8 @@ Class | Method | HTTP request | Description
123
129
  - [OryHydraClient::RegistrationRequestMethod](docs/RegistrationRequestMethod.md)
124
130
  - [OryHydraClient::RegistrationRequestMethodConfig](docs/RegistrationRequestMethodConfig.md)
125
131
  - [OryHydraClient::Session](docs/Session.md)
132
+ - [OryHydraClient::VerifiableAddress](docs/VerifiableAddress.md)
133
+ - [OryHydraClient::VerificationRequest](docs/VerificationRequest.md)
126
134
  - [OryHydraClient::Version](docs/Version.md)
127
135
 
128
136
 
data/docs/AdminApi.md CHANGED
@@ -11,6 +11,7 @@ Method | HTTP request | Description
11
11
  [**get_self_service_browser_profile_management_request**](AdminApi.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
12
12
  [**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
13
  [**get_self_service_error**](AdminApi.md#get_self_service_error) | **GET** /self-service/errors | Get user-facing self-service errors
14
+ [**get_self_service_verification_request**](AdminApi.md#get_self_service_verification_request) | **GET** /self-service/browser/flows/requests/verification | Get the request context of browser-based verification flows
14
15
  [**list_identities**](AdminApi.md#list_identities) | **GET** /identities | List all identities in the system
15
16
  [**update_identity**](AdminApi.md#update_identity) | **PUT** /identities/{id} | Update an identity
16
17
 
@@ -346,6 +347,53 @@ No authorization required
346
347
  - **Accept**: application/json
347
348
 
348
349
 
350
+ ## get_self_service_verification_request
351
+
352
+ > VerificationRequest get_self_service_verification_request(request)
353
+
354
+ Get the request context of browser-based verification flows
355
+
356
+ When accessing this endpoint through ORY Kratos' Public API, ensure that cookies are set as they are required for checking the auth session. To prevent scanning attacks, the public endpoint does not return 404 status codes but instead 403 or 500. More information can be found at [ORY Kratos Email and Phone Verification Documentation](https://www.ory.sh/docs/kratos/selfservice/flows/verify-email-account-activation).
357
+
358
+ ### Example
359
+
360
+ ```ruby
361
+ # load the gem
362
+ require 'ory-kratos-client'
363
+
364
+ api_instance = OryHydraClient::AdminApi.new
365
+ request = 'request_example' # String | Request is the Request ID The value for this parameter comes from `request` URL Query parameter sent to your application (e.g. `/verify?request=abcde`).
366
+
367
+ begin
368
+ #Get the request context of browser-based verification flows
369
+ result = api_instance.get_self_service_verification_request(request)
370
+ p result
371
+ rescue OryHydraClient::ApiError => e
372
+ puts "Exception when calling AdminApi->get_self_service_verification_request: #{e}"
373
+ end
374
+ ```
375
+
376
+ ### Parameters
377
+
378
+
379
+ Name | Type | Description | Notes
380
+ ------------- | ------------- | ------------- | -------------
381
+ **request** | **String**| Request is the Request ID The value for this parameter comes from `request` URL Query parameter sent to your application (e.g. `/verify?request=abcde`). |
382
+
383
+ ### Return type
384
+
385
+ [**VerificationRequest**](VerificationRequest.md)
386
+
387
+ ### Authorization
388
+
389
+ No authorization required
390
+
391
+ ### HTTP request headers
392
+
393
+ - **Content-Type**: Not defined
394
+ - **Accept**: application/json
395
+
396
+
349
397
  ## list_identities
350
398
 
351
399
  > Array<Identity> list_identities
data/docs/CommonApi.md CHANGED
@@ -8,6 +8,7 @@ Method | HTTP request | Description
8
8
  [**get_self_service_browser_profile_management_request**](CommonApi.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
9
9
  [**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
10
  [**get_self_service_error**](CommonApi.md#get_self_service_error) | **GET** /self-service/errors | Get user-facing self-service errors
11
+ [**get_self_service_verification_request**](CommonApi.md#get_self_service_verification_request) | **GET** /self-service/browser/flows/requests/verification | Get the request context of browser-based verification flows
11
12
 
12
13
 
13
14
 
@@ -200,3 +201,50 @@ No authorization required
200
201
  - **Content-Type**: Not defined
201
202
  - **Accept**: application/json
202
203
 
204
+
205
+ ## get_self_service_verification_request
206
+
207
+ > VerificationRequest get_self_service_verification_request(request)
208
+
209
+ Get the request context of browser-based verification flows
210
+
211
+ When accessing this endpoint through ORY Kratos' Public API, ensure that cookies are set as they are required for checking the auth session. To prevent scanning attacks, the public endpoint does not return 404 status codes but instead 403 or 500. More information can be found at [ORY Kratos Email and Phone Verification Documentation](https://www.ory.sh/docs/kratos/selfservice/flows/verify-email-account-activation).
212
+
213
+ ### Example
214
+
215
+ ```ruby
216
+ # load the gem
217
+ require 'ory-kratos-client'
218
+
219
+ api_instance = OryHydraClient::CommonApi.new
220
+ request = 'request_example' # String | Request is the Request ID The value for this parameter comes from `request` URL Query parameter sent to your application (e.g. `/verify?request=abcde`).
221
+
222
+ begin
223
+ #Get the request context of browser-based verification flows
224
+ result = api_instance.get_self_service_verification_request(request)
225
+ p result
226
+ rescue OryHydraClient::ApiError => e
227
+ puts "Exception when calling CommonApi->get_self_service_verification_request: #{e}"
228
+ end
229
+ ```
230
+
231
+ ### Parameters
232
+
233
+
234
+ Name | Type | Description | Notes
235
+ ------------- | ------------- | ------------- | -------------
236
+ **request** | **String**| Request is the Request ID The value for this parameter comes from `request` URL Query parameter sent to your application (e.g. `/verify?request=abcde`). |
237
+
238
+ ### Return type
239
+
240
+ [**VerificationRequest**](VerificationRequest.md)
241
+
242
+ ### Authorization
243
+
244
+ No authorization required
245
+
246
+ ### HTTP request headers
247
+
248
+ - **Content-Type**: Not defined
249
+ - **Accept**: application/json
250
+
data/docs/Form.md CHANGED
@@ -4,10 +4,10 @@
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\">). | [optional]
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
- **fields** | [**Array<FormField>**](FormField.md) | Fields contains multiple fields | [optional]
10
- **method** | **String** | Method is the form method (e.g. POST) | [optional]
9
+ **fields** | [**Array<FormField>**](FormField.md) | Fields contains multiple fields |
10
+ **method** | **String** | Method is the form method (e.g. POST) |
11
11
 
12
12
  ## Code Sample
13
13
 
data/docs/FormField.md CHANGED
@@ -4,12 +4,12 @@
4
4
 
5
5
  Name | Type | Description | Notes
6
6
  ------------ | ------------- | ------------- | -------------
7
- **disabled** | **String** | 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}}\"> | [optional]
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
- **required** | **Boolean** | Required is the equivalent of <input required=\"{{.Required}}\"> | [optional]
12
- **type** | **String** | Type is the equivalent of <input type=\"{{.Type}}\"> | [optional]
11
+ **required** | **Boolean** | Required is the equivalent of <input required=\"{{.Required}}\"> |
12
+ **type** | **String** | Type is the equivalent of <input type=\"{{.Type}}\"> |
13
13
  **value** | [**Object**](.md) | Value is the equivalent of <input value=\"{{.Value}}\"> | [optional]
14
14
 
15
15
  ## Code Sample
data/docs/Identity.md CHANGED
@@ -4,9 +4,10 @@
4
4
 
5
5
  Name | Type | Description | Notes
6
6
  ------------ | ------------- | ------------- | -------------
7
+ **addresses** | [**Array<VerifiableAddress>**](VerifiableAddress.md) | | [optional]
7
8
  **id** | **String** | |
8
9
  **traits** | [**Object**](.md) | |
9
- **traits_schema_id** | **String** | TraitsSchemaID is the ID of the JSON Schema to be used for validating the identity's traits. | [optional]
10
+ **traits_schema_id** | **String** | TraitsSchemaID is the ID of the JSON Schema to be used for validating the identity's traits. |
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]
11
12
 
12
13
  ## Code Sample
@@ -14,7 +15,8 @@ Name | Type | Description | Notes
14
15
  ```ruby
15
16
  require 'OryHydraClient'
16
17
 
17
- instance = OryHydraClient::Identity.new(id: null,
18
+ instance = OryHydraClient::Identity.new(addresses: null,
19
+ id: null,
18
20
  traits: null,
19
21
  traits_schema_id: null,
20
22
  traits_schema_url: null)
data/docs/LoginRequest.md CHANGED
@@ -5,11 +5,11 @@
5
5
  Name | Type | Description | Notes
6
6
  ------------ | ------------- | ------------- | -------------
7
7
  **active** | **String** | and so on. | [optional]
8
- **expires_at** | **DateTime** | ExpiresAt is the time (UTC) when the request expires. If the user still wishes to log in, a new request has to be initiated. | [optional]
9
- **id** | **String** | | [optional]
10
- **issued_at** | **DateTime** | IssuedAt is the time (UTC) when the request occurred. | [optional]
11
- **methods** | [**Hash<String, 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. | [optional]
12
- **request_url** | **String** | RequestURL is the initial URL that was requested from ORY Kratos. It can be used to forward information contained in the URL's path or query for example. | [optional]
8
+ **expires_at** | **DateTime** | ExpiresAt is the time (UTC) when the request expires. If the user still wishes to log in, a new request has to be initiated. |
9
+ **id** | **String** | |
10
+ **issued_at** | **DateTime** | IssuedAt is the time (UTC) when the request occurred. |
11
+ **methods** | [**Hash<String, 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. |
12
+ **request_url** | **String** | RequestURL is the initial URL that was requested from ORY Kratos. It can be used to forward information contained in the URL's path or query for example. |
13
13
 
14
14
  ## Code Sample
15
15
 
@@ -4,8 +4,8 @@
4
4
 
5
5
  Name | Type | Description | Notes
6
6
  ------------ | ------------- | ------------- | -------------
7
- **config** | [**LoginRequestMethodConfig**](LoginRequestMethodConfig.md) | | [optional]
8
- **method** | **String** | and so on. | [optional]
7
+ **config** | [**LoginRequestMethodConfig**](LoginRequestMethodConfig.md) | |
8
+ **method** | **String** | and so on. |
9
9
 
10
10
  ## Code Sample
11
11
 
@@ -4,13 +4,22 @@
4
4
 
5
5
  Name | Type | Description | Notes
6
6
  ------------ | ------------- | ------------- | -------------
7
+ **action** | **String** | Action should be used as the form action URL (<form action=\"{{ .Action }}\" method=\"post\">). |
8
+ **errors** | [**Array<Error>**](Error.md) | Errors contains all form errors. These will be duplicates of the individual field errors. | [optional]
9
+ **fields** | [**Array<FormField>**](FormField.md) | Fields contains multiple fields |
10
+ **method** | **String** | Method is the form method (e.g. POST) |
11
+ **providers** | [**Array<FormField>**](FormField.md) | Providers is set for the \"oidc\" request method. | [optional]
7
12
 
8
13
  ## Code Sample
9
14
 
10
15
  ```ruby
11
16
  require 'OryHydraClient'
12
17
 
13
- instance = OryHydraClient::LoginRequestMethodConfig.new()
18
+ instance = OryHydraClient::LoginRequestMethodConfig.new(action: null,
19
+ errors: null,
20
+ fields: null,
21
+ method: null,
22
+ providers: null)
14
23
  ```
15
24
 
16
25
 
@@ -4,13 +4,13 @@
4
4
 
5
5
  Name | Type | Description | Notes
6
6
  ------------ | ------------- | ------------- | -------------
7
- **expires_at** | **DateTime** | ExpiresAt is the time (UTC) when the request expires. If the user still wishes to update the profile, a new request has to be initiated. | [optional]
8
- **form** | [**Form**](Form.md) | | [optional]
9
- **id** | **String** | | [optional]
10
- **identity** | [**Identity**](Identity.md) | | [optional]
11
- **issued_at** | **DateTime** | IssuedAt is the time (UTC) when the request occurred. | [optional]
12
- **request_url** | **String** | RequestURL is the initial URL that was requested from ORY Kratos. It can be used to forward information contained in the URL's path or query for example. | [optional]
13
- **update_successful** | **Boolean** | UpdateSuccessful, if true, indicates that the profile 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. | [optional]
7
+ **expires_at** | **DateTime** | ExpiresAt is the time (UTC) when the request expires. If the user still wishes to update the profile, a new request has to be initiated. |
8
+ **form** | [**Form**](Form.md) | |
9
+ **id** | **String** | |
10
+ **identity** | [**Identity**](Identity.md) | |
11
+ **issued_at** | **DateTime** | IssuedAt is the time (UTC) when the request occurred. |
12
+ **request_url** | **String** | RequestURL is the initial URL that was requested from ORY Kratos. It can be used to forward information contained in the URL's path or query for example. |
13
+ **update_successful** | **Boolean** | UpdateSuccessful, if true, indicates that the profile 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. |
14
14
 
15
15
  ## Code Sample
16
16
 
data/docs/PublicApi.md CHANGED
@@ -5,14 +5,18 @@ All URIs are relative to *http://localhost*
5
5
  Method | HTTP request | Description
6
6
  ------------- | ------------- | -------------
7
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/complete | Complete the browser-based profile management flows
8
9
  [**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
9
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
10
11
  [**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
11
12
  [**get_self_service_error**](PublicApi.md#get_self_service_error) | **GET** /self-service/errors | Get user-facing self-service errors
13
+ [**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
12
14
  [**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
13
15
  [**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
14
16
  [**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
+ [**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
15
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
19
+ [**self_service_browser_verify**](PublicApi.md#self_service_browser_verify) | **GET** /self-service/browser/flows/verification/confirm/{code} | Complete the browser-based verification flows
16
20
  [**whoami**](PublicApi.md#whoami) | **GET** /sessions/whoami | Check who the current HTTP session belongs to
17
21
 
18
22
 
@@ -65,6 +69,52 @@ No authorization required
65
69
  - **Accept**: application/json
66
70
 
67
71
 
72
+ ## complete_self_service_browser_verification_flow
73
+
74
+ > complete_self_service_browser_verification_flow(request)
75
+
76
+ Complete the browser-based profile management flows
77
+
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).
79
+
80
+ ### Example
81
+
82
+ ```ruby
83
+ # load the gem
84
+ require 'ory-kratos-client'
85
+
86
+ api_instance = OryHydraClient::PublicApi.new
87
+ request = 'request_example' # String | Request is the Request ID The value for this parameter comes from `request` URL Query parameter sent to your application (e.g. `/verify?request=abcde`).
88
+
89
+ begin
90
+ #Complete the browser-based profile management flows
91
+ api_instance.complete_self_service_browser_verification_flow(request)
92
+ rescue OryHydraClient::ApiError => e
93
+ puts "Exception when calling PublicApi->complete_self_service_browser_verification_flow: #{e}"
94
+ end
95
+ ```
96
+
97
+ ### Parameters
98
+
99
+
100
+ Name | Type | Description | Notes
101
+ ------------- | ------------- | ------------- | -------------
102
+ **request** | **String**| Request is the Request ID The value for this parameter comes from `request` URL Query parameter sent to your application (e.g. `/verify?request=abcde`). |
103
+
104
+ ### Return type
105
+
106
+ nil (empty response body)
107
+
108
+ ### Authorization
109
+
110
+ No authorization required
111
+
112
+ ### HTTP request headers
113
+
114
+ - **Content-Type**: Not defined
115
+ - **Accept**: application/json
116
+
117
+
68
118
  ## get_self_service_browser_login_request
69
119
 
70
120
  > LoginRequest get_self_service_browser_login_request(request)
@@ -255,6 +305,53 @@ No authorization required
255
305
  - **Accept**: application/json
256
306
 
257
307
 
308
+ ## get_self_service_verification_request
309
+
310
+ > VerificationRequest get_self_service_verification_request(request)
311
+
312
+ Get the request context of browser-based verification flows
313
+
314
+ When accessing this endpoint through ORY Kratos' Public API, ensure that cookies are set as they are required for checking the auth session. To prevent scanning attacks, the public endpoint does not return 404 status codes but instead 403 or 500. More information can be found at [ORY Kratos Email and Phone Verification Documentation](https://www.ory.sh/docs/kratos/selfservice/flows/verify-email-account-activation).
315
+
316
+ ### Example
317
+
318
+ ```ruby
319
+ # load the gem
320
+ require 'ory-kratos-client'
321
+
322
+ api_instance = OryHydraClient::PublicApi.new
323
+ request = 'request_example' # String | Request is the Request ID The value for this parameter comes from `request` URL Query parameter sent to your application (e.g. `/verify?request=abcde`).
324
+
325
+ begin
326
+ #Get the request context of browser-based verification flows
327
+ result = api_instance.get_self_service_verification_request(request)
328
+ p result
329
+ rescue OryHydraClient::ApiError => e
330
+ puts "Exception when calling PublicApi->get_self_service_verification_request: #{e}"
331
+ end
332
+ ```
333
+
334
+ ### Parameters
335
+
336
+
337
+ Name | Type | Description | Notes
338
+ ------------- | ------------- | ------------- | -------------
339
+ **request** | **String**| Request is the Request ID The value for this parameter comes from `request` URL Query parameter sent to your application (e.g. `/verify?request=abcde`). |
340
+
341
+ ### Return type
342
+
343
+ [**VerificationRequest**](VerificationRequest.md)
344
+
345
+ ### Authorization
346
+
347
+ No authorization required
348
+
349
+ ### HTTP request headers
350
+
351
+ - **Content-Type**: Not defined
352
+ - **Accept**: application/json
353
+
354
+
258
355
  ## initialize_self_service_browser_login_flow
259
356
 
260
357
  > initialize_self_service_browser_login_flow
@@ -381,6 +478,52 @@ No authorization required
381
478
  - **Accept**: application/json
382
479
 
383
480
 
481
+ ## initialize_self_service_browser_verification_flow
482
+
483
+ > initialize_self_service_browser_verification_flow(via)
484
+
485
+ Initialize browser-based verification flow
486
+
487
+ 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).
488
+
489
+ ### Example
490
+
491
+ ```ruby
492
+ # load the gem
493
+ require 'ory-kratos-client'
494
+
495
+ api_instance = OryHydraClient::PublicApi.new
496
+ via = 'via_example' # String | What to verify Currently only \"email\" is supported.
497
+
498
+ begin
499
+ #Initialize browser-based verification flow
500
+ api_instance.initialize_self_service_browser_verification_flow(via)
501
+ rescue OryHydraClient::ApiError => e
502
+ puts "Exception when calling PublicApi->initialize_self_service_browser_verification_flow: #{e}"
503
+ end
504
+ ```
505
+
506
+ ### Parameters
507
+
508
+
509
+ Name | Type | Description | Notes
510
+ ------------- | ------------- | ------------- | -------------
511
+ **via** | **String**| What to verify Currently only \"email\" is supported. |
512
+
513
+ ### Return type
514
+
515
+ nil (empty response body)
516
+
517
+ ### Authorization
518
+
519
+ No authorization required
520
+
521
+ ### HTTP request headers
522
+
523
+ - **Content-Type**: Not defined
524
+ - **Accept**: application/json
525
+
526
+
384
527
  ## initialize_self_service_profile_management_flow
385
528
 
386
529
  > initialize_self_service_profile_management_flow
@@ -423,6 +566,52 @@ No authorization required
423
566
  - **Accept**: application/json
424
567
 
425
568
 
569
+ ## self_service_browser_verify
570
+
571
+ > self_service_browser_verify(code)
572
+
573
+ Complete the browser-based verification flows
574
+
575
+ This endpoint completes a browser-based verification flow. > This endpoint is NOT INTENDED for API clients and only works with browsers (Chrome, Firefox, ...) and HTML Forms. More information can be found at [ORY Kratos Email and Phone Verification Documentation](https://www.ory.sh/docs/kratos/selfservice/flows/verify-email-account-activation).
576
+
577
+ ### Example
578
+
579
+ ```ruby
580
+ # load the gem
581
+ require 'ory-kratos-client'
582
+
583
+ api_instance = OryHydraClient::PublicApi.new
584
+ code = 'code_example' # String |
585
+
586
+ begin
587
+ #Complete the browser-based verification flows
588
+ api_instance.self_service_browser_verify(code)
589
+ rescue OryHydraClient::ApiError => e
590
+ puts "Exception when calling PublicApi->self_service_browser_verify: #{e}"
591
+ end
592
+ ```
593
+
594
+ ### Parameters
595
+
596
+
597
+ Name | Type | Description | Notes
598
+ ------------- | ------------- | ------------- | -------------
599
+ **code** | **String**| |
600
+
601
+ ### Return type
602
+
603
+ nil (empty response body)
604
+
605
+ ### Authorization
606
+
607
+ No authorization required
608
+
609
+ ### HTTP request headers
610
+
611
+ - **Content-Type**: Not defined
612
+ - **Accept**: application/json
613
+
614
+
426
615
  ## whoami
427
616
 
428
617
  > Session whoami