ory-kratos-client 0.1.0.alpha5 → 0.3.0.alpha1

Sign up to get free protection for your applications and to get access to all the features.
Files changed (68) hide show
  1. checksums.yaml +4 -4
  2. data/README.md +27 -11
  3. data/docs/AdminApi.md +116 -21
  4. data/docs/CommonApi.md +116 -21
  5. data/docs/CompleteSelfServiceBrowserSettingsStrategyProfileFlowPayload.md +19 -0
  6. data/docs/Form.md +3 -3
  7. data/docs/FormField.md +7 -7
  8. data/docs/GenericErrorPayload.md +1 -1
  9. data/docs/Identity.md +4 -2
  10. data/docs/LoginRequest.md +7 -5
  11. data/docs/LoginRequestMethod.md +2 -2
  12. data/docs/LoginRequestMethodConfig.md +10 -1
  13. data/docs/ProfileManagementRequest.md +7 -7
  14. data/docs/ProviderCredentialsConfig.md +19 -0
  15. data/docs/PublicApi.md +365 -39
  16. data/docs/RegistrationRequest.md +5 -5
  17. data/docs/RegistrationRequestMethodConfig.md +10 -1
  18. data/docs/RequestMethodConfig.md +23 -0
  19. data/docs/Session.md +5 -5
  20. data/docs/SettingsRequest.md +31 -0
  21. data/docs/SettingsRequestMethod.md +19 -0
  22. data/docs/VerifiableAddress.md +27 -0
  23. data/docs/VerificationRequest.md +29 -0
  24. data/lib/ory-kratos-client.rb +8 -3
  25. data/lib/ory-kratos-client/api/admin_api.rb +159 -36
  26. data/lib/ory-kratos-client/api/common_api.rb +159 -36
  27. data/lib/ory-kratos-client/api/health_api.rb +1 -1
  28. data/lib/ory-kratos-client/api/public_api.rb +493 -59
  29. data/lib/ory-kratos-client/api/version_api.rb +1 -1
  30. data/lib/ory-kratos-client/api_client.rb +1 -1
  31. data/lib/ory-kratos-client/api_error.rb +1 -1
  32. data/lib/ory-kratos-client/configuration.rb +1 -1
  33. data/lib/ory-kratos-client/models/complete_self_service_browser_profile_management_flow_payload.rb +1 -1
  34. data/lib/ory-kratos-client/models/complete_self_service_browser_settings_strategy_profile_flow_payload.rb +222 -0
  35. data/lib/ory-kratos-client/models/error.rb +1 -1
  36. data/lib/ory-kratos-client/models/error_container.rb +1 -1
  37. data/lib/ory-kratos-client/models/form.rb +17 -2
  38. data/lib/ory-kratos-client/models/form_field.rb +18 -9
  39. data/lib/ory-kratos-client/models/generic_error.rb +1 -1
  40. data/lib/ory-kratos-client/models/generic_error_payload.rb +3 -4
  41. data/lib/ory-kratos-client/models/health_not_ready_status.rb +1 -1
  42. data/lib/ory-kratos-client/models/health_status.rb +1 -1
  43. data/lib/ory-kratos-client/models/identity.rb +18 -2
  44. data/lib/ory-kratos-client/models/login_request.rb +37 -2
  45. data/lib/ory-kratos-client/models/login_request_method.rb +11 -1
  46. data/lib/ory-kratos-client/models/login_request_method_config.rb +74 -3
  47. data/lib/ory-kratos-client/models/profile_management_request.rb +36 -1
  48. data/lib/ory-kratos-client/models/provider_credentials_config.rb +215 -0
  49. data/lib/ory-kratos-client/models/registration_request.rb +26 -1
  50. data/lib/ory-kratos-client/models/registration_request_method.rb +1 -1
  51. data/lib/ory-kratos-client/models/registration_request_method_config.rb +74 -3
  52. data/lib/ory-kratos-client/models/request_method_config.rb +256 -0
  53. data/lib/ory-kratos-client/models/session.rb +26 -1
  54. data/lib/ory-kratos-client/models/settings_request.rb +313 -0
  55. data/lib/ory-kratos-client/models/settings_request_method.rb +216 -0
  56. data/lib/ory-kratos-client/models/verifiable_address.rb +276 -0
  57. data/lib/ory-kratos-client/models/verification_request.rb +265 -0
  58. data/lib/ory-kratos-client/models/version.rb +1 -1
  59. data/lib/ory-kratos-client/version.rb +2 -2
  60. data/ory-kratos-client.gemspec +1 -1
  61. data/spec/models/complete_self_service_browser_settings_strategy_profile_flow_payload_spec.rb +47 -0
  62. data/spec/models/provider_credentials_config_spec.rb +47 -0
  63. data/spec/models/request_method_config_spec.rb +59 -0
  64. data/spec/models/settings_request_method_spec.rb +47 -0
  65. data/spec/models/settings_request_spec.rb +83 -0
  66. data/spec/models/verifiable_address_spec.rb +71 -0
  67. data/spec/models/verification_request_spec.rb +77 -0
  68. metadata +43 -15
