Login
Struct for a login.
| Full name | MFiles.Login |
|---|---|
| Proto file | mfiles/structs.proto |
Fields
| Field | Type | Number | Description |
|---|---|---|---|
account_type | AccountType | 1 | Account type (e.g. M-Files or Windows).Values: ACCOUNT_TYPE_UNINITIALIZED (0), ACCOUNT_TYPE_MFILES (1), ACCOUNT_TYPE_WINDOWS (2). |
domain_name | string | 2 | Domain name, if acctype is eAccountTypeWindows. Otherwise unset. |
user_name | string | 3 | User name. Cannot be unset. |
options | SRVROLES | 4 | Bitmask of the server roles of the login. |
full_name | string | 5 | The full name of the user. May be unset. |
email_address | string | 6 | The email address of the user. May be unset. |
license_type | LicenseType | 7 | License type.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). |
credential_type | CredentialType | 8 | Credential type.Values: CREDENTIAL_TYPE_USER (0), CREDENTIAL_TYPE_TECHNICAL (1). |
client_id | string | 9 | Client ID, if credentialtype is eCredentialTypeTechnical. Otherwise unset. |
external_id | string | 10 | The user identity in external system, such as Microsoft Entra (where the identity is a GUID). |
Used by methods
- IRPCLoginsAdmin.AddLogin -- Adds a login account to the server.
- IRPCLoginsAdmin.GetLogin -- Gets one login account by account name.
- IRPCLoginsAdmin.GetLogins -- Gets the login accounts the caller is allowed to see: all of them for system administrators, otherwise those linked to vaults the caller administers.
- IRPCLoginsAdmin.GetLoginsWithSessions -- Gets the login accounts that currently have open sessions on the server.
- IRPCVaultLoginsAdmin.AddVaultLogin -- Adds a login account to the vault.
- IRPCVaultLoginsAdmin.GetVaultLogin -- Gets one vault login by account name.
- IRPCVaultLoginsAdmin.GetVaultLogins -- Gets all login accounts stored in the vault.
- IRPCVaultLoginsAdmin.GetVaultLoginsWithSessions -- Gets the login accounts that currently have sessions to this vault.
- IRPCVaultLoginsAdmin.ModifyVaultLoginEx -- Replaces the data of a vault login, optionally including its account name.
Used in fields
AddLoginRequest.login-- The new login. See Login.GetLoginsResponse.values-- The login accounts. See Login.GetLoginResponse.plogin-- The login account. See Login.GetLoginsWithSessionsResponse.values-- The logins with sessions. See Login.AddVaultLoginRequest.login-- The new login. See Login.GetVaultLoginsResponse.values-- The vault logins. See Login.GetVaultLoginResponse.plogin-- The login. See Login.GetVaultLoginsWithSessionsResponse.values-- The logins with active sessions. See Login.ModifyVaultLoginExRequest.login-- The new data of the login. See Login.