IRPCLoginsAdmin.ModifyLogin

Administration API / specialized admin session idempotent

Changes a login account: its server roles and enabled state, and optionally its password, full name, e-mail address and license type.

Service	Server login accounts `MFiles.IRPCLoginsAdmin`
gRPC method	`/MFiles.IRPCLoginsAdmin/ModifyLogin`
HTTP (mf-http-grpc)	`POST /grpc/v1/modify-login`
Request	`ModifyLoginRequest`
Response	`ModifyLoginResponse`
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).
srvroles is always written; send the complete set (including can_log_in to keep the login enabled). The other fields are written only when change_password or update_other_fields is true.
Changing the license type fails if no license of that type is available.
On servers that use vault login accounts, a login that is not a system administrator can only be disabled or set to no license here.
update_client_id and client_id are ignored by this method.
By default, the linked user accounts in the online vaults are refreshed after a change.

Request: ModifyLoginRequest

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 account to modify.
`srvroles`	`SRVROLES`	The complete new server roles, including `can_log_in`.
`srvroles.all`	`bool`	Specifies all flags set; Including any future flags.
`srvroles.system_administrator`	`bool`	System administrator (can perform any operation on the server). [ name( "vaultCreator" ) ] const SRVROLES SRVROLE_VAULT_CREATOR = ( 1 << 1 ); //!< Can create, modify and delete vaults. Can also restore vaults. [ name( "backupOperator" ) ] const SRVROLES SRVROLE_BACKUP_OPERATOR = ( 1 << 2 ); //!< Can back up vaults.
`srvroles.can_log_in`	`bool`	Can log in. A login that does not have this role is disabled and cannot log in even if the login has the sysadmin role.
`srvroles.invalid_password`	`bool`	This special role indicates that the M-Files login does not yet have a valid password. MFAdmin uses this flag to force the user to define the password.
`change_password`	`bool`	True to set the password from `password_info`.
`password_hash`	`string`	Deprecated; leave empty and use `password_info`.
`password_info`	`PasswordInfo`	The new encrypted password hash. Used only when `change_password` is true.
`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).
`update_other_fields`	`bool`	True to write `full_name`, `email_address` and `licensetype`.
`full_name`	`string`	The full name of the account.
`email_address`	`string`	The email address of the account.
`licensetype`	`LicenseType`	The license type of the account.Values: `LICENSE_TYPE_NONE` (0), `LICENSE_TYPE_NAMED_USER_LICENSE` (1), `LICENSE_TYPE_CONCURRENT_USER_LICENSE` (2), `LICENSE_TYPE_READ_ONLY_LICENSE` (3), `LICENSE_TYPE_VISITOR_LICENSE` (4).
`update_client_id`	`bool`	Ignored.
`client_id`	`string`	Ignored.

Response: ModifyLoginResponse

No fields.