Sha256: 377d8994d0d4b73eae9d96a8166011ef17d4c1cbe324e01d53fef33ade206d37
Contents?: true
Size: 1.68 KB
Versions: 20
Compression:
Stored size: 1.68 KB
Contents
# OryClient::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** | **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-client' instance = OryClient::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
20 entries across 20 versions & 1 rubygems