ory-kratos-client 0.1.0.alpha5 → 0.3.0.alpha1
Sign up to get free protection for your applications and to get access to all the features.
- checksums.yaml +4 -4
- data/README.md +27 -11
- data/docs/AdminApi.md +116 -21
- data/docs/CommonApi.md +116 -21
- data/docs/CompleteSelfServiceBrowserSettingsStrategyProfileFlowPayload.md +19 -0
- data/docs/Form.md +3 -3
- data/docs/FormField.md +7 -7
- data/docs/GenericErrorPayload.md +1 -1
- data/docs/Identity.md +4 -2
- data/docs/LoginRequest.md +7 -5
- data/docs/LoginRequestMethod.md +2 -2
- data/docs/LoginRequestMethodConfig.md +10 -1
- data/docs/ProfileManagementRequest.md +7 -7
- data/docs/ProviderCredentialsConfig.md +19 -0
- data/docs/PublicApi.md +365 -39
- data/docs/RegistrationRequest.md +5 -5
- data/docs/RegistrationRequestMethodConfig.md +10 -1
- data/docs/RequestMethodConfig.md +23 -0
- data/docs/Session.md +5 -5
- data/docs/SettingsRequest.md +31 -0
- data/docs/SettingsRequestMethod.md +19 -0
- data/docs/VerifiableAddress.md +27 -0
- data/docs/VerificationRequest.md +29 -0
- data/lib/ory-kratos-client.rb +8 -3
- data/lib/ory-kratos-client/api/admin_api.rb +159 -36
- data/lib/ory-kratos-client/api/common_api.rb +159 -36
- data/lib/ory-kratos-client/api/health_api.rb +1 -1
- data/lib/ory-kratos-client/api/public_api.rb +493 -59
- data/lib/ory-kratos-client/api/version_api.rb +1 -1
- data/lib/ory-kratos-client/api_client.rb +1 -1
- data/lib/ory-kratos-client/api_error.rb +1 -1
- data/lib/ory-kratos-client/configuration.rb +1 -1
- data/lib/ory-kratos-client/models/complete_self_service_browser_profile_management_flow_payload.rb +1 -1
- 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.rb +1 -1
- data/lib/ory-kratos-client/models/error_container.rb +1 -1
- data/lib/ory-kratos-client/models/form.rb +17 -2
- data/lib/ory-kratos-client/models/form_field.rb +18 -9
- data/lib/ory-kratos-client/models/generic_error.rb +1 -1
- data/lib/ory-kratos-client/models/generic_error_payload.rb +3 -4
- data/lib/ory-kratos-client/models/health_not_ready_status.rb +1 -1
- data/lib/ory-kratos-client/models/health_status.rb +1 -1
- data/lib/ory-kratos-client/models/identity.rb +18 -2
- data/lib/ory-kratos-client/models/login_request.rb +37 -2
- data/lib/ory-kratos-client/models/login_request_method.rb +11 -1
- data/lib/ory-kratos-client/models/login_request_method_config.rb +74 -3
- data/lib/ory-kratos-client/models/profile_management_request.rb +36 -1
- data/lib/ory-kratos-client/models/provider_credentials_config.rb +215 -0
- data/lib/ory-kratos-client/models/registration_request.rb +26 -1
- data/lib/ory-kratos-client/models/registration_request_method.rb +1 -1
- data/lib/ory-kratos-client/models/registration_request_method_config.rb +74 -3
- data/lib/ory-kratos-client/models/request_method_config.rb +256 -0
- data/lib/ory-kratos-client/models/session.rb +26 -1
- 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 +276 -0
- data/lib/ory-kratos-client/models/verification_request.rb +265 -0
- data/lib/ory-kratos-client/models/version.rb +1 -1
- data/lib/ory-kratos-client/version.rb +2 -2
- data/ory-kratos-client.gemspec +1 -1
- data/spec/models/complete_self_service_browser_settings_strategy_profile_flow_payload_spec.rb +47 -0
- data/spec/models/provider_credentials_config_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
- data/spec/models/verifiable_address_spec.rb +71 -0
- data/spec/models/verification_request_spec.rb +77 -0
- metadata +43 -15
@@ -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,10 +4,10 @@
|
|
4
4
|
|
5
5
|
Name | Type | Description | Notes
|
6
6
|
------------ | ------------- | ------------- | -------------
|
7
|
-
**action** | **String** | Action should be used as the form action URL
|
7
|
+
**action** | **String** | Action should be used as the form action URL `<form action=\"{{ .Action }}\" method=\"post\">`. |
|
8
8
|
**errors** | [**Array<Error>**](Error.md) | Errors contains all form errors. These will be duplicates of the individual field errors. | [optional]
|
9
|
-
**fields** | [**Array<FormField>**](FormField.md) | Fields contains multiple fields |
|
10
|
-
**method** | **String** | Method is the form method (e.g. POST) |
|
9
|
+
**fields** | [**Array<FormField>**](FormField.md) | Fields contains multiple fields |
|
10
|
+
**method** | **String** | Method is the form method (e.g. POST) |
|
11
11
|
|
12
12
|
## Code Sample
|
13
13
|
|
data/docs/FormField.md
CHANGED
@@ -4,13 +4,13 @@
|
|
4
4
|
|
5
5
|
Name | Type | Description | Notes
|
6
6
|
------------ | ------------- | ------------- | -------------
|
7
|
-
**disabled** | **
|
8
|
-
**errors** | [**Array<Error>**](Error.md) |
|
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 disabled=\"{{.Disabled}}\">` | [optional]
|
8
|
+
**errors** | [**Array<Error>**](Error.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
|
|
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** | **Hash<String, Object>** | | [optional]
|
10
10
|
**message** | **String** | | [optional]
|
11
11
|
**reason** | **String** | | [optional]
|
12
12
|
**request** | **String** | | [optional]
|
data/docs/Identity.md
CHANGED
@@ -4,9 +4,10 @@
|
|
4
4
|
|
5
5
|
Name | Type | Description | Notes
|
6
6
|
------------ | ------------- | ------------- | -------------
|
7
|
+
**addresses** | [**Array<VerifiableAddress>**](VerifiableAddress.md) | | [optional]
|
7
8
|
**id** | **String** | |
|
8
9
|
**traits** | [**Object**](.md) | |
|
9
|
-
**traits_schema_id** | **String** | TraitsSchemaID is the ID of the JSON Schema to be used for validating the identity's traits. |
|
10
|
+
**traits_schema_id** | **String** | TraitsSchemaID is the ID of the JSON Schema to be used for validating the identity's traits. |
|
10
11
|
**traits_schema_url** | **String** | TraitsSchemaURL is the URL of the endpoint where the identity's traits schema can be fetched from. format: url | [optional]
|
11
12
|
|
12
13
|
## Code Sample
|
@@ -14,7 +15,8 @@ Name | Type | Description | Notes
|
|
14
15
|
```ruby
|
15
16
|
require 'OryHydraClient'
|
16
17
|
|
17
|
-
instance = OryHydraClient::Identity.new(
|
18
|
+
instance = OryHydraClient::Identity.new(addresses: null,
|
19
|
+
id: null,
|
18
20
|
traits: null,
|
19
21
|
traits_schema_id: null,
|
20
22
|
traits_schema_url: null)
|
data/docs/LoginRequest.md
CHANGED
@@ -5,11 +5,12 @@
|
|
5
5
|
Name | Type | Description | Notes
|
6
6
|
------------ | ------------- | ------------- | -------------
|
7
7
|
**active** | **String** | and so on. | [optional]
|
8
|
-
**expires_at** | **DateTime** | ExpiresAt is the time (UTC) when the request expires. If the user still wishes to log in, a new request has to be initiated. |
|
9
|
-
**
|
10
|
-
**
|
11
|
-
**
|
12
|
-
**
|
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]
|
10
|
+
**id** | **String** | |
|
11
|
+
**issued_at** | **DateTime** | IssuedAt is the time (UTC) when the request occurred. |
|
12
|
+
**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. |
|
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
|
|
14
15
|
## Code Sample
|
15
16
|
|
@@ -18,6 +19,7 @@ require 'OryHydraClient'
|
|
18
19
|
|
19
20
|
instance = OryHydraClient::LoginRequest.new(active: null,
|
20
21
|
expires_at: null,
|
22
|
+
forced: null,
|
21
23
|
id: null,
|
22
24
|
issued_at: null,
|
23
25
|
methods: null,
|
data/docs/LoginRequestMethod.md
CHANGED
@@ -4,8 +4,8 @@
|
|
4
4
|
|
5
5
|
Name | Type | Description | Notes
|
6
6
|
------------ | ------------- | ------------- | -------------
|
7
|
-
**config** | [**LoginRequestMethodConfig**](LoginRequestMethodConfig.md) | |
|
8
|
-
**method** | **String** | and so on. |
|
7
|
+
**config** | [**LoginRequestMethodConfig**](LoginRequestMethodConfig.md) | |
|
8
|
+
**method** | **String** | and so on. |
|
9
9
|
|
10
10
|
## Code Sample
|
11
11
|
|
@@ -4,13 +4,22 @@
|
|
4
4
|
|
5
5
|
Name | Type | Description | Notes
|
6
6
|
------------ | ------------- | ------------- | -------------
|
7
|
+
**action** | **String** | Action should be used as the form action URL `<form action=\"{{ .Action }}\" method=\"post\">`. |
|
8
|
+
**errors** | [**Array<Error>**](Error.md) | Errors contains all form errors. These will be duplicates of the individual field errors. | [optional]
|
9
|
+
**fields** | [**Array<FormField>**](FormField.md) | Fields contains multiple fields |
|
10
|
+
**method** | **String** | Method is the form method (e.g. POST) |
|
11
|
+
**providers** | [**Array<FormField>**](FormField.md) | Providers is set for the \"oidc\" request method. | [optional]
|
7
12
|
|
8
13
|
## Code Sample
|
9
14
|
|
10
15
|
```ruby
|
11
16
|
require 'OryHydraClient'
|
12
17
|
|
13
|
-
instance = OryHydraClient::LoginRequestMethodConfig.new(
|
18
|
+
instance = OryHydraClient::LoginRequestMethodConfig.new(action: null,
|
19
|
+
errors: null,
|
20
|
+
fields: null,
|
21
|
+
method: null,
|
22
|
+
providers: null)
|
14
23
|
```
|
15
24
|
|
16
25
|
|
@@ -4,13 +4,13 @@
|
|
4
4
|
|
5
5
|
Name | Type | Description | Notes
|
6
6
|
------------ | ------------- | ------------- | -------------
|
7
|
-
**expires_at** | **DateTime** | ExpiresAt is the time (UTC) when the request expires. If the user still wishes to update the profile, a new request has to be initiated. |
|
8
|
-
**form** | [**Form**](Form.md) | |
|
9
|
-
**id** | **String** | |
|
10
|
-
**identity** | [**Identity**](Identity.md) | |
|
11
|
-
**issued_at** | **DateTime** | IssuedAt is the time (UTC) when the request occurred. |
|
12
|
-
**request_url** | **String** | RequestURL is the initial URL that was requested from ORY Kratos. It can be used to forward information contained in the URL's path or query for example. |
|
13
|
-
**update_successful** | **Boolean** | UpdateSuccessful, if true, indicates that the profile has been updated successfully with the provided data. Done will stay true when repeatedly checking. If set to true, done will revert back to false only when a request with invalid (e.g. \"please use a valid phone number\") data was sent. |
|
7
|
+
**expires_at** | **DateTime** | ExpiresAt is the time (UTC) when the request expires. If the user still wishes to update the profile, a new request has to be initiated. |
|
8
|
+
**form** | [**Form**](Form.md) | |
|
9
|
+
**id** | **String** | |
|
10
|
+
**identity** | [**Identity**](Identity.md) | |
|
11
|
+
**issued_at** | **DateTime** | IssuedAt is the time (UTC) when the request occurred. |
|
12
|
+
**request_url** | **String** | RequestURL is the initial URL that was requested from ORY Kratos. It can be used to forward information contained in the URL's path or query for example. |
|
13
|
+
**update_successful** | **Boolean** | UpdateSuccessful, if true, indicates that the profile has been updated successfully with the provided data. Done will stay true when repeatedly checking. If set to true, done will revert back to false only when a request with invalid (e.g. \"please use a valid phone number\") data was sent. |
|
14
14
|
|
15
15
|
## Code Sample
|
16
16
|
|
@@ -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,26 +4,117 @@ All URIs are relative to *http://localhost*
|
|
4
4
|
|
5
5
|
Method | HTTP request | Description
|
6
6
|
------------- | ------------- | -------------
|
7
|
-
[**
|
7
|
+
[**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
|
8
|
+
[**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
|
9
|
+
[**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
|
10
|
+
[**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
|
11
|
+
[**get_schema**](PublicApi.md#get_schema) | **GET** /schemas/{id} |
|
8
12
|
[**get_self_service_browser_login_request**](PublicApi.md#get_self_service_browser_login_request) | **GET** /self-service/browser/flows/requests/login | Get the request context of browser-based login user flows
|
9
|
-
[**get_self_service_browser_profile_management_request**](PublicApi.md#get_self_service_browser_profile_management_request) | **GET** /self-service/browser/flows/requests/profile | Get the request context of browser-based profile management flows
|
10
13
|
[**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
|
14
|
+
[**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
|
11
15
|
[**get_self_service_error**](PublicApi.md#get_self_service_error) | **GET** /self-service/errors | Get user-facing self-service errors
|
16
|
+
[**get_self_service_verification_request**](PublicApi.md#get_self_service_verification_request) | **GET** /self-service/browser/flows/requests/verification | Get the request context of browser-based verification flows
|
12
17
|
[**initialize_self_service_browser_login_flow**](PublicApi.md#initialize_self_service_browser_login_flow) | **GET** /self-service/browser/flows/login | Initialize browser-based login user flow
|
13
18
|
[**initialize_self_service_browser_logout_flow**](PublicApi.md#initialize_self_service_browser_logout_flow) | **GET** /self-service/browser/flows/logout | Initialize Browser-Based Logout User Flow
|
14
19
|
[**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
|
15
|
-
[**
|
20
|
+
[**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
|
21
|
+
[**initialize_self_service_settings_flow**](PublicApi.md#initialize_self_service_settings_flow) | **GET** /self-service/browser/flows/settings | Initialize browser-based settings flow
|
22
|
+
[**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
|
16
23
|
[**whoami**](PublicApi.md#whoami) | **GET** /sessions/whoami | Check who the current HTTP session belongs to
|
17
24
|
|
18
25
|
|
19
26
|
|
20
|
-
##
|
27
|
+
## complete_self_service_browser_settings_oidc_settings_flow
|
21
28
|
|
22
|
-
>
|
29
|
+
> complete_self_service_browser_settings_oidc_settings_flow
|
23
30
|
|
24
|
-
Complete the browser-based
|
31
|
+
Complete the browser-based settings flow for the OpenID Connect strategy
|
25
32
|
|
26
|
-
This endpoint completes a browser-based
|
33
|
+
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).
|
34
|
+
|
35
|
+
### Example
|
36
|
+
|
37
|
+
```ruby
|
38
|
+
# load the gem
|
39
|
+
require 'ory-kratos-client'
|
40
|
+
|
41
|
+
api_instance = OryHydraClient::PublicApi.new
|
42
|
+
|
43
|
+
begin
|
44
|
+
#Complete the browser-based settings flow for the OpenID Connect strategy
|
45
|
+
api_instance.complete_self_service_browser_settings_oidc_settings_flow
|
46
|
+
rescue OryHydraClient::ApiError => e
|
47
|
+
puts "Exception when calling PublicApi->complete_self_service_browser_settings_oidc_settings_flow: #{e}"
|
48
|
+
end
|
49
|
+
```
|
50
|
+
|
51
|
+
### Parameters
|
52
|
+
|
53
|
+
This endpoint does not need any parameter.
|
54
|
+
|
55
|
+
### Return type
|
56
|
+
|
57
|
+
nil (empty response body)
|
58
|
+
|
59
|
+
### Authorization
|
60
|
+
|
61
|
+
No authorization required
|
62
|
+
|
63
|
+
### HTTP request headers
|
64
|
+
|
65
|
+
- **Content-Type**: Not defined
|
66
|
+
- **Accept**: application/json
|
67
|
+
|
68
|
+
|
69
|
+
## complete_self_service_browser_settings_password_strategy_flow
|
70
|
+
|
71
|
+
> complete_self_service_browser_settings_password_strategy_flow
|
72
|
+
|
73
|
+
Complete the browser-based settings flow for the password strategy
|
74
|
+
|
75
|
+
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).
|
76
|
+
|
77
|
+
### Example
|
78
|
+
|
79
|
+
```ruby
|
80
|
+
# load the gem
|
81
|
+
require 'ory-kratos-client'
|
82
|
+
|
83
|
+
api_instance = OryHydraClient::PublicApi.new
|
84
|
+
|
85
|
+
begin
|
86
|
+
#Complete the browser-based settings flow for the password strategy
|
87
|
+
api_instance.complete_self_service_browser_settings_password_strategy_flow
|
88
|
+
rescue OryHydraClient::ApiError => e
|
89
|
+
puts "Exception when calling PublicApi->complete_self_service_browser_settings_password_strategy_flow: #{e}"
|
90
|
+
end
|
91
|
+
```
|
92
|
+
|
93
|
+
### Parameters
|
94
|
+
|
95
|
+
This endpoint does not need any parameter.
|
96
|
+
|
97
|
+
### Return type
|
98
|
+
|
99
|
+
nil (empty response body)
|
100
|
+
|
101
|
+
### Authorization
|
102
|
+
|
103
|
+
No authorization required
|
104
|
+
|
105
|
+
### HTTP request headers
|
106
|
+
|
107
|
+
- **Content-Type**: Not defined
|
108
|
+
- **Accept**: application/json
|
109
|
+
|
110
|
+
|
111
|
+
## complete_self_service_browser_settings_profile_strategy_flow
|
112
|
+
|
113
|
+
> complete_self_service_browser_settings_profile_strategy_flow(request, body)
|
114
|
+
|
115
|
+
Complete the browser-based settings flow for profile data
|
116
|
+
|
117
|
+
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).
|
27
118
|
|
28
119
|
### Example
|
29
120
|
|
@@ -33,13 +124,13 @@ require 'ory-kratos-client'
|
|
33
124
|
|
34
125
|
api_instance = OryHydraClient::PublicApi.new
|
35
126
|
request = 'request_example' # String | Request is the request ID.
|
36
|
-
body = OryHydraClient::
|
127
|
+
body = OryHydraClient::CompleteSelfServiceBrowserSettingsStrategyProfileFlowPayload.new # CompleteSelfServiceBrowserSettingsStrategyProfileFlowPayload |
|
37
128
|
|
38
129
|
begin
|
39
|
-
#Complete the browser-based profile
|
40
|
-
api_instance.
|
130
|
+
#Complete the browser-based settings flow for profile data
|
131
|
+
api_instance.complete_self_service_browser_settings_profile_strategy_flow(request, body)
|
41
132
|
rescue OryHydraClient::ApiError => e
|
42
|
-
puts "Exception when calling PublicApi->
|
133
|
+
puts "Exception when calling PublicApi->complete_self_service_browser_settings_profile_strategy_flow: #{e}"
|
43
134
|
end
|
44
135
|
```
|
45
136
|
|
@@ -49,7 +140,7 @@ end
|
|
49
140
|
Name | Type | Description | Notes
|
50
141
|
------------- | ------------- | ------------- | -------------
|
51
142
|
**request** | **String**| Request is the request ID. |
|
52
|
-
**body** | [**
|
143
|
+
**body** | [**CompleteSelfServiceBrowserSettingsStrategyProfileFlowPayload**](CompleteSelfServiceBrowserSettingsStrategyProfileFlowPayload.md)| |
|
53
144
|
|
54
145
|
### Return type
|
55
146
|
|
@@ -65,13 +156,13 @@ No authorization required
|
|
65
156
|
- **Accept**: application/json
|
66
157
|
|
67
158
|
|
68
|
-
##
|
159
|
+
## complete_self_service_browser_verification_flow
|
69
160
|
|
70
|
-
>
|
161
|
+
> complete_self_service_browser_verification_flow(request, via)
|
71
162
|
|
72
|
-
|
163
|
+
Complete the browser-based verification flows
|
73
164
|
|
74
|
-
This endpoint
|
165
|
+
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).
|
75
166
|
|
76
167
|
### Example
|
77
168
|
|
@@ -80,14 +171,61 @@ This endpoint returns a login request's context with, for example, error details
|
|
80
171
|
require 'ory-kratos-client'
|
81
172
|
|
82
173
|
api_instance = OryHydraClient::PublicApi.new
|
83
|
-
request = 'request_example' # String | Request is the
|
174
|
+
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`).
|
175
|
+
via = 'via_example' # String | What to verify Currently only \"email\" is supported.
|
84
176
|
|
85
177
|
begin
|
86
|
-
#
|
87
|
-
|
178
|
+
#Complete the browser-based verification flows
|
179
|
+
api_instance.complete_self_service_browser_verification_flow(request, via)
|
180
|
+
rescue OryHydraClient::ApiError => e
|
181
|
+
puts "Exception when calling PublicApi->complete_self_service_browser_verification_flow: #{e}"
|
182
|
+
end
|
183
|
+
```
|
184
|
+
|
185
|
+
### Parameters
|
186
|
+
|
187
|
+
|
188
|
+
Name | Type | Description | Notes
|
189
|
+
------------- | ------------- | ------------- | -------------
|
190
|
+
**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`). |
|
191
|
+
**via** | **String**| What to verify Currently only \"email\" is supported. |
|
192
|
+
|
193
|
+
### Return type
|
194
|
+
|
195
|
+
nil (empty response body)
|
196
|
+
|
197
|
+
### Authorization
|
198
|
+
|
199
|
+
No authorization required
|
200
|
+
|
201
|
+
### HTTP request headers
|
202
|
+
|
203
|
+
- **Content-Type**: Not defined
|
204
|
+
- **Accept**: application/json
|
205
|
+
|
206
|
+
|
207
|
+
## get_schema
|
208
|
+
|
209
|
+
> Object get_schema(id)
|
210
|
+
|
211
|
+
|
212
|
+
|
213
|
+
Get a traits schema definition
|
214
|
+
|
215
|
+
### Example
|
216
|
+
|
217
|
+
```ruby
|
218
|
+
# load the gem
|
219
|
+
require 'ory-kratos-client'
|
220
|
+
|
221
|
+
api_instance = OryHydraClient::PublicApi.new
|
222
|
+
id = 'id_example' # String | ID must be set to the ID of schema you want to get
|
223
|
+
|
224
|
+
begin
|
225
|
+
result = api_instance.get_schema(id)
|
88
226
|
p result
|
89
227
|
rescue OryHydraClient::ApiError => e
|
90
|
-
puts "Exception when calling PublicApi->
|
228
|
+
puts "Exception when calling PublicApi->get_schema: #{e}"
|
91
229
|
end
|
92
230
|
```
|
93
231
|
|
@@ -96,11 +234,11 @@ end
|
|
96
234
|
|
97
235
|
Name | Type | Description | Notes
|
98
236
|
------------- | ------------- | ------------- | -------------
|
99
|
-
**
|
237
|
+
**id** | **String**| ID must be set to the ID of schema you want to get |
|
100
238
|
|
101
239
|
### Return type
|
102
240
|
|
103
|
-
|
241
|
+
**Object**
|
104
242
|
|
105
243
|
### Authorization
|
106
244
|
|
@@ -112,13 +250,13 @@ No authorization required
|
|
112
250
|
- **Accept**: application/json
|
113
251
|
|
114
252
|
|
115
|
-
##
|
253
|
+
## get_self_service_browser_login_request
|
116
254
|
|
117
|
-
>
|
255
|
+
> LoginRequest get_self_service_browser_login_request(request)
|
118
256
|
|
119
|
-
Get the request context of browser-based
|
257
|
+
Get the request context of browser-based login user flows
|
120
258
|
|
121
|
-
When accessing this endpoint through ORY Kratos' Public API, ensure that cookies are set as they are required for
|
259
|
+
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).
|
122
260
|
|
123
261
|
### Example
|
124
262
|
|
@@ -130,11 +268,11 @@ api_instance = OryHydraClient::PublicApi.new
|
|
130
268
|
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`).
|
131
269
|
|
132
270
|
begin
|
133
|
-
#Get the request context of browser-based
|
134
|
-
result = api_instance.
|
271
|
+
#Get the request context of browser-based login user flows
|
272
|
+
result = api_instance.get_self_service_browser_login_request(request)
|
135
273
|
p result
|
136
274
|
rescue OryHydraClient::ApiError => e
|
137
|
-
puts "Exception when calling PublicApi->
|
275
|
+
puts "Exception when calling PublicApi->get_self_service_browser_login_request: #{e}"
|
138
276
|
end
|
139
277
|
```
|
140
278
|
|
@@ -147,7 +285,7 @@ Name | Type | Description | Notes
|
|
147
285
|
|
148
286
|
### Return type
|
149
287
|
|
150
|
-
[**
|
288
|
+
[**LoginRequest**](LoginRequest.md)
|
151
289
|
|
152
290
|
### Authorization
|
153
291
|
|
@@ -206,6 +344,53 @@ No authorization required
|
|
206
344
|
- **Accept**: application/json
|
207
345
|
|
208
346
|
|
347
|
+
## get_self_service_browser_settings_request
|
348
|
+
|
349
|
+
> SettingsRequest get_self_service_browser_settings_request(request)
|
350
|
+
|
351
|
+
Get the request context of browser-based settings flows
|
352
|
+
|
353
|
+
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).
|
354
|
+
|
355
|
+
### Example
|
356
|
+
|
357
|
+
```ruby
|
358
|
+
# load the gem
|
359
|
+
require 'ory-kratos-client'
|
360
|
+
|
361
|
+
api_instance = OryHydraClient::PublicApi.new
|
362
|
+
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`).
|
363
|
+
|
364
|
+
begin
|
365
|
+
#Get the request context of browser-based settings flows
|
366
|
+
result = api_instance.get_self_service_browser_settings_request(request)
|
367
|
+
p result
|
368
|
+
rescue OryHydraClient::ApiError => e
|
369
|
+
puts "Exception when calling PublicApi->get_self_service_browser_settings_request: #{e}"
|
370
|
+
end
|
371
|
+
```
|
372
|
+
|
373
|
+
### Parameters
|
374
|
+
|
375
|
+
|
376
|
+
Name | Type | Description | Notes
|
377
|
+
------------- | ------------- | ------------- | -------------
|
378
|
+
**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`). |
|
379
|
+
|
380
|
+
### Return type
|
381
|
+
|
382
|
+
[**SettingsRequest**](SettingsRequest.md)
|
383
|
+
|
384
|
+
### Authorization
|
385
|
+
|
386
|
+
No authorization required
|
387
|
+
|
388
|
+
### HTTP request headers
|
389
|
+
|
390
|
+
- **Content-Type**: Not defined
|
391
|
+
- **Accept**: application/json
|
392
|
+
|
393
|
+
|
209
394
|
## get_self_service_error
|
210
395
|
|
211
396
|
> ErrorContainer get_self_service_error(opts)
|
@@ -222,7 +407,7 @@ require 'ory-kratos-client'
|
|
222
407
|
|
223
408
|
api_instance = OryHydraClient::PublicApi.new
|
224
409
|
opts = {
|
225
|
-
|
410
|
+
error: 'error_example' # String |
|
226
411
|
}
|
227
412
|
|
228
413
|
begin
|
@@ -239,7 +424,7 @@ end
|
|
239
424
|
|
240
425
|
Name | Type | Description | Notes
|
241
426
|
------------- | ------------- | ------------- | -------------
|
242
|
-
**
|
427
|
+
**error** | **String**| | [optional]
|
243
428
|
|
244
429
|
### Return type
|
245
430
|
|
@@ -255,6 +440,53 @@ No authorization required
|
|
255
440
|
- **Accept**: application/json
|
256
441
|
|
257
442
|
|
443
|
+
## get_self_service_verification_request
|
444
|
+
|
445
|
+
> VerificationRequest get_self_service_verification_request(request)
|
446
|
+
|
447
|
+
Get the request context of browser-based verification flows
|
448
|
+
|
449
|
+
When accessing this endpoint through ORY Kratos' Public API, ensure that cookies are set as they are required for checking the auth session. To prevent scanning attacks, the public endpoint does not return 404 status codes but instead 403 or 500. More information can be found at [ORY Kratos Email and Phone Verification Documentation](https://www.ory.sh/docs/kratos/selfservice/flows/verify-email-account-activation).
|
450
|
+
|
451
|
+
### Example
|
452
|
+
|
453
|
+
```ruby
|
454
|
+
# load the gem
|
455
|
+
require 'ory-kratos-client'
|
456
|
+
|
457
|
+
api_instance = OryHydraClient::PublicApi.new
|
458
|
+
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`).
|
459
|
+
|
460
|
+
begin
|
461
|
+
#Get the request context of browser-based verification flows
|
462
|
+
result = api_instance.get_self_service_verification_request(request)
|
463
|
+
p result
|
464
|
+
rescue OryHydraClient::ApiError => e
|
465
|
+
puts "Exception when calling PublicApi->get_self_service_verification_request: #{e}"
|
466
|
+
end
|
467
|
+
```
|
468
|
+
|
469
|
+
### Parameters
|
470
|
+
|
471
|
+
|
472
|
+
Name | Type | Description | Notes
|
473
|
+
------------- | ------------- | ------------- | -------------
|
474
|
+
**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`). |
|
475
|
+
|
476
|
+
### Return type
|
477
|
+
|
478
|
+
[**VerificationRequest**](VerificationRequest.md)
|
479
|
+
|
480
|
+
### Authorization
|
481
|
+
|
482
|
+
No authorization required
|
483
|
+
|
484
|
+
### HTTP request headers
|
485
|
+
|
486
|
+
- **Content-Type**: Not defined
|
487
|
+
- **Accept**: application/json
|
488
|
+
|
489
|
+
|
258
490
|
## initialize_self_service_browser_login_flow
|
259
491
|
|
260
492
|
> initialize_self_service_browser_login_flow
|
@@ -381,13 +613,59 @@ No authorization required
|
|
381
613
|
- **Accept**: application/json
|
382
614
|
|
383
615
|
|
384
|
-
##
|
616
|
+
## initialize_self_service_browser_verification_flow
|
617
|
+
|
618
|
+
> initialize_self_service_browser_verification_flow(via)
|
619
|
+
|
620
|
+
Initialize browser-based verification flow
|
621
|
+
|
622
|
+
This endpoint initializes a browser-based verification flow. Once initialized, the browser will be redirected to `urls.settings_ui` with the request ID set as a query parameter. If no valid user session exists, a login flow will be initialized. > This endpoint is NOT INTENDED for API clients and only works with browsers (Chrome, Firefox, ...). More information can be found at [ORY Kratos Email and Phone Verification Documentation](https://www.ory.sh/docs/kratos/selfservice/flows/verify-email-account-activation).
|
623
|
+
|
624
|
+
### Example
|
625
|
+
|
626
|
+
```ruby
|
627
|
+
# load the gem
|
628
|
+
require 'ory-kratos-client'
|
629
|
+
|
630
|
+
api_instance = OryHydraClient::PublicApi.new
|
631
|
+
via = 'via_example' # String | What to verify Currently only \"email\" is supported.
|
632
|
+
|
633
|
+
begin
|
634
|
+
#Initialize browser-based verification flow
|
635
|
+
api_instance.initialize_self_service_browser_verification_flow(via)
|
636
|
+
rescue OryHydraClient::ApiError => e
|
637
|
+
puts "Exception when calling PublicApi->initialize_self_service_browser_verification_flow: #{e}"
|
638
|
+
end
|
639
|
+
```
|
640
|
+
|
641
|
+
### Parameters
|
642
|
+
|
643
|
+
|
644
|
+
Name | Type | Description | Notes
|
645
|
+
------------- | ------------- | ------------- | -------------
|
646
|
+
**via** | **String**| What to verify Currently only \"email\" is supported. |
|
647
|
+
|
648
|
+
### Return type
|
649
|
+
|
650
|
+
nil (empty response body)
|
651
|
+
|
652
|
+
### Authorization
|
653
|
+
|
654
|
+
No authorization required
|
655
|
+
|
656
|
+
### HTTP request headers
|
657
|
+
|
658
|
+
- **Content-Type**: Not defined
|
659
|
+
- **Accept**: application/json
|
660
|
+
|
661
|
+
|
662
|
+
## initialize_self_service_settings_flow
|
385
663
|
|
386
|
-
>
|
664
|
+
> initialize_self_service_settings_flow
|
387
665
|
|
388
|
-
Initialize browser-based
|
666
|
+
Initialize browser-based settings flow
|
389
667
|
|
390
|
-
This endpoint initializes a browser-based
|
668
|
+
This endpoint initializes a browser-based settings flow. Once initialized, the browser will be redirected to `urls.settings_ui` with the request ID set as a query parameter. If no valid user session exists, a login flow will be initialized. > This endpoint is NOT INTENDED for API clients and only works with browsers (Chrome, Firefox, ...). More information can be found at [ORY Kratos User Settings & Profile Management Documentation](../self-service/flows/user-settings).
|
391
669
|
|
392
670
|
### Example
|
393
671
|
|
@@ -398,10 +676,10 @@ require 'ory-kratos-client'
|
|
398
676
|
api_instance = OryHydraClient::PublicApi.new
|
399
677
|
|
400
678
|
begin
|
401
|
-
#Initialize browser-based
|
402
|
-
api_instance.
|
679
|
+
#Initialize browser-based settings flow
|
680
|
+
api_instance.initialize_self_service_settings_flow
|
403
681
|
rescue OryHydraClient::ApiError => e
|
404
|
-
puts "Exception when calling PublicApi->
|
682
|
+
puts "Exception when calling PublicApi->initialize_self_service_settings_flow: #{e}"
|
405
683
|
end
|
406
684
|
```
|
407
685
|
|
@@ -423,6 +701,54 @@ No authorization required
|
|
423
701
|
- **Accept**: application/json
|
424
702
|
|
425
703
|
|
704
|
+
## self_service_browser_verify
|
705
|
+
|
706
|
+
> self_service_browser_verify(code, via)
|
707
|
+
|
708
|
+
Complete the browser-based verification flows
|
709
|
+
|
710
|
+
This endpoint completes a browser-based verification flow. > This endpoint is NOT INTENDED for API clients and only works with browsers (Chrome, Firefox, ...) and HTML Forms. More information can be found at [ORY Kratos Email and Phone Verification Documentation](https://www.ory.sh/docs/kratos/selfservice/flows/verify-email-account-activation).
|
711
|
+
|
712
|
+
### Example
|
713
|
+
|
714
|
+
```ruby
|
715
|
+
# load the gem
|
716
|
+
require 'ory-kratos-client'
|
717
|
+
|
718
|
+
api_instance = OryHydraClient::PublicApi.new
|
719
|
+
code = 'code_example' # String |
|
720
|
+
via = 'via_example' # String | What to verify Currently only \"email\" is supported.
|
721
|
+
|
722
|
+
begin
|
723
|
+
#Complete the browser-based verification flows
|
724
|
+
api_instance.self_service_browser_verify(code, via)
|
725
|
+
rescue OryHydraClient::ApiError => e
|
726
|
+
puts "Exception when calling PublicApi->self_service_browser_verify: #{e}"
|
727
|
+
end
|
728
|
+
```
|
729
|
+
|
730
|
+
### Parameters
|
731
|
+
|
732
|
+
|
733
|
+
Name | Type | Description | Notes
|
734
|
+
------------- | ------------- | ------------- | -------------
|
735
|
+
**code** | **String**| |
|
736
|
+
**via** | **String**| What to verify Currently only \"email\" is supported. |
|
737
|
+
|
738
|
+
### Return type
|
739
|
+
|
740
|
+
nil (empty response body)
|
741
|
+
|
742
|
+
### Authorization
|
743
|
+
|
744
|
+
No authorization required
|
745
|
+
|
746
|
+
### HTTP request headers
|
747
|
+
|
748
|
+
- **Content-Type**: Not defined
|
749
|
+
- **Accept**: application/json
|
750
|
+
|
751
|
+
|
426
752
|
## whoami
|
427
753
|
|
428
754
|
> Session whoami
|