Skip to content

Latest commit

 

History

History
21 lines (17 loc) · 2.09 KB

ClientRecoveryFlow.md

File metadata and controls

21 lines (17 loc) · 2.09 KB

Ory.Client.Model.ClientRecoveryFlow

This request is used when an identity wants to recover their account. We recommend reading the Account Recovery Documentation

Properties

Name Type Description Notes
Active string Active, if set, contains the recovery method that is being used. It is initially not set. [optional]
ContinueWith List<ClientContinueWith> Contains possible actions that could follow this flow [optional]
ExpiresAt DateTime ExpiresAt is the time (UTC) when the request expires. If the user still wishes to update the setting, a new request has to be initiated.
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>
IssuedAt DateTime IssuedAt is the time (UTC) when the request occurred.
RequestUrl 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.
ReturnTo 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.
TransientPayload Object TransientPayload is used to pass data from the recovery flow to hooks and email templates [optional]
Type string The flow type can either be `api` or `browser`.
Ui ClientUiContainer

[Back to Model list] [Back to API list] [Back to README]