IRPCLoginsAdmin.GetPasswordHash
Administration API / specialized admin session idempotent
Gets the encrypted password hash of an M-Files login, for copying the password to another server with SetPasswordHash.
| Service | Server login accounts MFiles.IRPCLoginsAdmin |
|---|---|
| gRPC method | /MFiles.IRPCLoginsAdmin/GetPasswordHash |
| HTTP (mf-http-grpc) | POST /grpc/v1/get-password-hash |
| Request | GetPasswordHashRequest |
| Response | GetPasswordHashResponse |
| Book and level | Administration API, specialized |
| Kind | admin |
| Session | Required: the session ID from LogIn in the mfiles-session-id-bin metadata. |
| Idempotent | yes |
| Returns metadata structure version | no |
| Streaming | none (unary) |
Remarks
- Requires the system administrator server role (server right
manage_logins). Denied for other callers. - The hash is encrypted with the public key the caller provides;
PASSWORD_ENCRYPTION_UNENCRYPTEDfails with "The parameter is incorrect.".
Request: GetPasswordHashRequest
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_encryption | PasswordEncryption | How to encrypt the hash for transit: set PASSWORD_ENCRYPTION_AES256.Values: PASSWORD_ENCRYPTION_RC4 (0), PASSWORD_ENCRYPTION_UNENCRYPTED (1), PASSWORD_ENCRYPTION_AES256 (2). |
public_key | bytes | The caller's public key; the hash is encrypted with it. |
account_name | string | The name of the account to get password hash from. |
Response: GetPasswordHashResponse
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_hash | string | Deprecated; filled only for old clients. Use password_info. |
password_info | PasswordInfo | The encrypted hash with its hash algorithm and salt. |
password_info.hash | string | Password hash. |
password_info.hash_algorithm | PasswordHashAlgorithm | Password hash algorithm.Values: PASSWORD_HASH_ALGORITHM_MD5 (0), PASSWORD_HASH_ALGORITHM_UNDEFINED (1), PASSWORD_HASH_ALGORITHM_PBKDF2_WITH_SHA512_AND100000_ITERS (2). |
password_info.salt | string | Password salt. |
password_info.encryption | PasswordEncryption | Encryption algorithm used to protect the password hash.Values: PASSWORD_ENCRYPTION_RC4 (0), PASSWORD_ENCRYPTION_UNENCRYPTED (1), PASSWORD_ENCRYPTION_AES256 (2). |
Related methods
- SetPasswordHash -- Sets the password of an M-Files login from a password hash, for example one read with GetPasswordHash on another server.