Show / Hide Table of Contents

Class WMUser

Class representing users as WMPrincipal instances to which access privileges can be granted, and ownership of objects assigned.

Inheritance
object
WMPrincipal
WMUser
Implements
IPolicyAssignable
IWMAssetOwner
IDbEntity
IWMEntity
Inherited Members
WMPrincipal.ID
WMPrincipal.CreatedBy
WMPrincipal.CreatedDate
WMPrincipal.LastUpdatedBy
WMPrincipal.LastUpdatedDate
WMPrincipal.Name
WMPrincipal.Status
WMPrincipal.Get(string, string)
WMPrincipal.HashPassword(string, out string)
WMPrincipal.VerifyPassword(string, string, string)
WMPrincipal.Policies
object.Equals(object)
object.Equals(object, object)
object.GetHashCode()
object.GetType()
object.MemberwiseClone()
object.ReferenceEquals(object, object)
object.ToString()
Namespace: Quantellia.WMServer.Auth.Model.UserAccess
Assembly: WMServer.dll
Syntax
[HasDTO(typeof(WMUserDTO))]
public class WMUser : WMPrincipal, IPolicyAssignable, IWMAssetOwner, IDbEntity, IWMEntity

Constructors

WMUser()

Default constructor that sets the ID to a new GUID.

Declaration
public WMUser()

WMUser(string)

Constructor that initializes the ID.

Declaration
public WMUser(string id)
Parameters
Type Name Description
string id

Properties

Email

Declaration
public string Email { get; set; }
Property Value
Type Description
string

IsSysAdmin

Whether this user is a system admin for this instance of WMServer

Declaration
public int IsSysAdmin { get; set; }
Property Value
Type Description
int

LoginName

Name for login.

Declaration
public string LoginName { get; set; }
Property Value
Type Description
string
Remarks

The pair LoginName, WMOrganization must be unique.

Password

Password used for authentication

Declaration
public string Password { get; set; }
Property Value
Type Description
string

Salt

Salt for hashing the password.

Declaration
public string Salt { get; set; }
Property Value
Type Description
string

Methods

Get(string, AuthDbContext?)

Declaration
public static Task<WMUser> Get(string id, AuthDbContext? context = null)
Parameters
Type Name Description
string id
AuthDbContext context
Returns
Type Description
Task<WMUser>

GetOrganizations(WMPrincipal, string, AuthDbContext)

Declaration
public static Task<IEnumerable<WMOrganization>> GetOrganizations(WMPrincipal principal, string userID, AuthDbContext context)
Parameters
Type Name Description
WMPrincipal principal
string userID
AuthDbContext context
Returns
Type Description
Task<IEnumerable<WMOrganization>>

GetUsers(WMPrincipal, AuthDbContext?)

Evaluate a list of all users that the caller is authorized to view. If caller does not have privileges to view users, status code 403 (Forbidden) will be returned.

Declaration
public static Task<List<WMUser>> GetUsers(WMPrincipal principal, AuthDbContext? context = null)
Parameters
Type Name Description
WMPrincipal principal
AuthDbContext context
Returns
Type Description
Task<List<WMUser>>

Implements

IPolicyAssignable
IWMAssetOwner
IDbEntity
IWMEntity
In this article
Back to top Copyright © 2025 Quantellia LLC.    Version 2.0.0 Revision 399     Last Updated 1/15/2025    DRAFT DOCUMENTATION. SUBJECT TO CHANGE