checksums.yaml CHANGED
@@ -1,7 +1,7 @@
1
1
  ---
2
2
  SHA256:
3
- metadata.gz: 5ea2266dd0b6d17b807ea0b086a8e305cda7fa6831e6a16f41858b2bae005a05
4
- data.tar.gz: 285a3d1abd7a2df22419445b6d44c942d4eb024f4c3a65b09b973a259c6b4b8d
3
+ metadata.gz: 5e628085fbdcbe215aa8177a6fc650b67474ad15697a8bfc6a0e24657ee22654
4
+ data.tar.gz: 759d694b5fa659c8ba6d0949451a9fcbb61bfb2b8091e6d9ad991d2b0c1862a7
5
5
  SHA512:
6
- metadata.gz: b920ecb4b08d3480e20e8f0a664bb5b67b8407d08667b0d7ac12f8db7a623de348fa4a7c71d6291effa8f674ffeaca6ac8312741afbcbd4a141d6e7f9d39bb08
7
- data.tar.gz: 9e82815b89cfec90f99b09ec1442b669d6c7bb6d9c363dedd5cf74432dd76b830b1206e685110878a5d0a522073c3bef5b790e1d2f24efd965b428f7ab607722
6
+ metadata.gz: eeb4494e6323ceb734183416249ef15f7c8f8eeed4b4393b535dbefcf8c3551ce024ebbe8b3a81f642a176050c74934a9ed6906925aa62d42cf67aebff02ed0b
7
+ data.tar.gz: 7eb3895a41dab9289287efde889ceb62479f05e12cdb0bdb1f4f7fb4ee488559e8998c49d1861f9888cd18ff6f7de7002e0997e10a33b15d6088d2570250cafa
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.3.0-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.1.0-alpha.5.gem
26
+ gem install ./ory-kratos-client-v0.3.0-alpha.1.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.3.0-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.1.0-alpha.5'
35
+ gem 'ory-kratos-client', '~> v0.3.0-alpha.1'
36
36
 
37
37
  ### Install from Git
38
38
 
