ory-kratos-client 0.1.1.alpha1 → 0.2.0.alpha2
Sign up to get free protection for your applications and to get access to all the features.
- checksums.yaml +4 -4
- data/README.md +18 -12
- data/docs/AdminApi.md +68 -21
- data/docs/CommonApi.md +68 -21
- data/docs/CompleteSelfServiceBrowserSettingsStrategyProfileFlowPayload.md +19 -0
- data/docs/Form.md +1 -1
- data/docs/FormField.md +6 -6
- data/docs/GenericErrorPayload.md +1 -1
- data/docs/LoginRequest.md +2 -0
- data/docs/LoginRequestMethodConfig.md +1 -1
- data/docs/PublicApi.md +134 -44
- data/docs/RegistrationRequestMethodConfig.md +1 -1
- data/docs/RequestMethodConfig.md +23 -0
- data/docs/SettingsRequest.md +31 -0
- data/docs/SettingsRequestMethod.md +19 -0
- data/docs/VerifiableAddress.md +1 -1
- data/docs/VerificationRequest.md +1 -1
- data/lib/ory-kratos-client.rb +4 -2
- data/lib/ory-kratos-client/api/admin_api.rb +95 -35
- data/lib/ory-kratos-client/api/common_api.rb +95 -35
- data/lib/ory-kratos-client/api/public_api.rb +181 -65
- data/lib/ory-kratos-client/models/complete_self_service_browser_settings_strategy_profile_flow_payload.rb +222 -0
- data/lib/ory-kratos-client/models/form.rb +1 -1
- data/lib/ory-kratos-client/models/form_field.rb +6 -6
- data/lib/ory-kratos-client/models/generic_error_payload.rb +2 -3
- data/lib/ory-kratos-client/models/login_request.rb +11 -1
- data/lib/ory-kratos-client/models/login_request_method_config.rb +1 -1
- data/lib/ory-kratos-client/models/registration_request_method_config.rb +1 -1
- data/lib/ory-kratos-client/models/request_method_config.rb +256 -0
- data/lib/ory-kratos-client/models/settings_request.rb +313 -0
- data/lib/ory-kratos-client/models/settings_request_method.rb +216 -0
- data/lib/ory-kratos-client/models/verifiable_address.rb +0 -5
- data/lib/ory-kratos-client/models/verification_request.rb +1 -1
- data/lib/ory-kratos-client/version.rb +1 -1
- data/spec/models/complete_self_service_browser_settings_strategy_profile_flow_payload_spec.rb +47 -0
- data/spec/models/request_method_config_spec.rb +59 -0
- data/spec/models/settings_request_method_spec.rb +47 -0
- data/spec/models/settings_request_spec.rb +83 -0
- metadata +36 -20
checksums.yaml
CHANGED
@@ -1,7 +1,7 @@
|
|
1
1
|
---
|
2
2
|
SHA256:
|
3
|
-
metadata.gz:
|
4
|
-
data.tar.gz:
|
3
|
+
metadata.gz: 594fc7166fd9fa21d959b334a0ab271f185868c3eceae69da5491a800fed7c38
|
4
|
+
data.tar.gz: b416aab62ed0d8012a9bdc2bef4b0f2adfcba00aa29d7af9855364c6ac66e336
|
5
5
|
SHA512:
|
6
|
-
metadata.gz:
|
7
|
-
data.tar.gz:
|
6
|
+
metadata.gz: 4236f829ec231ed7642a0276914bff5c398fbeb95fe3a65a6cfc56ec95bfb4057e5048a8ccf127247999bab407d529e935c20252700639d718b8ae8deb179bdd
|
7
|
+
data.tar.gz: a8a4b1cf786815a41ea4bbc72ddaa941346da0bdd093bcf3a5c24cfd6d82f652900e506c9aac13a82c70909679e63ecc6b6b4b07ad8186114eb7823cde577d66
|
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.
|
10
|
+
- Package version: v0.2.0-alpha.2
|
11
11
|
- Build package: org.openapitools.codegen.languages.RubyClientCodegen
|
12
12
|
|
13
13
|
## Installation
|
@@ -23,16 +23,16 @@ gem build ory-kratos-client.gemspec
|
|
23
23
|
Then either install the gem locally:
|
24
24
|
|
25
25
|
```shell
|
26
|
-
gem install ./ory-kratos-client-v0.
|
26
|
+
gem install ./ory-kratos-client-v0.2.0-alpha.2.gem
|
27
27
|
```
|
28
28
|
|
29
|
-
(for development, run `gem install --dev ./ory-kratos-client-v0.
|
29
|
+
(for development, run `gem install --dev ./ory-kratos-client-v0.2.0-alpha.2.gem` to install the development dependencies)
|
30
30
|
|
31
31
|
or publish the gem to a gem hosting service, e.g. [RubyGems](https://rubygems.org/).
|
32
32
|
|
33
33
|
Finally add this to the Gemfile:
|
34
34
|
|
35
|
-
gem 'ory-kratos-client', '~> v0.
|
35
|
+
gem 'ory-kratos-client', '~> v0.2.0-alpha.2'
|
36
36
|
|
37
37
|
### Install from Git
|
38
38
|
|
@@ -78,32 +78,36 @@ 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
|
85
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
|
86
87
|
*OryHydraClient::AdminApi* | [**list_identities**](docs/AdminApi.md#list_identities) | **GET** /identities | List all identities in the system
|
87
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} |
|
88
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
|
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
|
90
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
|
91
93
|
*OryHydraClient::CommonApi* | [**get_self_service_error**](docs/CommonApi.md#get_self_service_error) | **GET** /self-service/errors | Get user-facing self-service errors
|
92
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
|
93
95
|
*OryHydraClient::HealthApi* | [**is_instance_alive**](docs/HealthApi.md#is_instance_alive) | **GET** /health/alive | Check alive status
|
94
96
|
*OryHydraClient::HealthApi* | [**is_instance_ready**](docs/HealthApi.md#is_instance_ready) | **GET** /health/ready | Check readiness status
|
95
|
-
*OryHydraClient::PublicApi* | [**
|
96
|
-
*OryHydraClient::PublicApi* | [**
|
97
|
+
*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
|
98
|
+
*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
|
99
|
+
*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
|
100
|
+
*OryHydraClient::PublicApi* | [**get_schema**](docs/PublicApi.md#get_schema) | **GET** /schemas/{id} |
|
97
101
|
*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
|
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
|
99
102
|
*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
|
103
|
+
*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
|
100
104
|
*OryHydraClient::PublicApi* | [**get_self_service_error**](docs/PublicApi.md#get_self_service_error) | **GET** /self-service/errors | Get user-facing self-service errors
|
101
105
|
*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
|
102
106
|
*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
|
103
107
|
*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
|
104
108
|
*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
109
|
*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
|
106
|
-
*OryHydraClient::PublicApi* | [**
|
110
|
+
*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
|
107
111
|
*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
|
108
112
|
*OryHydraClient::PublicApi* | [**whoami**](docs/PublicApi.md#whoami) | **GET** /sessions/whoami | Check who the current HTTP session belongs to
|
109
113
|
*OryHydraClient::VersionApi* | [**get_version**](docs/VersionApi.md#get_version) | **GET** /version | Get service version
|
@@ -111,7 +115,7 @@ Class | Method | HTTP request | Description
|
|
111
115
|
|
112
116
|
## Documentation for Models
|
113
117
|
|
114
|
-
- [OryHydraClient::
|
118
|
+
- [OryHydraClient::CompleteSelfServiceBrowserSettingsStrategyProfileFlowPayload](docs/CompleteSelfServiceBrowserSettingsStrategyProfileFlowPayload.md)
|
115
119
|
- [OryHydraClient::Error](docs/Error.md)
|
116
120
|
- [OryHydraClient::ErrorContainer](docs/ErrorContainer.md)
|
117
121
|
- [OryHydraClient::Form](docs/Form.md)
|
@@ -124,11 +128,13 @@ Class | Method | HTTP request | Description
|
|
124
128
|
- [OryHydraClient::LoginRequest](docs/LoginRequest.md)
|
125
129
|
- [OryHydraClient::LoginRequestMethod](docs/LoginRequestMethod.md)
|
126
130
|
- [OryHydraClient::LoginRequestMethodConfig](docs/LoginRequestMethodConfig.md)
|
127
|
-
- [OryHydraClient::ProfileManagementRequest](docs/ProfileManagementRequest.md)
|
128
131
|
- [OryHydraClient::RegistrationRequest](docs/RegistrationRequest.md)
|
129
132
|
- [OryHydraClient::RegistrationRequestMethod](docs/RegistrationRequestMethod.md)
|
130
133
|
- [OryHydraClient::RegistrationRequestMethodConfig](docs/RegistrationRequestMethodConfig.md)
|
134
|
+
- [OryHydraClient::RequestMethodConfig](docs/RequestMethodConfig.md)
|
131
135
|
- [OryHydraClient::Session](docs/Session.md)
|
136
|
+
- [OryHydraClient::SettingsRequest](docs/SettingsRequest.md)
|
137
|
+
- [OryHydraClient::SettingsRequestMethod](docs/SettingsRequestMethod.md)
|
132
138
|
- [OryHydraClient::VerifiableAddress](docs/VerifiableAddress.md)
|
133
139
|
- [OryHydraClient::VerificationRequest](docs/VerificationRequest.md)
|
134
140
|
- [OryHydraClient::Version](docs/Version.md)
|
data/docs/AdminApi.md
CHANGED
@@ -7,9 +7,10 @@ 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
|
14
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
|
15
16
|
[**list_identities**](AdminApi.md#list_identities) | **GET** /identities | List all identities in the system
|
@@ -157,13 +158,13 @@ No authorization required
|
|
157
158
|
- **Accept**: application/json
|
158
159
|
|
159
160
|
|
160
|
-
##
|
161
|
+
## get_schema
|
161
162
|
|
162
|
-
>
|
163
|
+
> Object get_schema(id)
|
163
164
|
|
164
|
-
Get the request context of browser-based login user flows
|
165
165
|
|
166
|
-
|
166
|
+
|
167
|
+
Get a traits schema definition
|
167
168
|
|
168
169
|
### Example
|
169
170
|
|
@@ -172,14 +173,13 @@ This endpoint returns a login request's context with, for example, error details
|
|
172
173
|
require 'ory-kratos-client'
|
173
174
|
|
174
175
|
api_instance = OryHydraClient::AdminApi.new
|
175
|
-
|
176
|
+
id = 'id_example' # String | ID must be set to the ID of schema you want to get
|
176
177
|
|
177
178
|
begin
|
178
|
-
|
179
|
-
result = api_instance.get_self_service_browser_login_request(request)
|
179
|
+
result = api_instance.get_schema(id)
|
180
180
|
p result
|
181
181
|
rescue OryHydraClient::ApiError => e
|
182
|
-
puts "Exception when calling AdminApi->
|
182
|
+
puts "Exception when calling AdminApi->get_schema: #{e}"
|
183
183
|
end
|
184
184
|
```
|
185
185
|
|
@@ -188,11 +188,11 @@ end
|
|
188
188
|
|
189
189
|
Name | Type | Description | Notes
|
190
190
|
------------- | ------------- | ------------- | -------------
|
191
|
-
**
|
191
|
+
**id** | **String**| ID must be set to the ID of schema you want to get |
|
192
192
|
|
193
193
|
### Return type
|
194
194
|
|
195
|
-
|
195
|
+
**Object**
|
196
196
|
|
197
197
|
### Authorization
|
198
198
|
|
@@ -204,13 +204,13 @@ No authorization required
|
|
204
204
|
- **Accept**: application/json
|
205
205
|
|
206
206
|
|
207
|
-
##
|
207
|
+
## get_self_service_browser_login_request
|
208
208
|
|
209
|
-
>
|
209
|
+
> LoginRequest get_self_service_browser_login_request(request)
|
210
210
|
|
211
|
-
Get the request context of browser-based
|
211
|
+
Get the request context of browser-based login user flows
|
212
212
|
|
213
|
-
When accessing this endpoint through ORY Kratos' Public API, ensure that cookies are set as they are required for
|
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).
|
214
214
|
|
215
215
|
### Example
|
216
216
|
|
@@ -222,11 +222,11 @@ api_instance = OryHydraClient::AdminApi.new
|
|
222
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`).
|
223
223
|
|
224
224
|
begin
|
225
|
-
#Get the request context of browser-based
|
226
|
-
result = api_instance.
|
225
|
+
#Get the request context of browser-based login user flows
|
226
|
+
result = api_instance.get_self_service_browser_login_request(request)
|
227
227
|
p result
|
228
228
|
rescue OryHydraClient::ApiError => e
|
229
|
-
puts "Exception when calling AdminApi->
|
229
|
+
puts "Exception when calling AdminApi->get_self_service_browser_login_request: #{e}"
|
230
230
|
end
|
231
231
|
```
|
232
232
|
|
@@ -239,7 +239,7 @@ Name | Type | Description | Notes
|
|
239
239
|
|
240
240
|
### Return type
|
241
241
|
|
242
|
-
[**
|
242
|
+
[**LoginRequest**](LoginRequest.md)
|
243
243
|
|
244
244
|
### Authorization
|
245
245
|
|
@@ -298,6 +298,53 @@ No authorization required
|
|
298
298
|
- **Accept**: application/json
|
299
299
|
|
300
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](https://www.ory.sh/docs/next/kratos/self-service/flows/user-settings-profile-management).
|
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
|
+
|
301
348
|
## get_self_service_error
|
302
349
|
|
303
350
|
> ErrorContainer get_self_service_error(opts)
|
@@ -314,7 +361,7 @@ require 'ory-kratos-client'
|
|
314
361
|
|
315
362
|
api_instance = OryHydraClient::AdminApi.new
|
316
363
|
opts = {
|
317
|
-
|
364
|
+
error: 'error_example' # String |
|
318
365
|
}
|
319
366
|
|
320
367
|
begin
|
@@ -331,7 +378,7 @@ end
|
|
331
378
|
|
332
379
|
Name | Type | Description | Notes
|
333
380
|
------------- | ------------- | ------------- | -------------
|
334
|
-
**
|
381
|
+
**error** | **String**| | [optional]
|
335
382
|
|
336
383
|
### Return type
|
337
384
|
|
data/docs/CommonApi.md
CHANGED
@@ -4,21 +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
|
11
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
|
12
13
|
|
13
14
|
|
14
15
|
|
15
|
-
##
|
16
|
+
## get_schema
|
16
17
|
|
17
|
-
>
|
18
|
+
> Object get_schema(id)
|
18
19
|
|
19
|
-
Get the request context of browser-based login user flows
|
20
20
|
|
21
|
-
|
21
|
+
|
22
|
+
Get a traits schema definition
|
22
23
|
|
23
24
|
### Example
|
24
25
|
|
@@ -27,14 +28,13 @@ This endpoint returns a login request's context with, for example, error details
|
|
27
28
|
require 'ory-kratos-client'
|
28
29
|
|
29
30
|
api_instance = OryHydraClient::CommonApi.new
|
30
|
-
|
31
|
+
id = 'id_example' # String | ID must be set to the ID of schema you want to get
|
31
32
|
|
32
33
|
begin
|
33
|
-
|
34
|
-
result = api_instance.get_self_service_browser_login_request(request)
|
34
|
+
result = api_instance.get_schema(id)
|
35
35
|
p result
|
36
36
|
rescue OryHydraClient::ApiError => e
|
37
|
-
puts "Exception when calling CommonApi->
|
37
|
+
puts "Exception when calling CommonApi->get_schema: #{e}"
|
38
38
|
end
|
39
39
|
```
|
40
40
|
|
@@ -43,11 +43,11 @@ end
|
|
43
43
|
|
44
44
|
Name | Type | Description | Notes
|
45
45
|
------------- | ------------- | ------------- | -------------
|
46
|
-
**
|
46
|
+
**id** | **String**| ID must be set to the ID of schema you want to get |
|
47
47
|
|
48
48
|
### Return type
|
49
49
|
|
50
|
-
|
50
|
+
**Object**
|
51
51
|
|
52
52
|
### Authorization
|
53
53
|
|
@@ -59,13 +59,13 @@ No authorization required
|
|
59
59
|
- **Accept**: application/json
|
60
60
|
|
61
61
|
|
62
|
-
##
|
62
|
+
## get_self_service_browser_login_request
|
63
63
|
|
64
|
-
>
|
64
|
+
> LoginRequest get_self_service_browser_login_request(request)
|
65
65
|
|
66
|
-
Get the request context of browser-based
|
66
|
+
Get the request context of browser-based login user flows
|
67
67
|
|
68
|
-
When accessing this endpoint through ORY Kratos' Public API, ensure that cookies are set as they are required for
|
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).
|
69
69
|
|
70
70
|
### Example
|
71
71
|
|
@@ -77,11 +77,11 @@ api_instance = OryHydraClient::CommonApi.new
|
|
77
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`).
|
78
78
|
|
79
79
|
begin
|
80
|
-
#Get the request context of browser-based
|
81
|
-
result = api_instance.
|
80
|
+
#Get the request context of browser-based login user flows
|
81
|
+
result = api_instance.get_self_service_browser_login_request(request)
|
82
82
|
p result
|
83
83
|
rescue OryHydraClient::ApiError => e
|
84
|
-
puts "Exception when calling CommonApi->
|
84
|
+
puts "Exception when calling CommonApi->get_self_service_browser_login_request: #{e}"
|
85
85
|
end
|
86
86
|
```
|
87
87
|
|
@@ -94,7 +94,7 @@ Name | Type | Description | Notes
|
|
94
94
|
|
95
95
|
### Return type
|
96
96
|
|
97
|
-
[**
|
97
|
+
[**LoginRequest**](LoginRequest.md)
|
98
98
|
|
99
99
|
### Authorization
|
100
100
|
|
@@ -153,6 +153,53 @@ No authorization required
|
|
153
153
|
- **Accept**: application/json
|
154
154
|
|
155
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](https://www.ory.sh/docs/next/kratos/self-service/flows/user-settings-profile-management).
|
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
|
+
|
156
203
|
## get_self_service_error
|
157
204
|
|
158
205
|
> ErrorContainer get_self_service_error(opts)
|
@@ -169,7 +216,7 @@ require 'ory-kratos-client'
|
|
169
216
|
|
170
217
|
api_instance = OryHydraClient::CommonApi.new
|
171
218
|
opts = {
|
172
|
-
|
219
|
+
error: 'error_example' # String |
|
173
220
|
}
|
174
221
|
|
175
222
|
begin
|
@@ -186,7 +233,7 @@ end
|
|
186
233
|
|
187
234
|
Name | Type | Description | Notes
|
188
235
|
------------- | ------------- | ------------- | -------------
|
189
|
-
**
|
236
|
+
**error** | **String**| | [optional]
|
190
237
|
|
191
238
|
### Return type
|
192
239
|
|
@@ -0,0 +1,19 @@
|
|
1
|
+
# OryHydraClient::CompleteSelfServiceBrowserSettingsStrategyProfileFlowPayload
|
2
|
+
|
3
|
+
## Properties
|
4
|
+
|
5
|
+
Name | Type | Description | Notes
|
6
|
+
------------ | ------------- | ------------- | -------------
|
7
|
+
**request_id** | **String** | RequestID is request ID. in: query | [optional]
|
8
|
+
**traits** | [**Object**](.md) | Traits contains all of the identity's traits. type: string format: binary |
|
9
|
+
|
10
|
+
## Code Sample
|
11
|
+
|
12
|
+
```ruby
|
13
|
+
require 'OryHydraClient'
|
14
|
+
|
15
|
+
instance = OryHydraClient::CompleteSelfServiceBrowserSettingsStrategyProfileFlowPayload.new(request_id: null,
|
16
|
+
traits: null)
|
17
|
+
```
|
18
|
+
|
19
|
+
|