v1

latestOpenAPI 3.0.3Apache 2.02026-07-173769114.2 KB

public

Initialize Recovery Flow for API Clients

This endpoint initiates a recovery flow for API clients such as mobile devices, smart TVs, and so on.

If a valid provided session cookie or session token is provided, a 400 Bad Request error.

To fetch an existing recovery flow call /self-service/recovery/flows?flow=<flow_id>.

:::warning

You MUST NOT use this endpoint in client-side (Single Page Apps, ReactJS, AngularJS) nor server-side (Java Server Pages, NodeJS, PHP, Golang, ...) browser applications. Using this endpoint in these applications will make you vulnerable to a variety of CSRF attacks.

This endpoint MUST ONLY be used in scenarios such as native mobile apps (React Native, Objective C, Swift, Java, ...).

:::

More information can be found at Ory Kratos Account Recovery Documentation.

get/self-service/recovery/api

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.