IRPCServerAdmin.UpsertServerUser
Administration API / specialized admin session idempotent
Adds a server user or changes the server roles of an existing one.
| Service | Server administration MFiles.IRPCServerAdmin |
|---|---|
| gRPC method | /MFiles.IRPCServerAdmin/UpsertServerUser |
| HTTP (mf-http-grpc) | POST /grpc/v1/upsert-server-user |
| Request | UpsertServerUserRequest |
| Response | UpsertServerUserResponse |
| 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). - The server user is matched by
login_name.
Request: UpsertServerUserRequest
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 |
|---|---|---|
serveruser | ServerUser | The account name and its server roles. See ServerUser. |
serveruser.login_name | string | The login name that is associated with this server user (e.g. 'DOMAIN\user'). |
serveruser.server_roles | SRVROLES | Bitmask of the server roles of the login. |
serveruser.server_roles.all | bool | Specifies all flags set; Including any future flags. |
serveruser.server_roles.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. |
serveruser.server_roles.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. |
serveruser.server_roles.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. |
Response: UpsertServerUserResponse
No fields.