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,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
|
+
|
data/docs/Form.md
CHANGED
@@ -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
|
|
12
12
|
## Code Sample
|
@@ -15,8 +15,8 @@ Name | Type | Description | Notes
|
|
15
15
|
require 'OryHydraClient'
|
16
16
|
|
17
17
|
instance = OryHydraClient::Form.new(action: null,
|
18
|
-
errors: null,
|
19
18
|
fields: null,
|
19
|
+
messages: null,
|
20
20
|
method: null)
|
21
21
|
```
|
22
22
|
|
data/docs/FormField.md
CHANGED
@@ -4,13 +4,13 @@
|
|
4
4
|
|
5
5
|
Name | Type | Description | Notes
|
6
6
|
------------ | ------------- | ------------- | -------------
|
7
|
-
**disabled** | **Boolean** | Disabled is the equivalent of
|
8
|
-
**
|
9
|
-
**name** | **String** | Name is the equivalent of
|
10
|
-
**pattern** | **String** | Pattern is the equivalent of
|
11
|
-
**required** | **Boolean** | Required is the equivalent of
|
12
|
-
**type** | **String** | Type is the equivalent of
|
13
|
-
**value** | [**Object**](.md) | Value is the equivalent of
|
7
|
+
**disabled** | **Boolean** | Disabled is the equivalent of `<input {{if .Disabled}}disabled{{end}}\">` | [optional]
|
8
|
+
**messages** | [**Array<Message>**](Message.md) | | [optional]
|
9
|
+
**name** | **String** | Name is the equivalent of `<input name=\"{{.Name}}\">` |
|
10
|
+
**pattern** | **String** | Pattern is the equivalent of `<input pattern=\"{{.Pattern}}\">` | [optional]
|
11
|
+
**required** | **Boolean** | Required is the equivalent of `<input required=\"{{.Required}}\">` | [optional]
|
12
|
+
**type** | **String** | Type is the equivalent of `<input type=\"{{.Type}}\">` |
|
13
|
+
**value** | [**Object**](.md) | Value is the equivalent of `<input value=\"{{.Value}}\">` | [optional]
|
14
14
|
|
15
15
|
## Code Sample
|
16
16
|
|
@@ -18,7 +18,7 @@ Name | Type | Description | Notes
|
|
18
18
|
require 'OryHydraClient'
|
19
19
|
|
20
20
|
instance = OryHydraClient::FormField.new(disabled: null,
|
21
|
-
|
21
|
+
messages: null,
|
22
22
|
name: null,
|
23
23
|
pattern: null,
|
24
24
|
required: null,
|
data/docs/GenericErrorPayload.md
CHANGED
@@ -6,7 +6,7 @@ Name | Type | Description | Notes
|
|
6
6
|
------------ | ------------- | ------------- | -------------
|
7
7
|
**code** | **Integer** | Code represents the error status code (404, 403, 401, ...). | [optional]
|
8
8
|
**debug** | **String** | Debug contains debug information. This is usually not available and has to be enabled. | [optional]
|
9
|
-
**details** | **
|
9
|
+
**details** | [**Object**](.md) | | [optional]
|
10
10
|
**message** | **String** | | [optional]
|
11
11
|
**reason** | **String** | | [optional]
|
12
12
|
**request** | **String** | | [optional]
|
data/docs/Identity.md
CHANGED
@@ -4,22 +4,24 @@
|
|
4
4
|
|
5
5
|
Name | Type | Description | Notes
|
6
6
|
------------ | ------------- | ------------- | -------------
|
7
|
-
**addresses** | [**Array<VerifiableAddress>**](VerifiableAddress.md) | | [optional]
|
8
7
|
**id** | **String** | |
|
8
|
+
**recovery_addresses** | [**Array<RecoveryAddress>**](RecoveryAddress.md) | RecoveryAddresses contains all the addresses that can be used to recover an identity. | [optional]
|
9
|
+
**schema_id** | **String** | SchemaID is the ID of the JSON Schema to be used for validating the identity's traits. |
|
10
|
+
**schema_url** | **String** | SchemaURL is the URL of the endpoint where the identity's traits schema can be fetched from. format: url | [optional]
|
9
11
|
**traits** | [**Object**](.md) | |
|
10
|
-
**
|
11
|
-
**traits_schema_url** | **String** | TraitsSchemaURL is the URL of the endpoint where the identity's traits schema can be fetched from. format: url | [optional]
|
12
|
+
**verifiable_addresses** | [**Array<VerifiableAddress>**](VerifiableAddress.md) | VerifiableAddresses contains all the addresses that can be verified by the user. | [optional]
|
12
13
|
|
13
14
|
## Code Sample
|
14
15
|
|
15
16
|
```ruby
|
16
17
|
require 'OryHydraClient'
|
17
18
|
|
18
|
-
instance = OryHydraClient::Identity.new(
|
19
|
-
|
19
|
+
instance = OryHydraClient::Identity.new(id: null,
|
20
|
+
recovery_addresses: null,
|
21
|
+
schema_id: null,
|
22
|
+
schema_url: null,
|
20
23
|
traits: null,
|
21
|
-
|
22
|
-
traits_schema_url: null)
|
24
|
+
verifiable_addresses: null)
|
23
25
|
```
|
24
26
|
|
25
27
|
|
data/docs/LoginRequest.md
CHANGED
@@ -6,8 +6,10 @@ Name | Type | Description | Notes
|
|
6
6
|
------------ | ------------- | ------------- | -------------
|
7
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
|
+
**forced** | **Boolean** | Forced stores whether this login request should enforce reauthentication. | [optional]
|
9
10
|
**id** | **String** | |
|
10
11
|
**issued_at** | **DateTime** | IssuedAt is the time (UTC) when the request occurred. |
|
12
|
+
**messages** | [**Array<Message>**](Message.md) | | [optional]
|
11
13
|
**methods** | [**Hash<String, LoginRequestMethod>**](LoginRequestMethod.md) | Methods contains context for all enabled login methods. If a login request has been processed, but for example the password is incorrect, this will contain error messages. |
|
12
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. |
|
13
15
|
|
@@ -18,8 +20,10 @@ require 'OryHydraClient'
|
|
18
20
|
|
19
21
|
instance = OryHydraClient::LoginRequest.new(active: null,
|
20
22
|
expires_at: null,
|
23
|
+
forced: null,
|
21
24
|
id: null,
|
22
25
|
issued_at: null,
|
26
|
+
messages: null,
|
23
27
|
methods: null,
|
24
28
|
request_url: null)
|
25
29
|
```
|
@@ -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::LoginRequestMethodConfig.new(action: null,
|
19
|
-
errors: null,
|
20
19
|
fields: null,
|
20
|
+
messages: null,
|
21
21
|
method: null,
|
22
22
|
providers: null)
|
23
23
|
```
|
data/docs/Message.md
ADDED
@@ -0,0 +1,23 @@
|
|
1
|
+
# OryHydraClient::Message
|
2
|
+
|
3
|
+
## Properties
|
4
|
+
|
5
|
+
Name | Type | Description | Notes
|
6
|
+
------------ | ------------- | ------------- | -------------
|
7
|
+
**context** | [**Object**](.md) | | [optional]
|
8
|
+
**id** | **Integer** | | [optional]
|
9
|
+
**text** | **String** | | [optional]
|
10
|
+
**type** | **String** | | [optional]
|
11
|
+
|
12
|
+
## Code Sample
|
13
|
+
|
14
|
+
```ruby
|
15
|
+
require 'OryHydraClient'
|
16
|
+
|
17
|
+
instance = OryHydraClient::Message.new(context: null,
|
18
|
+
id: null,
|
19
|
+
text: null,
|
20
|
+
type: null)
|
21
|
+
```
|
22
|
+
|
23
|
+
|
@@ -0,0 +1,19 @@
|
|
1
|
+
# OryHydraClient::ProviderCredentialsConfig
|
2
|
+
|
3
|
+
## Properties
|
4
|
+
|
5
|
+
Name | Type | Description | Notes
|
6
|
+
------------ | ------------- | ------------- | -------------
|
7
|
+
**provider** | **String** | | [optional]
|
8
|
+
**subject** | **String** | | [optional]
|
9
|
+
|
10
|
+
## Code Sample
|
11
|
+
|
12
|
+
```ruby
|
13
|
+
require 'OryHydraClient'
|
14
|
+
|
15
|
+
instance = OryHydraClient::ProviderCredentialsConfig.new(provider: null,
|
16
|
+
subject: null)
|
17
|
+
```
|
18
|
+
|
19
|
+
|
data/docs/PublicApi.md
CHANGED
@@ -4,30 +4,162 @@ All URIs are relative to *http://localhost*
|
|
4
4
|
|
5
5
|
Method | HTTP request | Description
|
6
6
|
------------- | ------------- | -------------
|
7
|
-
[**
|
8
|
-
[**
|
7
|
+
[**complete_self_service_browser_recovery_link_strategy_flow**](PublicApi.md#complete_self_service_browser_recovery_link_strategy_flow) | **POST** /self-service/browser/flows/recovery/link | Complete the browser-based recovery flow using a recovery link
|
8
|
+
[**complete_self_service_browser_settings_oidc_settings_flow**](PublicApi.md#complete_self_service_browser_settings_oidc_settings_flow) | **POST** /self-service/browser/flows/registration/strategies/oidc/settings/connections | Complete the browser-based settings flow for the OpenID Connect strategy
|
9
|
+
[**complete_self_service_browser_settings_password_strategy_flow**](PublicApi.md#complete_self_service_browser_settings_password_strategy_flow) | **POST** /self-service/browser/flows/settings/strategies/password | Complete the browser-based settings flow for the password strategy
|
10
|
+
[**complete_self_service_browser_settings_profile_strategy_flow**](PublicApi.md#complete_self_service_browser_settings_profile_strategy_flow) | **POST** /self-service/browser/flows/settings/strategies/profile | Complete the browser-based settings flow for profile data
|
11
|
+
[**complete_self_service_browser_verification_flow**](PublicApi.md#complete_self_service_browser_verification_flow) | **POST** /self-service/browser/flows/verification/{via}/complete | Complete the browser-based verification flows
|
12
|
+
[**get_schema**](PublicApi.md#get_schema) | **GET** /schemas/{id} |
|
9
13
|
[**get_self_service_browser_login_request**](PublicApi.md#get_self_service_browser_login_request) | **GET** /self-service/browser/flows/requests/login | Get the request context of browser-based login user flows
|
10
|
-
[**
|
14
|
+
[**get_self_service_browser_recovery_request**](PublicApi.md#get_self_service_browser_recovery_request) | **GET** /self-service/browser/flows/requests/recovery | Get the request context of browser-based recovery flows
|
11
15
|
[**get_self_service_browser_registration_request**](PublicApi.md#get_self_service_browser_registration_request) | **GET** /self-service/browser/flows/requests/registration | Get the request context of browser-based registration user flows
|
16
|
+
[**get_self_service_browser_settings_request**](PublicApi.md#get_self_service_browser_settings_request) | **GET** /self-service/browser/flows/requests/settings | Get the request context of browser-based settings flows
|
12
17
|
[**get_self_service_error**](PublicApi.md#get_self_service_error) | **GET** /self-service/errors | Get user-facing self-service errors
|
13
18
|
[**get_self_service_verification_request**](PublicApi.md#get_self_service_verification_request) | **GET** /self-service/browser/flows/requests/verification | Get the request context of browser-based verification flows
|
14
19
|
[**initialize_self_service_browser_login_flow**](PublicApi.md#initialize_self_service_browser_login_flow) | **GET** /self-service/browser/flows/login | Initialize browser-based login user flow
|
15
20
|
[**initialize_self_service_browser_logout_flow**](PublicApi.md#initialize_self_service_browser_logout_flow) | **GET** /self-service/browser/flows/logout | Initialize Browser-Based Logout User Flow
|
16
21
|
[**initialize_self_service_browser_registration_flow**](PublicApi.md#initialize_self_service_browser_registration_flow) | **GET** /self-service/browser/flows/registration | Initialize browser-based registration user flow
|
17
22
|
[**initialize_self_service_browser_verification_flow**](PublicApi.md#initialize_self_service_browser_verification_flow) | **GET** /self-service/browser/flows/verification/init/{via} | Initialize browser-based verification flow
|
18
|
-
[**
|
19
|
-
[**
|
23
|
+
[**initialize_self_service_recovery_flow**](PublicApi.md#initialize_self_service_recovery_flow) | **GET** /self-service/browser/flows/recovery | Initialize browser-based account recovery flow
|
24
|
+
[**initialize_self_service_settings_flow**](PublicApi.md#initialize_self_service_settings_flow) | **GET** /self-service/browser/flows/settings | Initialize browser-based settings flow
|
25
|
+
[**self_service_browser_verify**](PublicApi.md#self_service_browser_verify) | **GET** /self-service/browser/flows/verification/{via}/confirm/{code} | Complete the browser-based verification flows
|
20
26
|
[**whoami**](PublicApi.md#whoami) | **GET** /sessions/whoami | Check who the current HTTP session belongs to
|
21
27
|
|
22
28
|
|
23
29
|
|
24
|
-
##
|
30
|
+
## complete_self_service_browser_recovery_link_strategy_flow
|
25
31
|
|
26
|
-
>
|
32
|
+
> complete_self_service_browser_recovery_link_strategy_flow
|
27
33
|
|
28
|
-
Complete the browser-based
|
34
|
+
Complete the browser-based recovery flow using a recovery link
|
29
35
|
|
30
|
-
|
36
|
+
> This endpoint is NOT INTENDED for API clients and only works with browsers (Chrome, Firefox, ...) and HTML Forms. More information can be found at [ORY Kratos Account Recovery Documentation](../self-service/flows/password-reset-account-recovery).
|
37
|
+
|
38
|
+
### Example
|
39
|
+
|
40
|
+
```ruby
|
41
|
+
# load the gem
|
42
|
+
require 'ory-kratos-client'
|
43
|
+
|
44
|
+
api_instance = OryHydraClient::PublicApi.new
|
45
|
+
|
46
|
+
begin
|
47
|
+
#Complete the browser-based recovery flow using a recovery link
|
48
|
+
api_instance.complete_self_service_browser_recovery_link_strategy_flow
|
49
|
+
rescue OryHydraClient::ApiError => e
|
50
|
+
puts "Exception when calling PublicApi->complete_self_service_browser_recovery_link_strategy_flow: #{e}"
|
51
|
+
end
|
52
|
+
```
|
53
|
+
|
54
|
+
### Parameters
|
55
|
+
|
56
|
+
This endpoint does not need any parameter.
|
57
|
+
|
58
|
+
### Return type
|
59
|
+
|
60
|
+
nil (empty response body)
|
61
|
+
|
62
|
+
### Authorization
|
63
|
+
|
64
|
+
No authorization required
|
65
|
+
|
66
|
+
### HTTP request headers
|
67
|
+
|
68
|
+
- **Content-Type**: Not defined
|
69
|
+
- **Accept**: application/json
|
70
|
+
|
71
|
+
|
72
|
+
## complete_self_service_browser_settings_oidc_settings_flow
|
73
|
+
|
74
|
+
> complete_self_service_browser_settings_oidc_settings_flow
|
75
|
+
|
76
|
+
Complete the browser-based settings flow for the OpenID Connect strategy
|
77
|
+
|
78
|
+
This endpoint completes a browser-based settings flow. This is usually achieved by POSTing data to this endpoint. > This endpoint is NOT INTENDED for API clients and only works with browsers (Chrome, Firefox, ...) and HTML Forms. More information can be found at [ORY Kratos User Settings & Profile Management Documentation](../self-service/flows/user-settings).
|
79
|
+
|
80
|
+
### Example
|
81
|
+
|
82
|
+
```ruby
|
83
|
+
# load the gem
|
84
|
+
require 'ory-kratos-client'
|
85
|
+
|
86
|
+
api_instance = OryHydraClient::PublicApi.new
|
87
|
+
|
88
|
+
begin
|
89
|
+
#Complete the browser-based settings flow for the OpenID Connect strategy
|
90
|
+
api_instance.complete_self_service_browser_settings_oidc_settings_flow
|
91
|
+
rescue OryHydraClient::ApiError => e
|
92
|
+
puts "Exception when calling PublicApi->complete_self_service_browser_settings_oidc_settings_flow: #{e}"
|
93
|
+
end
|
94
|
+
```
|
95
|
+
|
96
|
+
### Parameters
|
97
|
+
|
98
|
+
This endpoint does not need any parameter.
|
99
|
+
|
100
|
+
### Return type
|
101
|
+
|
102
|
+
nil (empty response body)
|
103
|
+
|
104
|
+
### Authorization
|
105
|
+
|
106
|
+
No authorization required
|
107
|
+
|
108
|
+
### HTTP request headers
|
109
|
+
|
110
|
+
- **Content-Type**: Not defined
|
111
|
+
- **Accept**: application/json
|
112
|
+
|
113
|
+
|
114
|
+
## complete_self_service_browser_settings_password_strategy_flow
|
115
|
+
|
116
|
+
> complete_self_service_browser_settings_password_strategy_flow
|
117
|
+
|
118
|
+
Complete the browser-based settings flow for the password strategy
|
119
|
+
|
120
|
+
This endpoint completes a browser-based settings flow. This is usually achieved by POSTing data to this endpoint. > This endpoint is NOT INTENDED for API clients and only works with browsers (Chrome, Firefox, ...) and HTML Forms. More information can be found at [ORY Kratos User Settings & Profile Management Documentation](../self-service/flows/user-settings).
|
121
|
+
|
122
|
+
### Example
|
123
|
+
|
124
|
+
```ruby
|
125
|
+
# load the gem
|
126
|
+
require 'ory-kratos-client'
|
127
|
+
|
128
|
+
api_instance = OryHydraClient::PublicApi.new
|
129
|
+
|
130
|
+
begin
|
131
|
+
#Complete the browser-based settings flow for the password strategy
|
132
|
+
api_instance.complete_self_service_browser_settings_password_strategy_flow
|
133
|
+
rescue OryHydraClient::ApiError => e
|
134
|
+
puts "Exception when calling PublicApi->complete_self_service_browser_settings_password_strategy_flow: #{e}"
|
135
|
+
end
|
136
|
+
```
|
137
|
+
|
138
|
+
### Parameters
|
139
|
+
|
140
|
+
This endpoint does not need any parameter.
|
141
|
+
|
142
|
+
### Return type
|
143
|
+
|
144
|
+
nil (empty response body)
|
145
|
+
|
146
|
+
### Authorization
|
147
|
+
|
148
|
+
No authorization required
|
149
|
+
|
150
|
+
### HTTP request headers
|
151
|
+
|
152
|
+
- **Content-Type**: Not defined
|
153
|
+
- **Accept**: application/json
|
154
|
+
|
155
|
+
|
156
|
+
## complete_self_service_browser_settings_profile_strategy_flow
|
157
|
+
|
158
|
+
> complete_self_service_browser_settings_profile_strategy_flow(request, body)
|
159
|
+
|
160
|
+
Complete the browser-based settings flow for profile data
|
161
|
+
|
162
|
+
This endpoint completes a browser-based settings flow. This is usually achieved by POSTing data to this endpoint. If the provided profile data is valid against the Identity's Traits JSON Schema, the data will be updated and the browser redirected to `url.settings_ui` for further steps. > This endpoint is NOT INTENDED for API clients and only works with browsers (Chrome, Firefox, ...) and HTML Forms. More information can be found at [ORY Kratos User Settings & Profile Management Documentation](../self-service/flows/user-settings).
|
31
163
|
|
32
164
|
### Example
|
33
165
|
|
@@ -37,13 +169,13 @@ require 'ory-kratos-client'
|
|
37
169
|
|
38
170
|
api_instance = OryHydraClient::PublicApi.new
|
39
171
|
request = 'request_example' # String | Request is the request ID.
|
40
|
-
body = OryHydraClient::
|
172
|
+
body = OryHydraClient::CompleteSelfServiceBrowserSettingsStrategyProfileFlowPayload.new # CompleteSelfServiceBrowserSettingsStrategyProfileFlowPayload |
|
41
173
|
|
42
174
|
begin
|
43
|
-
#Complete the browser-based profile
|
44
|
-
api_instance.
|
175
|
+
#Complete the browser-based settings flow for profile data
|
176
|
+
api_instance.complete_self_service_browser_settings_profile_strategy_flow(request, body)
|
45
177
|
rescue OryHydraClient::ApiError => e
|
46
|
-
puts "Exception when calling PublicApi->
|
178
|
+
puts "Exception when calling PublicApi->complete_self_service_browser_settings_profile_strategy_flow: #{e}"
|
47
179
|
end
|
48
180
|
```
|
49
181
|
|
@@ -53,7 +185,7 @@ end
|
|
53
185
|
Name | Type | Description | Notes
|
54
186
|
------------- | ------------- | ------------- | -------------
|
55
187
|
**request** | **String**| Request is the request ID. |
|
56
|
-
**body** | [**
|
188
|
+
**body** | [**CompleteSelfServiceBrowserSettingsStrategyProfileFlowPayload**](CompleteSelfServiceBrowserSettingsStrategyProfileFlowPayload.md)| |
|
57
189
|
|
58
190
|
### Return type
|
59
191
|
|
@@ -71,11 +203,11 @@ No authorization required
|
|
71
203
|
|
72
204
|
## complete_self_service_browser_verification_flow
|
73
205
|
|
74
|
-
> complete_self_service_browser_verification_flow(request)
|
206
|
+
> complete_self_service_browser_verification_flow(request, via)
|
75
207
|
|
76
|
-
Complete the browser-based
|
208
|
+
Complete the browser-based verification flows
|
77
209
|
|
78
|
-
This endpoint completes a browser-based
|
210
|
+
This endpoint completes a browser-based verification flow. This is usually achieved by POSTing data to this endpoint. If the provided data is valid against the Identity's Traits JSON Schema, the data will be updated and the browser redirected to `url.settings_ui` for further steps. > This endpoint is NOT INTENDED for API clients and only works with browsers (Chrome, Firefox, ...) and HTML Forms. More information can be found at [ORY Kratos Email and Phone Verification Documentation](https://www.ory.sh/docs/kratos/selfservice/flows/verify-email-account-activation).
|
79
211
|
|
80
212
|
### Example
|
81
213
|
|
@@ -85,10 +217,11 @@ require 'ory-kratos-client'
|
|
85
217
|
|
86
218
|
api_instance = OryHydraClient::PublicApi.new
|
87
219
|
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`).
|
220
|
+
via = 'via_example' # String | What to verify Currently only \"email\" is supported.
|
88
221
|
|
89
222
|
begin
|
90
|
-
#Complete the browser-based
|
91
|
-
api_instance.complete_self_service_browser_verification_flow(request)
|
223
|
+
#Complete the browser-based verification flows
|
224
|
+
api_instance.complete_self_service_browser_verification_flow(request, via)
|
92
225
|
rescue OryHydraClient::ApiError => e
|
93
226
|
puts "Exception when calling PublicApi->complete_self_service_browser_verification_flow: #{e}"
|
94
227
|
end
|
@@ -100,6 +233,7 @@ end
|
|
100
233
|
Name | Type | Description | Notes
|
101
234
|
------------- | ------------- | ------------- | -------------
|
102
235
|
**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`). |
|
236
|
+
**via** | **String**| What to verify Currently only \"email\" is supported. |
|
103
237
|
|
104
238
|
### Return type
|
105
239
|
|
@@ -115,13 +249,59 @@ No authorization required
|
|
115
249
|
- **Accept**: application/json
|
116
250
|
|
117
251
|
|
252
|
+
## get_schema
|
253
|
+
|
254
|
+
> Object get_schema(id)
|
255
|
+
|
256
|
+
|
257
|
+
|
258
|
+
Get a traits schema definition
|
259
|
+
|
260
|
+
### Example
|
261
|
+
|
262
|
+
```ruby
|
263
|
+
# load the gem
|
264
|
+
require 'ory-kratos-client'
|
265
|
+
|
266
|
+
api_instance = OryHydraClient::PublicApi.new
|
267
|
+
id = 'id_example' # String | ID must be set to the ID of schema you want to get
|
268
|
+
|
269
|
+
begin
|
270
|
+
result = api_instance.get_schema(id)
|
271
|
+
p result
|
272
|
+
rescue OryHydraClient::ApiError => e
|
273
|
+
puts "Exception when calling PublicApi->get_schema: #{e}"
|
274
|
+
end
|
275
|
+
```
|
276
|
+
|
277
|
+
### Parameters
|
278
|
+
|
279
|
+
|
280
|
+
Name | Type | Description | Notes
|
281
|
+
------------- | ------------- | ------------- | -------------
|
282
|
+
**id** | **String**| ID must be set to the ID of schema you want to get |
|
283
|
+
|
284
|
+
### Return type
|
285
|
+
|
286
|
+
**Object**
|
287
|
+
|
288
|
+
### Authorization
|
289
|
+
|
290
|
+
No authorization required
|
291
|
+
|
292
|
+
### HTTP request headers
|
293
|
+
|
294
|
+
- **Content-Type**: Not defined
|
295
|
+
- **Accept**: application/json
|
296
|
+
|
297
|
+
|
118
298
|
## get_self_service_browser_login_request
|
119
299
|
|
120
300
|
> LoginRequest get_self_service_browser_login_request(request)
|
121
301
|
|
122
302
|
Get the request context of browser-based login user flows
|
123
303
|
|
124
|
-
This endpoint returns a login request's context with, for example, error details and other information. When accessing this endpoint through ORY Kratos' Public API, ensure that cookies are set as they are required for CSRF to work. To prevent token scanning attacks, the public endpoint does not return 404 status codes
|
304
|
+
This endpoint returns a login request's context with, for example, error details and other information. When accessing this endpoint through ORY Kratos' Public API, ensure that cookies are set as they are required for CSRF to work. To prevent token scanning attacks, the public endpoint does not return 404 status codes. More information can be found at [ORY Kratos User Login and User Registration Documentation](https://www.ory.sh/docs/next/kratos/self-service/flows/user-login-user-registration).
|
125
305
|
|
126
306
|
### Example
|
127
307
|
|
@@ -162,13 +342,13 @@ No authorization required
|
|
162
342
|
- **Accept**: application/json
|
163
343
|
|
164
344
|
|
165
|
-
##
|
345
|
+
## get_self_service_browser_recovery_request
|
166
346
|
|
167
|
-
>
|
347
|
+
> RecoveryRequest get_self_service_browser_recovery_request(request)
|
168
348
|
|
169
|
-
Get the request context of browser-based
|
349
|
+
Get the request context of browser-based recovery flows
|
170
350
|
|
171
|
-
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
|
351
|
+
When accessing this endpoint through ORY Kratos' Public API, ensure that cookies are set as they are required for checking the auth session. To prevent scanning attacks, the public endpoint does not return 404 status codes but instead 403 or 500. More information can be found at [ORY Kratos Account Recovery Documentation](../self-service/flows/password-reset-account-recovery).
|
172
352
|
|
173
353
|
### Example
|
174
354
|
|
@@ -177,14 +357,14 @@ When accessing this endpoint through ORY Kratos' Public API, ensure that cookies
|
|
177
357
|
require 'ory-kratos-client'
|
178
358
|
|
179
359
|
api_instance = OryHydraClient::PublicApi.new
|
180
|
-
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. `/
|
360
|
+
request = 'request_example' # String | Request is the Login Request ID The value for this parameter comes from `request` URL Query parameter sent to your application (e.g. `/recover?request=abcde`).
|
181
361
|
|
182
362
|
begin
|
183
|
-
#Get the request context of browser-based
|
184
|
-
result = api_instance.
|
363
|
+
#Get the request context of browser-based recovery flows
|
364
|
+
result = api_instance.get_self_service_browser_recovery_request(request)
|
185
365
|
p result
|
186
366
|
rescue OryHydraClient::ApiError => e
|
187
|
-
puts "Exception when calling PublicApi->
|
367
|
+
puts "Exception when calling PublicApi->get_self_service_browser_recovery_request: #{e}"
|
188
368
|
end
|
189
369
|
```
|
190
370
|
|
@@ -193,11 +373,11 @@ end
|
|
193
373
|
|
194
374
|
Name | Type | Description | Notes
|
195
375
|
------------- | ------------- | ------------- | -------------
|
196
|
-
**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. `/
|
376
|
+
**request** | **String**| Request is the Login Request ID The value for this parameter comes from `request` URL Query parameter sent to your application (e.g. `/recover?request=abcde`). |
|
197
377
|
|
198
378
|
### Return type
|
199
379
|
|
200
|
-
[**
|
380
|
+
[**RecoveryRequest**](RecoveryRequest.md)
|
201
381
|
|
202
382
|
### Authorization
|
203
383
|
|
@@ -215,7 +395,7 @@ No authorization required
|
|
215
395
|
|
216
396
|
Get the request context of browser-based registration user flows
|
217
397
|
|
218
|
-
This endpoint returns a registration request's context with, for example, error details and other information. When accessing this endpoint through ORY Kratos' Public API, ensure that cookies are set as they are required for CSRF to work. To prevent token scanning attacks, the public endpoint does not return 404 status codes
|
398
|
+
This endpoint returns a registration request's context with, for example, error details and other information. When accessing this endpoint through ORY Kratos' Public API, ensure that cookies are set as they are required for CSRF to work. To prevent token scanning attacks, the public endpoint does not return 404 status codes. More information can be found at [ORY Kratos User Login and User Registration Documentation](https://www.ory.sh/docs/next/kratos/self-service/flows/user-login-user-registration).
|
219
399
|
|
220
400
|
### Example
|
221
401
|
|
@@ -256,13 +436,60 @@ No authorization required
|
|
256
436
|
- **Accept**: application/json
|
257
437
|
|
258
438
|
|
439
|
+
## get_self_service_browser_settings_request
|
440
|
+
|
441
|
+
> SettingsRequest get_self_service_browser_settings_request(request)
|
442
|
+
|
443
|
+
Get the request context of browser-based settings flows
|
444
|
+
|
445
|
+
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).
|
446
|
+
|
447
|
+
### Example
|
448
|
+
|
449
|
+
```ruby
|
450
|
+
# load the gem
|
451
|
+
require 'ory-kratos-client'
|
452
|
+
|
453
|
+
api_instance = OryHydraClient::PublicApi.new
|
454
|
+
request = 'request_example' # String | Request is the Login Request ID The value for this parameter comes from `request` URL Query parameter sent to your application (e.g. `/settingss?request=abcde`).
|
455
|
+
|
456
|
+
begin
|
457
|
+
#Get the request context of browser-based settings flows
|
458
|
+
result = api_instance.get_self_service_browser_settings_request(request)
|
459
|
+
p result
|
460
|
+
rescue OryHydraClient::ApiError => e
|
461
|
+
puts "Exception when calling PublicApi->get_self_service_browser_settings_request: #{e}"
|
462
|
+
end
|
463
|
+
```
|
464
|
+
|
465
|
+
### Parameters
|
466
|
+
|
467
|
+
|
468
|
+
Name | Type | Description | Notes
|
469
|
+
------------- | ------------- | ------------- | -------------
|
470
|
+
**request** | **String**| Request is the Login Request ID The value for this parameter comes from `request` URL Query parameter sent to your application (e.g. `/settingss?request=abcde`). |
|
471
|
+
|
472
|
+
### Return type
|
473
|
+
|
474
|
+
[**SettingsRequest**](SettingsRequest.md)
|
475
|
+
|
476
|
+
### Authorization
|
477
|
+
|
478
|
+
No authorization required
|
479
|
+
|
480
|
+
### HTTP request headers
|
481
|
+
|
482
|
+
- **Content-Type**: Not defined
|
483
|
+
- **Accept**: application/json
|
484
|
+
|
485
|
+
|
259
486
|
## get_self_service_error
|
260
487
|
|
261
488
|
> ErrorContainer get_self_service_error(opts)
|
262
489
|
|
263
490
|
Get user-facing self-service errors
|
264
491
|
|
265
|
-
This endpoint returns the error associated with a user-facing self service errors. When accessing this endpoint through ORY Kratos' Public API, ensure that cookies are set as they are required for CSRF to work. To prevent token scanning attacks, the public endpoint does not return 404 status codes
|
492
|
+
This endpoint returns the error associated with a user-facing self service errors. When accessing this endpoint through ORY Kratos' Public API, ensure that cookies are set as they are required for CSRF to work. To prevent token scanning attacks, the public endpoint does not return 404 status codes. More information can be found at [ORY Kratos User User Facing Error Documentation](https://www.ory.sh/docs/kratos/self-service/flows/user-facing-errors).
|
266
493
|
|
267
494
|
### Example
|
268
495
|
|
@@ -272,7 +499,7 @@ require 'ory-kratos-client'
|
|
272
499
|
|
273
500
|
api_instance = OryHydraClient::PublicApi.new
|
274
501
|
opts = {
|
275
|
-
|
502
|
+
error: 'error_example' # String |
|
276
503
|
}
|
277
504
|
|
278
505
|
begin
|
@@ -289,7 +516,7 @@ end
|
|
289
516
|
|
290
517
|
Name | Type | Description | Notes
|
291
518
|
------------- | ------------- | ------------- | -------------
|
292
|
-
**
|
519
|
+
**error** | **String**| | [optional]
|
293
520
|
|
294
521
|
### Return type
|
295
522
|
|
@@ -354,11 +581,11 @@ No authorization required
|
|
354
581
|
|
355
582
|
## initialize_self_service_browser_login_flow
|
356
583
|
|
357
|
-
> initialize_self_service_browser_login_flow
|
584
|
+
> initialize_self_service_browser_login_flow(opts)
|
358
585
|
|
359
586
|
Initialize browser-based login user flow
|
360
587
|
|
361
|
-
This endpoint initializes a browser-based user login flow. Once initialized, the browser will be redirected to `
|
588
|
+
This endpoint initializes a browser-based user login flow. Once initialized, the browser will be redirected to `selfservice.flows.login.ui_url` with the request ID set as a query parameter. If a valid user session exists already, the browser will be redirected to `urls.default_redirect_url`. > This endpoint is NOT INTENDED for API clients and only works with browsers (Chrome, Firefox, ...). More information can be found at [ORY Kratos User Login and User Registration Documentation](https://www.ory.sh/docs/next/kratos/self-service/flows/user-login-user-registration).
|
362
589
|
|
363
590
|
### Example
|
364
591
|
|
@@ -367,10 +594,13 @@ This endpoint initializes a browser-based user login flow. Once initialized, the
|
|
367
594
|
require 'ory-kratos-client'
|
368
595
|
|
369
596
|
api_instance = OryHydraClient::PublicApi.new
|
597
|
+
opts = {
|
598
|
+
refresh: true # Boolean | Refresh a login session If set to true, this will refresh an existing login session by asking the user to sign in again. This will reset the authenticated_at time of the session.
|
599
|
+
}
|
370
600
|
|
371
601
|
begin
|
372
602
|
#Initialize browser-based login user flow
|
373
|
-
api_instance.initialize_self_service_browser_login_flow
|
603
|
+
api_instance.initialize_self_service_browser_login_flow(opts)
|
374
604
|
rescue OryHydraClient::ApiError => e
|
375
605
|
puts "Exception when calling PublicApi->initialize_self_service_browser_login_flow: #{e}"
|
376
606
|
end
|
@@ -378,7 +608,10 @@ end
|
|
378
608
|
|
379
609
|
### Parameters
|
380
610
|
|
381
|
-
|
611
|
+
|
612
|
+
Name | Type | Description | Notes
|
613
|
+
------------- | ------------- | ------------- | -------------
|
614
|
+
**refresh** | **Boolean**| Refresh a login session If set to true, this will refresh an existing login session by asking the user to sign in again. This will reset the authenticated_at time of the session. | [optional]
|
382
615
|
|
383
616
|
### Return type
|
384
617
|
|
@@ -442,7 +675,7 @@ No authorization required
|
|
442
675
|
|
443
676
|
Initialize browser-based registration user flow
|
444
677
|
|
445
|
-
This endpoint initializes a browser-based user registration flow. Once initialized, the browser will be redirected to `
|
678
|
+
This endpoint initializes a browser-based user registration flow. Once initialized, the browser will be redirected to `selfservice.flows.registration.ui_url` with the request ID set as a query parameter. If a valid user session exists already, the browser will be redirected to `urls.default_redirect_url`. > This endpoint is NOT INTENDED for API clients and only works with browsers (Chrome, Firefox, ...). More information can be found at [ORY Kratos User Login and User Registration Documentation](https://www.ory.sh/docs/next/kratos/self-service/flows/user-login-user-registration).
|
446
679
|
|
447
680
|
### Example
|
448
681
|
|
@@ -484,7 +717,7 @@ No authorization required
|
|
484
717
|
|
485
718
|
Initialize browser-based verification flow
|
486
719
|
|
487
|
-
This endpoint initializes a browser-based
|
720
|
+
This endpoint initializes a browser-based verification flow. Once initialized, the browser will be redirected to `selfservice.flows.settings.ui_url` with the request ID set as a query parameter. If no valid user session exists, a login flow will be initialized. > This endpoint is NOT INTENDED for API clients and only works with browsers (Chrome, Firefox, ...). More information can be found at [ORY Kratos Email and Phone Verification Documentation](https://www.ory.sh/docs/kratos/selfservice/flows/verify-email-account-activation).
|
488
721
|
|
489
722
|
### Example
|
490
723
|
|
@@ -524,13 +757,13 @@ No authorization required
|
|
524
757
|
- **Accept**: application/json
|
525
758
|
|
526
759
|
|
527
|
-
##
|
760
|
+
## initialize_self_service_recovery_flow
|
528
761
|
|
529
|
-
>
|
762
|
+
> initialize_self_service_recovery_flow
|
530
763
|
|
531
|
-
Initialize browser-based
|
764
|
+
Initialize browser-based account recovery flow
|
532
765
|
|
533
|
-
This endpoint initializes a browser-based
|
766
|
+
This endpoint initializes a browser-based account recovery flow. Once initialized, the browser will be redirected to `selfservice.flows.recovery.ui_url` with the request ID set as a query parameter. If a valid user session exists, the request is aborted. > This endpoint is NOT INTENDED for API clients and only works with browsers (Chrome, Firefox, ...). More information can be found at [ORY Kratos Account Recovery Documentation](../self-service/flows/password-reset-account-recovery).
|
534
767
|
|
535
768
|
### Example
|
536
769
|
|
@@ -541,10 +774,52 @@ require 'ory-kratos-client'
|
|
541
774
|
api_instance = OryHydraClient::PublicApi.new
|
542
775
|
|
543
776
|
begin
|
544
|
-
#Initialize browser-based
|
545
|
-
api_instance.
|
777
|
+
#Initialize browser-based account recovery flow
|
778
|
+
api_instance.initialize_self_service_recovery_flow
|
546
779
|
rescue OryHydraClient::ApiError => e
|
547
|
-
puts "Exception when calling PublicApi->
|
780
|
+
puts "Exception when calling PublicApi->initialize_self_service_recovery_flow: #{e}"
|
781
|
+
end
|
782
|
+
```
|
783
|
+
|
784
|
+
### Parameters
|
785
|
+
|
786
|
+
This endpoint does not need any parameter.
|
787
|
+
|
788
|
+
### Return type
|
789
|
+
|
790
|
+
nil (empty response body)
|
791
|
+
|
792
|
+
### Authorization
|
793
|
+
|
794
|
+
No authorization required
|
795
|
+
|
796
|
+
### HTTP request headers
|
797
|
+
|
798
|
+
- **Content-Type**: Not defined
|
799
|
+
- **Accept**: application/json
|
800
|
+
|
801
|
+
|
802
|
+
## initialize_self_service_settings_flow
|
803
|
+
|
804
|
+
> initialize_self_service_settings_flow
|
805
|
+
|
806
|
+
Initialize browser-based settings flow
|
807
|
+
|
808
|
+
This endpoint initializes a browser-based settings flow. Once initialized, the browser will be redirected to `selfservice.flows.settings.ui_url` with the request ID set as a query parameter. If no valid user session exists, a login flow will be initialized. > This endpoint is NOT INTENDED for API clients and only works with browsers (Chrome, Firefox, ...). More information can be found at [ORY Kratos User Settings & Profile Management Documentation](../self-service/flows/user-settings).
|
809
|
+
|
810
|
+
### Example
|
811
|
+
|
812
|
+
```ruby
|
813
|
+
# load the gem
|
814
|
+
require 'ory-kratos-client'
|
815
|
+
|
816
|
+
api_instance = OryHydraClient::PublicApi.new
|
817
|
+
|
818
|
+
begin
|
819
|
+
#Initialize browser-based settings flow
|
820
|
+
api_instance.initialize_self_service_settings_flow
|
821
|
+
rescue OryHydraClient::ApiError => e
|
822
|
+
puts "Exception when calling PublicApi->initialize_self_service_settings_flow: #{e}"
|
548
823
|
end
|
549
824
|
```
|
550
825
|
|
@@ -568,7 +843,7 @@ No authorization required
|
|
568
843
|
|
569
844
|
## self_service_browser_verify
|
570
845
|
|
571
|
-
> self_service_browser_verify(code)
|
846
|
+
> self_service_browser_verify(code, via)
|
572
847
|
|
573
848
|
Complete the browser-based verification flows
|
574
849
|
|
@@ -582,10 +857,11 @@ require 'ory-kratos-client'
|
|
582
857
|
|
583
858
|
api_instance = OryHydraClient::PublicApi.new
|
584
859
|
code = 'code_example' # String |
|
860
|
+
via = 'via_example' # String | What to verify Currently only \"email\" is supported.
|
585
861
|
|
586
862
|
begin
|
587
863
|
#Complete the browser-based verification flows
|
588
|
-
api_instance.self_service_browser_verify(code)
|
864
|
+
api_instance.self_service_browser_verify(code, via)
|
589
865
|
rescue OryHydraClient::ApiError => e
|
590
866
|
puts "Exception when calling PublicApi->self_service_browser_verify: #{e}"
|
591
867
|
end
|
@@ -597,6 +873,7 @@ end
|
|
597
873
|
Name | Type | Description | Notes
|
598
874
|
------------- | ------------- | ------------- | -------------
|
599
875
|
**code** | **String**| |
|
876
|
+
**via** | **String**| What to verify Currently only \"email\" is supported. |
|
600
877
|
|
601
878
|
### Return type
|
602
879
|
|
@@ -618,7 +895,7 @@ No authorization required
|
|
618
895
|
|
619
896
|
Check who the current HTTP session belongs to
|
620
897
|
|
621
|
-
Uses the HTTP Headers in the GET request to determine (e.g. by using checking the cookies) who is authenticated. Returns a session object or 401 if the credentials are invalid or no credentials were sent. This endpoint is useful for reverse proxies and API Gateways.
|
898
|
+
Uses the HTTP Headers in the GET request to determine (e.g. by using checking the cookies) who is authenticated. Returns a session object in the body or 401 if the credentials are invalid or no credentials were sent. Additionally when the request it successful it adds the user ID to the 'X-Kratos-Authenticated-Identity-Id' header in the response. This endpoint is useful for reverse proxies and API Gateways.
|
622
899
|
|
623
900
|
### Example
|
624
901
|
|