UserAccount

Struct for a user account in a vault.

Full name	`MFiles.UserAccount`
Proto file	`mfiles/structs.proto`

Fields

Field	Type	Number	Description
`id`	`int32`	1	The ID of the user account.
`login_name`	`string`	2	The login name that is associated with this user account (e.g. 'DOMAIN\user').
`vault_roles`	`VAULTROLES`	3	Bitmask of the vault roles of the user.
`acl`	`AccessControlList`	4	Permissions.
`user_language`	`int32`	5	The vault language of the user.
`external_id`	`string`	6	The user identity in external system, such as Microsoft Entra (where the identity is a GUID). Read-only.

IRPCUsersAdmin.AddOrUndeleteUser -- Adds a user account, or brings back a removed one with the same login name.
IRPCUsersAdmin.AddOrUndeleteUserViaADSync -- Adds a user account during a directory import; brings back a removed account only when the vault allows that.
IRPCUsersAdmin.AddUser -- Adds a user account to the vault, or brings back a removed one.
IRPCUsersAdmin.GetChangedUserAccounts -- Gets the user accounts that were added, changed or removed after a version token.
IRPCUsersAdmin.GetUser -- Gets one user account by ID.
IRPCUsersAdmin.GetUsers -- Gets all user accounts of the vault.
IRPCUsersAdmin.ModifyUser -- Replaces the data of an existing user account.
IRPCUsersAdmin.SearchForUser -- Finds the user account of a login name.
IRPCUsersAdmin.UndeleteUserByGUID -- Brings back a removed user account, identified by its GUID in the Users value list.
IRPCViewsAdmin.GetViewsAndUsersAdmin -- Gets all common views and the private views of all users, with the owner of each private view.

GetUsersResponse.results -- All user accounts. See UserAccount.
ModifyUserRequest.user_account -- The complete new data of the account; id identifies the account to modify.
AddOrUndeleteUserRequest.user_account -- The new account. login_name is required; id is ignored. A removed user with the same login name is brought back with its old ID.
AddOrUndeleteUserViaADSyncRequest.user_account -- The new account. login_name is required; id is ignored.
GetUserResponse.putf8szua -- The user account. See UserAccount.
SearchForUserResponse.results -- The matching user account, or empty.
UndeleteUserByGUIDRequest.user_account_data -- The data to store in the restored account (login_name, vault roles, ...). id is ignored.
AddUserRequest.user_account -- The new account: login_name, vault_roles, and optionally acl and user_language. id is ignored.
GetChangedUserAccountsResponse.new_and_modified -- Accounts added or changed after version_token.
GetViewsAndUsersAdminResponse.user_accounts -- The owner of each private view, in the order of user_defined_views.