Contents

# OryKratosClient::RecoveryFlow

## Properties

| Name | Type | Description | Notes |
| ---- | ---- | ----------- | ----- |
| **active** | **String** | Active, if set, contains the recovery method that is being used. It is initially not set. | [optional] |
| **continue_with** | [**Array<ContinueWith>**](ContinueWith.md) | Contains possible actions that could follow this flow | [optional] |
| **expires_at** | **Time** | ExpiresAt is the time (UTC) when the request expires. If the user still wishes to update the setting, a new request has to be initiated. |  |
| **id** | **String** | ID represents the request's unique ID. When performing the recovery flow, this represents the id in the recovery ui's query parameter: http://<selfservice.flows.recovery.ui_url>?request=<id> |  |
| **issued_at** | **Time** | IssuedAt is the time (UTC) when the request occurred. |  |
| **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. |  |
| **return_to** | **String** | ReturnTo contains the requested return_to URL. | [optional] |
| **state** | **Object** | State represents the state of this request:  choose_method: ask the user to choose a method (e.g. recover account via email) sent_email: the email has been sent to the user passed_challenge: the request was successful and the recovery challenge was passed. |  |
| **type** | **String** | The flow type can either be `api` or `browser`. |  |
| **ui** | [**UiContainer**](UiContainer.md) |  |  |

## Example

```ruby
require 'ory-kratos-client'

instance = OryKratosClient::RecoveryFlow.new(
  active: null,
  continue_with: null,
  expires_at: null,
  id: null,
  issued_at: null,
  request_url: null,
  return_to: null,
  state: null,
  type: null,
  ui: null
)
```

Version data entries

1 entries across 1 versions & 1 rubygems

Version	Path
ory-kratos-client-1.1.0	docs/RecoveryFlow.md