Create Recovery Flow for Browsers

GET 
https://accounts.<domain>/auth/self-service/recovery/browser

This endpoint initializes a browser-based account recovery flow. Once initialized, the browser will be redirected to selfservice.flows.recovery.ui_url with the flow ID set as the query parameter ?flow=. If a valid user session exists, the browser is returned to the configured return URL.

If this endpoint is called via an AJAX request, the response contains the recovery flow without any redirects or a 400 bad request error if the user is already authenticated.

This endpoint is NOT INTENDED for clients that do not have a browser (Chrome, Firefox, ...) as cookies are needed.

Request

Query Parameters

return_to string

The URL to return the browser to after the flow was completed.

Responses

200

recoveryFlow

application/json

Schema

Schema

activestring

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

continue_with object[]
Contains possible actions that could follow this flow
Array [
oneOf
continueWithVerificationUi
actionstringrequired
Action will always be show_verification_ui show_verification_ui ContinueWithActionShowVerificationUIString
Possible values: [show_verification_ui]
flow objectrequired
idstring<uuid>required
The ID of the verification flow
urlstring
The URL of the verification flow
verifiable_addressstringrequired
The address that should be verified in this flow
continueWithSetOrySessionToken
actionstringrequired
Possible values: [set_ory_session_token]
ory_session_tokenstringrequired
Token is the token of the session
continueWithSettingsUi
actionstringrequired
Action will always be show_settings_ui show_settings_ui ContinueWithActionShowSettingsUIString
Possible values: [show_settings_ui]
flow objectrequired
idstring<uuid>required
The ID of the settings flow
continueWithRecoveryUi
actionstringrequired
Action will always be show_recovery_ui show_recovery_ui ContinueWithActionShowRecoveryUIString
Possible values: [show_recovery_ui]
flow objectrequired
idstring<uuid>required
The ID of the recovery flow
urlstring
The URL of the recovery flow
]
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<uuid>required

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=

issued_atstring<date-time>required

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

request_urlstringrequired

RequestURL is the initial URL that was requested. It can be used to forward information contained in the URL's path or query for example.

return_tostring

ReturnTo contains the requested return_to URL.

staterequired

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.

typeType is the flow type. (string)required

The flow type can either be api or browser.

ui objectrequired
Container represents a HTML Form. The container can work with both HTTP Form and JSON requests
actionstringrequired
Action should be used as the form action URL <form action="{{ .Action }}" method="post">.
messages object[]
Array [
contextobject
The message's context. Useful when customizing messages.
idinteger<int64>required
textstringrequired
The message text. Written in american english.
typestringrequired
The message type. info Info error Error success Success
Possible values: [info, error, success]
]
methodstringrequired
Method is the form method (e.g. POST)
nodes object[]required
Array [
attributes objectrequired
node_typerequired
Possible values: [a, img, input, script, text]
a
hrefstringrequired
The link's href (destination) URL.
format: uri
idstringrequired
A unique identifier
title objectrequired
contextobject
The message's context. Useful when customizing messages.
idinteger<int64>required
textstringrequired
The message text. Written in american english.
typestringrequired
The message type. info Info error Error success Success
Possible values: [info, error, success]
img
heightinteger<int64>required
Height of the image
idstringrequired
A unique identifier
srcstringrequired
The image's source URL.
format: uri
widthinteger<int64>required
Width of the image
input
autocompletestring
The autocomplete attribute for the input. email InputAttributeAutocompleteEmail tel InputAttributeAutocompleteTel url InputAttributeAutocompleteUrl current-password InputAttributeAutocompleteCurrentPassword new-password InputAttributeAutocompleteNewPassword one-time-code InputAttributeAutocompleteOneTimeCode
Possible values: [email, tel, url, current-password, new-password, one-time-code]
disabledbooleanrequired
Sets the input's disabled field to true or false.
label object
contextobject
The message's context. Useful when customizing messages.
idinteger<int64>required
textstringrequired
The message text. Written in american english.
typestringrequired
The message type. info Info error Error success Success
Possible values: [info, error, success]
namestringrequired
The input's element name.
onclickstring
OnClick may contain javascript which should be executed on click. This is primarily used for WebAuthn.
patternstring
The input's pattern.
requiredboolean
Mark this input field as required.
typestringrequired
The input's element type. text InputAttributeTypeText password InputAttributeTypePassword number InputAttributeTypeNumber checkbox InputAttributeTypeCheckbox hidden InputAttributeTypeHidden email InputAttributeTypeEmail tel InputAttributeTypeTel submit InputAttributeTypeSubmit button InputAttributeTypeButton datetime-local InputAttributeTypeDateTimeLocal date InputAttributeTypeDate url InputAttributeTypeURI
Possible values: [text, password, number, checkbox, hidden, email, tel, submit, button, datetime-local, date, url]
valuenullable
The input's value.
script
asyncbooleanrequired
The script async type
crossoriginstringrequired
The script cross origin policy
idstringrequired
A unique identifier
integritystringrequired
The script's integrity hash
noncestringrequired
Nonce for CSP
A nonce you may want to use to improve your Content Security Policy. You do not have to use this value but if you want to improve your CSP policies you may use it. You can also choose to use your own nonce value!
referrerpolicystringrequired
The script referrer policy
srcstringrequired
The script source
typestringrequired
The script MIME type
text
idstringrequired
A unique identifier
text objectrequired
contextobject
The message's context. Useful when customizing messages.
idinteger<int64>required
textstringrequired
The message text. Written in american english.
typestringrequired
The message type. info Info error Error success Success
Possible values: [info, error, success]
groupstringrequired
Group specifies which group (e.g. password authenticator) this node belongs to. default DefaultGroup password PasswordGroup oidc OpenIDConnectGroup profile ProfileGroup link LinkGroup code CodeGroup totp TOTPGroup lookup_secret LookupGroup webauthn WebAuthnGroup
Possible values: [default, password, oidc, profile, link, code, totp, lookup_secret, webauthn]
messages object[]required
Array [
contextobject
The message's context. Useful when customizing messages.
idinteger<int64>required
textstringrequired
The message text. Written in american english.
typestringrequired
The message type. info Info error Error success Success
Possible values: [info, error, success]
]
meta objectrequired
This might include a label and other information that can optionally be used to render UIs.
label object
contextobject
The message's context. Useful when customizing messages.
idinteger<int64>required
textstringrequired
The message text. Written in american english.
typestringrequired
The message type. info Info error Error success Success
Possible values: [info, error, success]
typestringrequired
The node's type text Text input Input img Image a Anchor script Script
Possible values: [text, input, img, a, script]
]

