Sign in

v1

latestOpenAPI 3.0.3Apache 2.02026-07-173769114.2 KB
public
admin

Get information about a recovery flow

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.

get/self-service/recovery/flows

Query parameters

idstring required

The Flow ID

The value for this parameter comes from request URL Query parameter sent to your application (e.g. /recovery?flow=abcde).

Response

recoveryFlow

activestring

Active, if set, contains the registration method that is being used. It is initially not set.

expires_atstring date-time required

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.

idstring uuid4 required
issued_atstring date-time required

IssuedAt is the time (UTC) when the request occurred.

methodsobject required

Methods contains context for all account recovery methods. If a registration request has been processed, but for example the password is incorrect, this will contain error messages.

request_urlstring required

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.

statestring required
typestring

The flow type can either be api or browser.