# IRPCVaultLoginsAdmin.CreateVaultLoginPasswordResetRequest

Location: [gRPC API](https://developer.m-files.com/APIs/gRPC-API/index.md) > [Administration API](https://developer.m-files.com/APIs/gRPC-API/admin/index.md) > [Vault login accounts](https://developer.m-files.com/APIs/gRPC-API/Reference/MFiles.IRPCVaultLoginsAdmin/index.md)

HTML version: https://developer.m-files.com/APIs/gRPC-API/Reference/MFiles.IRPCVaultLoginsAdmin/CreateVaultLoginPasswordResetRequest/

Badges: `Administration API / specialized` `admin` `session`

Creates a password reset link for an M-Files login of the vault, and optionally emails it to the
login's email address.

- **Service:** [Vault login accounts](https://developer.m-files.com/APIs/gRPC-API/Reference/MFiles.IRPCVaultLoginsAdmin/index.md) `MFiles.IRPCVaultLoginsAdmin`
- **gRPC method:** `/MFiles.IRPCVaultLoginsAdmin/CreateVaultLoginPasswordResetRequest`
- **HTTP (mf-http-grpc):** `POST /grpc/v1/create-vault-login-password-reset-request`
- **Request:** [`CreateVaultLoginPasswordResetRequestRequest`](https://developer.m-files.com/APIs/gRPC-API/Reference/MFiles.IRPCVaultLoginsAdmin/CreateVaultLoginPasswordResetRequest/index.md#request)
- **Response:** [`CreateVaultLoginPasswordResetRequestResponse`](https://developer.m-files.com/APIs/gRPC-API/Reference/MFiles.IRPCVaultLoginsAdmin/CreateVaultLoginPasswordResetRequest/index.md#response)
- **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)

<a id="remarks"></a>

## Remarks

- Requires a vault session; no vault rights are needed to request a reset. Only callers with the
  vault right `manage_users` get the link in `password_reset_url`; for others it is empty and the
  link reaches the user only by email.
- The login is found by `account_name`, or by `account_email_address` when the name is empty
  (the address must match exactly one login). It must be an M-Files login with an email
  address and without the system administrator role; otherwise the request fails.
- `site_url` is required. Repeated requests for the same login in a short time fail. The link
  expires after 7 days by default. The server can be configured to disable password resets.
- Complete the reset with
  [ResetVaultLoginPassword](https://developer.m-files.com/APIs/gRPC-API/Reference/MFiles.IRPCVaultLoginsAdmin/ResetVaultLoginPassword/index.md).

<a id="request"></a>

## Request: CreateVaultLoginPasswordResetRequestRequest

> 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 account name of the login, or empty to find it by email address. |
| `account_email_address` | `string` | The email address of the login; used when `account_name` is empty. |
| `site_url` | `string` | The web address the reset link is based on. |
| `send_email` | `bool` | True to email the link to the login's email address. |

<a id="response"></a>

## Response: CreateVaultLoginPasswordResetRequestResponse

> 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; empty unless the caller has the vault right `manage_users`. |

<a id="related"></a>

## Related methods

- [ResetVaultLoginPassword](https://developer.m-files.com/APIs/gRPC-API/Reference/MFiles.IRPCVaultLoginsAdmin/ResetVaultLoginPassword/index.md): Sets a new password for a vault login, authorized by a password reset link.