try out ↗

← API Index


/api/client/password2

Request a new password mail for an existing user. Looks up the account by email (and optional /cid suffix) or by numeric id, generates a password if none is set, and sends it to the user's mail address.

Change Note: add blocked indication

Parameters

Name Description Type
email email address of the user (may include /cid suffix to disambiguate) string
id numeric customer id (alternative to email) int
verbose 1 = return real exit code, 0 = collapse no_user/multiple/no_tour to 'sent' to prevent user enumeration (default 0 , may be enforced by system settings) int
oo-rf optionally define the response-format for this call. One of: compact (default) | compacts | full | fulls | json | md | html | js | openapi | yaml String
oo-auth optionally force the API to check against the role (instead of silently not returning data). For guests or public access, the default is -1. 0 (regular customer) and above define the role for which the current session is expected to be authorized. int

Response Types

Type Version Description
SendPasswordResult 1 Result of a password reminder request. When verbose=0 (default) the only success result is 'sent', regardless of whether the user actually exists; this prevents user enumeration. The 'blocked' and 'slower' results are always returned as-is.

OpenAPI

See password2.yaml

Referenced in skills