users.createRecovery
import { Client, Orvano } from '@orvano/js/server'
const orvano = new Orvano( new Client({ endpoint: 'https://orvano.example.com', apiKey: process.env.ORVANO_API_KEY }),)
await orvano.users.createRecovery('<userId>', { redirectUrl: 'https://app.example.com/auth/callback',})import 'dart:io';
import 'package:orvano_dart/orvano_dart.dart';
Future<void> main() async { final orvano = Orvano( Client( endpoint: 'https://orvano.example.com', apiKey: Platform.environment['ORVANO_API_KEY'], ), ); await orvano.users.createRecovery( '<userId>', CreateUserRecoveryRequest( redirectUrl: 'https://app.example.com/auth/callback', ), );}using Orvano;
using var orvano = new OrvanoClient(new OrvanoClientOptions(new Uri("https://orvano.example.com")){ ApiKey = Environment.GetEnvironmentVariable("ORVANO_API_KEY"),});await orvano.Users.CreateRecoveryAsync("<userId>", new CreateUserRecoveryRequest( RedirectUrl: "https://app.example.com/auth/callback"));Emails a user a password reset link.
Server SDKs: JavaScript on a server, Dart, and .NET call it with an API key. API key scope: users.write. A failure answers with a problem details body; its code has a page under Errors.
Authorizations
Section titled “Authorizations”Parameters
Section titled “Parameters”Path Parameters
Section titled “Path Parameters”The user ID.
Request Bodyrequired
Section titled “Request Bodyrequired”A request to email a user a password reset link.
object
The page that receives the link, on a host that is one of the project’s web platforms (http only on localhost
or 127.0.0.1). The link adds orvano_type=recovery and orvano_token to it.
Responses
Section titled “Responses”The request has been accepted for processing, but processing has not yet completed.
default
Section titled “default”An unexpected error response.
An RFC 9457 problem details body. Every operation declares it as its default response, sent
as application/problem+json.
object
Identifies the error: https://orvano.dev/errors/<code>.
The standard HTTP reason phrase for the status.
The HTTP status code.
A short, safe sentence about this occurrence, when the server has one.
Orvano’s stable error code, from the ErrorCode catalog. SDKs treat it as a plain string.
The request ID to quote when reporting a problem; also sent as X-Request-Id.
Example
{ "type": "https://orvano.dev/errors/not_found", "title": "Not Found", "status": 404, "code": "not_found", "requestId": "4bf92f3577b34da6a3ce929d0e0e4736"}