ory-kratos-client 0.1.0.alpha6 → 0.4.6.alpha1
Sign up to get free protection for your applications and to get access to all the features.
- checksums.yaml +4 -4
- data/Gemfile +1 -1
- data/README.md +31 -15
- data/docs/AdminApi.md +111 -16
- data/docs/CommonApi.md +111 -16
- data/docs/CompleteSelfServiceBrowserSettingsStrategyProfileFlowPayload.md +19 -0
- data/docs/Form.md +3 -3
- data/docs/FormField.md +8 -8
- data/docs/GenericErrorPayload.md +1 -1
- data/docs/Identity.md +9 -7
- data/docs/LoginRequest.md +4 -0
- data/docs/LoginRequestMethodConfig.md +3 -3
- data/docs/Message.md +23 -0
- data/docs/ProviderCredentialsConfig.md +19 -0
- data/docs/PublicApi.md +327 -50
- data/docs/RecoveryAddress.md +21 -0
- data/docs/RecoveryRequest.md +31 -0
- data/docs/RecoveryRequestMethod.md +19 -0
- data/docs/RegistrationRequest.md +3 -1
- data/docs/RegistrationRequestMethodConfig.md +3 -3
- data/docs/RequestMethodConfig.md +23 -0
- data/docs/SettingsRequest.md +33 -0
- data/docs/SettingsRequestMethod.md +19 -0
- data/docs/VerifiableAddress.md +1 -1
- data/docs/VerificationRequest.md +3 -1
- data/lib/ory-kratos-client.rb +11 -5
- data/lib/ory-kratos-client/api/admin_api.rb +150 -27
- data/lib/ory-kratos-client/api/common_api.rb +150 -27
- data/lib/ory-kratos-client/api/health_api.rb +2 -2
- data/lib/ory-kratos-client/api/public_api.rb +433 -71
- data/lib/ory-kratos-client/api/version_api.rb +2 -2
- data/lib/ory-kratos-client/api_client.rb +9 -7
- data/lib/ory-kratos-client/api_error.rb +2 -2
- data/lib/ory-kratos-client/configuration.rb +2 -2
- data/lib/ory-kratos-client/models/complete_self_service_browser_settings_strategy_profile_flow_payload.rb +222 -0
- data/lib/ory-kratos-client/models/error_container.rb +2 -2
- data/lib/ory-kratos-client/models/form.rb +15 -16
- data/lib/ory-kratos-client/models/form_field.rb +16 -22
- data/lib/ory-kratos-client/models/generic_error.rb +2 -2
- data/lib/ory-kratos-client/models/generic_error_payload.rb +4 -7
- data/lib/ory-kratos-client/models/health_not_ready_status.rb +2 -2
- data/lib/ory-kratos-client/models/health_status.rb +2 -2
- data/lib/ory-kratos-client/models/identity.rb +48 -35
- data/lib/ory-kratos-client/models/login_request.rb +24 -3
- data/lib/ory-kratos-client/models/login_request_method.rb +2 -2
- data/lib/ory-kratos-client/models/login_request_method_config.rb +15 -16
- data/lib/ory-kratos-client/models/message.rb +233 -0
- data/lib/ory-kratos-client/models/provider_credentials_config.rb +215 -0
- data/lib/ory-kratos-client/models/recovery_address.rb +239 -0
- data/lib/ory-kratos-client/models/recovery_request.rb +309 -0
- data/lib/ory-kratos-client/models/recovery_request_method.rb +216 -0
- data/lib/ory-kratos-client/models/registration_request.rb +14 -8
- data/lib/ory-kratos-client/models/registration_request_method.rb +2 -2
- data/lib/ory-kratos-client/models/registration_request_method_config.rb +15 -16
- data/lib/ory-kratos-client/models/request_method_config.rb +255 -0
- data/lib/ory-kratos-client/models/session.rb +2 -2
- data/lib/ory-kratos-client/models/settings_request.rb +323 -0
- data/lib/ory-kratos-client/models/settings_request_method.rb +216 -0
- data/lib/ory-kratos-client/models/verifiable_address.rb +2 -7
- data/lib/ory-kratos-client/models/verification_request.rb +15 -4
- data/lib/ory-kratos-client/models/version.rb +2 -2
- data/lib/ory-kratos-client/version.rb +3 -3
- data/ory-kratos-client.gemspec +2 -2
- data/spec/models/complete_self_service_browser_settings_strategy_profile_flow_payload_spec.rb +47 -0
- data/spec/models/message_spec.rb +59 -0
- data/spec/models/provider_credentials_config_spec.rb +47 -0
- data/spec/models/recovery_address_spec.rb +53 -0
- data/spec/models/recovery_request_method_spec.rb +47 -0
- data/spec/models/recovery_request_spec.rb +83 -0
- 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 +55 -19
@@ -0,0 +1,21 @@
|
|
1
|
+
# OryHydraClient::RecoveryAddress
|
2
|
+
|
3
|
+
## Properties
|
4
|
+
|
5
|
+
Name | Type | Description | Notes
|
6
|
+
------------ | ------------- | ------------- | -------------
|
7
|
+
**id** | **String** | |
|
8
|
+
**value** | **String** | |
|
9
|
+
**via** | **String** | |
|
10
|
+
|
11
|
+
## Code Sample
|
12
|
+
|
13
|
+
```ruby
|
14
|
+
require 'OryHydraClient'
|
15
|
+
|
16
|
+
instance = OryHydraClient::RecoveryAddress.new(id: null,
|
17
|
+
value: null,
|
18
|
+
via: null)
|
19
|
+
```
|
20
|
+
|
21
|
+
|
@@ -0,0 +1,31 @@
|
|
1
|
+
# OryHydraClient::RecoveryRequest
|
2
|
+
|
3
|
+
## Properties
|
4
|
+
|
5
|
+
Name | Type | Description | Notes
|
6
|
+
------------ | ------------- | ------------- | -------------
|
7
|
+
**active** | **String** | Active, if set, contains the registration method that is being used. It is initially not set. | [optional]
|
8
|
+
**expires_at** | **DateTime** | ExpiresAt is the time (UTC) when the request expires. If the user still wishes to update the setting, a new request has to be initiated. |
|
9
|
+
**id** | **String** | |
|
10
|
+
**issued_at** | **DateTime** | IssuedAt is the time (UTC) when the request occurred. |
|
11
|
+
**messages** | [**Array<Message>**](Message.md) | | [optional]
|
12
|
+
**methods** | [**Hash<String, RecoveryRequestMethod>**](RecoveryRequestMethod.md) | Methods contains context for all account recovery methods. If a registration request has been processed, but for example the password is incorrect, this will contain error messages. |
|
13
|
+
**request_url** | **String** | RequestURL is the initial URL that was requested from ORY Kratos. It can be used to forward information contained in the URL's path or query for example. |
|
14
|
+
**state** | **String** | |
|
15
|
+
|
16
|
+
## Code Sample
|
17
|
+
|
18
|
+
```ruby
|
19
|
+
require 'OryHydraClient'
|
20
|
+
|
21
|
+
instance = OryHydraClient::RecoveryRequest.new(active: null,
|
22
|
+
expires_at: null,
|
23
|
+
id: null,
|
24
|
+
issued_at: null,
|
25
|
+
messages: null,
|
26
|
+
methods: null,
|
27
|
+
request_url: null,
|
28
|
+
state: null)
|
29
|
+
```
|
30
|
+
|
31
|
+
|
@@ -0,0 +1,19 @@
|
|
1
|
+
# OryHydraClient::RecoveryRequestMethod
|
2
|
+
|
3
|
+
## Properties
|
4
|
+
|
5
|
+
Name | Type | Description | Notes
|
6
|
+
------------ | ------------- | ------------- | -------------
|
7
|
+
**config** | [**RequestMethodConfig**](RequestMethodConfig.md) | | [optional]
|
8
|
+
**method** | **String** | Method contains the request credentials type. | [optional]
|
9
|
+
|
10
|
+
## Code Sample
|
11
|
+
|
12
|
+
```ruby
|
13
|
+
require 'OryHydraClient'
|
14
|
+
|
15
|
+
instance = OryHydraClient::RecoveryRequestMethod.new(config: null,
|
16
|
+
method: null)
|
17
|
+
```
|
18
|
+
|
19
|
+
|
data/docs/RegistrationRequest.md
CHANGED
@@ -4,10 +4,11 @@
|
|
4
4
|
|
5
5
|
Name | Type | Description | Notes
|
6
6
|
------------ | ------------- | ------------- | -------------
|
7
|
-
**active** | **String** | and so on. |
|
7
|
+
**active** | **String** | and so on. | [optional]
|
8
8
|
**expires_at** | **DateTime** | ExpiresAt is the time (UTC) when the request expires. If the user still wishes to log in, a new request has to be initiated. |
|
9
9
|
**id** | **String** | |
|
10
10
|
**issued_at** | **DateTime** | IssuedAt is the time (UTC) when the request occurred. |
|
11
|
+
**messages** | [**Array<Message>**](Message.md) | | [optional]
|
11
12
|
**methods** | [**Hash<String, RegistrationRequestMethod>**](RegistrationRequestMethod.md) | Methods contains context for all enabled registration methods. If a registration request has been processed, but for example the password is incorrect, this will contain error messages. |
|
12
13
|
**request_url** | **String** | RequestURL is the initial URL that was requested from ORY Kratos. It can be used to forward information contained in the URL's path or query for example. |
|
13
14
|
|
@@ -20,6 +21,7 @@ instance = OryHydraClient::RegistrationRequest.new(active: null,
|
|
20
21
|
expires_at: null,
|
21
22
|
id: null,
|
22
23
|
issued_at: null,
|
24
|
+
messages: null,
|
23
25
|
methods: null,
|
24
26
|
request_url: null)
|
25
27
|
```
|
@@ -4,9 +4,9 @@
|
|
4
4
|
|
5
5
|
Name | Type | Description | Notes
|
6
6
|
------------ | ------------- | ------------- | -------------
|
7
|
-
**action** | **String** | Action should be used as the form action URL
|
8
|
-
**errors** | [**Array<Error>**](Error.md) | Errors contains all form errors. These will be duplicates of the individual field errors. | [optional]
|
7
|
+
**action** | **String** | Action should be used as the form action URL `<form action=\"{{ .Action }}\" method=\"post\">`. |
|
9
8
|
**fields** | [**Array<FormField>**](FormField.md) | Fields contains multiple fields |
|
9
|
+
**messages** | [**Array<Message>**](Message.md) | | [optional]
|
10
10
|
**method** | **String** | Method is the form method (e.g. POST) |
|
11
11
|
**providers** | [**Array<FormField>**](FormField.md) | Providers is set for the \"oidc\" request method. | [optional]
|
12
12
|
|
@@ -16,8 +16,8 @@ Name | Type | Description | Notes
|
|
16
16
|
require 'OryHydraClient'
|
17
17
|
|
18
18
|
instance = OryHydraClient::RegistrationRequestMethodConfig.new(action: null,
|
19
|
-
errors: null,
|
20
19
|
fields: null,
|
20
|
+
messages: null,
|
21
21
|
method: null,
|
22
22
|
providers: null)
|
23
23
|
```
|
@@ -0,0 +1,23 @@
|
|
1
|
+
# OryHydraClient::RequestMethodConfig
|
2
|
+
|
3
|
+
## Properties
|
4
|
+
|
5
|
+
Name | Type | Description | Notes
|
6
|
+
------------ | ------------- | ------------- | -------------
|
7
|
+
**action** | **String** | Action should be used as the form action URL `<form action=\"{{ .Action }}\" method=\"post\">`. |
|
8
|
+
**fields** | [**Array<FormField>**](FormField.md) | Fields contains multiple fields |
|
9
|
+
**messages** | [**Array<Message>**](Message.md) | | [optional]
|
10
|
+
**method** | **String** | Method is the form method (e.g. POST) |
|
11
|
+
|
12
|
+
## Code Sample
|
13
|
+
|
14
|
+
```ruby
|
15
|
+
require 'OryHydraClient'
|
16
|
+
|
17
|
+
instance = OryHydraClient::RequestMethodConfig.new(action: null,
|
18
|
+
fields: null,
|
19
|
+
messages: null,
|
20
|
+
method: null)
|
21
|
+
```
|
22
|
+
|
23
|
+
|
@@ -0,0 +1,33 @@
|
|
1
|
+
# OryHydraClient::SettingsRequest
|
2
|
+
|
3
|
+
## Properties
|
4
|
+
|
5
|
+
Name | Type | Description | Notes
|
6
|
+
------------ | ------------- | ------------- | -------------
|
7
|
+
**active** | **String** | Active, if set, contains the registration method that is being used. It is initially not set. | [optional]
|
8
|
+
**expires_at** | **DateTime** | ExpiresAt is the time (UTC) when the request expires. If the user still wishes to update the setting, a new request has to be initiated. |
|
9
|
+
**id** | **String** | |
|
10
|
+
**identity** | [**Identity**](Identity.md) | |
|
11
|
+
**issued_at** | **DateTime** | IssuedAt is the time (UTC) when the request occurred. |
|
12
|
+
**messages** | [**Array<Message>**](Message.md) | | [optional]
|
13
|
+
**methods** | [**Hash<String, SettingsRequestMethod>**](SettingsRequestMethod.md) | Methods contains context for all enabled registration methods. If a registration request has been processed, but for example the password is incorrect, this will contain error messages. |
|
14
|
+
**request_url** | **String** | RequestURL is the initial URL that was requested from ORY Kratos. It can be used to forward information contained in the URL's path or query for example. |
|
15
|
+
**state** | **String** | |
|
16
|
+
|
17
|
+
## Code Sample
|
18
|
+
|
19
|
+
```ruby
|
20
|
+
require 'OryHydraClient'
|
21
|
+
|
22
|
+
instance = OryHydraClient::SettingsRequest.new(active: null,
|
23
|
+
expires_at: null,
|
24
|
+
id: null,
|
25
|
+
identity: null,
|
26
|
+
issued_at: null,
|
27
|
+
messages: null,
|
28
|
+
methods: null,
|
29
|
+
request_url: null,
|
30
|
+
state: null)
|
31
|
+
```
|
32
|
+
|
33
|
+
|
@@ -0,0 +1,19 @@
|
|
1
|
+
# OryHydraClient::SettingsRequestMethod
|
2
|
+
|
3
|
+
## Properties
|
4
|
+
|
5
|
+
Name | Type | Description | Notes
|
6
|
+
------------ | ------------- | ------------- | -------------
|
7
|
+
**config** | [**RequestMethodConfig**](RequestMethodConfig.md) | | [optional]
|
8
|
+
**method** | **String** | Method contains the request credentials type. | [optional]
|
9
|
+
|
10
|
+
## Code Sample
|
11
|
+
|
12
|
+
```ruby
|
13
|
+
require 'OryHydraClient'
|
14
|
+
|
15
|
+
instance = OryHydraClient::SettingsRequestMethod.new(config: null,
|
16
|
+
method: null)
|
17
|
+
```
|
18
|
+
|
19
|
+
|
data/docs/VerifiableAddress.md
CHANGED
data/docs/VerificationRequest.md
CHANGED
@@ -4,10 +4,11 @@
|
|
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
|
7
|
+
**expires_at** | **DateTime** | ExpiresAt is the time (UTC) when the request expires. If the user still wishes to verify the address, a new request has to be initiated. | [optional]
|
8
8
|
**form** | [**Form**](Form.md) | | [optional]
|
9
9
|
**id** | **String** | | [optional]
|
10
10
|
**issued_at** | **DateTime** | IssuedAt is the time (UTC) when the request occurred. | [optional]
|
11
|
+
**messages** | [**Array<Message>**](Message.md) | | [optional]
|
11
12
|
**request_url** | **String** | RequestURL is the initial URL that was requested from ORY Kratos. It can be used to forward information contained in the URL's path or query for example. | [optional]
|
12
13
|
**success** | **Boolean** | Success, if true, implies that the request was completed successfully. | [optional]
|
13
14
|
**via** | **String** | | [optional]
|
@@ -21,6 +22,7 @@ instance = OryHydraClient::VerificationRequest.new(expires_at: null,
|
|
21
22
|
form: null,
|
22
23
|
id: null,
|
23
24
|
issued_at: null,
|
25
|
+
messages: null,
|
24
26
|
request_url: null,
|
25
27
|
success: null,
|
26
28
|
via: null)
|
data/lib/ory-kratos-client.rb
CHANGED
@@ -3,10 +3,10 @@
|
|
3
3
|
|
4
4
|
#Welcome to the ORY Kratos HTTP API documentation!
|
5
5
|
|
6
|
-
The version of the OpenAPI document:
|
6
|
+
The version of the OpenAPI document: v0.4.6-alpha.1
|
7
7
|
|
8
8
|
Generated by: https://openapi-generator.tech
|
9
|
-
OpenAPI Generator version: 4.
|
9
|
+
OpenAPI Generator version: 4.3.1
|
10
10
|
|
11
11
|
=end
|
12
12
|
|
@@ -17,8 +17,7 @@ require 'ory-kratos-client/version'
|
|
17
17
|
require 'ory-kratos-client/configuration'
|
18
18
|
|
19
19
|
# Models
|
20
|
-
require 'ory-kratos-client/models/
|
21
|
-
require 'ory-kratos-client/models/error'
|
20
|
+
require 'ory-kratos-client/models/complete_self_service_browser_settings_strategy_profile_flow_payload'
|
22
21
|
require 'ory-kratos-client/models/error_container'
|
23
22
|
require 'ory-kratos-client/models/form'
|
24
23
|
require 'ory-kratos-client/models/form_field'
|
@@ -30,11 +29,18 @@ require 'ory-kratos-client/models/identity'
|
|
30
29
|
require 'ory-kratos-client/models/login_request'
|
31
30
|
require 'ory-kratos-client/models/login_request_method'
|
32
31
|
require 'ory-kratos-client/models/login_request_method_config'
|
33
|
-
require 'ory-kratos-client/models/
|
32
|
+
require 'ory-kratos-client/models/message'
|
33
|
+
require 'ory-kratos-client/models/provider_credentials_config'
|
34
|
+
require 'ory-kratos-client/models/recovery_address'
|
35
|
+
require 'ory-kratos-client/models/recovery_request'
|
36
|
+
require 'ory-kratos-client/models/recovery_request_method'
|
34
37
|
require 'ory-kratos-client/models/registration_request'
|
35
38
|
require 'ory-kratos-client/models/registration_request_method'
|
36
39
|
require 'ory-kratos-client/models/registration_request_method_config'
|
40
|
+
require 'ory-kratos-client/models/request_method_config'
|
37
41
|
require 'ory-kratos-client/models/session'
|
42
|
+
require 'ory-kratos-client/models/settings_request'
|
43
|
+
require 'ory-kratos-client/models/settings_request_method'
|
38
44
|
require 'ory-kratos-client/models/verifiable_address'
|
39
45
|
require 'ory-kratos-client/models/verification_request'
|
40
46
|
require 'ory-kratos-client/models/version'
|
@@ -3,10 +3,10 @@
|
|
3
3
|
|
4
4
|
#Welcome to the ORY Kratos HTTP API documentation!
|
5
5
|
|
6
|
-
The version of the OpenAPI document:
|
6
|
+
The version of the OpenAPI document: v0.4.6-alpha.1
|
7
7
|
|
8
8
|
Generated by: https://openapi-generator.tech
|
9
|
-
OpenAPI Generator version: 4.
|
9
|
+
OpenAPI Generator version: 4.3.1
|
10
10
|
|
11
11
|
=end
|
12
12
|
|
@@ -207,8 +207,68 @@ module OryHydraClient
|
|
207
207
|
return data, status_code, headers
|
208
208
|
end
|
209
209
|
|
210
|
+
# Get a traits schema definition
|
211
|
+
# @param id [String] ID must be set to the ID of schema you want to get
|
212
|
+
# @param [Hash] opts the optional parameters
|
213
|
+
# @return [Object]
|
214
|
+
def get_schema(id, opts = {})
|
215
|
+
data, _status_code, _headers = get_schema_with_http_info(id, opts)
|
216
|
+
data
|
217
|
+
end
|
218
|
+
|
219
|
+
# Get a traits schema definition
|
220
|
+
# @param id [String] ID must be set to the ID of schema you want to get
|
221
|
+
# @param [Hash] opts the optional parameters
|
222
|
+
# @return [Array<(Object, Integer, Hash)>] Object data, response status code and response headers
|
223
|
+
def get_schema_with_http_info(id, opts = {})
|
224
|
+
if @api_client.config.debugging
|
225
|
+
@api_client.config.logger.debug 'Calling API: AdminApi.get_schema ...'
|
226
|
+
end
|
227
|
+
# verify the required parameter 'id' is set
|
228
|
+
if @api_client.config.client_side_validation && id.nil?
|
229
|
+
fail ArgumentError, "Missing the required parameter 'id' when calling AdminApi.get_schema"
|
230
|
+
end
|
231
|
+
# resource path
|
232
|
+
local_var_path = '/schemas/{id}'.sub('{' + 'id' + '}', CGI.escape(id.to_s))
|
233
|
+
|
234
|
+
# query parameters
|
235
|
+
query_params = opts[:query_params] || {}
|
236
|
+
|
237
|
+
# header parameters
|
238
|
+
header_params = opts[:header_params] || {}
|
239
|
+
# HTTP header 'Accept' (if needed)
|
240
|
+
header_params['Accept'] = @api_client.select_header_accept(['application/json'])
|
241
|
+
|
242
|
+
# form parameters
|
243
|
+
form_params = opts[:form_params] || {}
|
244
|
+
|
245
|
+
# http body (model)
|
246
|
+
post_body = opts[:body]
|
247
|
+
|
248
|
+
# return_type
|
249
|
+
return_type = opts[:return_type] || 'Object'
|
250
|
+
|
251
|
+
# auth_names
|
252
|
+
auth_names = opts[:auth_names] || []
|
253
|
+
|
254
|
+
new_options = opts.merge(
|
255
|
+
:header_params => header_params,
|
256
|
+
:query_params => query_params,
|
257
|
+
:form_params => form_params,
|
258
|
+
:body => post_body,
|
259
|
+
:auth_names => auth_names,
|
260
|
+
:return_type => return_type
|
261
|
+
)
|
262
|
+
|
263
|
+
data, status_code, headers = @api_client.call_api(:GET, local_var_path, new_options)
|
264
|
+
if @api_client.config.debugging
|
265
|
+
@api_client.config.logger.debug "API called: AdminApi#get_schema\nData: #{data.inspect}\nStatus code: #{status_code}\nHeaders: #{headers}"
|
266
|
+
end
|
267
|
+
return data, status_code, headers
|
268
|
+
end
|
269
|
+
|
210
270
|
# Get the request context of browser-based login user flows
|
211
|
-
# 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
|
271
|
+
# This endpoint returns a login request's context with, for example, error details and other information. When accessing this endpoint through ORY Kratos' Public API, ensure that cookies are set as they are required for CSRF to work. To prevent token scanning attacks, the public endpoint does not return 404 status codes. More information can be found at [ORY Kratos User Login and User Registration Documentation](https://www.ory.sh/docs/next/kratos/self-service/flows/user-login-user-registration).
|
212
272
|
# @param 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`).
|
213
273
|
# @param [Hash] opts the optional parameters
|
214
274
|
# @return [LoginRequest]
|
@@ -218,7 +278,7 @@ module OryHydraClient
|
|
218
278
|
end
|
219
279
|
|
220
280
|
# Get the request context of browser-based login user flows
|
221
|
-
# 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
|
281
|
+
# This endpoint returns a login request's context with, for example, error details and other information. When accessing this endpoint through ORY Kratos' Public API, ensure that cookies are set as they are required for CSRF to work. To prevent token scanning attacks, the public endpoint does not return 404 status codes. More information can be found at [ORY Kratos User Login and User Registration Documentation](https://www.ory.sh/docs/next/kratos/self-service/flows/user-login-user-registration).
|
222
282
|
# @param 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`).
|
223
283
|
# @param [Hash] opts the optional parameters
|
224
284
|
# @return [Array<(LoginRequest, Integer, Hash)>] LoginRequest data, response status code and response headers
|
@@ -270,31 +330,31 @@ module OryHydraClient
|
|
270
330
|
return data, status_code, headers
|
271
331
|
end
|
272
332
|
|
273
|
-
# Get the request context of browser-based
|
274
|
-
# 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
|
275
|
-
# @param 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. `/
|
333
|
+
# Get the request context of browser-based recovery flows
|
334
|
+
# When accessing this endpoint through ORY Kratos' Public API, ensure that cookies are set as they are required for checking the auth session. To prevent scanning attacks, the public endpoint does not return 404 status codes but instead 403 or 500. More information can be found at [ORY Kratos Account Recovery Documentation](../self-service/flows/password-reset-account-recovery).
|
335
|
+
# @param request [String] Request is the Login Request ID The value for this parameter comes from `request` URL Query parameter sent to your application (e.g. `/recover?request=abcde`).
|
276
336
|
# @param [Hash] opts the optional parameters
|
277
|
-
# @return [
|
278
|
-
def
|
279
|
-
data, _status_code, _headers =
|
337
|
+
# @return [RecoveryRequest]
|
338
|
+
def get_self_service_browser_recovery_request(request, opts = {})
|
339
|
+
data, _status_code, _headers = get_self_service_browser_recovery_request_with_http_info(request, opts)
|
280
340
|
data
|
281
341
|
end
|
282
342
|
|
283
|
-
# Get the request context of browser-based
|
284
|
-
# 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
|
285
|
-
# @param 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. `/
|
343
|
+
# Get the request context of browser-based recovery flows
|
344
|
+
# When accessing this endpoint through ORY Kratos' Public API, ensure that cookies are set as they are required for checking the auth session. To prevent scanning attacks, the public endpoint does not return 404 status codes but instead 403 or 500. More information can be found at [ORY Kratos Account Recovery Documentation](../self-service/flows/password-reset-account-recovery).
|
345
|
+
# @param request [String] Request is the Login Request ID The value for this parameter comes from `request` URL Query parameter sent to your application (e.g. `/recover?request=abcde`).
|
286
346
|
# @param [Hash] opts the optional parameters
|
287
|
-
# @return [Array<(
|
288
|
-
def
|
347
|
+
# @return [Array<(RecoveryRequest, Integer, Hash)>] RecoveryRequest data, response status code and response headers
|
348
|
+
def get_self_service_browser_recovery_request_with_http_info(request, opts = {})
|
289
349
|
if @api_client.config.debugging
|
290
|
-
@api_client.config.logger.debug 'Calling API: AdminApi.
|
350
|
+
@api_client.config.logger.debug 'Calling API: AdminApi.get_self_service_browser_recovery_request ...'
|
291
351
|
end
|
292
352
|
# verify the required parameter 'request' is set
|
293
353
|
if @api_client.config.client_side_validation && request.nil?
|
294
|
-
fail ArgumentError, "Missing the required parameter 'request' when calling AdminApi.
|
354
|
+
fail ArgumentError, "Missing the required parameter 'request' when calling AdminApi.get_self_service_browser_recovery_request"
|
295
355
|
end
|
296
356
|
# resource path
|
297
|
-
local_var_path = '/self-service/browser/flows/requests/
|
357
|
+
local_var_path = '/self-service/browser/flows/requests/recovery'
|
298
358
|
|
299
359
|
# query parameters
|
300
360
|
query_params = opts[:query_params] || {}
|
@@ -312,7 +372,7 @@ module OryHydraClient
|
|
312
372
|
post_body = opts[:body]
|
313
373
|
|
314
374
|
# return_type
|
315
|
-
return_type = opts[:return_type] || '
|
375
|
+
return_type = opts[:return_type] || 'RecoveryRequest'
|
316
376
|
|
317
377
|
# auth_names
|
318
378
|
auth_names = opts[:auth_names] || []
|
@@ -328,13 +388,13 @@ module OryHydraClient
|
|
328
388
|
|
329
389
|
data, status_code, headers = @api_client.call_api(:GET, local_var_path, new_options)
|
330
390
|
if @api_client.config.debugging
|
331
|
-
@api_client.config.logger.debug "API called: AdminApi#
|
391
|
+
@api_client.config.logger.debug "API called: AdminApi#get_self_service_browser_recovery_request\nData: #{data.inspect}\nStatus code: #{status_code}\nHeaders: #{headers}"
|
332
392
|
end
|
333
393
|
return data, status_code, headers
|
334
394
|
end
|
335
395
|
|
336
396
|
# Get the request context of browser-based registration user flows
|
337
|
-
# This endpoint returns a registration request's context with, for example, error details and other information. When accessing this endpoint through ORY Kratos' Public API, ensure that cookies are set as they are required for CSRF to work. To prevent token scanning attacks, the public endpoint does not return 404 status codes
|
397
|
+
# This endpoint returns a registration request's context with, for example, error details and other information. When accessing this endpoint through ORY Kratos' Public API, ensure that cookies are set as they are required for CSRF to work. To prevent token scanning attacks, the public endpoint does not return 404 status codes. More information can be found at [ORY Kratos User Login and User Registration Documentation](https://www.ory.sh/docs/next/kratos/self-service/flows/user-login-user-registration).
|
338
398
|
# @param request [String] Request is the Registration Request ID The value for this parameter comes from `request` URL Query parameter sent to your application (e.g. `/registration?request=abcde`).
|
339
399
|
# @param [Hash] opts the optional parameters
|
340
400
|
# @return [RegistrationRequest]
|
@@ -344,7 +404,7 @@ module OryHydraClient
|
|
344
404
|
end
|
345
405
|
|
346
406
|
# Get the request context of browser-based registration user flows
|
347
|
-
# This endpoint returns a registration request's context with, for example, error details and other information. When accessing this endpoint through ORY Kratos' Public API, ensure that cookies are set as they are required for CSRF to work. To prevent token scanning attacks, the public endpoint does not return 404 status codes
|
407
|
+
# This endpoint returns a registration request's context with, for example, error details and other information. When accessing this endpoint through ORY Kratos' Public API, ensure that cookies are set as they are required for CSRF to work. To prevent token scanning attacks, the public endpoint does not return 404 status codes. More information can be found at [ORY Kratos User Login and User Registration Documentation](https://www.ory.sh/docs/next/kratos/self-service/flows/user-login-user-registration).
|
348
408
|
# @param request [String] Request is the Registration Request ID The value for this parameter comes from `request` URL Query parameter sent to your application (e.g. `/registration?request=abcde`).
|
349
409
|
# @param [Hash] opts the optional parameters
|
350
410
|
# @return [Array<(RegistrationRequest, Integer, Hash)>] RegistrationRequest data, response status code and response headers
|
@@ -396,10 +456,73 @@ module OryHydraClient
|
|
396
456
|
return data, status_code, headers
|
397
457
|
end
|
398
458
|
|
459
|
+
# Get the request context of browser-based settings flows
|
460
|
+
# 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).
|
461
|
+
# @param request [String] Request is the Login Request ID The value for this parameter comes from `request` URL Query parameter sent to your application (e.g. `/settingss?request=abcde`).
|
462
|
+
# @param [Hash] opts the optional parameters
|
463
|
+
# @return [SettingsRequest]
|
464
|
+
def get_self_service_browser_settings_request(request, opts = {})
|
465
|
+
data, _status_code, _headers = get_self_service_browser_settings_request_with_http_info(request, opts)
|
466
|
+
data
|
467
|
+
end
|
468
|
+
|
469
|
+
# Get the request context of browser-based settings flows
|
470
|
+
# 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).
|
471
|
+
# @param request [String] Request is the Login Request ID The value for this parameter comes from `request` URL Query parameter sent to your application (e.g. `/settingss?request=abcde`).
|
472
|
+
# @param [Hash] opts the optional parameters
|
473
|
+
# @return [Array<(SettingsRequest, Integer, Hash)>] SettingsRequest data, response status code and response headers
|
474
|
+
def get_self_service_browser_settings_request_with_http_info(request, opts = {})
|
475
|
+
if @api_client.config.debugging
|
476
|
+
@api_client.config.logger.debug 'Calling API: AdminApi.get_self_service_browser_settings_request ...'
|
477
|
+
end
|
478
|
+
# verify the required parameter 'request' is set
|
479
|
+
if @api_client.config.client_side_validation && request.nil?
|
480
|
+
fail ArgumentError, "Missing the required parameter 'request' when calling AdminApi.get_self_service_browser_settings_request"
|
481
|
+
end
|
482
|
+
# resource path
|
483
|
+
local_var_path = '/self-service/browser/flows/requests/settings'
|
484
|
+
|
485
|
+
# query parameters
|
486
|
+
query_params = opts[:query_params] || {}
|
487
|
+
query_params[:'request'] = request
|
488
|
+
|
489
|
+
# header parameters
|
490
|
+
header_params = opts[:header_params] || {}
|
491
|
+
# HTTP header 'Accept' (if needed)
|
492
|
+
header_params['Accept'] = @api_client.select_header_accept(['application/json'])
|
493
|
+
|
494
|
+
# form parameters
|
495
|
+
form_params = opts[:form_params] || {}
|
496
|
+
|
497
|
+
# http body (model)
|
498
|
+
post_body = opts[:body]
|
499
|
+
|
500
|
+
# return_type
|
501
|
+
return_type = opts[:return_type] || 'SettingsRequest'
|
502
|
+
|
503
|
+
# auth_names
|
504
|
+
auth_names = opts[:auth_names] || []
|
505
|
+
|
506
|
+
new_options = opts.merge(
|
507
|
+
:header_params => header_params,
|
508
|
+
:query_params => query_params,
|
509
|
+
:form_params => form_params,
|
510
|
+
:body => post_body,
|
511
|
+
:auth_names => auth_names,
|
512
|
+
:return_type => return_type
|
513
|
+
)
|
514
|
+
|
515
|
+
data, status_code, headers = @api_client.call_api(:GET, local_var_path, new_options)
|
516
|
+
if @api_client.config.debugging
|
517
|
+
@api_client.config.logger.debug "API called: AdminApi#get_self_service_browser_settings_request\nData: #{data.inspect}\nStatus code: #{status_code}\nHeaders: #{headers}"
|
518
|
+
end
|
519
|
+
return data, status_code, headers
|
520
|
+
end
|
521
|
+
|
399
522
|
# Get user-facing self-service errors
|
400
|
-
# This endpoint returns the error associated with a user-facing self service errors. When accessing this endpoint through ORY Kratos' Public API, ensure that cookies are set as they are required for CSRF to work. To prevent token scanning attacks, the public endpoint does not return 404 status codes
|
523
|
+
# This endpoint returns the error associated with a user-facing self service errors. When accessing this endpoint through ORY Kratos' Public API, ensure that cookies are set as they are required for CSRF to work. To prevent token scanning attacks, the public endpoint does not return 404 status codes. More information can be found at [ORY Kratos User User Facing Error Documentation](https://www.ory.sh/docs/kratos/self-service/flows/user-facing-errors).
|
401
524
|
# @param [Hash] opts the optional parameters
|
402
|
-
# @option opts [String] :
|
525
|
+
# @option opts [String] :error
|
403
526
|
# @return [ErrorContainer]
|
404
527
|
def get_self_service_error(opts = {})
|
405
528
|
data, _status_code, _headers = get_self_service_error_with_http_info(opts)
|
@@ -407,9 +530,9 @@ module OryHydraClient
|
|
407
530
|
end
|
408
531
|
|
409
532
|
# Get user-facing self-service errors
|
410
|
-
# This endpoint returns the error associated with a user-facing self service errors. When accessing this endpoint through ORY Kratos' Public API, ensure that cookies are set as they are required for CSRF to work. To prevent token scanning attacks, the public endpoint does not return 404 status codes
|
533
|
+
# This endpoint returns the error associated with a user-facing self service errors. When accessing this endpoint through ORY Kratos' Public API, ensure that cookies are set as they are required for CSRF to work. To prevent token scanning attacks, the public endpoint does not return 404 status codes. More information can be found at [ORY Kratos User User Facing Error Documentation](https://www.ory.sh/docs/kratos/self-service/flows/user-facing-errors).
|
411
534
|
# @param [Hash] opts the optional parameters
|
412
|
-
# @option opts [String] :
|
535
|
+
# @option opts [String] :error
|
413
536
|
# @return [Array<(ErrorContainer, Integer, Hash)>] ErrorContainer data, response status code and response headers
|
414
537
|
def get_self_service_error_with_http_info(opts = {})
|
415
538
|
if @api_client.config.debugging
|
@@ -420,7 +543,7 @@ module OryHydraClient
|
|
420
543
|
|
421
544
|
# query parameters
|
422
545
|
query_params = opts[:query_params] || {}
|
423
|
-
query_params[:'
|
546
|
+
query_params[:'error'] = opts[:'error'] if !opts[:'error'].nil?
|
424
547
|
|
425
548
|
# header parameters
|
426
549
|
header_params = opts[:header_params] || {}
|