Example (auto)

{
  "active": "string",
  "continue_with": [
    {
      "action": "show_verification_ui",
      "flow": {
        "id": "3fa85f64-5717-4562-b3fc-2c963f66afa6",
        "url": "string",
        "verifiable_address": "string"
      }
    },
    {
      "action": "set_ory_session_token",
      "ory_session_token": "string"
    },
    {
      "action": "show_settings_ui",
      "flow": {
        "id": "3fa85f64-5717-4562-b3fc-2c963f66afa6"
      }
    },
    {
      "action": "show_recovery_ui",
      "flow": {
        "id": "3fa85f64-5717-4562-b3fc-2c963f66afa6",
        "url": "string"
      }
    }
  ],
  "expires_at": "2024-07-29T15:51:28.071Z",
  "id": "3fa85f64-5717-4562-b3fc-2c963f66afa6",
  "issued_at": "2024-07-29T15:51:28.071Z",
  "request_url": "string",
  "return_to": "string",
  "type": "string",
  "ui": {
    "action": "string",
    "messages": [
      {
        "context": {},
        "id": 0,
        "text": "string",
        "type": "info"
      }
    ],
    "method": "string",
    "nodes": [
      {
        "attributes": {
          "autocomplete": "email",
          "disabled": true,
          "label": {
            "context": {},
            "id": 0,
            "text": "string",
            "type": "info"
          },
          "name": "string",
          "node_type": "string",
          "onclick": "string",
          "pattern": "string",
          "required": true,
          "type": "text"
        },
        "group": "default",
        "messages": [
          {
            "context": {},
            "id": 0,
            "text": "string",
            "type": "info"
          }
        ],
        "meta": {
          "label": {
            "context": {},
            "id": 0,
            "text": "string",
            "type": "info"
          }
        },
        "type": "text"
      }
    ]
  }
}

303

Empty responses are sent when, for example, resources are deleted. The HTTP status code for empty responses is typically 201.

400

errorGeneric

application/json

Schema

Schema

error objectrequired
codeinteger<int64>
The status code
Example: 404
debugstring
Debug information
This field is often not exposed to protect against leaking sensitive information.
Example: SQL field "foo" is not a bool.
detailsobject
Further error details
idstring
The error ID
Useful when trying to identify various errors in application logic.
messagestringrequired
Error message
The error's message.
Example: The resource could not be found
reasonstring
A human-readable reason for the error
Example: User with ID 1234 does not exist.
requeststring
The request ID
The request ID is often exposed internally in order to trace errors across service architectures. This is often a UUID.
Example: d7ef54b1-ec15-46e6-bccb-524b82c035e6
statusstring
The status description
Example: Not Found

Example (auto)

{
  "error": {
    "code": 404,
    "debug": "SQL field \"foo\" is not a bool.",
    "details": {},
    "id": "string",
    "message": "The resource could not be found",
    "reason": "User with ID 1234 does not exist.",
    "request": "d7ef54b1-ec15-46e6-bccb-524b82c035e6",
    "status": "Not Found"
  }
}

default

errorGeneric

application/json

Schema

Schema

error objectrequired
codeinteger<int64>
The status code
Example: 404
debugstring
Debug information
This field is often not exposed to protect against leaking sensitive information.
Example: SQL field "foo" is not a bool.
detailsobject
Further error details
idstring
The error ID
Useful when trying to identify various errors in application logic.
messagestringrequired
Error message
The error's message.
Example: The resource could not be found
reasonstring
A human-readable reason for the error
Example: User with ID 1234 does not exist.
requeststring
The request ID
The request ID is often exposed internally in order to trace errors across service architectures. This is often a UUID.
Example: d7ef54b1-ec15-46e6-bccb-524b82c035e6
statusstring
The status description
Example: Not Found

Example (auto)

{
  "error": {
    "code": 404,
    "debug": "SQL field \"foo\" is not a bool.",
    "details": {},
    "id": "string",
    "message": "The resource could not be found",
    "reason": "User with ID 1234 does not exist.",
    "request": "d7ef54b1-ec15-46e6-bccb-524b82c035e6",
    "status": "Not Found"
  }
}

• csharp
• curl
• dart
• go
• http
• java
• javascript
• kotlin
• c
• nodejs
• objective-c
• ocaml
• php
• powershell
• python
• r
• ruby
• rust
• shell
• swift

• HTTPCLIENT
• RESTSHARP

var client = new HttpClient();
var request = new HttpRequestMessage(HttpMethod.Get, "https://accounts.<domain>/auth/self-service/recovery/browser");
request.Headers.Add("Accept", "application/json");
var response = await client.SendAsync(request);
response.EnsureSuccessStatusCode();
Console.WriteLine(await response.Content.ReadAsStringAsync());

Request Collapse all

Base URL

https://accounts.<domain>

Parameters

return_to — query