IRPCLoginsAdmin.CreatePasswordResetRequest

Administration API / specialized admin no session

Starts the "forgot password" flow for an M-Files login: sends the user an e-mail with a password reset link.

Service	Server login accounts `MFiles.IRPCLoginsAdmin`
gRPC method	`/MFiles.IRPCLoginsAdmin/CreatePasswordResetRequest`
HTTP (mf-http-grpc)	`POST /grpc/v1/create-password-reset-request`
Request	`CreatePasswordResetRequestRequest`
Response	`CreatePasswordResetRequestResponse`
Book and level	Administration API, specialized
Kind	admin
Session	Not needed: the call can be made before logging in.
Idempotent	no
Returns metadata structure version	no
Streaming	none (unary)

Remarks

Needs no session. The reset URL is not returned to the caller; it is only e-mailed. System administrators can get the URL with CreatePasswordResetRequestAdmin.
site_url must match the M-Files Web address configured for a vault on the server (with https if that address uses https); otherwise the call fails with "The parameter is incorrect.".
Fails when password reset is disabled on the server, the login is not found, is a Windows login, has no e-mail address, has the system administrator role, or a request was sent for it very recently.
On servers with vault login accounts, the vault given by vault_guid (or found from the host of site_url) is tried first.
The link is valid for 7 days by default. Complete the reset with ResetPassword.

Nested message fields are expanded to depth 3; follow a type link for deeper levels and for the type's own page.

Field	Type	Description
`account_name`	`string`	The login's account name. Leave empty to identify the login by `account_email_address`.
`account_email_address`	`string`	Used only when `account_name` is empty; exactly one login must have this address.
`site_url`	`string`	The M-Files Web page that handles the reset. The link is this URL with `username`, `hash` and `expiration` query parameters added.
`send_email`	`bool`	True if an e-mail containing the password reset URL should be sent to the user.
`vault_guid`	`string`	Optional vault for servers that use vault login accounts.

No fields.

CreatePasswordResetRequestAdmin -- Creates a password reset link for an M-Files login, returns it, and optionally e-mails it to the user.
ResetPassword -- Completes the "forgot password" flow: sets a new password for a login with the values from the password reset link.