Axuz Developers

POST /auth/password/reset/method/begin

Desafio válido (não gasta tentativa); o método tem de estar ATIVO na conta; delega ao Begin do método.

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

Accepted authentication

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

Desafio válido (não gasta tentativa); o método tem de estar ATIVO na conta; delega ao Begin do método.

passwordResetMethodBegin executa o passo prévio de um método (passkey).

Retorno: 200 {method, ...corpo do método} (passkey: publicKey); 400 invalid_body | invalid_challenge_id | method_unavailable | method_has_no_begin; 401 reset_challenge_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

{method, ...corpo do método} (passkey: publicKey)

400

Invalid_body | invalid_challenge_id | method_unavailable | method_has_no_begin

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/method/begin' \
  -H "Content-Type: application/json" \
  -d '{}'

Node.js

const res = await fetch("https://auth-api.axuz.net/auth/password/reset/method/begin", {
  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/method/begin",
    json={},
    timeout=30,
)
res.raise_for_status()
print(res.json())