Set a new password with an emailed reset token.

POST

/v1/auth/password/reset/confirm

curl --request POST \
  --url https://api.opdns.io/v1/auth/password/reset/confirm \
  --header 'Content-Type: application/json' \
  --data '{ "token": "example", "password": "example", "totp_code": "example", "recovery_code": "example" }'

An account with a second factor (TOTP or a passkey) must also send totp_code or recovery_code: email alone never unlocks it (second_factor_required, invalid_second_factor). On success every session is revoked, the cookie is cleared and a “password changed” email is sent; sign in again. Token failures are 400 invalid_token, token_expired or token_used.

Request Body^required

Media typeapplication/json

object

token

required

string

password

required

12 to 128 characters (Unicode code points), no composition rules.

string

>= 12 characters <= 128 characters

totp_code

string

recovery_code

string

Example^generated

{
  "token": "example",
  "password": "example",
  "totp_code": "example",
  "recovery_code": "example"
}

Responses

200

Password set.

Media typeapplication/json

object

status

required

string

Allowed value: password_reset

Example

{
  "status": "password_reset"
}

400

Malformed request.

Media typeapplication/problem+json

object

type

required

string format: uri

title

required

string

status

required

integer

code

required

Stable machine code.

string

Allowed values: bad_request body_too_large bad_if_match unauthenticated invalid_credentials signup_closed invite_required waitlist_unavailable invalid_token token_expired token_used session_required insufficient_scope csrf_rejected not_found version_mismatch ip_conflict unknown_list too_many_rules validation_failed rate_limited internal node_revoked node_offline node_busy node_timeout node_error result_too_large shape_unsupported node_token_superseded relay_unavailable not_implemented query_timeout query_too_expensive range_too_large too_many_queries second_factor_required invalid_second_factor mfa_enrolment_required mfa_required reauth_required no_second_factor totp_already_enabled totp_not_enabled last_credential passkey_exists passkey_invalid passkeys_unavailable ceremony_invalid account_pending_deletion credential_required deletion_pending no_deletion_pending deletion_started organisation_has_members export_in_progress export_not_ready block_exists invalid_recovery_code profile_not_empty invalid_cursor bad_idempotency_key idempotency_key_reused idempotency_in_progress too_many_streams too_many_reports password_too_short password_too_long profile_suspended

detail

string

errors

Array<object>

object

field

required

string

message

required

string

request_id

string

retry_after

Seconds, repeating the Retry-After header (rate limits, offline nodes).

integer

Example

{
  "type": "https://opdns.io/problems/bad_request",
  "title": "Bad Request",
  "status": 400,
  "code": "bad_request",
  "detail": "invalid JSON body",
  "request_id": "5f2c9a0e7b1d4c38"
}

401

Not authenticated.

Media typeapplication/problem+json

object

type

required

string format: uri

title

required

string

status

required

integer

code

required

Stable machine code.

string

Allowed values: bad_request body_too_large bad_if_match unauthenticated invalid_credentials signup_closed invite_required waitlist_unavailable invalid_token token_expired token_used session_required insufficient_scope csrf_rejected not_found version_mismatch ip_conflict unknown_list too_many_rules validation_failed rate_limited internal node_revoked node_offline node_busy node_timeout node_error result_too_large shape_unsupported node_token_superseded relay_unavailable not_implemented query_timeout query_too_expensive range_too_large too_many_queries second_factor_required invalid_second_factor mfa_enrolment_required mfa_required reauth_required no_second_factor totp_already_enabled totp_not_enabled last_credential passkey_exists passkey_invalid passkeys_unavailable ceremony_invalid account_pending_deletion credential_required deletion_pending no_deletion_pending deletion_started organisation_has_members export_in_progress export_not_ready block_exists invalid_recovery_code profile_not_empty invalid_cursor bad_idempotency_key idempotency_key_reused idempotency_in_progress too_many_streams too_many_reports password_too_short password_too_long profile_suspended

detail

string

errors

Array<object>

object

field

required

string

message

required

string

request_id

string

retry_after

