Axuz Developers

POST /auth/password/reset/start

Rate limit por IP (conta só link inválido); valida o link; lê os métodos ativos e a liberação viva; consome o link e abre o desafio (15 m...

  • Access: Public
  • Service: https://auth-api.axuz.net

Accepted authentication

No authentication (public route, or protected by link/signature).

Rate limit por IP (conta só link inválido); valida o link; lê os métodos ativos e a liberação viva; consome o link e abre o desafio (15 min, 5 tentativas, uso único). Modo: grant com liberação ativa, link sem nenhum método além do e-mail primário, factor no resto.

passwordResetStart troca o link do e-mail por um desafio de redefinição.

Retorno: 200 {reset_challenge_id, mode: factor|grant|link, methods, expires_in, attempts_remaining, support_url? (só no factor)}; 400 invalid_body; 401 link_invalid; 429; 500.

Parameters

No parameters.

Request body

Corpo JSON. O schema detalhado deste endpoint ainda não está tipado na spec; veja a descrição da operação.

application/json

NameTypeRequiredDescription
(corpo)objectno
{}

Responses

200

{reset_challenge_id, mode: factor|grant|link, methods, expires_in, attempts_remaining, support_url? (só no factor)}

400

Invalid_body

NameTypeRequiredDescription
errorstringyes

401

Sem credencial valida

NameTypeRequiredDescription
errorstringyes

429

Limite de requisições excedido.

NameTypeRequiredDescription
errorstringyes

500

Ver descrição

NameTypeRequiredDescription
errorstringyes

Examples

"Try it" is turned off in this reference. Use the examples with your test credential.

curl

curl -sS -X POST 'https://auth-api.axuz.net/auth/password/reset/start' \
  -H "Content-Type: application/json" \
  -d '{}'

Node.js

const res = await fetch("https://auth-api.axuz.net/auth/password/reset/start", {
  method: 'POST',
  headers: {
    'Content-Type': 'application/json',
  },
  body: JSON.stringify({}),
});
if (!res.ok) throw new Error(`HTTP ${res.status}: ${await res.text()}`);
console.log(await res.json());

Python

import os
import requests

res = requests.request(
    "POST",
    "https://auth-api.axuz.net/auth/password/reset/start",
    json={},
    timeout=30,
)
res.raise_for_status()
print(res.json())