IRPCLoginsAdmin.CreatePasswordResetRequestAdmin
Administration API / specialized admin session
Creates a password reset link for an M-Files login, returns it, and optionally e-mails it to the user.
| Service | Server login accounts MFiles.IRPCLoginsAdmin |
|---|---|
| gRPC method | /MFiles.IRPCLoginsAdmin/CreatePasswordResetRequestAdmin |
| HTTP (mf-http-grpc) | POST /grpc/v1/create-password-reset-request-admin |
| Request | CreatePasswordResetRequestAdminRequest |
| Response | CreatePasswordResetRequestAdminResponse |
| Book and level | Administration API, specialized |
| Kind | admin |
| Session | Required: the session ID from LogIn in the mfiles-session-id-bin metadata. |
| Idempotent | no |
| Returns metadata structure version | no |
| Streaming | none (unary) |
Remarks
- Requires the system administrator server role (server right
manage_logins). - The same rules as in CreatePasswordResetRequest apply.
Request: CreatePasswordResetRequestAdminRequest
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 name of the login account whose password should be reset. |
account_email_address | string | The e-mail address of the login account whose password should be reset. |
site_url | string | The site URL used in forming the password reset URL. |
send_email | bool | True to also e-mail the link to the user. |
vault_guid | string | The vault to try login account reset request in. |
Response: CreatePasswordResetRequestAdminResponse
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 |
|---|---|---|
password_reset_url | string | The reset link. |
Related methods
- CreatePasswordResetRequest -- Starts the "forgot password" flow for an M-Files login: sends the user an e-mail with a password reset link.