Seconds, repeating the Retry-After header (rate limits, offline nodes).

integer

Example

{
  "type": "https://opdns.io/problems/unauthenticated",
  "title": "Unauthorized",
  "status": 401,
  "code": "unauthenticated",
  "detail": "authentication required",
  "request_id": "5f2c9a0e7b1d4c38"
}

422

The request failed validation (validation_failed), or the new password was refused: password_too_short (under 12 characters), password_too_long (over 128). Length is counted in Unicode code points and the password is used as sent (no normalisation). A password problem alongside other invalid fields is validation_failed listing them all. errors names the password field.

Media typeapplication/problem+json

object

type

required

string format: uri

title

required

string

status

required

integer

code

required

Stable machine code.

string

Allowed values: bad_request body_too_large bad_if_match unauthenticated invalid_credentials signup_closed invite_required waitlist_unavailable invalid_token token_expired token_used session_required insufficient_scope csrf_rejected not_found version_mismatch ip_conflict unknown_list too_many_rules validation_failed rate_limited internal node_revoked node_offline node_busy node_timeout node_error result_too_large shape_unsupported node_token_superseded relay_unavailable not_implemented query_timeout query_too_expensive range_too_large too_many_queries second_factor_required invalid_second_factor mfa_enrolment_required mfa_required reauth_required no_second_factor totp_already_enabled totp_not_enabled last_credential passkey_exists passkey_invalid passkeys_unavailable ceremony_invalid account_pending_deletion credential_required deletion_pending no_deletion_pending deletion_started organisation_has_members export_in_progress export_not_ready block_exists invalid_recovery_code profile_not_empty invalid_cursor bad_idempotency_key idempotency_key_reused idempotency_in_progress too_many_streams too_many_reports password_too_short password_too_long profile_suspended

detail

string

errors

Array<object>

object

field

required

string

message

required

string

request_id

string

retry_after

Seconds, repeating the Retry-After header (rate limits, offline nodes).

integer

Example

{
  "type": "https://opdns.io/problems/password_too_short",
  "title": "Unprocessable Content",
  "status": 422,
  "code": "password_too_short",
  "detail": "the password must be at least 12 characters",
  "errors": [
    {
      "field": "password",
      "message": "at least 12 characters"
    }
  ],
  "request_id": "5f2c9a0e7b1d4c38"
}

429

Rate limited (rate_limited).

Media typeapplication/problem+json

object

type

required

string format: uri

title

required

string

status

required

integer

code

required

Stable machine code.

string

Allowed values: bad_request body_too_large bad_if_match unauthenticated invalid_credentials signup_closed invite_required waitlist_unavailable invalid_token token_expired token_used session_required insufficient_scope csrf_rejected not_found version_mismatch ip_conflict unknown_list too_many_rules validation_failed rate_limited internal node_revoked node_offline node_busy node_timeout node_error result_too_large shape_unsupported node_token_superseded relay_unavailable not_implemented query_timeout query_too_expensive range_too_large too_many_queries second_factor_required invalid_second_factor mfa_enrolment_required mfa_required reauth_required no_second_factor totp_already_enabled totp_not_enabled last_credential passkey_exists passkey_invalid passkeys_unavailable ceremony_invalid account_pending_deletion credential_required deletion_pending no_deletion_pending deletion_started organisation_has_members export_in_progress export_not_ready block_exists invalid_recovery_code profile_not_empty invalid_cursor bad_idempotency_key idempotency_key_reused idempotency_in_progress too_many_streams too_many_reports password_too_short password_too_long profile_suspended

detail

string

errors

Array<object>

object

field

required

string

message

required

string

request_id

string

retry_after

Seconds, repeating the Retry-After header (rate limits, offline nodes).

integer

Example

{
  "type": "https://opdns.io/problems/rate_limited",
  "title": "Too Many Requests",
  "status": 429,
  "code": "rate_limited",
  "detail": "too many requests",
  "request_id": "5f2c9a0e7b1d4c38",
  "retry_after": 6
}

Headers

Retry-After

integer