Sign in

Request Password Reset

POST https://{organization}.myguper.com/api/connect/password-reset/request

Initiates a password-reset flow for a user in the organization.

The caller authenticates via RSA signature (OriginValidation middleware), not a user token — because the user requesting a reset is not logged in. The user-agent header identifies the calling system (e.g. admin, storemanager) and is cryptographically verified against its public key in etc/keys/{user-agent}.pem.

The verified user-agent is stored as the request's origin. Only the same origin can later confirm the reset — this is the origin lock, which prevents a token issued by one system from being redeemed by another.

Anti-enumeration: When the login does not exist, the endpoint returns { "requested": true } without token or personId. The caller cannot distinguish this from a successful request and should always show a generic "check your email" message to the end user.

Cooldown: A 5-minute cooldown is enforced per (organization, login). A second request within the window returns HTTP 429.

The caller is responsible for delivering the token to the user (e-mail, WhatsApp, etc.) — Connect generates and validates the token but does not send any notification.

Try-it values populated from environment ACME (Demo)


Authentication

Signature

RSA signature via OriginValidation middleware. Send the user-agent header with the calling system's name (e.g. admin) and the signature header with the RSA-signed nonce. No x-guper-authorization token is required — the user is not authenticated.

Headers

Name Type Description
x-guper-authorization * string User token issued by Guper.
Content-Type * string Always `application/json` for endpoints that accept a JSON body.

Request body

Content-Type: application/json

{
    "login": "maria.silva@company.com"
}

Responses

{
    "requested": true,
    "token":     "a1b2c3d4e5f6...64 hex characters",
    "personId":  4399137,
    "login":     "maria.silva@company.com"
}

Related

Copied to clipboard