Sha256: 1e31662a27f91f853feb872594c175650d133828a3dd715c9c31003913676b31

Contents?: true

Size: 1.49 KB

Versions: 4

Compression:

Stored size: 1.49 KB

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] |
| **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** | [**RecoveryFlowState**](RecoveryFlowState.md) |  |  |
| **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,
  expires_at: null,
  id: null,
  issued_at: null,
  request_url: null,
  return_to: null,
  state: null,
  type: null,
  ui: null
)
```

Version data entries

4 entries across 4 versions & 1 rubygems

Version Path
ory-kratos-client-1.0.0 docs/RecoveryFlow.md
ory-kratos-client-0.13.1 docs/RecoveryFlow.md
ory-kratos-client-0.11.1 docs/RecoveryFlow.md
ory-kratos-client-0.11.0 docs/RecoveryFlow.md