@@ -78,34 +78,45 @@ Class | Method | HTTP request | Description
78
78
  *OryHydraClient::AdminApi* | [**create_identity**](docs/AdminApi.md#create_identity) | **POST** /identities | Create an identity
79
79
  *OryHydraClient::AdminApi* | [**delete_identity**](docs/AdminApi.md#delete_identity) | **DELETE** /identities/{id} | Delete an identity
80
80
  *OryHydraClient::AdminApi* | [**get_identity**](docs/AdminApi.md#get_identity) | **GET** /identities/{id} | Get an identity
81
+ *OryHydraClient::AdminApi* | [**get_schema**](docs/AdminApi.md#get_schema) | **GET** /schemas/{id} |
81
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
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
+ *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
84
85
  *OryHydraClient::AdminApi* | [**get_self_service_error**](docs/AdminApi.md#get_self_service_error) | **GET** /self-service/errors | Get user-facing self-service errors
86
+ *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
87
  *OryHydraClient::AdminApi* | [**list_identities**](docs/AdminApi.md#list_identities) | **GET** /identities | List all identities in the system
86
88
  *OryHydraClient::AdminApi* | [**update_identity**](docs/AdminApi.md#update_identity) | **PUT** /identities/{id} | Update an identity
89
+ *OryHydraClient::CommonApi* | [**get_schema**](docs/CommonApi.md#get_schema) | **GET** /schemas/{id} |
87
90
  *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
- *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
91
  *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
+ *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
90
93
  *OryHydraClient::CommonApi* | [**get_self_service_error**](docs/CommonApi.md#get_self_service_error) | **GET** /self-service/errors | Get user-facing self-service errors
94
+ *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
95
  *OryHydraClient::HealthApi* | [**is_instance_alive**](docs/HealthApi.md#is_instance_alive) | **GET** /health/alive | Check alive status
92
96
  *OryHydraClient::HealthApi* | [**is_instance_ready**](docs/HealthApi.md#is_instance_ready) | **GET** /health/ready | Check readiness status
93
- *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
97
+ *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
+ *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
+ *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
+ *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
+ *OryHydraClient::PublicApi* | [**get_schema**](docs/PublicApi.md#get_schema) | **GET** /schemas/{id} |
94
102
  *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
- *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
103
  *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
+ *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
97
105
  *OryHydraClient::PublicApi* | [**get_self_service_error**](docs/PublicApi.md#get_self_service_error) | **GET** /self-service/errors | Get user-facing self-service errors
106
+ *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
107
  *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
108
  *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
109
  *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
101
- *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
110
+ *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
111
+ *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
+ *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
102
113
  *OryHydraClient::PublicApi* | [**whoami**](docs/PublicApi.md#whoami) | **GET** /sessions/whoami | Check who the current HTTP session belongs to
103
114
  *OryHydraClient::VersionApi* | [**get_version**](docs/VersionApi.md#get_version) | **GET** /version | Get service version
104
115
 
105
116
 
106
117
  ## Documentation for Models
107
118
 
108
- - [OryHydraClient::CompleteSelfServiceBrowserProfileManagementFlowPayload](docs/CompleteSelfServiceBrowserProfileManagementFlowPayload.md)
119
+ - [OryHydraClient::CompleteSelfServiceBrowserSettingsStrategyProfileFlowPayload](docs/CompleteSelfServiceBrowserSettingsStrategyProfileFlowPayload.md)
109
120
  - [OryHydraClient::Error](docs/Error.md)
110
121
  - [OryHydraClient::ErrorContainer](docs/ErrorContainer.md)
111
122
  - [OryHydraClient::Form](docs/Form.md)
@@ -118,11 +129,16 @@ Class | Method | HTTP request | Description
118
129
  - [OryHydraClient::LoginRequest](docs/LoginRequest.md)
119
130
  - [OryHydraClient::LoginRequestMethod](docs/LoginRequestMethod.md)
120
131
  - [OryHydraClient::LoginRequestMethodConfig](docs/LoginRequestMethodConfig.md)
121
- - [OryHydraClient::ProfileManagementRequest](docs/ProfileManagementRequest.md)
132
+ - [OryHydraClient::ProviderCredentialsConfig](docs/ProviderCredentialsConfig.md)
122
133
  - [OryHydraClient::RegistrationRequest](docs/RegistrationRequest.md)
123
134
  - [OryHydraClient::RegistrationRequestMethod](docs/RegistrationRequestMethod.md)
124
135
  - [OryHydraClient::RegistrationRequestMethodConfig](docs/RegistrationRequestMethodConfig.md)
136
+ - [OryHydraClient::RequestMethodConfig](docs/RequestMethodConfig.md)
125
137
  - [OryHydraClient::Session](docs/Session.md)
138
+ - [OryHydraClient::SettingsRequest](docs/SettingsRequest.md)
139
+ - [OryHydraClient::SettingsRequestMethod](docs/SettingsRequestMethod.md)
140
+ - [OryHydraClient::VerifiableAddress](docs/VerifiableAddress.md)
141
+ - [OryHydraClient::VerificationRequest](docs/VerificationRequest.md)
126
142
  - [OryHydraClient::Version](docs/Version.md)
127
143
 
128
144
 
@@ -7,10 +7,12 @@ Method | HTTP request | Description
7
7
  [**create_identity**](AdminApi.md#create_identity) | **POST** /identities | Create an identity
8
8
  [**delete_identity**](AdminApi.md#delete_identity) | **DELETE** /identities/{id} | Delete an identity
9
9
  [**get_identity**](AdminApi.md#get_identity) | **GET** /identities/{id} | Get an identity
10
+ [**get_schema**](AdminApi.md#get_schema) | **GET** /schemas/{id} |
10
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
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
+ [**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
13
14
  [**get_self_service_error**](AdminApi.md#get_self_service_error) | **GET** /self-service/errors | Get user-facing self-service errors
15
+ [**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
16
  [**list_identities**](AdminApi.md#list_identities) | **GET** /identities | List all identities in the system
15
17
  [**update_identity**](AdminApi.md#update_identity) | **PUT** /identities/{id} | Update an identity
16
18
 
@@ -156,13 +158,13 @@ No authorization required
156
158
  - **Accept**: application/json
157
159
 
158
160
 
159
- ## get_self_service_browser_login_request
161
+ ## get_schema
160
162
 
161
- > LoginRequest get_self_service_browser_login_request(request)
163
+ > Object get_schema(id)
162
164
 
163
- Get the request context of browser-based login user flows
164
165
 
165
- This endpoint returns a login request's context with, for example, error details and other information. When accessing this endpoint through ORY Kratos' Public API, ensure that cookies are set as they are required for CSRF to work. To prevent token scanning attacks, the public endpoint does not return 404 status codes to prevent scanning attacks. More information can be found at [ORY Kratos User Login and User Registration Documentation](https://www.ory.sh/docs/next/kratos/self-service/flows/user-login-user-registration).
166
+
167
+ Get a traits schema definition
166
168
 
167
169
  ### Example
168
170
 
@@ -171,14 +173,13 @@ This endpoint returns a login request's context with, for example, error details
171
173
  require 'ory-kratos-client'
172
174
 
173
175
  api_instance = OryHydraClient::AdminApi.new
174
- request = 'request_example' # String | Request is the Login Request ID The value for this parameter comes from `request` URL Query parameter sent to your application (e.g. `/login?request=abcde`).
176
+ id = 'id_example' # String | ID must be set to the ID of schema you want to get
175
177
 
176
178
  begin
177
- #Get the request context of browser-based login user flows
178
- result = api_instance.get_self_service_browser_login_request(request)
179
+ result = api_instance.get_schema(id)
179
180
  p result
180
181
  rescue OryHydraClient::ApiError => e
181
- puts "Exception when calling AdminApi->get_self_service_browser_login_request: #{e}"
182
+ puts "Exception when calling AdminApi->get_schema: #{e}"
182
183
  end
183
184
  ```
184
185
 
@@ -187,11 +188,11 @@ end
187
188
 
188
189
  Name | Type | Description | Notes
189
190
  ------------- | ------------- | ------------- | -------------
190
- **request** | **String**| Request is the Login Request ID The value for this parameter comes from `request` URL Query parameter sent to your application (e.g. `/login?request=abcde`). |
191
+ **id** | **String**| ID must be set to the ID of schema you want to get |
191
192
 
192
193
  ### Return type
193
194
 
194
- [**LoginRequest**](LoginRequest.md)
195
+ **Object**
195
196
 
196
197
  ### Authorization
197
198
 
@@ -203,13 +204,13 @@ No authorization required
203
204
  - **Accept**: application/json
204
205
 
205
206
 
206
- ## get_self_service_browser_profile_management_request
207
+ ## get_self_service_browser_login_request
207
208
 
208
- > ProfileManagementRequest get_self_service_browser_profile_management_request(request)
209
+ > LoginRequest get_self_service_browser_login_request(request)
209
210
 
210
- Get the request context of browser-based profile management flows
211
+ Get the request context of browser-based login user flows
211
212
 
212
- When accessing this endpoint through ORY Kratos' Public API, ensure that cookies are set as they are required for checking the auth session. To prevent scanning attacks, the public endpoint does not return 404 status codes but instead 403 or 500. More information can be found at [ORY Kratos Profile Management Documentation](https://www.ory.sh/docs/next/kratos/self-service/flows/user-profile-management).
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 to prevent scanning attacks. More information can be found at [ORY Kratos User Login and User Registration Documentation](https://www.ory.sh/docs/next/kratos/self-service/flows/user-login-user-registration).
213
214
 
214
215
  ### Example
215
216
 
@@ -221,11 +222,11 @@ api_instance = OryHydraClient::AdminApi.new
221
222
  request = 'request_example' # String | Request is the Login Request ID The value for this parameter comes from `request` URL Query parameter sent to your application (e.g. `/login?request=abcde`).
222
223
 
223
224
  begin
224
- #Get the request context of browser-based profile management flows
225
- result = api_instance.get_self_service_browser_profile_management_request(request)
225
+ #Get the request context of browser-based login user flows
226
+ result = api_instance.get_self_service_browser_login_request(request)
226
227
  p result
227
228
  rescue OryHydraClient::ApiError => e
228
- puts "Exception when calling AdminApi->get_self_service_browser_profile_management_request: #{e}"
229
+ puts "Exception when calling AdminApi->get_self_service_browser_login_request: #{e}"
229
230
  end
230
231
  ```
231
232
 
@@ -238,7 +239,7 @@ Name | Type | Description | Notes
238
239
 
239
240
  ### Return type
240
241
 
241
- [**ProfileManagementRequest**](ProfileManagementRequest.md)
242
+ [**LoginRequest**](LoginRequest.md)
242
243
 
243
244
  ### Authorization
244
245
 
@@ -297,6 +298,53 @@ No authorization required
297
298
  - **Accept**: application/json
298
299
 
299
300
 
301
+ ## get_self_service_browser_settings_request
302
+
303
+ > SettingsRequest get_self_service_browser_settings_request(request)
304
+
305
+ Get the request context of browser-based settings flows
306
+
307
+ When accessing this endpoint through ORY Kratos' Public API, ensure that cookies are set as they are required for checking the auth session. To prevent scanning attacks, the public endpoint does not return 404 status codes but instead 403 or 500. More information can be found at [ORY Kratos User Settings & Profile Management Documentation](../self-service/flows/user-settings).
308
+
309
+ ### Example
310
+
311
+ ```ruby
312
+ # load the gem
313
+ require 'ory-kratos-client'
314
+
315
+ 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. `/login?request=abcde`).
317
+
318
+ begin
319
+ #Get the request context of browser-based settings flows
320
+ result = api_instance.get_self_service_browser_settings_request(request)
321
+ p result
322
+ rescue OryHydraClient::ApiError => e
323
+ puts "Exception when calling AdminApi->get_self_service_browser_settings_request: #{e}"
324
+ end
325
+ ```
326
+
327
+ ### Parameters
328
+
329
+
330
+ Name | Type | Description | Notes
331
+ ------------- | ------------- | ------------- | -------------
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. `/login?request=abcde`). |
333
+
334
+ ### Return type
335
+
336
+ [**SettingsRequest**](SettingsRequest.md)
337
+
338
+ ### Authorization
339
+
340
+ No authorization required
341
+
342
+ ### HTTP request headers
343
+
344
+ - **Content-Type**: Not defined
345
+ - **Accept**: application/json
346
+
347
+
300
348
  ## get_self_service_error
301
349
 
302
350
  > ErrorContainer get_self_service_error(opts)
@@ -313,7 +361,7 @@ require 'ory-kratos-client'
313
361
 
314
362
  api_instance = OryHydraClient::AdminApi.new
315
363
  opts = {
316
- id: 'id_example' # String |
364
+ error: 'error_example' # String |
317
365
  }
318
366
 
319
367
  begin
@@ -330,7 +378,7 @@ end
330
378
 
331
379
  Name | Type | Description | Notes
332
380
  ------------- | ------------- | ------------- | -------------
333
- **id** | **String**| | [optional]
381
+ **error** | **String**| | [optional]
334
382
 
335
383
  ### Return type
336
384
 
@@ -346,6 +394,53 @@ No authorization required
346
394
  - **Accept**: application/json
347
395
 
348
396
 
397
+ ## get_self_service_verification_request
398
+
399
+ > VerificationRequest get_self_service_verification_request(request)
400
+
401
+ Get the request context of browser-based verification flows
402
+
403
+ 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).
404
+
405
+ ### Example
406
+
407
+ ```ruby
408
+ # load the gem
409
+ require 'ory-kratos-client'
410
+
411
+ api_instance = OryHydraClient::AdminApi.new
412
+ 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`).
413
+
414
+ begin
415
+ #Get the request context of browser-based verification flows
416
+ result = api_instance.get_self_service_verification_request(request)
417
+ p result
418
+ rescue OryHydraClient::ApiError => e
419
+ puts "Exception when calling AdminApi->get_self_service_verification_request: #{e}"
420
+ end
421
+ ```
422
+
423
+ ### Parameters
424
+
425
+
426
+ Name | Type | Description | Notes
427
+ ------------- | ------------- | ------------- | -------------
428
+ **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`). |
429
+
430
+ ### Return type
431
+
432
+ [**VerificationRequest**](VerificationRequest.md)
433
+
434
+ ### Authorization
435
+
436
+ No authorization required
437
+
438
+ ### HTTP request headers
439
+
440
+ - **Content-Type**: Not defined
441
+ - **Accept**: application/json
442
+
443
+
349
444
  ## list_identities
350
445
 
351
446
  > Array<Identity> list_identities
@@ -4,20 +4,22 @@ All URIs are relative to *http://localhost*
4
4
 
5
5
  Method | HTTP request | Description
6
6
  ------------- | ------------- | -------------
7
+ [**get_schema**](CommonApi.md#get_schema) | **GET** /schemas/{id} |
7
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
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
+ [**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
10
11
  [**get_self_service_error**](CommonApi.md#get_self_service_error) | **GET** /self-service/errors | Get user-facing self-service errors
12
+ [**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
13
 
12
14
 
13
15
 
14
- ## get_self_service_browser_login_request
16
+ ## get_schema
15
17
 
16
- > LoginRequest get_self_service_browser_login_request(request)
18
+ > Object get_schema(id)
17
19
 
18
- Get the request context of browser-based login user flows
19
20
 
20
- This endpoint returns a login request's context with, for example, error details and other information. When accessing this endpoint through ORY Kratos' Public API, ensure that cookies are set as they are required for CSRF to work. To prevent token scanning attacks, the public endpoint does not return 404 status codes to prevent scanning attacks. More information can be found at [ORY Kratos User Login and User Registration Documentation](https://www.ory.sh/docs/next/kratos/self-service/flows/user-login-user-registration).
21
+
22
+ Get a traits schema definition
21
23
 
22
24
  ### Example
23
25
 
@@ -26,14 +28,13 @@ This endpoint returns a login request's context with, for example, error details
26
28
  require 'ory-kratos-client'
27
29
 
28
30
  api_instance = OryHydraClient::CommonApi.new
29
- request = 'request_example' # String | Request is the Login Request ID The value for this parameter comes from `request` URL Query parameter sent to your application (e.g. `/login?request=abcde`).
31
+ id = 'id_example' # String | ID must be set to the ID of schema you want to get
30
32
 
31
33
  begin
32
- #Get the request context of browser-based login user flows
33
- result = api_instance.get_self_service_browser_login_request(request)
34
+ result = api_instance.get_schema(id)
34
35
  p result
35
36
  rescue OryHydraClient::ApiError => e
36
- puts "Exception when calling CommonApi->get_self_service_browser_login_request: #{e}"
37
+ puts "Exception when calling CommonApi->get_schema: #{e}"
37
38
  end
38
39
  ```
39
40
 
@@ -42,11 +43,11 @@ end
42
43
 
43
44
  Name | Type | Description | Notes
44
45
  ------------- | ------------- | ------------- | -------------
45
- **request** | **String**| Request is the Login Request ID The value for this parameter comes from `request` URL Query parameter sent to your application (e.g. `/login?request=abcde`). |
46
+ **id** | **String**| ID must be set to the ID of schema you want to get |
46
47
 
47
48
  ### Return type
48
49
 
49
- [**LoginRequest**](LoginRequest.md)
50
+ **Object**
50
51
 
51
52
  ### Authorization
52
53
 
@@ -58,13 +59,13 @@ No authorization required
58
59
  - **Accept**: application/json
59
60
 
60
61
 
61
- ## get_self_service_browser_profile_management_request
62
+ ## get_self_service_browser_login_request
62
63
 
63
- > ProfileManagementRequest get_self_service_browser_profile_management_request(request)
64
+ > LoginRequest get_self_service_browser_login_request(request)
64
65
 
65
- Get the request context of browser-based profile management flows
66
+ Get the request context of browser-based login user flows
66
67
 
67
- When accessing this endpoint through ORY Kratos' Public API, ensure that cookies are set as they are required for checking the auth session. To prevent scanning attacks, the public endpoint does not return 404 status codes but instead 403 or 500. More information can be found at [ORY Kratos Profile Management Documentation](https://www.ory.sh/docs/next/kratos/self-service/flows/user-profile-management).
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 to prevent scanning attacks. More information can be found at [ORY Kratos User Login and User Registration Documentation](https://www.ory.sh/docs/next/kratos/self-service/flows/user-login-user-registration).
68
69
 
69
70
  ### Example
70
71
 
@@ -76,11 +77,11 @@ api_instance = OryHydraClient::CommonApi.new
76
77
  request = 'request_example' # String | Request is the Login Request ID The value for this parameter comes from `request` URL Query parameter sent to your application (e.g. `/login?request=abcde`).
77
78
 
78
79
  begin
79
- #Get the request context of browser-based profile management flows
80
- result = api_instance.get_self_service_browser_profile_management_request(request)
80
+ #Get the request context of browser-based login user flows
81
+ result = api_instance.get_self_service_browser_login_request(request)
81
82
  p result
82
83
  rescue OryHydraClient::ApiError => e
83
- puts "Exception when calling CommonApi->get_self_service_browser_profile_management_request: #{e}"
84
+ puts "Exception when calling CommonApi->get_self_service_browser_login_request: #{e}"
84
85
  end
85
86
  ```
86
87
 
@@ -93,7 +94,7 @@ Name | Type | Description | Notes
93
94
 
94
95
  ### Return type
95
96
 
96
- [**ProfileManagementRequest**](ProfileManagementRequest.md)
97
+ [**LoginRequest**](LoginRequest.md)
97
98
 
98
99
  ### Authorization
99
100
 
@@ -152,6 +153,53 @@ No authorization required
152
153
  - **Accept**: application/json
153
154
 
154
155
 
156
+ ## get_self_service_browser_settings_request
157
+
158
+ > SettingsRequest get_self_service_browser_settings_request(request)
159
+
160
+ Get the request context of browser-based settings flows
161
+
162
+ When accessing this endpoint through ORY Kratos' Public API, ensure that cookies are set as they are required for checking the auth session. To prevent scanning attacks, the public endpoint does not return 404 status codes but instead 403 or 500. More information can be found at [ORY Kratos User Settings & Profile Management Documentation](../self-service/flows/user-settings).
163
+
164
+ ### Example
165
+
166
+ ```ruby
167
+ # load the gem
168
+ require 'ory-kratos-client'
169
+
170
+ 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. `/login?request=abcde`).
172
+
173
+ begin
174
+ #Get the request context of browser-based settings flows
175
+ result = api_instance.get_self_service_browser_settings_request(request)
176
+ p result
177
+ rescue OryHydraClient::ApiError => e
178
+ puts "Exception when calling CommonApi->get_self_service_browser_settings_request: #{e}"
179
+ end
180
+ ```
181
+
182
+ ### Parameters
183
+
184
+
185
+ Name | Type | Description | Notes
186
+ ------------- | ------------- | ------------- | -------------
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. `/login?request=abcde`). |
188
+
189
+ ### Return type
190
+
191
+ [**SettingsRequest**](SettingsRequest.md)
192
+
193
+ ### Authorization
194
+
195
+ No authorization required
196
+
197
+ ### HTTP request headers
198
+
199
+ - **Content-Type**: Not defined
200
+ - **Accept**: application/json
201
+
202
+
155
203
  ## get_self_service_error
156
204
 
157
205
  > ErrorContainer get_self_service_error(opts)
@@ -168,7 +216,7 @@ require 'ory-kratos-client'
168
216
 
169
217
  api_instance = OryHydraClient::CommonApi.new
170
218
  opts = {
171
- id: 'id_example' # String |
219
+ error: 'error_example' # String |
172
220
  }
173
221
 
174
222
  begin
@@ -185,7 +233,7 @@ end
185
233
 
186
234
  Name | Type | Description | Notes
187
235
  ------------- | ------------- | ------------- | -------------
188
- **id** | **String**| | [optional]
236
+ **error** | **String**| | [optional]
189
237
 
190
238
  ### Return type
191
239
 
@@ -200,3 +248,50 @@ No authorization required
200
248
  - **Content-Type**: Not defined
201
249
  - **Accept**: application/json
202
250
 
251
+
252
+ ## get_self_service_verification_request
253
+
254
+ > VerificationRequest get_self_service_verification_request(request)
255
+
256
+ Get the request context of browser-based verification flows
257
+
258
+ 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).
259
+
260
+ ### Example
261
+
262
+ ```ruby
263
+ # load the gem
264
+ require 'ory-kratos-client'
265
+
266
+ api_instance = OryHydraClient::CommonApi.new
267
+ 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`).
268
+
269
+ begin
270
+ #Get the request context of browser-based verification flows
271
+ result = api_instance.get_self_service_verification_request(request)
272
+ p result
273
+ rescue OryHydraClient::ApiError => e
274
+ puts "Exception when calling CommonApi->get_self_service_verification_request: #{e}"
275
+ end
276
+ ```
277
+
278
+ ### Parameters
279
+
280
+
281
+ Name | Type | Description | Notes
282
+ ------------- | ------------- | ------------- | -------------
283
+ **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`). |
284
+
285
+ ### Return type
286
+
287
+ [**VerificationRequest**](VerificationRequest.md)
288
+
289
+ ### Authorization
290
+
291
+ No authorization required
292
+
293
+ ### HTTP request headers
294
+
295
+ - **Content-Type**: Not defined
296
+ - **Accept**: application/json
297
+