ory-kratos-client 0.5.0.alpha1 → 0.5.5.alpha2
Sign up to get free protection for your applications and to get access to all the features.
- checksums.yaml +4 -4
- data/README.md +7 -7
- data/docs/AdminApi.md +382 -143
- data/docs/CompleteSelfServiceLoginFlowWithPasswordMethod.md +12 -11
- data/docs/CompleteSelfServiceRecoveryFlowWithLinkMethod.md +10 -9
- data/docs/CompleteSelfServiceSettingsFlowWithPasswordMethod.md +10 -9
- data/docs/CompleteSelfServiceVerificationFlowWithLinkMethod.md +10 -9
- data/docs/CreateIdentity.md +10 -9
- data/docs/CreateRecoveryLink.md +10 -9
- data/docs/ErrorContainer.md +10 -9
- data/docs/FormField.md +20 -19
- data/docs/GenericError.md +8 -7
- data/docs/GenericErrorPayload.md +20 -19
- data/docs/HealthApi.md +50 -15
- data/docs/HealthNotReadyStatus.md +8 -7
- data/docs/HealthStatus.md +8 -7
- data/docs/Identity.md +18 -17
- data/docs/LoginFlow.md +24 -23
- data/docs/LoginFlowMethod.md +10 -9
- data/docs/LoginFlowMethodConfig.md +16 -15
- data/docs/LoginViaApiResponse.md +10 -9
- data/docs/Message.md +14 -13
- data/docs/PublicApi.md +707 -237
- data/docs/RecoveryAddress.md +12 -11
- data/docs/RecoveryFlow.md +24 -23
- data/docs/RecoveryFlowMethod.md +10 -9
- data/docs/RecoveryFlowMethodConfig.md +14 -13
- data/docs/RecoveryLink.md +10 -9
- data/docs/RegistrationFlow.md +22 -21
- data/docs/RegistrationFlowMethod.md +10 -9
- data/docs/RegistrationFlowMethodConfig.md +16 -15
- data/docs/RegistrationViaApiResponse.md +12 -11
- data/docs/RevokeSession.md +8 -7
- data/docs/Session.md +18 -17
- data/docs/SettingsFlow.md +26 -25
- data/docs/SettingsFlowMethod.md +10 -9
- data/docs/SettingsFlowMethodConfig.md +14 -13
- data/docs/SettingsViaApiResponse.md +10 -9
- data/docs/UpdateIdentity.md +10 -9
- data/docs/VerifiableAddress.md +18 -17
- data/docs/VerificationFlow.md +24 -23
- data/docs/VerificationFlowMethod.md +10 -9
- data/docs/VerificationFlowMethodConfig.md +14 -13
- data/docs/Version.md +8 -7
- data/docs/VersionApi.md +26 -9
- data/lib/ory-kratos-client.rb +2 -2
- data/lib/ory-kratos-client/api/admin_api.rb +58 -44
- data/lib/ory-kratos-client/api/health_api.rb +10 -8
- data/lib/ory-kratos-client/api/public_api.rb +113 -86
- data/lib/ory-kratos-client/api/version_api.rb +6 -5
- data/lib/ory-kratos-client/api_client.rb +50 -48
- data/lib/ory-kratos-client/api_error.rb +2 -2
- data/lib/ory-kratos-client/configuration.rb +34 -7
- data/lib/ory-kratos-client/models/complete_self_service_login_flow_with_password_method.rb +20 -8
- data/lib/ory-kratos-client/models/complete_self_service_recovery_flow_with_link_method.rb +20 -8
- data/lib/ory-kratos-client/models/complete_self_service_settings_flow_with_password_method.rb +20 -8
- data/lib/ory-kratos-client/models/complete_self_service_verification_flow_with_link_method.rb +20 -8
- data/lib/ory-kratos-client/models/create_identity.rb +20 -8
- data/lib/ory-kratos-client/models/create_recovery_link.rb +20 -8
- data/lib/ory-kratos-client/models/error_container.rb +20 -8
- data/lib/ory-kratos-client/models/form_field.rb +20 -8
- data/lib/ory-kratos-client/models/generic_error.rb +20 -8
- data/lib/ory-kratos-client/models/generic_error_payload.rb +20 -8
- data/lib/ory-kratos-client/models/health_not_ready_status.rb +20 -8
- data/lib/ory-kratos-client/models/health_status.rb +20 -8
- data/lib/ory-kratos-client/models/identity.rb +20 -8
- data/lib/ory-kratos-client/models/login_flow.rb +22 -10
- data/lib/ory-kratos-client/models/login_flow_method.rb +20 -8
- data/lib/ory-kratos-client/models/login_flow_method_config.rb +20 -8
- data/lib/ory-kratos-client/models/login_via_api_response.rb +20 -8
- data/lib/ory-kratos-client/models/message.rb +20 -8
- data/lib/ory-kratos-client/models/recovery_address.rb +20 -8
- data/lib/ory-kratos-client/models/recovery_flow.rb +22 -10
- data/lib/ory-kratos-client/models/recovery_flow_method.rb +20 -8
- data/lib/ory-kratos-client/models/recovery_flow_method_config.rb +20 -8
- data/lib/ory-kratos-client/models/recovery_link.rb +21 -9
- data/lib/ory-kratos-client/models/registration_flow.rb +22 -10
- data/lib/ory-kratos-client/models/registration_flow_method.rb +20 -8
- data/lib/ory-kratos-client/models/registration_flow_method_config.rb +20 -8
- data/lib/ory-kratos-client/models/registration_via_api_response.rb +20 -8
- data/lib/ory-kratos-client/models/revoke_session.rb +20 -8
- data/lib/ory-kratos-client/models/session.rb +23 -11
- data/lib/ory-kratos-client/models/settings_flow.rb +22 -10
- data/lib/ory-kratos-client/models/settings_flow_method.rb +20 -8
- data/lib/ory-kratos-client/models/settings_flow_method_config.rb +20 -8
- data/lib/ory-kratos-client/models/settings_via_api_response.rb +20 -8
- data/lib/ory-kratos-client/models/update_identity.rb +20 -8
- data/lib/ory-kratos-client/models/verifiable_address.rb +21 -9
- data/lib/ory-kratos-client/models/verification_flow.rb +22 -10
- data/lib/ory-kratos-client/models/verification_flow_method.rb +20 -8
- data/lib/ory-kratos-client/models/verification_flow_method_config.rb +20 -8
- data/lib/ory-kratos-client/models/version.rb +20 -8
- data/lib/ory-kratos-client/version.rb +3 -3
- data/ory-kratos-client.gemspec +4 -5
- data/spec/api_client_spec.rb +3 -3
- data/spec/configuration_spec.rb +2 -2
- data/spec/spec_helper.rb +2 -2
- metadata +49 -69
@@ -2,16 +2,17 @@
|
|
2
2
|
|
3
3
|
## Properties
|
4
4
|
|
5
|
-
Name | Type | Description | Notes
|
6
|
-
|
7
|
-
**errors** | **Hash<String, String>** | Errors contains a list of errors that caused the not ready status. | [optional]
|
5
|
+
| Name | Type | Description | Notes |
|
6
|
+
| ---- | ---- | ----------- | ----- |
|
7
|
+
| **errors** | **Hash<String, String>** | Errors contains a list of errors that caused the not ready status. | [optional] |
|
8
8
|
|
9
|
-
##
|
9
|
+
## Example
|
10
10
|
|
11
11
|
```ruby
|
12
|
-
require '
|
12
|
+
require 'ory-kratos-client'
|
13
13
|
|
14
|
-
instance = OryHydraClient::HealthNotReadyStatus.new(
|
14
|
+
instance = OryHydraClient::HealthNotReadyStatus.new(
|
15
|
+
errors: null
|
16
|
+
)
|
15
17
|
```
|
16
18
|
|
17
|
-
|
data/docs/HealthStatus.md
CHANGED
@@ -2,16 +2,17 @@
|
|
2
2
|
|
3
3
|
## Properties
|
4
4
|
|
5
|
-
Name | Type | Description | Notes
|
6
|
-
|
7
|
-
**status** | **String** | Status always contains \"ok\". | [optional]
|
5
|
+
| Name | Type | Description | Notes |
|
6
|
+
| ---- | ---- | ----------- | ----- |
|
7
|
+
| **status** | **String** | Status always contains \"ok\". | [optional] |
|
8
8
|
|
9
|
-
##
|
9
|
+
## Example
|
10
10
|
|
11
11
|
```ruby
|
12
|
-
require '
|
12
|
+
require 'ory-kratos-client'
|
13
13
|
|
14
|
-
instance = OryHydraClient::HealthStatus.new(
|
14
|
+
instance = OryHydraClient::HealthStatus.new(
|
15
|
+
status: null
|
16
|
+
)
|
15
17
|
```
|
16
18
|
|
17
|
-
|
data/docs/Identity.md
CHANGED
@@ -2,26 +2,27 @@
|
|
2
2
|
|
3
3
|
## Properties
|
4
4
|
|
5
|
-
Name | Type | Description | Notes
|
6
|
-
|
7
|
-
**id** | **String** | |
|
8
|
-
**recovery_addresses** | [**Array<RecoveryAddress>**](RecoveryAddress.md) | RecoveryAddresses contains all the addresses that can be used to recover an identity. | [optional]
|
9
|
-
**schema_id** | **String** | SchemaID is the ID of the JSON Schema to be used for validating the identity's traits. |
|
10
|
-
**schema_url** | **String** | SchemaURL is the URL of the endpoint where the identity's traits schema can be fetched from. format: url |
|
11
|
-
**traits** |
|
12
|
-
**verifiable_addresses** | [**Array<VerifiableAddress>**](VerifiableAddress.md) | VerifiableAddresses contains all the addresses that can be verified by the user. | [optional]
|
5
|
+
| Name | Type | Description | Notes |
|
6
|
+
| ---- | ---- | ----------- | ----- |
|
7
|
+
| **id** | **String** | | |
|
8
|
+
| **recovery_addresses** | [**Array<RecoveryAddress>**](RecoveryAddress.md) | RecoveryAddresses contains all the addresses that can be used to recover an identity. | [optional] |
|
9
|
+
| **schema_id** | **String** | SchemaID is the ID of the JSON Schema to be used for validating the identity's traits. | |
|
10
|
+
| **schema_url** | **String** | SchemaURL is the URL of the endpoint where the identity's traits schema can be fetched from. format: url | |
|
11
|
+
| **traits** | **Object** | | |
|
12
|
+
| **verifiable_addresses** | [**Array<VerifiableAddress>**](VerifiableAddress.md) | VerifiableAddresses contains all the addresses that can be verified by the user. | [optional] |
|
13
13
|
|
14
|
-
##
|
14
|
+
## Example
|
15
15
|
|
16
16
|
```ruby
|
17
|
-
require '
|
17
|
+
require 'ory-kratos-client'
|
18
18
|
|
19
|
-
instance = OryHydraClient::Identity.new(
|
20
|
-
|
21
|
-
|
22
|
-
|
23
|
-
|
24
|
-
|
19
|
+
instance = OryHydraClient::Identity.new(
|
20
|
+
id: null,
|
21
|
+
recovery_addresses: null,
|
22
|
+
schema_id: null,
|
23
|
+
schema_url: null,
|
24
|
+
traits: null,
|
25
|
+
verifiable_addresses: null
|
26
|
+
)
|
25
27
|
```
|
26
28
|
|
27
|
-
|
data/docs/LoginFlow.md
CHANGED
@@ -2,32 +2,33 @@
|
|
2
2
|
|
3
3
|
## Properties
|
4
4
|
|
5
|
-
Name | Type | Description | Notes
|
6
|
-
|
7
|
-
**active** | **String** | and so on. | [optional]
|
8
|
-
**expires_at** | **
|
9
|
-
**forced** | **Boolean** | Forced stores whether this login flow should enforce re-authentication. | [optional]
|
10
|
-
**id** | **String** | |
|
11
|
-
**issued_at** | **
|
12
|
-
**messages** | [**Array<Message>**](Message.md) | | [optional]
|
13
|
-
**methods** | [**Hash<String, LoginFlowMethod>**](LoginFlowMethod.md) | List of login methods This is the list of available login methods with their required form fields, such as `identifier` and `password` for the password login method. This will also contain error messages such as \"password can not be empty\". |
|
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
|
-
**type** | **String** | The flow type can either be `api` or `browser`. | [optional]
|
5
|
+
| Name | Type | Description | Notes |
|
6
|
+
| ---- | ---- | ----------- | ----- |
|
7
|
+
| **active** | **String** | and so on. | [optional] |
|
8
|
+
| **expires_at** | **Time** | ExpiresAt is the time (UTC) when the flow expires. If the user still wishes to log in, a new flow has to be initiated. | |
|
9
|
+
| **forced** | **Boolean** | Forced stores whether this login flow should enforce re-authentication. | [optional] |
|
10
|
+
| **id** | **String** | | |
|
11
|
+
| **issued_at** | **Time** | IssuedAt is the time (UTC) when the flow started. | |
|
12
|
+
| **messages** | [**Array<Message>**](Message.md) | | [optional] |
|
13
|
+
| **methods** | [**Hash<String, LoginFlowMethod>**](LoginFlowMethod.md) | List of login methods This is the list of available login methods with their required form fields, such as `identifier` and `password` for the password login method. This will also contain error messages such as \"password can not be empty\". | |
|
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
|
+
| **type** | **String** | The flow type can either be `api` or `browser`. | [optional] |
|
16
16
|
|
17
|
-
##
|
17
|
+
## Example
|
18
18
|
|
19
19
|
```ruby
|
20
|
-
require '
|
20
|
+
require 'ory-kratos-client'
|
21
21
|
|
22
|
-
instance = OryHydraClient::LoginFlow.new(
|
23
|
-
|
24
|
-
|
25
|
-
|
26
|
-
|
27
|
-
|
28
|
-
|
29
|
-
|
30
|
-
|
22
|
+
instance = OryHydraClient::LoginFlow.new(
|
23
|
+
active: null,
|
24
|
+
expires_at: null,
|
25
|
+
forced: null,
|
26
|
+
id: null,
|
27
|
+
issued_at: null,
|
28
|
+
messages: null,
|
29
|
+
methods: null,
|
30
|
+
request_url: null,
|
31
|
+
type: null
|
32
|
+
)
|
31
33
|
```
|
32
34
|
|
33
|
-
|
data/docs/LoginFlowMethod.md
CHANGED
@@ -2,18 +2,19 @@
|
|
2
2
|
|
3
3
|
## Properties
|
4
4
|
|
5
|
-
Name | Type | Description | Notes
|
6
|
-
|
7
|
-
**config** | [**LoginFlowMethodConfig**](LoginFlowMethodConfig.md) | |
|
8
|
-
**method** | **String** | and so on. |
|
5
|
+
| Name | Type | Description | Notes |
|
6
|
+
| ---- | ---- | ----------- | ----- |
|
7
|
+
| **config** | [**LoginFlowMethodConfig**](LoginFlowMethodConfig.md) | | |
|
8
|
+
| **method** | **String** | and so on. | |
|
9
9
|
|
10
|
-
##
|
10
|
+
## Example
|
11
11
|
|
12
12
|
```ruby
|
13
|
-
require '
|
13
|
+
require 'ory-kratos-client'
|
14
14
|
|
15
|
-
instance = OryHydraClient::LoginFlowMethod.new(
|
16
|
-
|
15
|
+
instance = OryHydraClient::LoginFlowMethod.new(
|
16
|
+
config: null,
|
17
|
+
method: null
|
18
|
+
)
|
17
19
|
```
|
18
20
|
|
19
|
-
|
@@ -2,24 +2,25 @@
|
|
2
2
|
|
3
3
|
## Properties
|
4
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
|
-
**providers** | [**Array<FormField>**](FormField.md) | Providers is set for the \"oidc\" flow method. | [optional]
|
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
|
+
| **providers** | [**Array<FormField>**](FormField.md) | Providers is set for the \"oidc\" flow method. | [optional] |
|
12
12
|
|
13
|
-
##
|
13
|
+
## Example
|
14
14
|
|
15
15
|
```ruby
|
16
|
-
require '
|
16
|
+
require 'ory-kratos-client'
|
17
17
|
|
18
|
-
instance = OryHydraClient::LoginFlowMethodConfig.new(
|
19
|
-
|
20
|
-
|
21
|
-
|
22
|
-
|
18
|
+
instance = OryHydraClient::LoginFlowMethodConfig.new(
|
19
|
+
action: null,
|
20
|
+
fields: null,
|
21
|
+
messages: null,
|
22
|
+
method: null,
|
23
|
+
providers: null
|
24
|
+
)
|
23
25
|
```
|
24
26
|
|
25
|
-
|
data/docs/LoginViaApiResponse.md
CHANGED
@@ -2,18 +2,19 @@
|
|
2
2
|
|
3
3
|
## Properties
|
4
4
|
|
5
|
-
Name | Type | Description | Notes
|
6
|
-
|
7
|
-
**session** | [**Session**](Session.md) | |
|
8
|
-
**session_token** | **String** | The Session Token A session token is equivalent to a session cookie, but it can be sent in the HTTP Authorization Header: Authorization: bearer ${session-token} The session token is only issued for API flows, not for Browser flows! |
|
5
|
+
| Name | Type | Description | Notes |
|
6
|
+
| ---- | ---- | ----------- | ----- |
|
7
|
+
| **session** | [**Session**](Session.md) | | |
|
8
|
+
| **session_token** | **String** | The Session Token A session token is equivalent to a session cookie, but it can be sent in the HTTP Authorization Header: Authorization: bearer ${session-token} The session token is only issued for API flows, not for Browser flows! | |
|
9
9
|
|
10
|
-
##
|
10
|
+
## Example
|
11
11
|
|
12
12
|
```ruby
|
13
|
-
require '
|
13
|
+
require 'ory-kratos-client'
|
14
14
|
|
15
|
-
instance = OryHydraClient::LoginViaApiResponse.new(
|
16
|
-
|
15
|
+
instance = OryHydraClient::LoginViaApiResponse.new(
|
16
|
+
session: null,
|
17
|
+
session_token: null
|
18
|
+
)
|
17
19
|
```
|
18
20
|
|
19
|
-
|
data/docs/Message.md
CHANGED
@@ -2,22 +2,23 @@
|
|
2
2
|
|
3
3
|
## Properties
|
4
4
|
|
5
|
-
Name | Type | Description | Notes
|
6
|
-
|
7
|
-
**context** |
|
8
|
-
**id** | **Integer** | | [optional]
|
9
|
-
**text** | **String** | | [optional]
|
10
|
-
**type** | **String** | The flow type can either be `api` or `browser`. | [optional]
|
5
|
+
| Name | Type | Description | Notes |
|
6
|
+
| ---- | ---- | ----------- | ----- |
|
7
|
+
| **context** | **Object** | | [optional] |
|
8
|
+
| **id** | **Integer** | | [optional] |
|
9
|
+
| **text** | **String** | | [optional] |
|
10
|
+
| **type** | **String** | The flow type can either be `api` or `browser`. | [optional] |
|
11
11
|
|
12
|
-
##
|
12
|
+
## Example
|
13
13
|
|
14
14
|
```ruby
|
15
|
-
require '
|
15
|
+
require 'ory-kratos-client'
|
16
16
|
|
17
|
-
instance = OryHydraClient::Message.new(
|
18
|
-
|
19
|
-
|
20
|
-
|
17
|
+
instance = OryHydraClient::Message.new(
|
18
|
+
context: null,
|
19
|
+
id: null,
|
20
|
+
text: null,
|
21
|
+
type: null
|
22
|
+
)
|
21
23
|
```
|
22
24
|
|
23
|
-
|
data/docs/PublicApi.md
CHANGED
@@ -2,36 +2,35 @@
|
|
2
2
|
|
3
3
|
All URIs are relative to *http://localhost*
|
4
4
|
|
5
|
-
Method | HTTP request | Description
|
6
|
-
|
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_login_flow_with_password_method**](PublicApi.md#complete_self_service_login_flow_with_password_method) | **POST** /self-service/login/methods/password | Complete Login Flow with Username/Email Password Method
|
9
|
-
[**complete_self_service_recovery_flow_with_link_method**](PublicApi.md#complete_self_service_recovery_flow_with_link_method) | **POST** /self-service/recovery/methods/link | Complete Recovery Flow with Link Method
|
10
|
-
[**complete_self_service_registration_flow_with_password_method**](PublicApi.md#complete_self_service_registration_flow_with_password_method) | **POST** /self-service/registration/methods/password | Complete Registration Flow with Username/Email Password Method
|
11
|
-
[**complete_self_service_settings_flow_with_password_method**](PublicApi.md#complete_self_service_settings_flow_with_password_method) | **POST** /self-service/settings/methods/password | Complete Settings Flow with Username/Email Password Method
|
12
|
-
[**complete_self_service_settings_flow_with_profile_method**](PublicApi.md#complete_self_service_settings_flow_with_profile_method) | **POST** /self-service/settings/methods/profile | Complete Settings Flow with Profile Method
|
13
|
-
[**complete_self_service_verification_flow_with_link_method**](PublicApi.md#complete_self_service_verification_flow_with_link_method) | **POST** /self-service/verification/methods/link | Complete Verification Flow with Link Method
|
14
|
-
[**get_schema**](PublicApi.md#get_schema) | **GET** /schemas/{id} |
|
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_login_flow**](PublicApi.md#get_self_service_login_flow) | **GET** /self-service/login/flows | Get Login Flow
|
17
|
-
[**get_self_service_recovery_flow**](PublicApi.md#get_self_service_recovery_flow) | **GET** /self-service/recovery/flows | Get information about a recovery flow
|
18
|
-
[**get_self_service_registration_flow**](PublicApi.md#get_self_service_registration_flow) | **GET** /self-service/registration/flows | Get Registration Flow
|
19
|
-
[**get_self_service_settings_flow**](PublicApi.md#get_self_service_settings_flow) | **GET** /self-service/settings/flows | Get Settings Flow
|
20
|
-
[**get_self_service_verification_flow**](PublicApi.md#get_self_service_verification_flow) | **GET** /self-service/verification/flows | Get Verification Flow
|
21
|
-
[**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
|
22
|
-
[**initialize_self_service_login_via_api_flow**](PublicApi.md#initialize_self_service_login_via_api_flow) | **GET** /self-service/login/api | Initialize Login Flow for API clients
|
23
|
-
[**initialize_self_service_login_via_browser_flow**](PublicApi.md#initialize_self_service_login_via_browser_flow) | **GET** /self-service/login/browser | Initialize Login Flow for browsers
|
24
|
-
[**initialize_self_service_recovery_via_api_flow**](PublicApi.md#initialize_self_service_recovery_via_api_flow) | **GET** /self-service/recovery/api | Initialize Recovery Flow for API Clients
|
25
|
-
[**initialize_self_service_recovery_via_browser_flow**](PublicApi.md#initialize_self_service_recovery_via_browser_flow) | **GET** /self-service/recovery/browser | Initialize Recovery Flow for Browser Clients
|
26
|
-
[**initialize_self_service_registration_via_api_flow**](PublicApi.md#initialize_self_service_registration_via_api_flow) | **GET** /self-service/registration/api | Initialize Registration Flow for API clients
|
27
|
-
[**initialize_self_service_registration_via_browser_flow**](PublicApi.md#initialize_self_service_registration_via_browser_flow) | **GET** /self-service/registration/browser | Initialize Registration Flow for browsers
|
28
|
-
[**initialize_self_service_settings_via_api_flow**](PublicApi.md#initialize_self_service_settings_via_api_flow) | **GET** /self-service/settings/api | Initialize Settings Flow for API Clients
|
29
|
-
[**initialize_self_service_settings_via_browser_flow**](PublicApi.md#initialize_self_service_settings_via_browser_flow) | **GET** /self-service/settings/browser
|
30
|
-
[**initialize_self_service_verification_via_api_flow**](PublicApi.md#initialize_self_service_verification_via_api_flow) | **GET** /self-service/verification/api | Initialize Verification Flow for API Clients
|
31
|
-
[**initialize_self_service_verification_via_browser_flow**](PublicApi.md#initialize_self_service_verification_via_browser_flow) | **GET** /self-service/verification/browser | Initialize Verification Flow for Browser Clients
|
32
|
-
[**revoke_session**](PublicApi.md#revoke_session) | **DELETE** /sessions | Revoke and Invalidate a Session
|
33
|
-
[**whoami**](PublicApi.md#whoami) | **GET** /sessions/whoami | Check Who the Current HTTP Session Belongs To
|
34
|
-
|
5
|
+
| Method | HTTP request | Description |
|
6
|
+
| ------ | ------------ | ----------- |
|
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_login_flow_with_password_method**](PublicApi.md#complete_self_service_login_flow_with_password_method) | **POST** /self-service/login/methods/password | Complete Login Flow with Username/Email Password Method |
|
9
|
+
| [**complete_self_service_recovery_flow_with_link_method**](PublicApi.md#complete_self_service_recovery_flow_with_link_method) | **POST** /self-service/recovery/methods/link | Complete Recovery Flow with Link Method |
|
10
|
+
| [**complete_self_service_registration_flow_with_password_method**](PublicApi.md#complete_self_service_registration_flow_with_password_method) | **POST** /self-service/registration/methods/password | Complete Registration Flow with Username/Email Password Method |
|
11
|
+
| [**complete_self_service_settings_flow_with_password_method**](PublicApi.md#complete_self_service_settings_flow_with_password_method) | **POST** /self-service/settings/methods/password | Complete Settings Flow with Username/Email Password Method |
|
12
|
+
| [**complete_self_service_settings_flow_with_profile_method**](PublicApi.md#complete_self_service_settings_flow_with_profile_method) | **POST** /self-service/settings/methods/profile | Complete Settings Flow with Profile Method |
|
13
|
+
| [**complete_self_service_verification_flow_with_link_method**](PublicApi.md#complete_self_service_verification_flow_with_link_method) | **POST** /self-service/verification/methods/link | Complete Verification Flow with Link Method |
|
14
|
+
| [**get_schema**](PublicApi.md#get_schema) | **GET** /schemas/{id} | |
|
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_login_flow**](PublicApi.md#get_self_service_login_flow) | **GET** /self-service/login/flows | Get Login Flow |
|
17
|
+
| [**get_self_service_recovery_flow**](PublicApi.md#get_self_service_recovery_flow) | **GET** /self-service/recovery/flows | Get information about a recovery flow |
|
18
|
+
| [**get_self_service_registration_flow**](PublicApi.md#get_self_service_registration_flow) | **GET** /self-service/registration/flows | Get Registration Flow |
|
19
|
+
| [**get_self_service_settings_flow**](PublicApi.md#get_self_service_settings_flow) | **GET** /self-service/settings/flows | Get Settings Flow |
|
20
|
+
| [**get_self_service_verification_flow**](PublicApi.md#get_self_service_verification_flow) | **GET** /self-service/verification/flows | Get Verification Flow |
|
21
|
+
| [**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 |
|
22
|
+
| [**initialize_self_service_login_via_api_flow**](PublicApi.md#initialize_self_service_login_via_api_flow) | **GET** /self-service/login/api | Initialize Login Flow for API clients |
|
23
|
+
| [**initialize_self_service_login_via_browser_flow**](PublicApi.md#initialize_self_service_login_via_browser_flow) | **GET** /self-service/login/browser | Initialize Login Flow for browsers |
|
24
|
+
| [**initialize_self_service_recovery_via_api_flow**](PublicApi.md#initialize_self_service_recovery_via_api_flow) | **GET** /self-service/recovery/api | Initialize Recovery Flow for API Clients |
|
25
|
+
| [**initialize_self_service_recovery_via_browser_flow**](PublicApi.md#initialize_self_service_recovery_via_browser_flow) | **GET** /self-service/recovery/browser | Initialize Recovery Flow for Browser Clients |
|
26
|
+
| [**initialize_self_service_registration_via_api_flow**](PublicApi.md#initialize_self_service_registration_via_api_flow) | **GET** /self-service/registration/api | Initialize Registration Flow for API clients |
|
27
|
+
| [**initialize_self_service_registration_via_browser_flow**](PublicApi.md#initialize_self_service_registration_via_browser_flow) | **GET** /self-service/registration/browser | Initialize Registration Flow for browsers |
|
28
|
+
| [**initialize_self_service_settings_via_api_flow**](PublicApi.md#initialize_self_service_settings_via_api_flow) | **GET** /self-service/settings/api | Initialize Settings Flow for API Clients |
|
29
|
+
| [**initialize_self_service_settings_via_browser_flow**](PublicApi.md#initialize_self_service_settings_via_browser_flow) | **GET** /self-service/settings/browser | Initialize Settings Flow for Browsers |
|
30
|
+
| [**initialize_self_service_verification_via_api_flow**](PublicApi.md#initialize_self_service_verification_via_api_flow) | **GET** /self-service/verification/api | Initialize Verification Flow for API Clients |
|
31
|
+
| [**initialize_self_service_verification_via_browser_flow**](PublicApi.md#initialize_self_service_verification_via_browser_flow) | **GET** /self-service/verification/browser | Initialize Verification Flow for Browser Clients |
|
32
|
+
| [**revoke_session**](PublicApi.md#revoke_session) | **DELETE** /sessions | Revoke and Invalidate a Session |
|
33
|
+
| [**whoami**](PublicApi.md#whoami) | **GET** /sessions/whoami | Check Who the Current HTTP Session Belongs To |
|
35
34
|
|
36
35
|
|
37
36
|
## complete_self_service_browser_settings_oidc_settings_flow
|
@@ -42,19 +41,37 @@ Complete the Browser-Based Settings Flow for the OpenID Connect Strategy
|
|
42
41
|
|
43
42
|
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).
|
44
43
|
|
45
|
-
###
|
44
|
+
### Examples
|
46
45
|
|
47
46
|
```ruby
|
48
|
-
|
47
|
+
require 'time'
|
49
48
|
require 'ory-kratos-client'
|
50
49
|
|
51
50
|
api_instance = OryHydraClient::PublicApi.new
|
52
51
|
|
53
52
|
begin
|
54
|
-
#Complete the Browser-Based Settings Flow for the OpenID Connect Strategy
|
53
|
+
# Complete the Browser-Based Settings Flow for the OpenID Connect Strategy
|
55
54
|
api_instance.complete_self_service_browser_settings_oidc_settings_flow
|
56
55
|
rescue OryHydraClient::ApiError => e
|
57
|
-
puts "
|
56
|
+
puts "Error when calling PublicApi->complete_self_service_browser_settings_oidc_settings_flow: #{e}"
|
57
|
+
end
|
58
|
+
```
|
59
|
+
|
60
|
+
#### Using the complete_self_service_browser_settings_oidc_settings_flow_with_http_info variant
|
61
|
+
|
62
|
+
This returns an Array which contains the response data (`nil` in this case), status code and headers.
|
63
|
+
|
64
|
+
> <Array(nil, Integer, Hash)> complete_self_service_browser_settings_oidc_settings_flow_with_http_info
|
65
|
+
|
66
|
+
```ruby
|
67
|
+
begin
|
68
|
+
# Complete the Browser-Based Settings Flow for the OpenID Connect Strategy
|
69
|
+
data, status_code, headers = api_instance.complete_self_service_browser_settings_oidc_settings_flow_with_http_info
|
70
|
+
p status_code # => 2xx
|
71
|
+
p headers # => { ... }
|
72
|
+
p data # => nil
|
73
|
+
rescue OryHydraClient::ApiError => e
|
74
|
+
puts "Error when calling PublicApi->complete_self_service_browser_settings_oidc_settings_flow_with_http_info: #{e}"
|
58
75
|
end
|
59
76
|
```
|
60
77
|
|
@@ -78,16 +95,16 @@ No authorization required
|
|
78
95
|
|
79
96
|
## complete_self_service_login_flow_with_password_method
|
80
97
|
|
81
|
-
> LoginViaApiResponse complete_self_service_login_flow_with_password_method(flow, opts)
|
98
|
+
> <LoginViaApiResponse> complete_self_service_login_flow_with_password_method(flow, opts)
|
82
99
|
|
83
100
|
Complete Login Flow with Username/Email Password Method
|
84
101
|
|
85
102
|
Use this endpoint to complete a login flow by sending an identity's identifier and password. This endpoint behaves differently for API and browser flows. API flows expect `application/json` to be sent in the body and responds with HTTP 200 and a application/json body with the session token on success; HTTP 302 redirect to a fresh login flow if the original flow expired with the appropriate error messages set; HTTP 400 on form validation errors. Browser flows expect `application/x-www-form-urlencoded` to be sent in the body and responds with a HTTP 302 redirect to the post/after login URL or the `return_to` value if it was set and if the login succeeded; a HTTP 302 redirect to the login UI URL with the flow ID containing the validation errors otherwise. 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).
|
86
103
|
|
87
|
-
###
|
104
|
+
### Examples
|
88
105
|
|
89
106
|
```ruby
|
90
|
-
|
107
|
+
require 'time'
|
91
108
|
require 'ory-kratos-client'
|
92
109
|
|
93
110
|
api_instance = OryHydraClient::PublicApi.new
|
@@ -97,21 +114,38 @@ opts = {
|
|
97
114
|
}
|
98
115
|
|
99
116
|
begin
|
100
|
-
#Complete Login Flow with Username/Email Password Method
|
117
|
+
# Complete Login Flow with Username/Email Password Method
|
101
118
|
result = api_instance.complete_self_service_login_flow_with_password_method(flow, opts)
|
102
119
|
p result
|
103
120
|
rescue OryHydraClient::ApiError => e
|
104
|
-
puts "
|
121
|
+
puts "Error when calling PublicApi->complete_self_service_login_flow_with_password_method: #{e}"
|
105
122
|
end
|
106
123
|
```
|
107
124
|
|
108
|
-
|
125
|
+
#### Using the complete_self_service_login_flow_with_password_method_with_http_info variant
|
109
126
|
|
127
|
+
This returns an Array which contains the response data, status code and headers.
|
110
128
|
|
111
|
-
|
112
|
-
|
113
|
-
|
114
|
-
|
129
|
+
> <Array(<LoginViaApiResponse>, Integer, Hash)> complete_self_service_login_flow_with_password_method_with_http_info(flow, opts)
|
130
|
+
|
131
|
+
```ruby
|
132
|
+
begin
|
133
|
+
# Complete Login Flow with Username/Email Password Method
|
134
|
+
data, status_code, headers = api_instance.complete_self_service_login_flow_with_password_method_with_http_info(flow, opts)
|
135
|
+
p status_code # => 2xx
|
136
|
+
p headers # => { ... }
|
137
|
+
p data # => <LoginViaApiResponse>
|
138
|
+
rescue OryHydraClient::ApiError => e
|
139
|
+
puts "Error when calling PublicApi->complete_self_service_login_flow_with_password_method_with_http_info: #{e}"
|
140
|
+
end
|
141
|
+
```
|
142
|
+
|
143
|
+
### Parameters
|
144
|
+
|
145
|
+
| Name | Type | Description | Notes |
|
146
|
+
| ---- | ---- | ----------- | ----- |
|
147
|
+
| **flow** | **String** | The Flow ID | |
|
148
|
+
| **body** | [**CompleteSelfServiceLoginFlowWithPasswordMethod**](CompleteSelfServiceLoginFlowWithPasswordMethod.md) | | [optional] |
|
115
149
|
|
116
150
|
### Return type
|
117
151
|
|
@@ -135,10 +169,10 @@ Complete Recovery Flow with Link Method
|
|
135
169
|
|
136
170
|
Use this endpoint to complete a recovery flow using the link method. This endpoint behaves differently for API and browser flows and has several states: `choose_method` expects `flow` (in the URL query) and `email` (in the body) to be sent and works with API- and Browser-initiated flows. For API clients it either returns a HTTP 200 OK when the form is valid and HTTP 400 OK when the form is invalid and a HTTP 302 Found redirect with a fresh recovery flow if the flow was otherwise invalid (e.g. expired). For Browser clients it returns a HTTP 302 Found redirect to the Recovery UI URL with the Recovery Flow ID appended. `sent_email` is the success state after `choose_method` and allows the user to request another recovery email. It works for both API and Browser-initiated flows and returns the same responses as the flow in `choose_method` state. `passed_challenge` expects a `token` to be sent in the URL query and given the nature of the flow (\"sending a recovery link\") does not have any API capabilities. The server responds with a HTTP 302 Found redirect either to the Settings UI URL (if the link was valid) and instructs the user to update their password, or a redirect to the Recover UI URL with a new Recovery Flow ID which contains an error message that the recovery link was invalid. More information can be found at [ORY Kratos Account Recovery Documentation](../self-service/flows/account-recovery.mdx).
|
137
171
|
|
138
|
-
###
|
172
|
+
### Examples
|
139
173
|
|
140
174
|
```ruby
|
141
|
-
|
175
|
+
require 'time'
|
142
176
|
require 'ory-kratos-client'
|
143
177
|
|
144
178
|
api_instance = OryHydraClient::PublicApi.new
|
@@ -149,21 +183,38 @@ opts = {
|
|
149
183
|
}
|
150
184
|
|
151
185
|
begin
|
152
|
-
#Complete Recovery Flow with Link Method
|
186
|
+
# Complete Recovery Flow with Link Method
|
153
187
|
api_instance.complete_self_service_recovery_flow_with_link_method(opts)
|
154
188
|
rescue OryHydraClient::ApiError => e
|
155
|
-
puts "
|
189
|
+
puts "Error when calling PublicApi->complete_self_service_recovery_flow_with_link_method: #{e}"
|
156
190
|
end
|
157
191
|
```
|
158
192
|
|
159
|
-
|
193
|
+
#### Using the complete_self_service_recovery_flow_with_link_method_with_http_info variant
|
194
|
+
|
195
|
+
This returns an Array which contains the response data (`nil` in this case), status code and headers.
|
196
|
+
|
197
|
+
> <Array(nil, Integer, Hash)> complete_self_service_recovery_flow_with_link_method_with_http_info(opts)
|
198
|
+
|
199
|
+
```ruby
|
200
|
+
begin
|
201
|
+
# Complete Recovery Flow with Link Method
|
202
|
+
data, status_code, headers = api_instance.complete_self_service_recovery_flow_with_link_method_with_http_info(opts)
|
203
|
+
p status_code # => 2xx
|
204
|
+
p headers # => { ... }
|
205
|
+
p data # => nil
|
206
|
+
rescue OryHydraClient::ApiError => e
|
207
|
+
puts "Error when calling PublicApi->complete_self_service_recovery_flow_with_link_method_with_http_info: #{e}"
|
208
|
+
end
|
209
|
+
```
|
160
210
|
|
211
|
+
### Parameters
|
161
212
|
|
162
|
-
Name | Type | Description
|
163
|
-
|
164
|
-
**token** | **String
|
165
|
-
**flow** | **String
|
166
|
-
**body** | [**CompleteSelfServiceRecoveryFlowWithLinkMethod**](CompleteSelfServiceRecoveryFlowWithLinkMethod.md)| | [optional]
|
213
|
+
| Name | Type | Description | Notes |
|
214
|
+
| ---- | ---- | ----------- | ----- |
|
215
|
+
| **token** | **String** | Recovery Token The recovery token which completes the recovery request. If the token is invalid (e.g. expired) an error will be shown to the end-user. | [optional] |
|
216
|
+
| **flow** | **String** | The Flow ID format: uuid | [optional] |
|
217
|
+
| **body** | [**CompleteSelfServiceRecoveryFlowWithLinkMethod**](CompleteSelfServiceRecoveryFlowWithLinkMethod.md) | | [optional] |
|
167
218
|
|
168
219
|
### Return type
|
169
220
|
|
@@ -181,40 +232,57 @@ No authorization required
|
|
181
232
|
|
182
233
|
## complete_self_service_registration_flow_with_password_method
|
183
234
|
|
184
|
-
> RegistrationViaApiResponse complete_self_service_registration_flow_with_password_method(opts)
|
235
|
+
> <RegistrationViaApiResponse> complete_self_service_registration_flow_with_password_method(opts)
|
185
236
|
|
186
237
|
Complete Registration Flow with Username/Email Password Method
|
187
238
|
|
188
239
|
Use this endpoint to complete a registration flow by sending an identity's traits and password. This endpoint behaves differently for API and browser flows. API flows expect `application/json` to be sent in the body and respond with HTTP 200 and a application/json body with the created identity success - if the session hook is configured the `session` and `session_token` will also be included; HTTP 302 redirect to a fresh registration flow if the original flow expired with the appropriate error messages set; HTTP 400 on form validation errors. Browser flows expect `application/x-www-form-urlencoded` to be sent in the body and responds with a HTTP 302 redirect to the post/after registration URL or the `return_to` value if it was set and if the registration succeeded; a HTTP 302 redirect to the registration UI URL with the flow ID containing the validation errors otherwise. 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).
|
189
240
|
|
190
|
-
###
|
241
|
+
### Examples
|
191
242
|
|
192
243
|
```ruby
|
193
|
-
|
244
|
+
require 'time'
|
194
245
|
require 'ory-kratos-client'
|
195
246
|
|
196
247
|
api_instance = OryHydraClient::PublicApi.new
|
197
248
|
opts = {
|
198
249
|
flow: 'flow_example', # String | Flow is flow ID.
|
199
|
-
payload:
|
250
|
+
payload: Object # Object |
|
200
251
|
}
|
201
252
|
|
202
253
|
begin
|
203
|
-
#Complete Registration Flow with Username/Email Password Method
|
254
|
+
# Complete Registration Flow with Username/Email Password Method
|
204
255
|
result = api_instance.complete_self_service_registration_flow_with_password_method(opts)
|
205
256
|
p result
|
206
257
|
rescue OryHydraClient::ApiError => e
|
207
|
-
puts "
|
258
|
+
puts "Error when calling PublicApi->complete_self_service_registration_flow_with_password_method: #{e}"
|
208
259
|
end
|
209
260
|
```
|
210
261
|
|
211
|
-
|
262
|
+
#### Using the complete_self_service_registration_flow_with_password_method_with_http_info variant
|
212
263
|
|
264
|
+
This returns an Array which contains the response data, status code and headers.
|
213
265
|
|
214
|
-
|
215
|
-
|
216
|
-
|
217
|
-
|
266
|
+
> <Array(<RegistrationViaApiResponse>, Integer, Hash)> complete_self_service_registration_flow_with_password_method_with_http_info(opts)
|
267
|
+
|
268
|
+
```ruby
|
269
|
+
begin
|
270
|
+
# Complete Registration Flow with Username/Email Password Method
|
271
|
+
data, status_code, headers = api_instance.complete_self_service_registration_flow_with_password_method_with_http_info(opts)
|
272
|
+
p status_code # => 2xx
|
273
|
+
p headers # => { ... }
|
274
|
+
p data # => <RegistrationViaApiResponse>
|
275
|
+
rescue OryHydraClient::ApiError => e
|
276
|
+
puts "Error when calling PublicApi->complete_self_service_registration_flow_with_password_method_with_http_info: #{e}"
|
277
|
+
end
|
278
|
+
```
|
279
|
+
|
280
|
+
### Parameters
|
281
|
+
|
282
|
+
| Name | Type | Description | Notes |
|
283
|
+
| ---- | ---- | ----------- | ----- |
|
284
|
+
| **flow** | **String** | Flow is flow ID. | [optional] |
|
285
|
+
| **payload** | **Object** | | [optional] |
|
218
286
|
|
219
287
|
### Return type
|
220
288
|
|
@@ -232,47 +300,64 @@ No authorization required
|
|
232
300
|
|
233
301
|
## complete_self_service_settings_flow_with_password_method
|
234
302
|
|
235
|
-
> SettingsViaApiResponse complete_self_service_settings_flow_with_password_method(opts)
|
303
|
+
> <SettingsViaApiResponse> complete_self_service_settings_flow_with_password_method(opts)
|
236
304
|
|
237
305
|
Complete Settings Flow with Username/Email Password Method
|
238
306
|
|
239
307
|
Use this endpoint to complete a settings flow by sending an identity's updated password. This endpoint behaves differently for API and browser flows. API-initiated flows expect `application/json` to be sent in the body and respond with HTTP 200 and an application/json body with the session token on success; HTTP 302 redirect to a fresh settings flow if the original flow expired with the appropriate error messages set; HTTP 400 on form validation errors. HTTP 401 when the endpoint is called without a valid session token. HTTP 403 when `selfservice.flows.settings.privileged_session_max_age` was reached. Implies that the user needs to re-authenticate. Browser flows expect `application/x-www-form-urlencoded` to be sent in the body and responds with a HTTP 302 redirect to the post/after settings URL or the `return_to` value if it was set and if the flow succeeded; a HTTP 302 redirect to the Settings UI URL with the flow ID containing the validation errors otherwise. a HTTP 302 redirect to the login endpoint when `selfservice.flows.settings.privileged_session_max_age` was reached. More information can be found at [ORY Kratos User Settings & Profile Management Documentation](../self-service/flows/user-settings).
|
240
308
|
|
241
|
-
###
|
309
|
+
### Examples
|
242
310
|
|
243
311
|
```ruby
|
244
|
-
|
312
|
+
require 'time'
|
245
313
|
require 'ory-kratos-client'
|
246
314
|
# setup authorization
|
247
315
|
OryHydraClient.configure do |config|
|
248
316
|
# Configure API key authorization: sessionToken
|
249
317
|
config.api_key['X-Session-Token'] = 'YOUR API KEY'
|
250
318
|
# Uncomment the following line to set a prefix for the API key, e.g. 'Bearer' (defaults to nil)
|
251
|
-
#config.api_key_prefix['X-Session-Token'] = 'Bearer'
|
319
|
+
# config.api_key_prefix['X-Session-Token'] = 'Bearer'
|
252
320
|
end
|
253
321
|
|
254
322
|
api_instance = OryHydraClient::PublicApi.new
|
255
323
|
opts = {
|
256
324
|
flow: 'flow_example', # String | Flow is flow ID.
|
257
|
-
body: OryHydraClient::CompleteSelfServiceSettingsFlowWithPasswordMethod.new # CompleteSelfServiceSettingsFlowWithPasswordMethod |
|
325
|
+
body: OryHydraClient::CompleteSelfServiceSettingsFlowWithPasswordMethod.new({password: 'password_example'}) # CompleteSelfServiceSettingsFlowWithPasswordMethod |
|
258
326
|
}
|
259
327
|
|
260
328
|
begin
|
261
|
-
#Complete Settings Flow with Username/Email Password Method
|
329
|
+
# Complete Settings Flow with Username/Email Password Method
|
262
330
|
result = api_instance.complete_self_service_settings_flow_with_password_method(opts)
|
263
331
|
p result
|
264
332
|
rescue OryHydraClient::ApiError => e
|
265
|
-
puts "
|
333
|
+
puts "Error when calling PublicApi->complete_self_service_settings_flow_with_password_method: #{e}"
|
266
334
|
end
|
267
335
|
```
|
268
336
|
|
269
|
-
|
337
|
+
#### Using the complete_self_service_settings_flow_with_password_method_with_http_info variant
|
338
|
+
|
339
|
+
This returns an Array which contains the response data, status code and headers.
|
340
|
+
|
341
|
+
> <Array(<SettingsViaApiResponse>, Integer, Hash)> complete_self_service_settings_flow_with_password_method_with_http_info(opts)
|
342
|
+
|
343
|
+
```ruby
|
344
|
+
begin
|
345
|
+
# Complete Settings Flow with Username/Email Password Method
|
346
|
+
data, status_code, headers = api_instance.complete_self_service_settings_flow_with_password_method_with_http_info(opts)
|
347
|
+
p status_code # => 2xx
|
348
|
+
p headers # => { ... }
|
349
|
+
p data # => <SettingsViaApiResponse>
|
350
|
+
rescue OryHydraClient::ApiError => e
|
351
|
+
puts "Error when calling PublicApi->complete_self_service_settings_flow_with_password_method_with_http_info: #{e}"
|
352
|
+
end
|
353
|
+
```
|
270
354
|
|
355
|
+
### Parameters
|
271
356
|
|
272
|
-
Name | Type | Description
|
273
|
-
|
274
|
-
**flow** | **String
|
275
|
-
**body** | [**CompleteSelfServiceSettingsFlowWithPasswordMethod**](CompleteSelfServiceSettingsFlowWithPasswordMethod.md)| | [optional]
|
357
|
+
| Name | Type | Description | Notes |
|
358
|
+
| ---- | ---- | ----------- | ----- |
|
359
|
+
| **flow** | **String** | Flow is flow ID. | [optional] |
|
360
|
+
| **body** | [**CompleteSelfServiceSettingsFlowWithPasswordMethod**](CompleteSelfServiceSettingsFlowWithPasswordMethod.md) | | [optional] |
|
276
361
|
|
277
362
|
### Return type
|
278
363
|
|
@@ -290,47 +375,64 @@ Name | Type | Description | Notes
|
|
290
375
|
|
291
376
|
## complete_self_service_settings_flow_with_profile_method
|
292
377
|
|
293
|
-
> SettingsFlow complete_self_service_settings_flow_with_profile_method(opts)
|
378
|
+
> <SettingsFlow> complete_self_service_settings_flow_with_profile_method(opts)
|
294
379
|
|
295
380
|
Complete Settings Flow with Profile Method
|
296
381
|
|
297
382
|
Use this endpoint to complete a settings flow by sending an identity's updated traits. This endpoint behaves differently for API and browser flows. API-initiated flows expect `application/json` to be sent in the body and respond with HTTP 200 and an application/json body with the session token on success; HTTP 302 redirect to a fresh settings flow if the original flow expired with the appropriate error messages set; HTTP 400 on form validation errors. HTTP 401 when the endpoint is called without a valid session token. HTTP 403 when `selfservice.flows.settings.privileged_session_max_age` was reached and a sensitive field was updated (e.g. recovery email). Implies that the user needs to re-authenticate. Browser flows expect `application/x-www-form-urlencoded` to be sent in the body and responds with a HTTP 302 redirect to the post/after settings URL or the `return_to` value if it was set and if the flow succeeded; a HTTP 302 redirect to the settings UI URL with the flow ID containing the validation errors otherwise. a HTTP 302 redirect to the login endpoint when `selfservice.flows.settings.privileged_session_max_age` was reached. More information can be found at [ORY Kratos User Settings & Profile Management Documentation](../self-service/flows/user-settings).
|
298
383
|
|
299
|
-
###
|
384
|
+
### Examples
|
300
385
|
|
301
386
|
```ruby
|
302
|
-
|
387
|
+
require 'time'
|
303
388
|
require 'ory-kratos-client'
|
304
389
|
# setup authorization
|
305
390
|
OryHydraClient.configure do |config|
|
306
391
|
# Configure API key authorization: sessionToken
|
307
392
|
config.api_key['X-Session-Token'] = 'YOUR API KEY'
|
308
393
|
# Uncomment the following line to set a prefix for the API key, e.g. 'Bearer' (defaults to nil)
|
309
|
-
#config.api_key_prefix['X-Session-Token'] = 'Bearer'
|
394
|
+
# config.api_key_prefix['X-Session-Token'] = 'Bearer'
|
310
395
|
end
|
311
396
|
|
312
397
|
api_instance = OryHydraClient::PublicApi.new
|
313
398
|
opts = {
|
314
399
|
flow: 'flow_example', # String | Flow is flow ID.
|
315
|
-
payload:
|
400
|
+
payload: Object # Object |
|
316
401
|
}
|
317
402
|
|
318
403
|
begin
|
319
|
-
#Complete Settings Flow with Profile Method
|
404
|
+
# Complete Settings Flow with Profile Method
|
320
405
|
result = api_instance.complete_self_service_settings_flow_with_profile_method(opts)
|
321
406
|
p result
|
322
407
|
rescue OryHydraClient::ApiError => e
|
323
|
-
puts "
|
408
|
+
puts "Error when calling PublicApi->complete_self_service_settings_flow_with_profile_method: #{e}"
|
324
409
|
end
|
325
410
|
```
|
326
411
|
|
327
|
-
|
412
|
+
#### Using the complete_self_service_settings_flow_with_profile_method_with_http_info variant
|
413
|
+
|
414
|
+
This returns an Array which contains the response data, status code and headers.
|
415
|
+
|
416
|
+
> <Array(<SettingsFlow>, Integer, Hash)> complete_self_service_settings_flow_with_profile_method_with_http_info(opts)
|
417
|
+
|
418
|
+
```ruby
|
419
|
+
begin
|
420
|
+
# Complete Settings Flow with Profile Method
|
421
|
+
data, status_code, headers = api_instance.complete_self_service_settings_flow_with_profile_method_with_http_info(opts)
|
422
|
+
p status_code # => 2xx
|
423
|
+
p headers # => { ... }
|
424
|
+
p data # => <SettingsFlow>
|
425
|
+
rescue OryHydraClient::ApiError => e
|
426
|
+
puts "Error when calling PublicApi->complete_self_service_settings_flow_with_profile_method_with_http_info: #{e}"
|
427
|
+
end
|
428
|
+
```
|
328
429
|
|
430
|
+
### Parameters
|
329
431
|
|
330
|
-
Name | Type | Description
|
331
|
-
|
332
|
-
**flow** | **String
|
333
|
-
**payload** | **Object
|
432
|
+
| Name | Type | Description | Notes |
|
433
|
+
| ---- | ---- | ----------- | ----- |
|
434
|
+
| **flow** | **String** | Flow is flow ID. | [optional] |
|
435
|
+
| **payload** | **Object** | | [optional] |
|
334
436
|
|
335
437
|
### Return type
|
336
438
|
|
@@ -354,10 +456,10 @@ Complete Verification Flow with Link Method
|
|
354
456
|
|
355
457
|
Use this endpoint to complete a verification flow using the link method. This endpoint behaves differently for API and browser flows and has several states: `choose_method` expects `flow` (in the URL query) and `email` (in the body) to be sent and works with API- and Browser-initiated flows. For API clients it either returns a HTTP 200 OK when the form is valid and HTTP 400 OK when the form is invalid and a HTTP 302 Found redirect with a fresh verification flow if the flow was otherwise invalid (e.g. expired). For Browser clients it returns a HTTP 302 Found redirect to the Verification UI URL with the Verification Flow ID appended. `sent_email` is the success state after `choose_method` and allows the user to request another verification email. It works for both API and Browser-initiated flows and returns the same responses as the flow in `choose_method` state. `passed_challenge` expects a `token` to be sent in the URL query and given the nature of the flow (\"sending a verification link\") does not have any API capabilities. The server responds with a HTTP 302 Found redirect either to the Settings UI URL (if the link was valid) and instructs the user to update their password, or a redirect to the Verification UI URL with a new Verification Flow ID which contains an error message that the verification link was invalid. 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).
|
356
458
|
|
357
|
-
###
|
459
|
+
### Examples
|
358
460
|
|
359
461
|
```ruby
|
360
|
-
|
462
|
+
require 'time'
|
361
463
|
require 'ory-kratos-client'
|
362
464
|
|
363
465
|
api_instance = OryHydraClient::PublicApi.new
|
@@ -368,21 +470,38 @@ opts = {
|
|
368
470
|
}
|
369
471
|
|
370
472
|
begin
|
371
|
-
#Complete Verification Flow with Link Method
|
473
|
+
# Complete Verification Flow with Link Method
|
372
474
|
api_instance.complete_self_service_verification_flow_with_link_method(opts)
|
373
475
|
rescue OryHydraClient::ApiError => e
|
374
|
-
puts "
|
476
|
+
puts "Error when calling PublicApi->complete_self_service_verification_flow_with_link_method: #{e}"
|
375
477
|
end
|
376
478
|
```
|
377
479
|
|
378
|
-
|
480
|
+
#### Using the complete_self_service_verification_flow_with_link_method_with_http_info variant
|
481
|
+
|
482
|
+
This returns an Array which contains the response data (`nil` in this case), status code and headers.
|
483
|
+
|
484
|
+
> <Array(nil, Integer, Hash)> complete_self_service_verification_flow_with_link_method_with_http_info(opts)
|
485
|
+
|
486
|
+
```ruby
|
487
|
+
begin
|
488
|
+
# Complete Verification Flow with Link Method
|
489
|
+
data, status_code, headers = api_instance.complete_self_service_verification_flow_with_link_method_with_http_info(opts)
|
490
|
+
p status_code # => 2xx
|
491
|
+
p headers # => { ... }
|
492
|
+
p data # => nil
|
493
|
+
rescue OryHydraClient::ApiError => e
|
494
|
+
puts "Error when calling PublicApi->complete_self_service_verification_flow_with_link_method_with_http_info: #{e}"
|
495
|
+
end
|
496
|
+
```
|
379
497
|
|
498
|
+
### Parameters
|
380
499
|
|
381
|
-
Name | Type | Description
|
382
|
-
|
383
|
-
**token** | **String
|
384
|
-
**flow** | **String
|
385
|
-
**body** | [**CompleteSelfServiceVerificationFlowWithLinkMethod**](CompleteSelfServiceVerificationFlowWithLinkMethod.md)| | [optional]
|
500
|
+
| Name | Type | Description | Notes |
|
501
|
+
| ---- | ---- | ----------- | ----- |
|
502
|
+
| **token** | **String** | Verification Token The verification token which completes the verification request. If the token is invalid (e.g. expired) an error will be shown to the end-user. | [optional] |
|
503
|
+
| **flow** | **String** | The Flow ID format: uuid | [optional] |
|
504
|
+
| **body** | [**CompleteSelfServiceVerificationFlowWithLinkMethod**](CompleteSelfServiceVerificationFlowWithLinkMethod.md) | | [optional] |
|
386
505
|
|
387
506
|
### Return type
|
388
507
|
|
@@ -406,29 +525,47 @@ No authorization required
|
|
406
525
|
|
407
526
|
Get a Traits Schema Definition
|
408
527
|
|
409
|
-
###
|
528
|
+
### Examples
|
410
529
|
|
411
530
|
```ruby
|
412
|
-
|
531
|
+
require 'time'
|
413
532
|
require 'ory-kratos-client'
|
414
533
|
|
415
534
|
api_instance = OryHydraClient::PublicApi.new
|
416
535
|
id = 'id_example' # String | ID must be set to the ID of schema you want to get
|
417
536
|
|
418
537
|
begin
|
538
|
+
|
419
539
|
result = api_instance.get_schema(id)
|
420
540
|
p result
|
421
541
|
rescue OryHydraClient::ApiError => e
|
422
|
-
puts "
|
542
|
+
puts "Error when calling PublicApi->get_schema: #{e}"
|
423
543
|
end
|
424
544
|
```
|
425
545
|
|
426
|
-
|
546
|
+
#### Using the get_schema_with_http_info variant
|
427
547
|
|
548
|
+
This returns an Array which contains the response data, status code and headers.
|
428
549
|
|
429
|
-
|
430
|
-
|
431
|
-
|
550
|
+
> <Array(Object, Integer, Hash)> get_schema_with_http_info(id)
|
551
|
+
|
552
|
+
```ruby
|
553
|
+
begin
|
554
|
+
|
555
|
+
data, status_code, headers = api_instance.get_schema_with_http_info(id)
|
556
|
+
p status_code # => 2xx
|
557
|
+
p headers # => { ... }
|
558
|
+
p data # => Object
|
559
|
+
rescue OryHydraClient::ApiError => e
|
560
|
+
puts "Error when calling PublicApi->get_schema_with_http_info: #{e}"
|
561
|
+
end
|
562
|
+
```
|
563
|
+
|
564
|
+
### Parameters
|
565
|
+
|
566
|
+
| Name | Type | Description | Notes |
|
567
|
+
| ---- | ---- | ----------- | ----- |
|
568
|
+
| **id** | **String** | ID must be set to the ID of schema you want to get | |
|
432
569
|
|
433
570
|
### Return type
|
434
571
|
|
@@ -446,36 +583,53 @@ No authorization required
|
|
446
583
|
|
447
584
|
## get_self_service_error
|
448
585
|
|
449
|
-
> ErrorContainer get_self_service_error(error)
|
586
|
+
> <ErrorContainer> get_self_service_error(error)
|
450
587
|
|
451
588
|
Get User-Facing Self-Service Errors
|
452
589
|
|
453
590
|
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).
|
454
591
|
|
455
|
-
###
|
592
|
+
### Examples
|
456
593
|
|
457
594
|
```ruby
|
458
|
-
|
595
|
+
require 'time'
|
459
596
|
require 'ory-kratos-client'
|
460
597
|
|
461
598
|
api_instance = OryHydraClient::PublicApi.new
|
462
599
|
error = 'error_example' # String | Error is the container's ID
|
463
600
|
|
464
601
|
begin
|
465
|
-
#Get User-Facing Self-Service Errors
|
602
|
+
# Get User-Facing Self-Service Errors
|
466
603
|
result = api_instance.get_self_service_error(error)
|
467
604
|
p result
|
468
605
|
rescue OryHydraClient::ApiError => e
|
469
|
-
puts "
|
606
|
+
puts "Error when calling PublicApi->get_self_service_error: #{e}"
|
470
607
|
end
|
471
608
|
```
|
472
609
|
|
473
|
-
|
610
|
+
#### Using the get_self_service_error_with_http_info variant
|
474
611
|
|
612
|
+
This returns an Array which contains the response data, status code and headers.
|
475
613
|
|
476
|
-
|
477
|
-
|
478
|
-
|
614
|
+
> <Array(<ErrorContainer>, Integer, Hash)> get_self_service_error_with_http_info(error)
|
615
|
+
|
616
|
+
```ruby
|
617
|
+
begin
|
618
|
+
# Get User-Facing Self-Service Errors
|
619
|
+
data, status_code, headers = api_instance.get_self_service_error_with_http_info(error)
|
620
|
+
p status_code # => 2xx
|
621
|
+
p headers # => { ... }
|
622
|
+
p data # => <ErrorContainer>
|
623
|
+
rescue OryHydraClient::ApiError => e
|
624
|
+
puts "Error when calling PublicApi->get_self_service_error_with_http_info: #{e}"
|
625
|
+
end
|
626
|
+
```
|
627
|
+
|
628
|
+
### Parameters
|
629
|
+
|
630
|
+
| Name | Type | Description | Notes |
|
631
|
+
| ---- | ---- | ----------- | ----- |
|
632
|
+
| **error** | **String** | Error is the container's ID | |
|
479
633
|
|
480
634
|
### Return type
|
481
635
|
|
@@ -493,36 +647,53 @@ No authorization required
|
|
493
647
|
|
494
648
|
## get_self_service_login_flow
|
495
649
|
|
496
|
-
> LoginFlow get_self_service_login_flow(id)
|
650
|
+
> <LoginFlow> get_self_service_login_flow(id)
|
497
651
|
|
498
652
|
Get Login Flow
|
499
653
|
|
500
654
|
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).
|
501
655
|
|
502
|
-
###
|
656
|
+
### Examples
|
503
657
|
|
504
658
|
```ruby
|
505
|
-
|
659
|
+
require 'time'
|
506
660
|
require 'ory-kratos-client'
|
507
661
|
|
508
662
|
api_instance = OryHydraClient::PublicApi.new
|
509
663
|
id = 'id_example' # 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`).
|
510
664
|
|
511
665
|
begin
|
512
|
-
#Get Login Flow
|
666
|
+
# Get Login Flow
|
513
667
|
result = api_instance.get_self_service_login_flow(id)
|
514
668
|
p result
|
515
669
|
rescue OryHydraClient::ApiError => e
|
516
|
-
puts "
|
670
|
+
puts "Error when calling PublicApi->get_self_service_login_flow: #{e}"
|
517
671
|
end
|
518
672
|
```
|
519
673
|
|
520
|
-
|
674
|
+
#### Using the get_self_service_login_flow_with_http_info variant
|
675
|
+
|
676
|
+
This returns an Array which contains the response data, status code and headers.
|
521
677
|
|
678
|
+
> <Array(<LoginFlow>, Integer, Hash)> get_self_service_login_flow_with_http_info(id)
|
522
679
|
|
523
|
-
|
524
|
-
|
525
|
-
|
680
|
+
```ruby
|
681
|
+
begin
|
682
|
+
# Get Login Flow
|
683
|
+
data, status_code, headers = api_instance.get_self_service_login_flow_with_http_info(id)
|
684
|
+
p status_code # => 2xx
|
685
|
+
p headers # => { ... }
|
686
|
+
p data # => <LoginFlow>
|
687
|
+
rescue OryHydraClient::ApiError => e
|
688
|
+
puts "Error when calling PublicApi->get_self_service_login_flow_with_http_info: #{e}"
|
689
|
+
end
|
690
|
+
```
|
691
|
+
|
692
|
+
### Parameters
|
693
|
+
|
694
|
+
| Name | Type | Description | Notes |
|
695
|
+
| ---- | ---- | ----------- | ----- |
|
696
|
+
| **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`). | |
|
526
697
|
|
527
698
|
### Return type
|
528
699
|
|
@@ -540,36 +711,53 @@ No authorization required
|
|
540
711
|
|
541
712
|
## get_self_service_recovery_flow
|
542
713
|
|
543
|
-
> RecoveryFlow get_self_service_recovery_flow(id)
|
714
|
+
> <RecoveryFlow> get_self_service_recovery_flow(id)
|
544
715
|
|
545
716
|
Get information about a recovery flow
|
546
717
|
|
547
718
|
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).
|
548
719
|
|
549
|
-
###
|
720
|
+
### Examples
|
550
721
|
|
551
722
|
```ruby
|
552
|
-
|
723
|
+
require 'time'
|
553
724
|
require 'ory-kratos-client'
|
554
725
|
|
555
726
|
api_instance = OryHydraClient::PublicApi.new
|
556
727
|
id = 'id_example' # String | The Flow ID The value for this parameter comes from `request` URL Query parameter sent to your application (e.g. `/recovery?flow=abcde`).
|
557
728
|
|
558
729
|
begin
|
559
|
-
#Get information about a recovery flow
|
730
|
+
# Get information about a recovery flow
|
560
731
|
result = api_instance.get_self_service_recovery_flow(id)
|
561
732
|
p result
|
562
733
|
rescue OryHydraClient::ApiError => e
|
563
|
-
puts "
|
734
|
+
puts "Error when calling PublicApi->get_self_service_recovery_flow: #{e}"
|
564
735
|
end
|
565
736
|
```
|
566
737
|
|
567
|
-
|
738
|
+
#### Using the get_self_service_recovery_flow_with_http_info variant
|
739
|
+
|
740
|
+
This returns an Array which contains the response data, status code and headers.
|
741
|
+
|
742
|
+
> <Array(<RecoveryFlow>, Integer, Hash)> get_self_service_recovery_flow_with_http_info(id)
|
743
|
+
|
744
|
+
```ruby
|
745
|
+
begin
|
746
|
+
# Get information about a recovery flow
|
747
|
+
data, status_code, headers = api_instance.get_self_service_recovery_flow_with_http_info(id)
|
748
|
+
p status_code # => 2xx
|
749
|
+
p headers # => { ... }
|
750
|
+
p data # => <RecoveryFlow>
|
751
|
+
rescue OryHydraClient::ApiError => e
|
752
|
+
puts "Error when calling PublicApi->get_self_service_recovery_flow_with_http_info: #{e}"
|
753
|
+
end
|
754
|
+
```
|
568
755
|
|
756
|
+
### Parameters
|
569
757
|
|
570
|
-
Name | Type | Description
|
571
|
-
|
572
|
-
**id** | **String
|
758
|
+
| Name | Type | Description | Notes |
|
759
|
+
| ---- | ---- | ----------- | ----- |
|
760
|
+
| **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`). | |
|
573
761
|
|
574
762
|
### Return type
|
575
763
|
|
@@ -587,36 +775,53 @@ No authorization required
|
|
587
775
|
|
588
776
|
## get_self_service_registration_flow
|
589
777
|
|
590
|
-
> RegistrationFlow get_self_service_registration_flow(id)
|
778
|
+
> <RegistrationFlow> get_self_service_registration_flow(id)
|
591
779
|
|
592
780
|
Get Registration Flow
|
593
781
|
|
594
782
|
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).
|
595
783
|
|
596
|
-
###
|
784
|
+
### Examples
|
597
785
|
|
598
786
|
```ruby
|
599
|
-
|
787
|
+
require 'time'
|
600
788
|
require 'ory-kratos-client'
|
601
789
|
|
602
790
|
api_instance = OryHydraClient::PublicApi.new
|
603
791
|
id = 'id_example' # 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`).
|
604
792
|
|
605
793
|
begin
|
606
|
-
#Get Registration Flow
|
794
|
+
# Get Registration Flow
|
607
795
|
result = api_instance.get_self_service_registration_flow(id)
|
608
796
|
p result
|
609
797
|
rescue OryHydraClient::ApiError => e
|
610
|
-
puts "
|
798
|
+
puts "Error when calling PublicApi->get_self_service_registration_flow: #{e}"
|
611
799
|
end
|
612
800
|
```
|
613
801
|
|
614
|
-
|
802
|
+
#### Using the get_self_service_registration_flow_with_http_info variant
|
803
|
+
|
804
|
+
This returns an Array which contains the response data, status code and headers.
|
805
|
+
|
806
|
+
> <Array(<RegistrationFlow>, Integer, Hash)> get_self_service_registration_flow_with_http_info(id)
|
807
|
+
|
808
|
+
```ruby
|
809
|
+
begin
|
810
|
+
# Get Registration Flow
|
811
|
+
data, status_code, headers = api_instance.get_self_service_registration_flow_with_http_info(id)
|
812
|
+
p status_code # => 2xx
|
813
|
+
p headers # => { ... }
|
814
|
+
p data # => <RegistrationFlow>
|
815
|
+
rescue OryHydraClient::ApiError => e
|
816
|
+
puts "Error when calling PublicApi->get_self_service_registration_flow_with_http_info: #{e}"
|
817
|
+
end
|
818
|
+
```
|
615
819
|
|
820
|
+
### Parameters
|
616
821
|
|
617
|
-
Name | Type | Description
|
618
|
-
|
619
|
-
**id** | **String
|
822
|
+
| Name | Type | Description | Notes |
|
823
|
+
| ---- | ---- | ----------- | ----- |
|
824
|
+
| **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`). | |
|
620
825
|
|
621
826
|
### Return type
|
622
827
|
|
@@ -634,43 +839,60 @@ No authorization required
|
|
634
839
|
|
635
840
|
## get_self_service_settings_flow
|
636
841
|
|
637
|
-
> SettingsFlow get_self_service_settings_flow(id)
|
842
|
+
> <SettingsFlow> get_self_service_settings_flow(id)
|
638
843
|
|
639
844
|
Get Settings Flow
|
640
845
|
|
641
846
|
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).
|
642
847
|
|
643
|
-
###
|
848
|
+
### Examples
|
644
849
|
|
645
850
|
```ruby
|
646
|
-
|
851
|
+
require 'time'
|
647
852
|
require 'ory-kratos-client'
|
648
853
|
# setup authorization
|
649
854
|
OryHydraClient.configure do |config|
|
650
855
|
# Configure API key authorization: sessionToken
|
651
856
|
config.api_key['X-Session-Token'] = 'YOUR API KEY'
|
652
857
|
# Uncomment the following line to set a prefix for the API key, e.g. 'Bearer' (defaults to nil)
|
653
|
-
#config.api_key_prefix['X-Session-Token'] = 'Bearer'
|
858
|
+
# config.api_key_prefix['X-Session-Token'] = 'Bearer'
|
654
859
|
end
|
655
860
|
|
656
861
|
api_instance = OryHydraClient::PublicApi.new
|
657
862
|
id = 'id_example' # 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`).
|
658
863
|
|
659
864
|
begin
|
660
|
-
#Get Settings Flow
|
865
|
+
# Get Settings Flow
|
661
866
|
result = api_instance.get_self_service_settings_flow(id)
|
662
867
|
p result
|
663
868
|
rescue OryHydraClient::ApiError => e
|
664
|
-
puts "
|
869
|
+
puts "Error when calling PublicApi->get_self_service_settings_flow: #{e}"
|
665
870
|
end
|
666
871
|
```
|
667
872
|
|
668
|
-
|
873
|
+
#### Using the get_self_service_settings_flow_with_http_info variant
|
874
|
+
|
875
|
+
This returns an Array which contains the response data, status code and headers.
|
669
876
|
|
877
|
+
> <Array(<SettingsFlow>, Integer, Hash)> get_self_service_settings_flow_with_http_info(id)
|
878
|
+
|
879
|
+
```ruby
|
880
|
+
begin
|
881
|
+
# Get Settings Flow
|
882
|
+
data, status_code, headers = api_instance.get_self_service_settings_flow_with_http_info(id)
|
883
|
+
p status_code # => 2xx
|
884
|
+
p headers # => { ... }
|
885
|
+
p data # => <SettingsFlow>
|
886
|
+
rescue OryHydraClient::ApiError => e
|
887
|
+
puts "Error when calling PublicApi->get_self_service_settings_flow_with_http_info: #{e}"
|
888
|
+
end
|
889
|
+
```
|
890
|
+
|
891
|
+
### Parameters
|
670
892
|
|
671
|
-
Name | Type | Description
|
672
|
-
|
673
|
-
**id** | **String
|
893
|
+
| Name | Type | Description | Notes |
|
894
|
+
| ---- | ---- | ----------- | ----- |
|
895
|
+
| **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`). | |
|
674
896
|
|
675
897
|
### Return type
|
676
898
|
|
@@ -688,36 +910,53 @@ Name | Type | Description | Notes
|
|
688
910
|
|
689
911
|
## get_self_service_verification_flow
|
690
912
|
|
691
|
-
> VerificationFlow get_self_service_verification_flow(id)
|
913
|
+
> <VerificationFlow> get_self_service_verification_flow(id)
|
692
914
|
|
693
915
|
Get Verification Flow
|
694
916
|
|
695
917
|
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).
|
696
918
|
|
697
|
-
###
|
919
|
+
### Examples
|
698
920
|
|
699
921
|
```ruby
|
700
|
-
|
922
|
+
require 'time'
|
701
923
|
require 'ory-kratos-client'
|
702
924
|
|
703
925
|
api_instance = OryHydraClient::PublicApi.new
|
704
926
|
id = 'id_example' # String | The Flow ID The value for this parameter comes from `request` URL Query parameter sent to your application (e.g. `/verification?flow=abcde`).
|
705
927
|
|
706
928
|
begin
|
707
|
-
#Get Verification Flow
|
929
|
+
# Get Verification Flow
|
708
930
|
result = api_instance.get_self_service_verification_flow(id)
|
709
931
|
p result
|
710
932
|
rescue OryHydraClient::ApiError => e
|
711
|
-
puts "
|
933
|
+
puts "Error when calling PublicApi->get_self_service_verification_flow: #{e}"
|
712
934
|
end
|
713
935
|
```
|
714
936
|
|
715
|
-
|
937
|
+
#### Using the get_self_service_verification_flow_with_http_info variant
|
938
|
+
|
939
|
+
This returns an Array which contains the response data, status code and headers.
|
716
940
|
|
941
|
+
> <Array(<VerificationFlow>, Integer, Hash)> get_self_service_verification_flow_with_http_info(id)
|
717
942
|
|
718
|
-
|
719
|
-
|
720
|
-
|
943
|
+
```ruby
|
944
|
+
begin
|
945
|
+
# Get Verification Flow
|
946
|
+
data, status_code, headers = api_instance.get_self_service_verification_flow_with_http_info(id)
|
947
|
+
p status_code # => 2xx
|
948
|
+
p headers # => { ... }
|
949
|
+
p data # => <VerificationFlow>
|
950
|
+
rescue OryHydraClient::ApiError => e
|
951
|
+
puts "Error when calling PublicApi->get_self_service_verification_flow_with_http_info: #{e}"
|
952
|
+
end
|
953
|
+
```
|
954
|
+
|
955
|
+
### Parameters
|
956
|
+
|
957
|
+
| Name | Type | Description | Notes |
|
958
|
+
| ---- | ---- | ----------- | ----- |
|
959
|
+
| **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`). | |
|
721
960
|
|
722
961
|
### Return type
|
723
962
|
|
@@ -739,21 +978,39 @@ No authorization required
|
|
739
978
|
|
740
979
|
Initialize Browser-Based Logout User Flow
|
741
980
|
|
742
|
-
This endpoint initializes a logout flow. > This endpoint is NOT INTENDED for API clients and only works with browsers (Chrome, Firefox, ...). On successful logout, the browser will be redirected (HTTP 302 Found) to `urls.default_return_to`. More information can be found at [ORY Kratos User Logout Documentation](https://www.ory.sh/docs/next/kratos/self-service/flows/user-logout).
|
981
|
+
This endpoint initializes a logout flow. > This endpoint is NOT INTENDED for API clients and only works with browsers (Chrome, Firefox, ...). On successful logout, the browser will be redirected (HTTP 302 Found) to the `return_to` parameter of the initial request or fall back to `urls.default_return_to`. More information can be found at [ORY Kratos User Logout Documentation](https://www.ory.sh/docs/next/kratos/self-service/flows/user-logout).
|
743
982
|
|
744
|
-
###
|
983
|
+
### Examples
|
745
984
|
|
746
985
|
```ruby
|
747
|
-
|
986
|
+
require 'time'
|
748
987
|
require 'ory-kratos-client'
|
749
988
|
|
750
989
|
api_instance = OryHydraClient::PublicApi.new
|
751
990
|
|
752
991
|
begin
|
753
|
-
#Initialize Browser-Based Logout User Flow
|
992
|
+
# Initialize Browser-Based Logout User Flow
|
754
993
|
api_instance.initialize_self_service_browser_logout_flow
|
755
994
|
rescue OryHydraClient::ApiError => e
|
756
|
-
puts "
|
995
|
+
puts "Error when calling PublicApi->initialize_self_service_browser_logout_flow: #{e}"
|
996
|
+
end
|
997
|
+
```
|
998
|
+
|
999
|
+
#### Using the initialize_self_service_browser_logout_flow_with_http_info variant
|
1000
|
+
|
1001
|
+
This returns an Array which contains the response data (`nil` in this case), status code and headers.
|
1002
|
+
|
1003
|
+
> <Array(nil, Integer, Hash)> initialize_self_service_browser_logout_flow_with_http_info
|
1004
|
+
|
1005
|
+
```ruby
|
1006
|
+
begin
|
1007
|
+
# Initialize Browser-Based Logout User Flow
|
1008
|
+
data, status_code, headers = api_instance.initialize_self_service_browser_logout_flow_with_http_info
|
1009
|
+
p status_code # => 2xx
|
1010
|
+
p headers # => { ... }
|
1011
|
+
p data # => nil
|
1012
|
+
rescue OryHydraClient::ApiError => e
|
1013
|
+
puts "Error when calling PublicApi->initialize_self_service_browser_logout_flow_with_http_info: #{e}"
|
757
1014
|
end
|
758
1015
|
```
|
759
1016
|
|
@@ -777,16 +1034,16 @@ No authorization required
|
|
777
1034
|
|
778
1035
|
## initialize_self_service_login_via_api_flow
|
779
1036
|
|
780
|
-
> LoginFlow initialize_self_service_login_via_api_flow(opts)
|
1037
|
+
> <LoginFlow> initialize_self_service_login_via_api_flow(opts)
|
781
1038
|
|
782
1039
|
Initialize Login Flow for API clients
|
783
1040
|
|
784
1041
|
This endpoint initiates a login flow for API clients such as mobile devices, smart TVs, and so on. If a valid provided session cookie or session token is provided, a 400 Bad Request error will be returned unless the URL query parameter `?refresh=true` is set. To fetch an existing login flow call `/self-service/login/flows?flow=<flow_id>`. :::warning You MUST NOT use this endpoint in client-side (Single Page Apps, ReactJS, AngularJS) nor server-side (Java Server Pages, NodeJS, PHP, Golang, ...) browser applications. Using this endpoint in these applications will make you vulnerable to a variety of CSRF attacks, including CSRF login attacks. This endpoint MUST ONLY be used in scenarios such as native mobile apps (React Native, Objective C, Swift, Java, ...). ::: 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).
|
785
1042
|
|
786
|
-
###
|
1043
|
+
### Examples
|
787
1044
|
|
788
1045
|
```ruby
|
789
|
-
|
1046
|
+
require 'time'
|
790
1047
|
require 'ory-kratos-client'
|
791
1048
|
|
792
1049
|
api_instance = OryHydraClient::PublicApi.new
|
@@ -795,20 +1052,37 @@ opts = {
|
|
795
1052
|
}
|
796
1053
|
|
797
1054
|
begin
|
798
|
-
#Initialize Login Flow for API clients
|
1055
|
+
# Initialize Login Flow for API clients
|
799
1056
|
result = api_instance.initialize_self_service_login_via_api_flow(opts)
|
800
1057
|
p result
|
801
1058
|
rescue OryHydraClient::ApiError => e
|
802
|
-
puts "
|
1059
|
+
puts "Error when calling PublicApi->initialize_self_service_login_via_api_flow: #{e}"
|
803
1060
|
end
|
804
1061
|
```
|
805
1062
|
|
806
|
-
|
1063
|
+
#### Using the initialize_self_service_login_via_api_flow_with_http_info variant
|
1064
|
+
|
1065
|
+
This returns an Array which contains the response data, status code and headers.
|
1066
|
+
|
1067
|
+
> <Array(<LoginFlow>, Integer, Hash)> initialize_self_service_login_via_api_flow_with_http_info(opts)
|
1068
|
+
|
1069
|
+
```ruby
|
1070
|
+
begin
|
1071
|
+
# Initialize Login Flow for API clients
|
1072
|
+
data, status_code, headers = api_instance.initialize_self_service_login_via_api_flow_with_http_info(opts)
|
1073
|
+
p status_code # => 2xx
|
1074
|
+
p headers # => { ... }
|
1075
|
+
p data # => <LoginFlow>
|
1076
|
+
rescue OryHydraClient::ApiError => e
|
1077
|
+
puts "Error when calling PublicApi->initialize_self_service_login_via_api_flow_with_http_info: #{e}"
|
1078
|
+
end
|
1079
|
+
```
|
807
1080
|
|
1081
|
+
### Parameters
|
808
1082
|
|
809
|
-
Name | Type | Description
|
810
|
-
|
811
|
-
**refresh** | **Boolean
|
1083
|
+
| Name | Type | Description | Notes |
|
1084
|
+
| ---- | ---- | ----------- | ----- |
|
1085
|
+
| **refresh** | **Boolean** | Refresh a login session If set to true, this will refresh an existing login session by asking the user to sign in again. This will reset the authenticated_at time of the session. | [optional] |
|
812
1086
|
|
813
1087
|
### Return type
|
814
1088
|
|
@@ -832,19 +1106,37 @@ Initialize Login Flow for browsers
|
|
832
1106
|
|
833
1107
|
This endpoint initializes a browser-based user login flow. Once initialized, the browser will be redirected to `selfservice.flows.login.ui_url` with the flow ID set as the query parameter `?flow=`. If a valid user session exists already, the browser will be redirected to `urls.default_redirect_url` unless the query parameter `?refresh=true` was set. This endpoint is NOT INTENDED for API clients and only works with browsers (Chrome, Firefox, ...). More information can be found at [ORY Kratos User Login and User Registration Documentation](https://www.ory.sh/docs/next/kratos/self-service/flows/user-login-user-registration).
|
834
1108
|
|
835
|
-
###
|
1109
|
+
### Examples
|
836
1110
|
|
837
1111
|
```ruby
|
838
|
-
|
1112
|
+
require 'time'
|
839
1113
|
require 'ory-kratos-client'
|
840
1114
|
|
841
1115
|
api_instance = OryHydraClient::PublicApi.new
|
842
1116
|
|
843
1117
|
begin
|
844
|
-
#Initialize Login Flow for browsers
|
1118
|
+
# Initialize Login Flow for browsers
|
845
1119
|
api_instance.initialize_self_service_login_via_browser_flow
|
846
1120
|
rescue OryHydraClient::ApiError => e
|
847
|
-
puts "
|
1121
|
+
puts "Error when calling PublicApi->initialize_self_service_login_via_browser_flow: #{e}"
|
1122
|
+
end
|
1123
|
+
```
|
1124
|
+
|
1125
|
+
#### Using the initialize_self_service_login_via_browser_flow_with_http_info variant
|
1126
|
+
|
1127
|
+
This returns an Array which contains the response data (`nil` in this case), status code and headers.
|
1128
|
+
|
1129
|
+
> <Array(nil, Integer, Hash)> initialize_self_service_login_via_browser_flow_with_http_info
|
1130
|
+
|
1131
|
+
```ruby
|
1132
|
+
begin
|
1133
|
+
# Initialize Login Flow for browsers
|
1134
|
+
data, status_code, headers = api_instance.initialize_self_service_login_via_browser_flow_with_http_info
|
1135
|
+
p status_code # => 2xx
|
1136
|
+
p headers # => { ... }
|
1137
|
+
p data # => nil
|
1138
|
+
rescue OryHydraClient::ApiError => e
|
1139
|
+
puts "Error when calling PublicApi->initialize_self_service_login_via_browser_flow_with_http_info: #{e}"
|
848
1140
|
end
|
849
1141
|
```
|
850
1142
|
|
@@ -868,26 +1160,44 @@ No authorization required
|
|
868
1160
|
|
869
1161
|
## initialize_self_service_recovery_via_api_flow
|
870
1162
|
|
871
|
-
> RecoveryFlow initialize_self_service_recovery_via_api_flow
|
1163
|
+
> <RecoveryFlow> initialize_self_service_recovery_via_api_flow
|
872
1164
|
|
873
1165
|
Initialize Recovery Flow for API Clients
|
874
1166
|
|
875
1167
|
This endpoint initiates a recovery flow for API clients such as mobile devices, smart TVs, and so on. If a valid provided session cookie or session token is provided, a 400 Bad Request error. To fetch an existing recovery flow call `/self-service/recovery/flows?flow=<flow_id>`. :::warning You MUST NOT use this endpoint in client-side (Single Page Apps, ReactJS, AngularJS) nor server-side (Java Server Pages, NodeJS, PHP, Golang, ...) browser applications. Using this endpoint in these applications will make you vulnerable to a variety of CSRF attacks. This endpoint MUST ONLY be used in scenarios such as native mobile apps (React Native, Objective C, Swift, Java, ...). ::: More information can be found at [ORY Kratos Account Recovery Documentation](../self-service/flows/account-recovery.mdx).
|
876
1168
|
|
877
|
-
###
|
1169
|
+
### Examples
|
878
1170
|
|
879
1171
|
```ruby
|
880
|
-
|
1172
|
+
require 'time'
|
881
1173
|
require 'ory-kratos-client'
|
882
1174
|
|
883
1175
|
api_instance = OryHydraClient::PublicApi.new
|
884
1176
|
|
885
1177
|
begin
|
886
|
-
#Initialize Recovery Flow for API Clients
|
1178
|
+
# Initialize Recovery Flow for API Clients
|
887
1179
|
result = api_instance.initialize_self_service_recovery_via_api_flow
|
888
1180
|
p result
|
889
1181
|
rescue OryHydraClient::ApiError => e
|
890
|
-
puts "
|
1182
|
+
puts "Error when calling PublicApi->initialize_self_service_recovery_via_api_flow: #{e}"
|
1183
|
+
end
|
1184
|
+
```
|
1185
|
+
|
1186
|
+
#### Using the initialize_self_service_recovery_via_api_flow_with_http_info variant
|
1187
|
+
|
1188
|
+
This returns an Array which contains the response data, status code and headers.
|
1189
|
+
|
1190
|
+
> <Array(<RecoveryFlow>, Integer, Hash)> initialize_self_service_recovery_via_api_flow_with_http_info
|
1191
|
+
|
1192
|
+
```ruby
|
1193
|
+
begin
|
1194
|
+
# Initialize Recovery Flow for API Clients
|
1195
|
+
data, status_code, headers = api_instance.initialize_self_service_recovery_via_api_flow_with_http_info
|
1196
|
+
p status_code # => 2xx
|
1197
|
+
p headers # => { ... }
|
1198
|
+
p data # => <RecoveryFlow>
|
1199
|
+
rescue OryHydraClient::ApiError => e
|
1200
|
+
puts "Error when calling PublicApi->initialize_self_service_recovery_via_api_flow_with_http_info: #{e}"
|
891
1201
|
end
|
892
1202
|
```
|
893
1203
|
|
@@ -917,19 +1227,37 @@ Initialize Recovery Flow for Browser Clients
|
|
917
1227
|
|
918
1228
|
This endpoint initializes a browser-based account recovery flow. Once initialized, the browser will be redirected to `selfservice.flows.recovery.ui_url` with the flow ID set as the query parameter `?flow=`. If a valid user session exists, the browser is returned to the configured return URL. This endpoint is NOT INTENDED for API clients and only works with browsers (Chrome, Firefox, ...). More information can be found at [ORY Kratos Account Recovery Documentation](../self-service/flows/account-recovery.mdx).
|
919
1229
|
|
920
|
-
###
|
1230
|
+
### Examples
|
921
1231
|
|
922
1232
|
```ruby
|
923
|
-
|
1233
|
+
require 'time'
|
924
1234
|
require 'ory-kratos-client'
|
925
1235
|
|
926
1236
|
api_instance = OryHydraClient::PublicApi.new
|
927
1237
|
|
928
1238
|
begin
|
929
|
-
#Initialize Recovery Flow for Browser Clients
|
1239
|
+
# Initialize Recovery Flow for Browser Clients
|
930
1240
|
api_instance.initialize_self_service_recovery_via_browser_flow
|
931
1241
|
rescue OryHydraClient::ApiError => e
|
932
|
-
puts "
|
1242
|
+
puts "Error when calling PublicApi->initialize_self_service_recovery_via_browser_flow: #{e}"
|
1243
|
+
end
|
1244
|
+
```
|
1245
|
+
|
1246
|
+
#### Using the initialize_self_service_recovery_via_browser_flow_with_http_info variant
|
1247
|
+
|
1248
|
+
This returns an Array which contains the response data (`nil` in this case), status code and headers.
|
1249
|
+
|
1250
|
+
> <Array(nil, Integer, Hash)> initialize_self_service_recovery_via_browser_flow_with_http_info
|
1251
|
+
|
1252
|
+
```ruby
|
1253
|
+
begin
|
1254
|
+
# Initialize Recovery Flow for Browser Clients
|
1255
|
+
data, status_code, headers = api_instance.initialize_self_service_recovery_via_browser_flow_with_http_info
|
1256
|
+
p status_code # => 2xx
|
1257
|
+
p headers # => { ... }
|
1258
|
+
p data # => nil
|
1259
|
+
rescue OryHydraClient::ApiError => e
|
1260
|
+
puts "Error when calling PublicApi->initialize_self_service_recovery_via_browser_flow_with_http_info: #{e}"
|
933
1261
|
end
|
934
1262
|
```
|
935
1263
|
|
@@ -953,26 +1281,44 @@ No authorization required
|
|
953
1281
|
|
954
1282
|
## initialize_self_service_registration_via_api_flow
|
955
1283
|
|
956
|
-
> RegistrationFlow initialize_self_service_registration_via_api_flow
|
1284
|
+
> <RegistrationFlow> initialize_self_service_registration_via_api_flow
|
957
1285
|
|
958
1286
|
Initialize Registration Flow for API clients
|
959
1287
|
|
960
1288
|
This endpoint initiates a registration flow for API clients such as mobile devices, smart TVs, and so on. If a valid provided session cookie or session token is provided, a 400 Bad Request error will be returned unless the URL query parameter `?refresh=true` is set. To fetch an existing registration flow call `/self-service/registration/flows?flow=<flow_id>`. :::warning You MUST NOT use this endpoint in client-side (Single Page Apps, ReactJS, AngularJS) nor server-side (Java Server Pages, NodeJS, PHP, Golang, ...) browser applications. Using this endpoint in these applications will make you vulnerable to a variety of CSRF attacks. This endpoint MUST ONLY be used in scenarios such as native mobile apps (React Native, Objective C, Swift, Java, ...). ::: 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).
|
961
1289
|
|
962
|
-
###
|
1290
|
+
### Examples
|
963
1291
|
|
964
1292
|
```ruby
|
965
|
-
|
1293
|
+
require 'time'
|
966
1294
|
require 'ory-kratos-client'
|
967
1295
|
|
968
1296
|
api_instance = OryHydraClient::PublicApi.new
|
969
1297
|
|
970
1298
|
begin
|
971
|
-
#Initialize Registration Flow for API clients
|
1299
|
+
# Initialize Registration Flow for API clients
|
972
1300
|
result = api_instance.initialize_self_service_registration_via_api_flow
|
973
1301
|
p result
|
974
1302
|
rescue OryHydraClient::ApiError => e
|
975
|
-
puts "
|
1303
|
+
puts "Error when calling PublicApi->initialize_self_service_registration_via_api_flow: #{e}"
|
1304
|
+
end
|
1305
|
+
```
|
1306
|
+
|
1307
|
+
#### Using the initialize_self_service_registration_via_api_flow_with_http_info variant
|
1308
|
+
|
1309
|
+
This returns an Array which contains the response data, status code and headers.
|
1310
|
+
|
1311
|
+
> <Array(<RegistrationFlow>, Integer, Hash)> initialize_self_service_registration_via_api_flow_with_http_info
|
1312
|
+
|
1313
|
+
```ruby
|
1314
|
+
begin
|
1315
|
+
# Initialize Registration Flow for API clients
|
1316
|
+
data, status_code, headers = api_instance.initialize_self_service_registration_via_api_flow_with_http_info
|
1317
|
+
p status_code # => 2xx
|
1318
|
+
p headers # => { ... }
|
1319
|
+
p data # => <RegistrationFlow>
|
1320
|
+
rescue OryHydraClient::ApiError => e
|
1321
|
+
puts "Error when calling PublicApi->initialize_self_service_registration_via_api_flow_with_http_info: #{e}"
|
976
1322
|
end
|
977
1323
|
```
|
978
1324
|
|
@@ -1002,19 +1348,37 @@ Initialize Registration Flow for browsers
|
|
1002
1348
|
|
1003
1349
|
This endpoint initializes a browser-based user registration flow. Once initialized, the browser will be redirected to `selfservice.flows.registration.ui_url` with the flow ID set as the query parameter `?flow=`. If a valid user session exists already, the browser will be redirected to `urls.default_redirect_url` unless the query parameter `?refresh=true` was set. :::note This endpoint is NOT INTENDED for API clients and only works with browsers (Chrome, Firefox, ...). ::: More information can be found at [ORY Kratos User Login and User Registration Documentation](https://www.ory.sh/docs/next/kratos/self-service/flows/user-login-user-registration).
|
1004
1350
|
|
1005
|
-
###
|
1351
|
+
### Examples
|
1006
1352
|
|
1007
1353
|
```ruby
|
1008
|
-
|
1354
|
+
require 'time'
|
1009
1355
|
require 'ory-kratos-client'
|
1010
1356
|
|
1011
1357
|
api_instance = OryHydraClient::PublicApi.new
|
1012
1358
|
|
1013
1359
|
begin
|
1014
|
-
#Initialize Registration Flow for browsers
|
1360
|
+
# Initialize Registration Flow for browsers
|
1015
1361
|
api_instance.initialize_self_service_registration_via_browser_flow
|
1016
1362
|
rescue OryHydraClient::ApiError => e
|
1017
|
-
puts "
|
1363
|
+
puts "Error when calling PublicApi->initialize_self_service_registration_via_browser_flow: #{e}"
|
1364
|
+
end
|
1365
|
+
```
|
1366
|
+
|
1367
|
+
#### Using the initialize_self_service_registration_via_browser_flow_with_http_info variant
|
1368
|
+
|
1369
|
+
This returns an Array which contains the response data (`nil` in this case), status code and headers.
|
1370
|
+
|
1371
|
+
> <Array(nil, Integer, Hash)> initialize_self_service_registration_via_browser_flow_with_http_info
|
1372
|
+
|
1373
|
+
```ruby
|
1374
|
+
begin
|
1375
|
+
# Initialize Registration Flow for browsers
|
1376
|
+
data, status_code, headers = api_instance.initialize_self_service_registration_via_browser_flow_with_http_info
|
1377
|
+
p status_code # => 2xx
|
1378
|
+
p headers # => { ... }
|
1379
|
+
p data # => nil
|
1380
|
+
rescue OryHydraClient::ApiError => e
|
1381
|
+
puts "Error when calling PublicApi->initialize_self_service_registration_via_browser_flow_with_http_info: #{e}"
|
1018
1382
|
end
|
1019
1383
|
```
|
1020
1384
|
|
@@ -1038,33 +1402,51 @@ No authorization required
|
|
1038
1402
|
|
1039
1403
|
## initialize_self_service_settings_via_api_flow
|
1040
1404
|
|
1041
|
-
> SettingsFlow initialize_self_service_settings_via_api_flow
|
1405
|
+
> <SettingsFlow> initialize_self_service_settings_via_api_flow
|
1042
1406
|
|
1043
1407
|
Initialize Settings Flow for API Clients
|
1044
1408
|
|
1045
1409
|
This endpoint initiates a settings flow for API clients such as mobile devices, smart TVs, and so on. You must provide a valid ORY Kratos Session Token for this endpoint to respond with HTTP 200 OK. To fetch an existing settings flow call `/self-service/settings/flows?flow=<flow_id>`. :::warning You MUST NOT use this endpoint in client-side (Single Page Apps, ReactJS, AngularJS) nor server-side (Java Server Pages, NodeJS, PHP, Golang, ...) browser applications. Using this endpoint in these applications will make you vulnerable to a variety of CSRF attacks. This endpoint MUST ONLY be used in scenarios such as native mobile apps (React Native, Objective C, Swift, Java, ...). ::: More information can be found at [ORY Kratos User Settings & Profile Management Documentation](../self-service/flows/user-settings).
|
1046
1410
|
|
1047
|
-
###
|
1411
|
+
### Examples
|
1048
1412
|
|
1049
1413
|
```ruby
|
1050
|
-
|
1414
|
+
require 'time'
|
1051
1415
|
require 'ory-kratos-client'
|
1052
1416
|
# setup authorization
|
1053
1417
|
OryHydraClient.configure do |config|
|
1054
1418
|
# Configure API key authorization: sessionToken
|
1055
1419
|
config.api_key['X-Session-Token'] = 'YOUR API KEY'
|
1056
1420
|
# Uncomment the following line to set a prefix for the API key, e.g. 'Bearer' (defaults to nil)
|
1057
|
-
#config.api_key_prefix['X-Session-Token'] = 'Bearer'
|
1421
|
+
# config.api_key_prefix['X-Session-Token'] = 'Bearer'
|
1058
1422
|
end
|
1059
1423
|
|
1060
1424
|
api_instance = OryHydraClient::PublicApi.new
|
1061
1425
|
|
1062
1426
|
begin
|
1063
|
-
#Initialize Settings Flow for API Clients
|
1427
|
+
# Initialize Settings Flow for API Clients
|
1064
1428
|
result = api_instance.initialize_self_service_settings_via_api_flow
|
1065
1429
|
p result
|
1066
1430
|
rescue OryHydraClient::ApiError => e
|
1067
|
-
puts "
|
1431
|
+
puts "Error when calling PublicApi->initialize_self_service_settings_via_api_flow: #{e}"
|
1432
|
+
end
|
1433
|
+
```
|
1434
|
+
|
1435
|
+
#### Using the initialize_self_service_settings_via_api_flow_with_http_info variant
|
1436
|
+
|
1437
|
+
This returns an Array which contains the response data, status code and headers.
|
1438
|
+
|
1439
|
+
> <Array(<SettingsFlow>, Integer, Hash)> initialize_self_service_settings_via_api_flow_with_http_info
|
1440
|
+
|
1441
|
+
```ruby
|
1442
|
+
begin
|
1443
|
+
# Initialize Settings Flow for API Clients
|
1444
|
+
data, status_code, headers = api_instance.initialize_self_service_settings_via_api_flow_with_http_info
|
1445
|
+
p status_code # => 2xx
|
1446
|
+
p headers # => { ... }
|
1447
|
+
p data # => <SettingsFlow>
|
1448
|
+
rescue OryHydraClient::ApiError => e
|
1449
|
+
puts "Error when calling PublicApi->initialize_self_service_settings_via_api_flow_with_http_info: #{e}"
|
1068
1450
|
end
|
1069
1451
|
```
|
1070
1452
|
|
@@ -1094,26 +1476,44 @@ Initialize Settings Flow for Browsers
|
|
1094
1476
|
|
1095
1477
|
This endpoint initializes a browser-based user settings flow. Once initialized, the browser will be redirected to `selfservice.flows.settings.ui_url` with the flow ID set as the query parameter `?flow=`. If no valid ORY Kratos Session Cookie is included in the request, a login flow will be initialized. :::note 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).
|
1096
1478
|
|
1097
|
-
###
|
1479
|
+
### Examples
|
1098
1480
|
|
1099
1481
|
```ruby
|
1100
|
-
|
1482
|
+
require 'time'
|
1101
1483
|
require 'ory-kratos-client'
|
1102
1484
|
# setup authorization
|
1103
1485
|
OryHydraClient.configure do |config|
|
1104
1486
|
# Configure API key authorization: sessionToken
|
1105
1487
|
config.api_key['X-Session-Token'] = 'YOUR API KEY'
|
1106
1488
|
# Uncomment the following line to set a prefix for the API key, e.g. 'Bearer' (defaults to nil)
|
1107
|
-
#config.api_key_prefix['X-Session-Token'] = 'Bearer'
|
1489
|
+
# config.api_key_prefix['X-Session-Token'] = 'Bearer'
|
1108
1490
|
end
|
1109
1491
|
|
1110
1492
|
api_instance = OryHydraClient::PublicApi.new
|
1111
1493
|
|
1112
1494
|
begin
|
1113
|
-
#Initialize Settings Flow for Browsers
|
1495
|
+
# Initialize Settings Flow for Browsers
|
1114
1496
|
api_instance.initialize_self_service_settings_via_browser_flow
|
1115
1497
|
rescue OryHydraClient::ApiError => e
|
1116
|
-
puts "
|
1498
|
+
puts "Error when calling PublicApi->initialize_self_service_settings_via_browser_flow: #{e}"
|
1499
|
+
end
|
1500
|
+
```
|
1501
|
+
|
1502
|
+
#### Using the initialize_self_service_settings_via_browser_flow_with_http_info variant
|
1503
|
+
|
1504
|
+
This returns an Array which contains the response data (`nil` in this case), status code and headers.
|
1505
|
+
|
1506
|
+
> <Array(nil, Integer, Hash)> initialize_self_service_settings_via_browser_flow_with_http_info
|
1507
|
+
|
1508
|
+
```ruby
|
1509
|
+
begin
|
1510
|
+
# Initialize Settings Flow for Browsers
|
1511
|
+
data, status_code, headers = api_instance.initialize_self_service_settings_via_browser_flow_with_http_info
|
1512
|
+
p status_code # => 2xx
|
1513
|
+
p headers # => { ... }
|
1514
|
+
p data # => nil
|
1515
|
+
rescue OryHydraClient::ApiError => e
|
1516
|
+
puts "Error when calling PublicApi->initialize_self_service_settings_via_browser_flow_with_http_info: #{e}"
|
1117
1517
|
end
|
1118
1518
|
```
|
1119
1519
|
|
@@ -1137,26 +1537,44 @@ nil (empty response body)
|
|
1137
1537
|
|
1138
1538
|
## initialize_self_service_verification_via_api_flow
|
1139
1539
|
|
1140
|
-
> VerificationFlow initialize_self_service_verification_via_api_flow
|
1540
|
+
> <VerificationFlow> initialize_self_service_verification_via_api_flow
|
1141
1541
|
|
1142
1542
|
Initialize Verification Flow for API Clients
|
1143
1543
|
|
1144
1544
|
This endpoint initiates a verification flow for API clients such as mobile devices, smart TVs, and so on. To fetch an existing verification flow call `/self-service/verification/flows?flow=<flow_id>`. :::warning You MUST NOT use this endpoint in client-side (Single Page Apps, ReactJS, AngularJS) nor server-side (Java Server Pages, NodeJS, PHP, Golang, ...) browser applications. Using this endpoint in these applications will make you vulnerable to a variety of CSRF attacks. This endpoint MUST ONLY be used in scenarios such as native mobile apps (React Native, Objective C, Swift, Java, ...). ::: 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).
|
1145
1545
|
|
1146
|
-
###
|
1546
|
+
### Examples
|
1147
1547
|
|
1148
1548
|
```ruby
|
1149
|
-
|
1549
|
+
require 'time'
|
1150
1550
|
require 'ory-kratos-client'
|
1151
1551
|
|
1152
1552
|
api_instance = OryHydraClient::PublicApi.new
|
1153
1553
|
|
1154
1554
|
begin
|
1155
|
-
#Initialize Verification Flow for API Clients
|
1555
|
+
# Initialize Verification Flow for API Clients
|
1156
1556
|
result = api_instance.initialize_self_service_verification_via_api_flow
|
1157
1557
|
p result
|
1158
1558
|
rescue OryHydraClient::ApiError => e
|
1159
|
-
puts "
|
1559
|
+
puts "Error when calling PublicApi->initialize_self_service_verification_via_api_flow: #{e}"
|
1560
|
+
end
|
1561
|
+
```
|
1562
|
+
|
1563
|
+
#### Using the initialize_self_service_verification_via_api_flow_with_http_info variant
|
1564
|
+
|
1565
|
+
This returns an Array which contains the response data, status code and headers.
|
1566
|
+
|
1567
|
+
> <Array(<VerificationFlow>, Integer, Hash)> initialize_self_service_verification_via_api_flow_with_http_info
|
1568
|
+
|
1569
|
+
```ruby
|
1570
|
+
begin
|
1571
|
+
# Initialize Verification Flow for API Clients
|
1572
|
+
data, status_code, headers = api_instance.initialize_self_service_verification_via_api_flow_with_http_info
|
1573
|
+
p status_code # => 2xx
|
1574
|
+
p headers # => { ... }
|
1575
|
+
p data # => <VerificationFlow>
|
1576
|
+
rescue OryHydraClient::ApiError => e
|
1577
|
+
puts "Error when calling PublicApi->initialize_self_service_verification_via_api_flow_with_http_info: #{e}"
|
1160
1578
|
end
|
1161
1579
|
```
|
1162
1580
|
|
@@ -1186,19 +1604,37 @@ Initialize Verification Flow for Browser Clients
|
|
1186
1604
|
|
1187
1605
|
This endpoint initializes a browser-based account verification flow. Once initialized, the browser will be redirected to `selfservice.flows.verification.ui_url` with the flow ID set as the query parameter `?flow=`. 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).
|
1188
1606
|
|
1189
|
-
###
|
1607
|
+
### Examples
|
1190
1608
|
|
1191
1609
|
```ruby
|
1192
|
-
|
1610
|
+
require 'time'
|
1193
1611
|
require 'ory-kratos-client'
|
1194
1612
|
|
1195
1613
|
api_instance = OryHydraClient::PublicApi.new
|
1196
1614
|
|
1197
1615
|
begin
|
1198
|
-
#Initialize Verification Flow for Browser Clients
|
1616
|
+
# Initialize Verification Flow for Browser Clients
|
1199
1617
|
api_instance.initialize_self_service_verification_via_browser_flow
|
1200
1618
|
rescue OryHydraClient::ApiError => e
|
1201
|
-
puts "
|
1619
|
+
puts "Error when calling PublicApi->initialize_self_service_verification_via_browser_flow: #{e}"
|
1620
|
+
end
|
1621
|
+
```
|
1622
|
+
|
1623
|
+
#### Using the initialize_self_service_verification_via_browser_flow_with_http_info variant
|
1624
|
+
|
1625
|
+
This returns an Array which contains the response data (`nil` in this case), status code and headers.
|
1626
|
+
|
1627
|
+
> <Array(nil, Integer, Hash)> initialize_self_service_verification_via_browser_flow_with_http_info
|
1628
|
+
|
1629
|
+
```ruby
|
1630
|
+
begin
|
1631
|
+
# Initialize Verification Flow for Browser Clients
|
1632
|
+
data, status_code, headers = api_instance.initialize_self_service_verification_via_browser_flow_with_http_info
|
1633
|
+
p status_code # => 2xx
|
1634
|
+
p headers # => { ... }
|
1635
|
+
p data # => nil
|
1636
|
+
rescue OryHydraClient::ApiError => e
|
1637
|
+
puts "Error when calling PublicApi->initialize_self_service_verification_via_browser_flow_with_http_info: #{e}"
|
1202
1638
|
end
|
1203
1639
|
```
|
1204
1640
|
|
@@ -1228,29 +1664,46 @@ Revoke and Invalidate a Session
|
|
1228
1664
|
|
1229
1665
|
Use this endpoint to revoke a session using its token. This endpoint is particularly useful for API clients such as mobile apps to log the user out of the system and invalidate the session. This endpoint does not remove any HTTP Cookies - use the Self-Service Logout Flow instead.
|
1230
1666
|
|
1231
|
-
###
|
1667
|
+
### Examples
|
1232
1668
|
|
1233
1669
|
```ruby
|
1234
|
-
|
1670
|
+
require 'time'
|
1235
1671
|
require 'ory-kratos-client'
|
1236
1672
|
|
1237
1673
|
api_instance = OryHydraClient::PublicApi.new
|
1238
|
-
body = OryHydraClient::RevokeSession.new # RevokeSession |
|
1674
|
+
body = OryHydraClient::RevokeSession.new({session_token: 'session_token_example'}) # RevokeSession |
|
1239
1675
|
|
1240
1676
|
begin
|
1241
|
-
#Revoke and Invalidate a Session
|
1677
|
+
# Revoke and Invalidate a Session
|
1242
1678
|
api_instance.revoke_session(body)
|
1243
1679
|
rescue OryHydraClient::ApiError => e
|
1244
|
-
puts "
|
1680
|
+
puts "Error when calling PublicApi->revoke_session: #{e}"
|
1245
1681
|
end
|
1246
1682
|
```
|
1247
1683
|
|
1248
|
-
|
1684
|
+
#### Using the revoke_session_with_http_info variant
|
1685
|
+
|
1686
|
+
This returns an Array which contains the response data (`nil` in this case), status code and headers.
|
1687
|
+
|
1688
|
+
> <Array(nil, Integer, Hash)> revoke_session_with_http_info(body)
|
1689
|
+
|
1690
|
+
```ruby
|
1691
|
+
begin
|
1692
|
+
# Revoke and Invalidate a Session
|
1693
|
+
data, status_code, headers = api_instance.revoke_session_with_http_info(body)
|
1694
|
+
p status_code # => 2xx
|
1695
|
+
p headers # => { ... }
|
1696
|
+
p data # => nil
|
1697
|
+
rescue OryHydraClient::ApiError => e
|
1698
|
+
puts "Error when calling PublicApi->revoke_session_with_http_info: #{e}"
|
1699
|
+
end
|
1700
|
+
```
|
1249
1701
|
|
1702
|
+
### Parameters
|
1250
1703
|
|
1251
|
-
Name | Type | Description
|
1252
|
-
|
1253
|
-
**body** | [**RevokeSession**](RevokeSession.md)| |
|
1704
|
+
| Name | Type | Description | Notes |
|
1705
|
+
| ---- | ---- | ----------- | ----- |
|
1706
|
+
| **body** | [**RevokeSession**](RevokeSession.md) | | |
|
1254
1707
|
|
1255
1708
|
### Return type
|
1256
1709
|
|
@@ -1268,23 +1721,23 @@ No authorization required
|
|
1268
1721
|
|
1269
1722
|
## whoami
|
1270
1723
|
|
1271
|
-
> Session whoami(opts)
|
1724
|
+
> <Session> whoami(opts)
|
1272
1725
|
|
1273
1726
|
Check Who the Current HTTP Session Belongs To
|
1274
1727
|
|
1275
1728
|
Uses the HTTP Headers in the GET request to determine (e.g. by using checking the cookies) who is authenticated. Returns a session object in the body or 401 if the credentials are invalid or no credentials were sent. Additionally when the request it successful it adds the user ID to the 'X-Kratos-Authenticated-Identity-Id' header in the response. This endpoint is useful for reverse proxies and API Gateways.
|
1276
1729
|
|
1277
|
-
###
|
1730
|
+
### Examples
|
1278
1731
|
|
1279
1732
|
```ruby
|
1280
|
-
|
1733
|
+
require 'time'
|
1281
1734
|
require 'ory-kratos-client'
|
1282
1735
|
# setup authorization
|
1283
1736
|
OryHydraClient.configure do |config|
|
1284
1737
|
# Configure API key authorization: sessionToken
|
1285
1738
|
config.api_key['X-Session-Token'] = 'YOUR API KEY'
|
1286
1739
|
# Uncomment the following line to set a prefix for the API key, e.g. 'Bearer' (defaults to nil)
|
1287
|
-
#config.api_key_prefix['X-Session-Token'] = 'Bearer'
|
1740
|
+
# config.api_key_prefix['X-Session-Token'] = 'Bearer'
|
1288
1741
|
end
|
1289
1742
|
|
1290
1743
|
api_instance = OryHydraClient::PublicApi.new
|
@@ -1294,21 +1747,38 @@ opts = {
|
|
1294
1747
|
}
|
1295
1748
|
|
1296
1749
|
begin
|
1297
|
-
#Check Who the Current HTTP Session Belongs To
|
1750
|
+
# Check Who the Current HTTP Session Belongs To
|
1298
1751
|
result = api_instance.whoami(opts)
|
1299
1752
|
p result
|
1300
1753
|
rescue OryHydraClient::ApiError => e
|
1301
|
-
puts "
|
1754
|
+
puts "Error when calling PublicApi->whoami: #{e}"
|
1302
1755
|
end
|
1303
1756
|
```
|
1304
1757
|
|
1305
|
-
|
1758
|
+
#### Using the whoami_with_http_info variant
|
1759
|
+
|
1760
|
+
This returns an Array which contains the response data, status code and headers.
|
1306
1761
|
|
1762
|
+
> <Array(<Session>, Integer, Hash)> whoami_with_http_info(opts)
|
1763
|
+
|
1764
|
+
```ruby
|
1765
|
+
begin
|
1766
|
+
# Check Who the Current HTTP Session Belongs To
|
1767
|
+
data, status_code, headers = api_instance.whoami_with_http_info(opts)
|
1768
|
+
p status_code # => 2xx
|
1769
|
+
p headers # => { ... }
|
1770
|
+
p data # => <Session>
|
1771
|
+
rescue OryHydraClient::ApiError => e
|
1772
|
+
puts "Error when calling PublicApi->whoami_with_http_info: #{e}"
|
1773
|
+
end
|
1774
|
+
```
|
1775
|
+
|
1776
|
+
### Parameters
|
1307
1777
|
|
1308
|
-
Name | Type | Description
|
1309
|
-
|
1310
|
-
**cookie** | **String
|
1311
|
-
**authorization** | **String
|
1778
|
+
| Name | Type | Description | Notes |
|
1779
|
+
| ---- | ---- | ----------- | ----- |
|
1780
|
+
| **cookie** | **String** | | [optional] |
|
1781
|
+
| **authorization** | **String** | in: authorization | [optional] |
|
1312
1782
|
|
1313
1783
|
### Return type
|
1314
1784
|
|