ory-kratos-client 0.1.1.alpha1 → 0.5.0.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 +86 -48
- data/docs/AdminApi.md +290 -85
- data/docs/CommonApi.md +111 -16
- data/docs/CompleteSelfServiceBrowserSettingsStrategyProfileFlowPayload.md +19 -0
- data/docs/CompleteSelfServiceLoginFlowWithPasswordMethod.md +21 -0
- data/docs/CompleteSelfServiceRecoveryFlowWithLinkMethod.md +19 -0
- data/docs/CompleteSelfServiceSettingsFlowWithPasswordMethod.md +19 -0
- data/docs/CompleteSelfServiceVerificationFlowWithLinkMethod.md +19 -0
- data/docs/CreateIdentity.md +19 -0
- data/docs/CreateRecoveryLink.md +19 -0
- data/docs/ErrorContainer.md +2 -2
- 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/LoginFlow.md +33 -0
- data/docs/LoginFlowMethod.md +19 -0
- data/docs/LoginFlowMethodConfig.md +25 -0
- data/docs/LoginRequest.md +4 -0
- data/docs/LoginRequestMethodConfig.md +3 -3
- data/docs/LoginViaApiResponse.md +19 -0
- data/docs/Message.md +23 -0
- data/docs/ProviderCredentialsConfig.md +19 -0
- data/docs/PublicApi.md +806 -141
- data/docs/RecoveryAddress.md +21 -0
- data/docs/RecoveryFlow.md +33 -0
- data/docs/RecoveryFlowMethod.md +19 -0
- data/docs/RecoveryFlowMethodConfig.md +23 -0
- data/docs/RecoveryLink.md +19 -0
- data/docs/RecoveryRequest.md +31 -0
- data/docs/RecoveryRequestMethod.md +19 -0
- data/docs/RegistrationFlow.md +31 -0
- data/docs/RegistrationFlowMethod.md +19 -0
- data/docs/RegistrationFlowMethodConfig.md +25 -0
- data/docs/RegistrationRequest.md +3 -1
- data/docs/RegistrationRequestMethodConfig.md +3 -3
- data/docs/RegistrationViaApiResponse.md +21 -0
- data/docs/RequestMethodConfig.md +23 -0
- data/docs/RevokeSession.md +17 -0
- data/docs/Session.md +6 -4
- data/docs/SettingsFlow.md +35 -0
- data/docs/SettingsFlowMethod.md +19 -0
- data/docs/SettingsFlowMethodConfig.md +23 -0
- data/docs/SettingsRequest.md +33 -0
- data/docs/SettingsRequestMethod.md +19 -0
- data/docs/SettingsViaApiResponse.md +19 -0
- data/docs/UpdateIdentity.md +19 -0
- data/docs/VerifiableAddress.md +4 -4
- data/docs/VerificationFlow.md +33 -0
- data/docs/VerificationFlowMethod.md +19 -0
- data/docs/VerificationFlowMethodConfig.md +23 -0
- data/docs/VerificationRequest.md +3 -1
- data/lib/ory-kratos-client.rb +31 -14
- data/lib/ory-kratos-client/api/admin_api.rb +379 -128
- 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 +1000 -234
- data/lib/ory-kratos-client/api/version_api.rb +2 -2
- data/lib/ory-kratos-client/api_client.rb +10 -7
- data/lib/ory-kratos-client/api_error.rb +2 -2
- data/lib/ory-kratos-client/configuration.rb +9 -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/complete_self_service_login_flow_with_password_method.rb +227 -0
- data/lib/ory-kratos-client/models/complete_self_service_recovery_flow_with_link_method.rb +217 -0
- data/lib/ory-kratos-client/models/complete_self_service_settings_flow_with_password_method.rb +222 -0
- data/lib/ory-kratos-client/models/complete_self_service_verification_flow_with_link_method.rb +217 -0
- data/lib/ory-kratos-client/models/create_identity.rb +227 -0
- data/lib/ory-kratos-client/models/create_recovery_link.rb +238 -0
- data/lib/ory-kratos-client/models/error_container.rb +13 -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 +53 -35
- data/lib/ory-kratos-client/models/login_flow.rb +315 -0
- data/lib/ory-kratos-client/models/login_flow_method.rb +226 -0
- data/lib/ory-kratos-client/models/login_flow_method_config.rb +267 -0
- 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/login_via_api_response.rb +227 -0
- data/lib/ory-kratos-client/models/message.rb +234 -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_flow.rb +319 -0
- data/lib/ory-kratos-client/models/recovery_flow_method.rb +226 -0
- data/lib/ory-kratos-client/models/recovery_flow_method_config.rb +255 -0
- data/lib/ory-kratos-client/models/recovery_link.rb +222 -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_flow.rb +304 -0
- data/lib/ory-kratos-client/models/registration_flow_method.rb +226 -0
- data/lib/ory-kratos-client/models/registration_flow_method_config.rb +267 -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/registration_via_api_response.rb +236 -0
- data/lib/ory-kratos-client/models/request_method_config.rb +255 -0
- data/lib/ory-kratos-client/models/revoke_session.rb +212 -0
- data/lib/ory-kratos-client/models/session.rb +29 -20
- data/lib/ory-kratos-client/models/settings_flow.rb +333 -0
- data/lib/ory-kratos-client/models/settings_flow_method.rb +226 -0
- data/lib/ory-kratos-client/models/settings_flow_method_config.rb +255 -0
- 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/settings_via_api_response.rb +226 -0
- data/lib/ory-kratos-client/models/update_identity.rb +222 -0
- data/lib/ory-kratos-client/models/verifiable_address.rb +17 -22
- data/lib/ory-kratos-client/models/verification_flow.rb +299 -0
- data/lib/ory-kratos-client/models/verification_flow_method.rb +226 -0
- data/lib/ory-kratos-client/models/verification_flow_method_config.rb +255 -0
- 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/complete_self_service_login_flow_with_password_method_spec.rb +53 -0
- data/spec/models/complete_self_service_recovery_flow_with_link_method_spec.rb +47 -0
- data/spec/models/complete_self_service_settings_flow_with_password_method_spec.rb +47 -0
- data/spec/models/complete_self_service_verification_flow_with_link_method_spec.rb +47 -0
- data/spec/models/create_identity_spec.rb +47 -0
- data/spec/models/create_recovery_link_spec.rb +47 -0
- data/spec/models/login_flow_method_config_spec.rb +65 -0
- data/spec/models/login_flow_method_spec.rb +47 -0
- data/spec/models/login_flow_spec.rb +89 -0
- data/spec/models/login_via_api_response_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_flow_method_config_spec.rb +59 -0
- data/spec/models/recovery_flow_method_spec.rb +47 -0
- data/spec/models/recovery_flow_spec.rb +89 -0
- data/spec/models/recovery_link_spec.rb +47 -0
- data/spec/models/recovery_request_method_spec.rb +47 -0
- data/spec/models/recovery_request_spec.rb +83 -0
- data/spec/models/registration_flow_method_config_spec.rb +65 -0
- data/spec/models/registration_flow_method_spec.rb +47 -0
- data/spec/models/registration_flow_spec.rb +83 -0
- data/spec/models/registration_via_api_response_spec.rb +53 -0
- data/spec/models/request_method_config_spec.rb +59 -0
- data/spec/models/revoke_session_spec.rb +41 -0
- data/spec/models/settings_flow_method_config_spec.rb +59 -0
- data/spec/models/settings_flow_method_spec.rb +47 -0
- data/spec/models/settings_flow_spec.rb +95 -0
- data/spec/models/settings_request_method_spec.rb +47 -0
- data/spec/models/settings_request_spec.rb +83 -0
- data/spec/models/settings_via_api_response_spec.rb +47 -0
- data/spec/models/update_identity_spec.rb +47 -0
- data/spec/models/verification_flow_method_config_spec.rb +59 -0
- data/spec/models/verification_flow_method_spec.rb +47 -0
- data/spec/models/verification_flow_spec.rb +89 -0
- metadata +161 -17
@@ -0,0 +1,23 @@
|
|
1
|
+
# OryHydraClient::SettingsFlowMethodConfig
|
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::SettingsFlowMethodConfig.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
|
+
|
@@ -0,0 +1,19 @@
|
|
1
|
+
# OryHydraClient::SettingsViaApiResponse
|
2
|
+
|
3
|
+
## Properties
|
4
|
+
|
5
|
+
Name | Type | Description | Notes
|
6
|
+
------------ | ------------- | ------------- | -------------
|
7
|
+
**flow** | [**SettingsFlow**](SettingsFlow.md) | |
|
8
|
+
**identity** | [**Identity**](Identity.md) | |
|
9
|
+
|
10
|
+
## Code Sample
|
11
|
+
|
12
|
+
```ruby
|
13
|
+
require 'OryHydraClient'
|
14
|
+
|
15
|
+
instance = OryHydraClient::SettingsViaApiResponse.new(flow: null,
|
16
|
+
identity: null)
|
17
|
+
```
|
18
|
+
|
19
|
+
|
@@ -0,0 +1,19 @@
|
|
1
|
+
# OryHydraClient::UpdateIdentity
|
2
|
+
|
3
|
+
## Properties
|
4
|
+
|
5
|
+
Name | Type | Description | Notes
|
6
|
+
------------ | ------------- | ------------- | -------------
|
7
|
+
**schema_id** | **String** | SchemaID is the ID of the JSON Schema to be used for validating the identity's traits. If set will update the Identity's SchemaID. | [optional]
|
8
|
+
**traits** | [**Object**](.md) | Traits represent an identity's traits. The identity is able to create, modify, and delete traits in a self-service manner. The input will always be validated against the JSON Schema defined in `schema_id`. |
|
9
|
+
|
10
|
+
## Code Sample
|
11
|
+
|
12
|
+
```ruby
|
13
|
+
require 'OryHydraClient'
|
14
|
+
|
15
|
+
instance = OryHydraClient::UpdateIdentity.new(schema_id: null,
|
16
|
+
traits: null)
|
17
|
+
```
|
18
|
+
|
19
|
+
|
data/docs/VerifiableAddress.md
CHANGED
@@ -4,11 +4,11 @@
|
|
4
4
|
|
5
5
|
Name | Type | Description | Notes
|
6
6
|
------------ | ------------- | ------------- | -------------
|
7
|
-
**expires_at** | **DateTime** | |
|
8
7
|
**id** | **String** | |
|
8
|
+
**status** | **String** | |
|
9
9
|
**value** | **String** | |
|
10
10
|
**verified** | **Boolean** | |
|
11
|
-
**verified_at** | **DateTime** | |
|
11
|
+
**verified_at** | **DateTime** | | [optional]
|
12
12
|
**via** | **String** | |
|
13
13
|
|
14
14
|
## Code Sample
|
@@ -16,8 +16,8 @@ Name | Type | Description | Notes
|
|
16
16
|
```ruby
|
17
17
|
require 'OryHydraClient'
|
18
18
|
|
19
|
-
instance = OryHydraClient::VerifiableAddress.new(
|
20
|
-
|
19
|
+
instance = OryHydraClient::VerifiableAddress.new(id: null,
|
20
|
+
status: null,
|
21
21
|
value: null,
|
22
22
|
verified: null,
|
23
23
|
verified_at: null,
|
@@ -0,0 +1,33 @@
|
|
1
|
+
# OryHydraClient::VerificationFlow
|
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 verify the address, a new request has to be initiated. | [optional]
|
9
|
+
**id** | **String** | | [optional]
|
10
|
+
**issued_at** | **DateTime** | IssuedAt is the time (UTC) when the request occurred. | [optional]
|
11
|
+
**messages** | [**Array<Message>**](Message.md) | | [optional]
|
12
|
+
**methods** | [**Hash<String, VerificationFlowMethod>**](VerificationFlowMethod.md) | Methods contains context for all account verification 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. | [optional]
|
14
|
+
**state** | **String** | |
|
15
|
+
**type** | **String** | The flow type can either be `api` or `browser`. | [optional]
|
16
|
+
|
17
|
+
## Code Sample
|
18
|
+
|
19
|
+
```ruby
|
20
|
+
require 'OryHydraClient'
|
21
|
+
|
22
|
+
instance = OryHydraClient::VerificationFlow.new(active: null,
|
23
|
+
expires_at: null,
|
24
|
+
id: null,
|
25
|
+
issued_at: null,
|
26
|
+
messages: null,
|
27
|
+
methods: null,
|
28
|
+
request_url: null,
|
29
|
+
state: null,
|
30
|
+
type: null)
|
31
|
+
```
|
32
|
+
|
33
|
+
|
@@ -0,0 +1,19 @@
|
|
1
|
+
# OryHydraClient::VerificationFlowMethod
|
2
|
+
|
3
|
+
## Properties
|
4
|
+
|
5
|
+
Name | Type | Description | Notes
|
6
|
+
------------ | ------------- | ------------- | -------------
|
7
|
+
**config** | [**VerificationFlowMethodConfig**](VerificationFlowMethodConfig.md) | |
|
8
|
+
**method** | **String** | Method contains the request credentials type. |
|
9
|
+
|
10
|
+
## Code Sample
|
11
|
+
|
12
|
+
```ruby
|
13
|
+
require 'OryHydraClient'
|
14
|
+
|
15
|
+
instance = OryHydraClient::VerificationFlowMethod.new(config: null,
|
16
|
+
method: null)
|
17
|
+
```
|
18
|
+
|
19
|
+
|
@@ -0,0 +1,23 @@
|
|
1
|
+
# OryHydraClient::VerificationFlowMethodConfig
|
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::VerificationFlowMethodConfig.new(action: null,
|
18
|
+
fields: null,
|
19
|
+
messages: null,
|
20
|
+
method: null)
|
21
|
+
```
|
22
|
+
|
23
|
+
|
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.5.0-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,31 +17,48 @@ 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/
|
20
|
+
require 'ory-kratos-client/models/complete_self_service_login_flow_with_password_method'
|
21
|
+
require 'ory-kratos-client/models/complete_self_service_recovery_flow_with_link_method'
|
22
|
+
require 'ory-kratos-client/models/complete_self_service_settings_flow_with_password_method'
|
23
|
+
require 'ory-kratos-client/models/complete_self_service_verification_flow_with_link_method'
|
24
|
+
require 'ory-kratos-client/models/create_identity'
|
25
|
+
require 'ory-kratos-client/models/create_recovery_link'
|
22
26
|
require 'ory-kratos-client/models/error_container'
|
23
|
-
require 'ory-kratos-client/models/form'
|
24
27
|
require 'ory-kratos-client/models/form_field'
|
25
28
|
require 'ory-kratos-client/models/generic_error'
|
26
29
|
require 'ory-kratos-client/models/generic_error_payload'
|
27
30
|
require 'ory-kratos-client/models/health_not_ready_status'
|
28
31
|
require 'ory-kratos-client/models/health_status'
|
29
32
|
require 'ory-kratos-client/models/identity'
|
30
|
-
require 'ory-kratos-client/models/
|
31
|
-
require 'ory-kratos-client/models/
|
32
|
-
require 'ory-kratos-client/models/
|
33
|
-
require 'ory-kratos-client/models/
|
34
|
-
require 'ory-kratos-client/models/
|
35
|
-
require 'ory-kratos-client/models/
|
36
|
-
require 'ory-kratos-client/models/
|
33
|
+
require 'ory-kratos-client/models/login_flow'
|
34
|
+
require 'ory-kratos-client/models/login_flow_method'
|
35
|
+
require 'ory-kratos-client/models/login_flow_method_config'
|
36
|
+
require 'ory-kratos-client/models/login_via_api_response'
|
37
|
+
require 'ory-kratos-client/models/message'
|
38
|
+
require 'ory-kratos-client/models/recovery_address'
|
39
|
+
require 'ory-kratos-client/models/recovery_flow'
|
40
|
+
require 'ory-kratos-client/models/recovery_flow_method'
|
41
|
+
require 'ory-kratos-client/models/recovery_flow_method_config'
|
42
|
+
require 'ory-kratos-client/models/recovery_link'
|
43
|
+
require 'ory-kratos-client/models/registration_flow'
|
44
|
+
require 'ory-kratos-client/models/registration_flow_method'
|
45
|
+
require 'ory-kratos-client/models/registration_flow_method_config'
|
46
|
+
require 'ory-kratos-client/models/registration_via_api_response'
|
47
|
+
require 'ory-kratos-client/models/revoke_session'
|
37
48
|
require 'ory-kratos-client/models/session'
|
49
|
+
require 'ory-kratos-client/models/settings_flow'
|
50
|
+
require 'ory-kratos-client/models/settings_flow_method'
|
51
|
+
require 'ory-kratos-client/models/settings_flow_method_config'
|
52
|
+
require 'ory-kratos-client/models/settings_via_api_response'
|
53
|
+
require 'ory-kratos-client/models/update_identity'
|
38
54
|
require 'ory-kratos-client/models/verifiable_address'
|
39
|
-
require 'ory-kratos-client/models/
|
55
|
+
require 'ory-kratos-client/models/verification_flow'
|
56
|
+
require 'ory-kratos-client/models/verification_flow_method'
|
57
|
+
require 'ory-kratos-client/models/verification_flow_method_config'
|
40
58
|
require 'ory-kratos-client/models/version'
|
41
59
|
|
42
60
|
# APIs
|
43
61
|
require 'ory-kratos-client/api/admin_api'
|
44
|
-
require 'ory-kratos-client/api/common_api'
|
45
62
|
require 'ory-kratos-client/api/health_api'
|
46
63
|
require 'ory-kratos-client/api/public_api'
|
47
64
|
require 'ory-kratos-client/api/version_api'
|
@@ -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.5.0-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
|
|
@@ -19,29 +19,25 @@ module OryHydraClient
|
|
19
19
|
def initialize(api_client = ApiClient.default)
|
20
20
|
@api_client = api_client
|
21
21
|
end
|
22
|
-
# Create an
|
22
|
+
# Create an Identity
|
23
23
|
# This endpoint creates an identity. It is NOT possible to set an identity's credentials (password, ...) using this method! A way to achieve that will be introduced in the future. Learn how identities work in [ORY Kratos' User And Identity Model Documentation](https://www.ory.sh/docs/next/kratos/concepts/identity-user-model).
|
24
|
-
# @param body [Identity]
|
25
24
|
# @param [Hash] opts the optional parameters
|
25
|
+
# @option opts [CreateIdentity] :body
|
26
26
|
# @return [Identity]
|
27
|
-
def create_identity(
|
28
|
-
data, _status_code, _headers = create_identity_with_http_info(
|
27
|
+
def create_identity(opts = {})
|
28
|
+
data, _status_code, _headers = create_identity_with_http_info(opts)
|
29
29
|
data
|
30
30
|
end
|
31
31
|
|
32
|
-
# Create an
|
32
|
+
# Create an Identity
|
33
33
|
# This endpoint creates an identity. It is NOT possible to set an identity's credentials (password, ...) using this method! A way to achieve that will be introduced in the future. Learn how identities work in [ORY Kratos' User And Identity Model Documentation](https://www.ory.sh/docs/next/kratos/concepts/identity-user-model).
|
34
|
-
# @param body [Identity]
|
35
34
|
# @param [Hash] opts the optional parameters
|
35
|
+
# @option opts [CreateIdentity] :body
|
36
36
|
# @return [Array<(Identity, Integer, Hash)>] Identity data, response status code and response headers
|
37
|
-
def create_identity_with_http_info(
|
37
|
+
def create_identity_with_http_info(opts = {})
|
38
38
|
if @api_client.config.debugging
|
39
39
|
@api_client.config.logger.debug 'Calling API: AdminApi.create_identity ...'
|
40
40
|
end
|
41
|
-
# verify the required parameter 'body' is set
|
42
|
-
if @api_client.config.client_side_validation && body.nil?
|
43
|
-
fail ArgumentError, "Missing the required parameter 'body' when calling AdminApi.create_identity"
|
44
|
-
end
|
45
41
|
# resource path
|
46
42
|
local_var_path = '/identities'
|
47
43
|
|
@@ -59,7 +55,7 @@ module OryHydraClient
|
|
59
55
|
form_params = opts[:form_params] || {}
|
60
56
|
|
61
57
|
# http body (model)
|
62
|
-
post_body = opts[:body] || @api_client.object_to_http_body(body)
|
58
|
+
post_body = opts[:body] || @api_client.object_to_http_body(opts[:'body'])
|
63
59
|
|
64
60
|
# return_type
|
65
61
|
return_type = opts[:return_type] || 'Identity'
|
@@ -83,8 +79,68 @@ module OryHydraClient
|
|
83
79
|
return data, status_code, headers
|
84
80
|
end
|
85
81
|
|
86
|
-
#
|
87
|
-
# This endpoint
|
82
|
+
# Create a Recovery Link
|
83
|
+
# This endpoint creates a recovery link which should be given to the user in order for them to recover (or activate) their account.
|
84
|
+
# @param [Hash] opts the optional parameters
|
85
|
+
# @option opts [CreateRecoveryLink] :body
|
86
|
+
# @return [RecoveryLink]
|
87
|
+
def create_recovery_link(opts = {})
|
88
|
+
data, _status_code, _headers = create_recovery_link_with_http_info(opts)
|
89
|
+
data
|
90
|
+
end
|
91
|
+
|
92
|
+
# Create a Recovery Link
|
93
|
+
# This endpoint creates a recovery link which should be given to the user in order for them to recover (or activate) their account.
|
94
|
+
# @param [Hash] opts the optional parameters
|
95
|
+
# @option opts [CreateRecoveryLink] :body
|
96
|
+
# @return [Array<(RecoveryLink, Integer, Hash)>] RecoveryLink data, response status code and response headers
|
97
|
+
def create_recovery_link_with_http_info(opts = {})
|
98
|
+
if @api_client.config.debugging
|
99
|
+
@api_client.config.logger.debug 'Calling API: AdminApi.create_recovery_link ...'
|
100
|
+
end
|
101
|
+
# resource path
|
102
|
+
local_var_path = '/recovery/link'
|
103
|
+
|
104
|
+
# query parameters
|
105
|
+
query_params = opts[:query_params] || {}
|
106
|
+
|
107
|
+
# header parameters
|
108
|
+
header_params = opts[:header_params] || {}
|
109
|
+
# HTTP header 'Accept' (if needed)
|
110
|
+
header_params['Accept'] = @api_client.select_header_accept(['application/json'])
|
111
|
+
# HTTP header 'Content-Type'
|
112
|
+
header_params['Content-Type'] = @api_client.select_header_content_type(['application/json'])
|
113
|
+
|
114
|
+
# form parameters
|
115
|
+
form_params = opts[:form_params] || {}
|
116
|
+
|
117
|
+
# http body (model)
|
118
|
+
post_body = opts[:body] || @api_client.object_to_http_body(opts[:'body'])
|
119
|
+
|
120
|
+
# return_type
|
121
|
+
return_type = opts[:return_type] || 'RecoveryLink'
|
122
|
+
|
123
|
+
# auth_names
|
124
|
+
auth_names = opts[:auth_names] || []
|
125
|
+
|
126
|
+
new_options = opts.merge(
|
127
|
+
:header_params => header_params,
|
128
|
+
:query_params => query_params,
|
129
|
+
:form_params => form_params,
|
130
|
+
:body => post_body,
|
131
|
+
:auth_names => auth_names,
|
132
|
+
:return_type => return_type
|
133
|
+
)
|
134
|
+
|
135
|
+
data, status_code, headers = @api_client.call_api(:POST, local_var_path, new_options)
|
136
|
+
if @api_client.config.debugging
|
137
|
+
@api_client.config.logger.debug "API called: AdminApi#create_recovery_link\nData: #{data.inspect}\nStatus code: #{status_code}\nHeaders: #{headers}"
|
138
|
+
end
|
139
|
+
return data, status_code, headers
|
140
|
+
end
|
141
|
+
|
142
|
+
# Delete an Identity
|
143
|
+
# Calling this endpoint irrecoverably and permanently deletes the identity given its ID. This action can not be undone. This endpoint returns 204 when the identity was deleted or when the identity was not found, in which case it is assumed that is has been deleted already. Learn how identities work in [ORY Kratos' User And Identity Model Documentation](https://www.ory.sh/docs/next/kratos/concepts/identity-user-model).
|
88
144
|
# @param id [String] ID is the identity's ID.
|
89
145
|
# @param [Hash] opts the optional parameters
|
90
146
|
# @return [nil]
|
@@ -93,8 +149,8 @@ module OryHydraClient
|
|
93
149
|
nil
|
94
150
|
end
|
95
151
|
|
96
|
-
# Delete an
|
97
|
-
#
|
152
|
+
# Delete an Identity
|
153
|
+
# Calling this endpoint irrecoverably and permanently deletes the identity given its ID. This action can not be undone. This endpoint returns 204 when the identity was deleted or when the identity was not found, in which case it is assumed that is has been deleted already. Learn how identities work in [ORY Kratos' User And Identity Model Documentation](https://www.ory.sh/docs/next/kratos/concepts/identity-user-model).
|
98
154
|
# @param id [String] ID is the identity's ID.
|
99
155
|
# @param [Hash] opts the optional parameters
|
100
156
|
# @return [Array<(nil, Integer, Hash)>] nil, response status code and response headers
|
@@ -145,7 +201,7 @@ module OryHydraClient
|
|
145
201
|
return data, status_code, headers
|
146
202
|
end
|
147
203
|
|
148
|
-
# Get an
|
204
|
+
# Get an Identity
|
149
205
|
# Learn how identities work in [ORY Kratos' User And Identity Model Documentation](https://www.ory.sh/docs/next/kratos/concepts/identity-user-model).
|
150
206
|
# @param id [String] ID must be set to the ID of identity you want to get
|
151
207
|
# @param [Hash] opts the optional parameters
|
@@ -155,7 +211,7 @@ module OryHydraClient
|
|
155
211
|
data
|
156
212
|
end
|
157
213
|
|
158
|
-
# Get an
|
214
|
+
# Get an Identity
|
159
215
|
# Learn how identities work in [ORY Kratos' User And Identity Model Documentation](https://www.ory.sh/docs/next/kratos/concepts/identity-user-model).
|
160
216
|
# @param id [String] ID must be set to the ID of identity you want to get
|
161
217
|
# @param [Hash] opts the optional parameters
|
@@ -207,35 +263,32 @@ module OryHydraClient
|
|
207
263
|
return data, status_code, headers
|
208
264
|
end
|
209
265
|
|
210
|
-
# Get
|
211
|
-
#
|
212
|
-
# @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`).
|
266
|
+
# Get a Traits Schema Definition
|
267
|
+
# @param id [String] ID must be set to the ID of schema you want to get
|
213
268
|
# @param [Hash] opts the optional parameters
|
214
|
-
# @return [
|
215
|
-
def
|
216
|
-
data, _status_code, _headers =
|
269
|
+
# @return [Object]
|
270
|
+
def get_schema(id, opts = {})
|
271
|
+
data, _status_code, _headers = get_schema_with_http_info(id, opts)
|
217
272
|
data
|
218
273
|
end
|
219
274
|
|
220
|
-
# Get
|
221
|
-
#
|
222
|
-
# @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`).
|
275
|
+
# Get a Traits Schema Definition
|
276
|
+
# @param id [String] ID must be set to the ID of schema you want to get
|
223
277
|
# @param [Hash] opts the optional parameters
|
224
|
-
# @return [Array<(
|
225
|
-
def
|
278
|
+
# @return [Array<(Object, Integer, Hash)>] Object data, response status code and response headers
|
279
|
+
def get_schema_with_http_info(id, opts = {})
|
226
280
|
if @api_client.config.debugging
|
227
|
-
@api_client.config.logger.debug 'Calling API: AdminApi.
|
281
|
+
@api_client.config.logger.debug 'Calling API: AdminApi.get_schema ...'
|
228
282
|
end
|
229
|
-
# verify the required parameter '
|
230
|
-
if @api_client.config.client_side_validation &&
|
231
|
-
fail ArgumentError, "Missing the required parameter '
|
283
|
+
# verify the required parameter 'id' is set
|
284
|
+
if @api_client.config.client_side_validation && id.nil?
|
285
|
+
fail ArgumentError, "Missing the required parameter 'id' when calling AdminApi.get_schema"
|
232
286
|
end
|
233
287
|
# resource path
|
234
|
-
local_var_path = '/
|
288
|
+
local_var_path = '/schemas/{id}'.sub('{' + 'id' + '}', CGI.escape(id.to_s))
|
235
289
|
|
236
290
|
# query parameters
|
237
291
|
query_params = opts[:query_params] || {}
|
238
|
-
query_params[:'request'] = request
|
239
292
|
|
240
293
|
# header parameters
|
241
294
|
header_params = opts[:header_params] || {}
|
@@ -249,7 +302,7 @@ module OryHydraClient
|
|
249
302
|
post_body = opts[:body]
|
250
303
|
|
251
304
|
# return_type
|
252
|
-
return_type = opts[:return_type] || '
|
305
|
+
return_type = opts[:return_type] || 'Object'
|
253
306
|
|
254
307
|
# auth_names
|
255
308
|
auth_names = opts[:auth_names] || []
|
@@ -265,40 +318,40 @@ module OryHydraClient
|
|
265
318
|
|
266
319
|
data, status_code, headers = @api_client.call_api(:GET, local_var_path, new_options)
|
267
320
|
if @api_client.config.debugging
|
268
|
-
@api_client.config.logger.debug "API called: AdminApi#
|
321
|
+
@api_client.config.logger.debug "API called: AdminApi#get_schema\nData: #{data.inspect}\nStatus code: #{status_code}\nHeaders: #{headers}"
|
269
322
|
end
|
270
323
|
return data, status_code, headers
|
271
324
|
end
|
272
325
|
|
273
|
-
# Get
|
274
|
-
#
|
275
|
-
# @param
|
326
|
+
# Get User-Facing Self-Service Errors
|
327
|
+
# This endpoint returns the error associated with a user-facing self service errors. This endpoint supports stub values to help you implement the error UI: `?error=stub:500` - returns a stub 500 (Internal Server Error) error. 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).
|
328
|
+
# @param error [String] Error is the container's ID
|
276
329
|
# @param [Hash] opts the optional parameters
|
277
|
-
# @return [
|
278
|
-
def
|
279
|
-
data, _status_code, _headers =
|
330
|
+
# @return [ErrorContainer]
|
331
|
+
def get_self_service_error(error, opts = {})
|
332
|
+
data, _status_code, _headers = get_self_service_error_with_http_info(error, opts)
|
280
333
|
data
|
281
334
|
end
|
282
335
|
|
283
|
-
# Get
|
284
|
-
#
|
285
|
-
# @param
|
336
|
+
# Get User-Facing Self-Service Errors
|
337
|
+
# This endpoint returns the error associated with a user-facing self service errors. This endpoint supports stub values to help you implement the error UI: `?error=stub:500` - returns a stub 500 (Internal Server Error) error. 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).
|
338
|
+
# @param error [String] Error is the container's ID
|
286
339
|
# @param [Hash] opts the optional parameters
|
287
|
-
# @return [Array<(
|
288
|
-
def
|
340
|
+
# @return [Array<(ErrorContainer, Integer, Hash)>] ErrorContainer data, response status code and response headers
|
341
|
+
def get_self_service_error_with_http_info(error, opts = {})
|
289
342
|
if @api_client.config.debugging
|
290
|
-
@api_client.config.logger.debug 'Calling API: AdminApi.
|
343
|
+
@api_client.config.logger.debug 'Calling API: AdminApi.get_self_service_error ...'
|
291
344
|
end
|
292
|
-
# verify the required parameter '
|
293
|
-
if @api_client.config.client_side_validation &&
|
294
|
-
fail ArgumentError, "Missing the required parameter '
|
345
|
+
# verify the required parameter 'error' is set
|
346
|
+
if @api_client.config.client_side_validation && error.nil?
|
347
|
+
fail ArgumentError, "Missing the required parameter 'error' when calling AdminApi.get_self_service_error"
|
295
348
|
end
|
296
349
|
# resource path
|
297
|
-
local_var_path = '/self-service/
|
350
|
+
local_var_path = '/self-service/errors'
|
298
351
|
|
299
352
|
# query parameters
|
300
353
|
query_params = opts[:query_params] || {}
|
301
|
-
query_params[:'
|
354
|
+
query_params[:'error'] = error
|
302
355
|
|
303
356
|
# header parameters
|
304
357
|
header_params = opts[:header_params] || {}
|
@@ -312,7 +365,7 @@ module OryHydraClient
|
|
312
365
|
post_body = opts[:body]
|
313
366
|
|
314
367
|
# return_type
|
315
|
-
return_type = opts[:return_type] || '
|
368
|
+
return_type = opts[:return_type] || 'ErrorContainer'
|
316
369
|
|
317
370
|
# auth_names
|
318
371
|
auth_names = opts[:auth_names] || []
|
@@ -328,40 +381,40 @@ module OryHydraClient
|
|
328
381
|
|
329
382
|
data, status_code, headers = @api_client.call_api(:GET, local_var_path, new_options)
|
330
383
|
if @api_client.config.debugging
|
331
|
-
@api_client.config.logger.debug "API called: AdminApi#
|
384
|
+
@api_client.config.logger.debug "API called: AdminApi#get_self_service_error\nData: #{data.inspect}\nStatus code: #{status_code}\nHeaders: #{headers}"
|
332
385
|
end
|
333
386
|
return data, status_code, headers
|
334
387
|
end
|
335
388
|
|
336
|
-
# Get
|
337
|
-
# This endpoint returns a
|
338
|
-
# @param
|
389
|
+
# Get Login Flow
|
390
|
+
# This endpoint returns a login flow's context with, for example, error details and other information. 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).
|
391
|
+
# @param id [String] The Login Flow ID The value for this parameter comes from `flow` URL Query parameter sent to your application (e.g. `/login?flow=abcde`).
|
339
392
|
# @param [Hash] opts the optional parameters
|
340
|
-
# @return [
|
341
|
-
def
|
342
|
-
data, _status_code, _headers =
|
393
|
+
# @return [LoginFlow]
|
394
|
+
def get_self_service_login_flow(id, opts = {})
|
395
|
+
data, _status_code, _headers = get_self_service_login_flow_with_http_info(id, opts)
|
343
396
|
data
|
344
397
|
end
|
345
398
|
|
346
|
-
# Get
|
347
|
-
# This endpoint returns a
|
348
|
-
# @param
|
399
|
+
# Get Login Flow
|
400
|
+
# This endpoint returns a login flow's context with, for example, error details and other information. 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).
|
401
|
+
# @param id [String] The Login Flow ID The value for this parameter comes from `flow` URL Query parameter sent to your application (e.g. `/login?flow=abcde`).
|
349
402
|
# @param [Hash] opts the optional parameters
|
350
|
-
# @return [Array<(
|
351
|
-
def
|
403
|
+
# @return [Array<(LoginFlow, Integer, Hash)>] LoginFlow data, response status code and response headers
|
404
|
+
def get_self_service_login_flow_with_http_info(id, opts = {})
|
352
405
|
if @api_client.config.debugging
|
353
|
-
@api_client.config.logger.debug 'Calling API: AdminApi.
|
406
|
+
@api_client.config.logger.debug 'Calling API: AdminApi.get_self_service_login_flow ...'
|
354
407
|
end
|
355
|
-
# verify the required parameter '
|
356
|
-
if @api_client.config.client_side_validation &&
|
357
|
-
fail ArgumentError, "Missing the required parameter '
|
408
|
+
# verify the required parameter 'id' is set
|
409
|
+
if @api_client.config.client_side_validation && id.nil?
|
410
|
+
fail ArgumentError, "Missing the required parameter 'id' when calling AdminApi.get_self_service_login_flow"
|
358
411
|
end
|
359
412
|
# resource path
|
360
|
-
local_var_path = '/self-service/
|
413
|
+
local_var_path = '/self-service/login/flows'
|
361
414
|
|
362
415
|
# query parameters
|
363
416
|
query_params = opts[:query_params] || {}
|
364
|
-
query_params[:'
|
417
|
+
query_params[:'id'] = id
|
365
418
|
|
366
419
|
# header parameters
|
367
420
|
header_params = opts[:header_params] || {}
|
@@ -375,7 +428,7 @@ module OryHydraClient
|
|
375
428
|
post_body = opts[:body]
|
376
429
|
|
377
430
|
# return_type
|
378
|
-
return_type = opts[:return_type] || '
|
431
|
+
return_type = opts[:return_type] || 'LoginFlow'
|
379
432
|
|
380
433
|
# auth_names
|
381
434
|
auth_names = opts[:auth_names] || []
|
@@ -391,36 +444,40 @@ module OryHydraClient
|
|
391
444
|
|
392
445
|
data, status_code, headers = @api_client.call_api(:GET, local_var_path, new_options)
|
393
446
|
if @api_client.config.debugging
|
394
|
-
@api_client.config.logger.debug "API called: AdminApi#
|
447
|
+
@api_client.config.logger.debug "API called: AdminApi#get_self_service_login_flow\nData: #{data.inspect}\nStatus code: #{status_code}\nHeaders: #{headers}"
|
395
448
|
end
|
396
449
|
return data, status_code, headers
|
397
450
|
end
|
398
451
|
|
399
|
-
# Get
|
400
|
-
# This endpoint returns
|
452
|
+
# Get information about a recovery flow
|
453
|
+
# This endpoint returns a recovery flow's context with, for example, error details and other information. More information can be found at [ORY Kratos Account Recovery Documentation](../self-service/flows/account-recovery.mdx).
|
454
|
+
# @param id [String] The Flow ID The value for this parameter comes from `request` URL Query parameter sent to your application (e.g. `/recovery?flow=abcde`).
|
401
455
|
# @param [Hash] opts the optional parameters
|
402
|
-
# @
|
403
|
-
|
404
|
-
|
405
|
-
data, _status_code, _headers = get_self_service_error_with_http_info(opts)
|
456
|
+
# @return [RecoveryFlow]
|
457
|
+
def get_self_service_recovery_flow(id, opts = {})
|
458
|
+
data, _status_code, _headers = get_self_service_recovery_flow_with_http_info(id, opts)
|
406
459
|
data
|
407
460
|
end
|
408
461
|
|
409
|
-
# Get
|
410
|
-
# This endpoint returns
|
462
|
+
# Get information about a recovery flow
|
463
|
+
# This endpoint returns a recovery flow's context with, for example, error details and other information. More information can be found at [ORY Kratos Account Recovery Documentation](../self-service/flows/account-recovery.mdx).
|
464
|
+
# @param id [String] The Flow ID The value for this parameter comes from `request` URL Query parameter sent to your application (e.g. `/recovery?flow=abcde`).
|
411
465
|
# @param [Hash] opts the optional parameters
|
412
|
-
# @
|
413
|
-
|
414
|
-
def get_self_service_error_with_http_info(opts = {})
|
466
|
+
# @return [Array<(RecoveryFlow, Integer, Hash)>] RecoveryFlow data, response status code and response headers
|
467
|
+
def get_self_service_recovery_flow_with_http_info(id, opts = {})
|
415
468
|
if @api_client.config.debugging
|
416
|
-
@api_client.config.logger.debug 'Calling API: AdminApi.
|
469
|
+
@api_client.config.logger.debug 'Calling API: AdminApi.get_self_service_recovery_flow ...'
|
470
|
+
end
|
471
|
+
# verify the required parameter 'id' is set
|
472
|
+
if @api_client.config.client_side_validation && id.nil?
|
473
|
+
fail ArgumentError, "Missing the required parameter 'id' when calling AdminApi.get_self_service_recovery_flow"
|
417
474
|
end
|
418
475
|
# resource path
|
419
|
-
local_var_path = '/self-service/
|
476
|
+
local_var_path = '/self-service/recovery/flows'
|
420
477
|
|
421
478
|
# query parameters
|
422
479
|
query_params = opts[:query_params] || {}
|
423
|
-
query_params[:'id'] =
|
480
|
+
query_params[:'id'] = id
|
424
481
|
|
425
482
|
# header parameters
|
426
483
|
header_params = opts[:header_params] || {}
|
@@ -434,7 +491,7 @@ module OryHydraClient
|
|
434
491
|
post_body = opts[:body]
|
435
492
|
|
436
493
|
# return_type
|
437
|
-
return_type = opts[:return_type] || '
|
494
|
+
return_type = opts[:return_type] || 'RecoveryFlow'
|
438
495
|
|
439
496
|
# auth_names
|
440
497
|
auth_names = opts[:auth_names] || []
|
@@ -450,40 +507,166 @@ module OryHydraClient
|
|
450
507
|
|
451
508
|
data, status_code, headers = @api_client.call_api(:GET, local_var_path, new_options)
|
452
509
|
if @api_client.config.debugging
|
453
|
-
@api_client.config.logger.debug "API called: AdminApi#
|
510
|
+
@api_client.config.logger.debug "API called: AdminApi#get_self_service_recovery_flow\nData: #{data.inspect}\nStatus code: #{status_code}\nHeaders: #{headers}"
|
511
|
+
end
|
512
|
+
return data, status_code, headers
|
513
|
+
end
|
514
|
+
|
515
|
+
# Get Registration Flow
|
516
|
+
# This endpoint returns a registration flow's context with, for example, error details and other information. 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).
|
517
|
+
# @param id [String] The Registration Flow ID The value for this parameter comes from `flow` URL Query parameter sent to your application (e.g. `/registration?flow=abcde`).
|
518
|
+
# @param [Hash] opts the optional parameters
|
519
|
+
# @return [RegistrationFlow]
|
520
|
+
def get_self_service_registration_flow(id, opts = {})
|
521
|
+
data, _status_code, _headers = get_self_service_registration_flow_with_http_info(id, opts)
|
522
|
+
data
|
523
|
+
end
|
524
|
+
|
525
|
+
# Get Registration Flow
|
526
|
+
# This endpoint returns a registration flow's context with, for example, error details and other information. 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).
|
527
|
+
# @param id [String] The Registration Flow ID The value for this parameter comes from `flow` URL Query parameter sent to your application (e.g. `/registration?flow=abcde`).
|
528
|
+
# @param [Hash] opts the optional parameters
|
529
|
+
# @return [Array<(RegistrationFlow, Integer, Hash)>] RegistrationFlow data, response status code and response headers
|
530
|
+
def get_self_service_registration_flow_with_http_info(id, opts = {})
|
531
|
+
if @api_client.config.debugging
|
532
|
+
@api_client.config.logger.debug 'Calling API: AdminApi.get_self_service_registration_flow ...'
|
533
|
+
end
|
534
|
+
# verify the required parameter 'id' is set
|
535
|
+
if @api_client.config.client_side_validation && id.nil?
|
536
|
+
fail ArgumentError, "Missing the required parameter 'id' when calling AdminApi.get_self_service_registration_flow"
|
537
|
+
end
|
538
|
+
# resource path
|
539
|
+
local_var_path = '/self-service/registration/flows'
|
540
|
+
|
541
|
+
# query parameters
|
542
|
+
query_params = opts[:query_params] || {}
|
543
|
+
query_params[:'id'] = id
|
544
|
+
|
545
|
+
# header parameters
|
546
|
+
header_params = opts[:header_params] || {}
|
547
|
+
# HTTP header 'Accept' (if needed)
|
548
|
+
header_params['Accept'] = @api_client.select_header_accept(['application/json'])
|
549
|
+
|
550
|
+
# form parameters
|
551
|
+
form_params = opts[:form_params] || {}
|
552
|
+
|
553
|
+
# http body (model)
|
554
|
+
post_body = opts[:body]
|
555
|
+
|
556
|
+
# return_type
|
557
|
+
return_type = opts[:return_type] || 'RegistrationFlow'
|
558
|
+
|
559
|
+
# auth_names
|
560
|
+
auth_names = opts[:auth_names] || []
|
561
|
+
|
562
|
+
new_options = opts.merge(
|
563
|
+
:header_params => header_params,
|
564
|
+
:query_params => query_params,
|
565
|
+
:form_params => form_params,
|
566
|
+
:body => post_body,
|
567
|
+
:auth_names => auth_names,
|
568
|
+
:return_type => return_type
|
569
|
+
)
|
570
|
+
|
571
|
+
data, status_code, headers = @api_client.call_api(:GET, local_var_path, new_options)
|
572
|
+
if @api_client.config.debugging
|
573
|
+
@api_client.config.logger.debug "API called: AdminApi#get_self_service_registration_flow\nData: #{data.inspect}\nStatus code: #{status_code}\nHeaders: #{headers}"
|
574
|
+
end
|
575
|
+
return data, status_code, headers
|
576
|
+
end
|
577
|
+
|
578
|
+
# Get Settings Flow
|
579
|
+
# When accessing this endpoint through ORY Kratos' Public API you must ensure that either the ORY Kratos Session Cookie or the ORY Kratos Session Token are set. The public endpoint does not return 404 status codes but instead 403 or 500 to improve data privacy. You can access this endpoint without credentials when using ORY Kratos' Admin API. More information can be found at [ORY Kratos User Settings & Profile Management Documentation](../self-service/flows/user-settings).
|
580
|
+
# @param id [String] ID is the Settings Flow ID The value for this parameter comes from `flow` URL Query parameter sent to your application (e.g. `/settings?flow=abcde`).
|
581
|
+
# @param [Hash] opts the optional parameters
|
582
|
+
# @return [SettingsFlow]
|
583
|
+
def get_self_service_settings_flow(id, opts = {})
|
584
|
+
data, _status_code, _headers = get_self_service_settings_flow_with_http_info(id, opts)
|
585
|
+
data
|
586
|
+
end
|
587
|
+
|
588
|
+
# Get Settings Flow
|
589
|
+
# When accessing this endpoint through ORY Kratos' Public API you must ensure that either the ORY Kratos Session Cookie or the ORY Kratos Session Token are set. The public endpoint does not return 404 status codes but instead 403 or 500 to improve data privacy. You can access this endpoint without credentials when using ORY Kratos' Admin API. More information can be found at [ORY Kratos User Settings & Profile Management Documentation](../self-service/flows/user-settings).
|
590
|
+
# @param id [String] ID is the Settings Flow ID The value for this parameter comes from `flow` URL Query parameter sent to your application (e.g. `/settings?flow=abcde`).
|
591
|
+
# @param [Hash] opts the optional parameters
|
592
|
+
# @return [Array<(SettingsFlow, Integer, Hash)>] SettingsFlow data, response status code and response headers
|
593
|
+
def get_self_service_settings_flow_with_http_info(id, opts = {})
|
594
|
+
if @api_client.config.debugging
|
595
|
+
@api_client.config.logger.debug 'Calling API: AdminApi.get_self_service_settings_flow ...'
|
596
|
+
end
|
597
|
+
# verify the required parameter 'id' is set
|
598
|
+
if @api_client.config.client_side_validation && id.nil?
|
599
|
+
fail ArgumentError, "Missing the required parameter 'id' when calling AdminApi.get_self_service_settings_flow"
|
600
|
+
end
|
601
|
+
# resource path
|
602
|
+
local_var_path = '/self-service/settings/flows'
|
603
|
+
|
604
|
+
# query parameters
|
605
|
+
query_params = opts[:query_params] || {}
|
606
|
+
query_params[:'id'] = id
|
607
|
+
|
608
|
+
# header parameters
|
609
|
+
header_params = opts[:header_params] || {}
|
610
|
+
# HTTP header 'Accept' (if needed)
|
611
|
+
header_params['Accept'] = @api_client.select_header_accept(['application/json'])
|
612
|
+
|
613
|
+
# form parameters
|
614
|
+
form_params = opts[:form_params] || {}
|
615
|
+
|
616
|
+
# http body (model)
|
617
|
+
post_body = opts[:body]
|
618
|
+
|
619
|
+
# return_type
|
620
|
+
return_type = opts[:return_type] || 'SettingsFlow'
|
621
|
+
|
622
|
+
# auth_names
|
623
|
+
auth_names = opts[:auth_names] || ['sessionToken']
|
624
|
+
|
625
|
+
new_options = opts.merge(
|
626
|
+
:header_params => header_params,
|
627
|
+
:query_params => query_params,
|
628
|
+
:form_params => form_params,
|
629
|
+
:body => post_body,
|
630
|
+
:auth_names => auth_names,
|
631
|
+
:return_type => return_type
|
632
|
+
)
|
633
|
+
|
634
|
+
data, status_code, headers = @api_client.call_api(:GET, local_var_path, new_options)
|
635
|
+
if @api_client.config.debugging
|
636
|
+
@api_client.config.logger.debug "API called: AdminApi#get_self_service_settings_flow\nData: #{data.inspect}\nStatus code: #{status_code}\nHeaders: #{headers}"
|
454
637
|
end
|
455
638
|
return data, status_code, headers
|
456
639
|
end
|
457
640
|
|
458
|
-
# Get
|
459
|
-
#
|
460
|
-
# @param
|
641
|
+
# Get Verification Flow
|
642
|
+
# This endpoint returns a verification flow's context with, for example, error details and other information. 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).
|
643
|
+
# @param id [String] The Flow ID The value for this parameter comes from `request` URL Query parameter sent to your application (e.g. `/verification?flow=abcde`).
|
461
644
|
# @param [Hash] opts the optional parameters
|
462
|
-
# @return [
|
463
|
-
def
|
464
|
-
data, _status_code, _headers =
|
645
|
+
# @return [VerificationFlow]
|
646
|
+
def get_self_service_verification_flow(id, opts = {})
|
647
|
+
data, _status_code, _headers = get_self_service_verification_flow_with_http_info(id, opts)
|
465
648
|
data
|
466
649
|
end
|
467
650
|
|
468
|
-
# Get
|
469
|
-
#
|
470
|
-
# @param
|
651
|
+
# Get Verification Flow
|
652
|
+
# This endpoint returns a verification flow's context with, for example, error details and other information. 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).
|
653
|
+
# @param id [String] The Flow ID The value for this parameter comes from `request` URL Query parameter sent to your application (e.g. `/verification?flow=abcde`).
|
471
654
|
# @param [Hash] opts the optional parameters
|
472
|
-
# @return [Array<(
|
473
|
-
def
|
655
|
+
# @return [Array<(VerificationFlow, Integer, Hash)>] VerificationFlow data, response status code and response headers
|
656
|
+
def get_self_service_verification_flow_with_http_info(id, opts = {})
|
474
657
|
if @api_client.config.debugging
|
475
|
-
@api_client.config.logger.debug 'Calling API: AdminApi.
|
658
|
+
@api_client.config.logger.debug 'Calling API: AdminApi.get_self_service_verification_flow ...'
|
476
659
|
end
|
477
|
-
# verify the required parameter '
|
478
|
-
if @api_client.config.client_side_validation &&
|
479
|
-
fail ArgumentError, "Missing the required parameter '
|
660
|
+
# verify the required parameter 'id' is set
|
661
|
+
if @api_client.config.client_side_validation && id.nil?
|
662
|
+
fail ArgumentError, "Missing the required parameter 'id' when calling AdminApi.get_self_service_verification_flow"
|
480
663
|
end
|
481
664
|
# resource path
|
482
|
-
local_var_path = '/self-service/
|
665
|
+
local_var_path = '/self-service/verification/flows'
|
483
666
|
|
484
667
|
# query parameters
|
485
668
|
query_params = opts[:query_params] || {}
|
486
|
-
query_params[:'
|
669
|
+
query_params[:'id'] = id
|
487
670
|
|
488
671
|
# header parameters
|
489
672
|
header_params = opts[:header_params] || {}
|
@@ -497,7 +680,7 @@ module OryHydraClient
|
|
497
680
|
post_body = opts[:body]
|
498
681
|
|
499
682
|
# return_type
|
500
|
-
return_type = opts[:return_type] || '
|
683
|
+
return_type = opts[:return_type] || 'VerificationFlow'
|
501
684
|
|
502
685
|
# auth_names
|
503
686
|
auth_names = opts[:auth_names] || []
|
@@ -513,33 +696,51 @@ module OryHydraClient
|
|
513
696
|
|
514
697
|
data, status_code, headers = @api_client.call_api(:GET, local_var_path, new_options)
|
515
698
|
if @api_client.config.debugging
|
516
|
-
@api_client.config.logger.debug "API called: AdminApi#
|
699
|
+
@api_client.config.logger.debug "API called: AdminApi#get_self_service_verification_flow\nData: #{data.inspect}\nStatus code: #{status_code}\nHeaders: #{headers}"
|
517
700
|
end
|
518
701
|
return data, status_code, headers
|
519
702
|
end
|
520
703
|
|
521
|
-
# List
|
522
|
-
#
|
704
|
+
# List Identities
|
705
|
+
# Lists all identities. Does not support search at the moment. Learn how identities work in [ORY Kratos' User And Identity Model Documentation](https://www.ory.sh/docs/next/kratos/concepts/identity-user-model).
|
523
706
|
# @param [Hash] opts the optional parameters
|
707
|
+
# @option opts [Integer] :per_page Items per Page This is the number of items per page. (default to 100)
|
708
|
+
# @option opts [Integer] :page Pagination Page (default to 0)
|
524
709
|
# @return [Array<Identity>]
|
525
710
|
def list_identities(opts = {})
|
526
711
|
data, _status_code, _headers = list_identities_with_http_info(opts)
|
527
712
|
data
|
528
713
|
end
|
529
714
|
|
530
|
-
# List
|
531
|
-
#
|
715
|
+
# List Identities
|
716
|
+
# Lists all identities. Does not support search at the moment. Learn how identities work in [ORY Kratos' User And Identity Model Documentation](https://www.ory.sh/docs/next/kratos/concepts/identity-user-model).
|
532
717
|
# @param [Hash] opts the optional parameters
|
718
|
+
# @option opts [Integer] :per_page Items per Page This is the number of items per page.
|
719
|
+
# @option opts [Integer] :page Pagination Page
|
533
720
|
# @return [Array<(Array<Identity>, Integer, Hash)>] Array<Identity> data, response status code and response headers
|
534
721
|
def list_identities_with_http_info(opts = {})
|
535
722
|
if @api_client.config.debugging
|
536
723
|
@api_client.config.logger.debug 'Calling API: AdminApi.list_identities ...'
|
537
724
|
end
|
725
|
+
if @api_client.config.client_side_validation && !opts[:'per_page'].nil? && opts[:'per_page'] > 500
|
726
|
+
fail ArgumentError, 'invalid value for "opts[:"per_page"]" when calling AdminApi.list_identities, must be smaller than or equal to 500.'
|
727
|
+
end
|
728
|
+
|
729
|
+
if @api_client.config.client_side_validation && !opts[:'per_page'].nil? && opts[:'per_page'] < 1
|
730
|
+
fail ArgumentError, 'invalid value for "opts[:"per_page"]" when calling AdminApi.list_identities, must be greater than or equal to 1.'
|
731
|
+
end
|
732
|
+
|
733
|
+
if @api_client.config.client_side_validation && !opts[:'page'].nil? && opts[:'page'] < 0
|
734
|
+
fail ArgumentError, 'invalid value for "opts[:"page"]" when calling AdminApi.list_identities, must be greater than or equal to 0.'
|
735
|
+
end
|
736
|
+
|
538
737
|
# resource path
|
539
738
|
local_var_path = '/identities'
|
540
739
|
|
541
740
|
# query parameters
|
542
741
|
query_params = opts[:query_params] || {}
|
742
|
+
query_params[:'per_page'] = opts[:'per_page'] if !opts[:'per_page'].nil?
|
743
|
+
query_params[:'page'] = opts[:'page'] if !opts[:'page'].nil?
|
543
744
|
|
544
745
|
# header parameters
|
545
746
|
header_params = opts[:header_params] || {}
|
@@ -574,24 +775,78 @@ module OryHydraClient
|
|
574
775
|
return data, status_code, headers
|
575
776
|
end
|
576
777
|
|
577
|
-
#
|
778
|
+
# Get snapshot metrics from the Hydra service. If you're using k8s, you can then add annotations to your deployment like so:
|
779
|
+
# ``` metadata: annotations: prometheus.io/port: \"4434\" prometheus.io/path: \"/metrics/prometheus\" ```
|
780
|
+
# @param [Hash] opts the optional parameters
|
781
|
+
# @return [nil]
|
782
|
+
def prometheus(opts = {})
|
783
|
+
prometheus_with_http_info(opts)
|
784
|
+
nil
|
785
|
+
end
|
786
|
+
|
787
|
+
# Get snapshot metrics from the Hydra service. If you're using k8s, you can then add annotations to your deployment like so:
|
788
|
+
# ``` metadata: annotations: prometheus.io/port: \"4434\" prometheus.io/path: \"/metrics/prometheus\" ```
|
789
|
+
# @param [Hash] opts the optional parameters
|
790
|
+
# @return [Array<(nil, Integer, Hash)>] nil, response status code and response headers
|
791
|
+
def prometheus_with_http_info(opts = {})
|
792
|
+
if @api_client.config.debugging
|
793
|
+
@api_client.config.logger.debug 'Calling API: AdminApi.prometheus ...'
|
794
|
+
end
|
795
|
+
# resource path
|
796
|
+
local_var_path = '/metrics/prometheus'
|
797
|
+
|
798
|
+
# query parameters
|
799
|
+
query_params = opts[:query_params] || {}
|
800
|
+
|
801
|
+
# header parameters
|
802
|
+
header_params = opts[:header_params] || {}
|
803
|
+
|
804
|
+
# form parameters
|
805
|
+
form_params = opts[:form_params] || {}
|
806
|
+
|
807
|
+
# http body (model)
|
808
|
+
post_body = opts[:body]
|
809
|
+
|
810
|
+
# return_type
|
811
|
+
return_type = opts[:return_type]
|
812
|
+
|
813
|
+
# auth_names
|
814
|
+
auth_names = opts[:auth_names] || []
|
815
|
+
|
816
|
+
new_options = opts.merge(
|
817
|
+
:header_params => header_params,
|
818
|
+
:query_params => query_params,
|
819
|
+
:form_params => form_params,
|
820
|
+
:body => post_body,
|
821
|
+
:auth_names => auth_names,
|
822
|
+
:return_type => return_type
|
823
|
+
)
|
824
|
+
|
825
|
+
data, status_code, headers = @api_client.call_api(:GET, local_var_path, new_options)
|
826
|
+
if @api_client.config.debugging
|
827
|
+
@api_client.config.logger.debug "API called: AdminApi#prometheus\nData: #{data.inspect}\nStatus code: #{status_code}\nHeaders: #{headers}"
|
828
|
+
end
|
829
|
+
return data, status_code, headers
|
830
|
+
end
|
831
|
+
|
832
|
+
# Update an Identity
|
578
833
|
# This endpoint updates an identity. It is NOT possible to set an identity's credentials (password, ...) using this method! A way to achieve that will be introduced in the future. The full identity payload (except credentials) is expected. This endpoint does not support patching. Learn how identities work in [ORY Kratos' User And Identity Model Documentation](https://www.ory.sh/docs/next/kratos/concepts/identity-user-model).
|
579
834
|
# @param id [String] ID must be set to the ID of identity you want to update
|
580
|
-
# @param body [Identity]
|
581
835
|
# @param [Hash] opts the optional parameters
|
836
|
+
# @option opts [UpdateIdentity] :body
|
582
837
|
# @return [Identity]
|
583
|
-
def update_identity(id,
|
584
|
-
data, _status_code, _headers = update_identity_with_http_info(id,
|
838
|
+
def update_identity(id, opts = {})
|
839
|
+
data, _status_code, _headers = update_identity_with_http_info(id, opts)
|
585
840
|
data
|
586
841
|
end
|
587
842
|
|
588
|
-
# Update an
|
843
|
+
# Update an Identity
|
589
844
|
# This endpoint updates an identity. It is NOT possible to set an identity's credentials (password, ...) using this method! A way to achieve that will be introduced in the future. The full identity payload (except credentials) is expected. This endpoint does not support patching. Learn how identities work in [ORY Kratos' User And Identity Model Documentation](https://www.ory.sh/docs/next/kratos/concepts/identity-user-model).
|
590
845
|
# @param id [String] ID must be set to the ID of identity you want to update
|
591
|
-
# @param body [Identity]
|
592
846
|
# @param [Hash] opts the optional parameters
|
847
|
+
# @option opts [UpdateIdentity] :body
|
593
848
|
# @return [Array<(Identity, Integer, Hash)>] Identity data, response status code and response headers
|
594
|
-
def update_identity_with_http_info(id,
|
849
|
+
def update_identity_with_http_info(id, opts = {})
|
595
850
|
if @api_client.config.debugging
|
596
851
|
@api_client.config.logger.debug 'Calling API: AdminApi.update_identity ...'
|
597
852
|
end
|
@@ -599,10 +854,6 @@ module OryHydraClient
|
|
599
854
|
if @api_client.config.client_side_validation && id.nil?
|
600
855
|
fail ArgumentError, "Missing the required parameter 'id' when calling AdminApi.update_identity"
|
601
856
|
end
|
602
|
-
# verify the required parameter 'body' is set
|
603
|
-
if @api_client.config.client_side_validation && body.nil?
|
604
|
-
fail ArgumentError, "Missing the required parameter 'body' when calling AdminApi.update_identity"
|
605
|
-
end
|
606
857
|
# resource path
|
607
858
|
local_var_path = '/identities/{id}'.sub('{' + 'id' + '}', CGI.escape(id.to_s))
|
608
859
|
|
@@ -620,7 +871,7 @@ module OryHydraClient
|
|
620
871
|
form_params = opts[:form_params] || {}
|
621
872
|
|
622
873
|
# http body (model)
|
623
|
-
post_body = opts[:body] || @api_client.object_to_http_body(body)
|
874
|
+
post_body = opts[:body] || @api_client.object_to_http_body(opts[:'body'])
|
624
875
|
|
625
876
|
# return_type
|
626
877
|
return_type = opts[:return_type] || 'Identity'
|