SecurityUser Class

Security user represents a user for the purpose of security

Inheritance Hierarchy

SystemObject
  SanteDB.Core.ModelIdentifiedData
    SanteDB.Core.ModelBaseEntityData
      SanteDB.Core.ModelNonVersionedEntityData
        SanteDB.Core.Model.SecuritySecurityEntity
          SanteDB.Core.Model.SecuritySecurityUser

Namespace: SanteDB.Core.Model.Security
Assembly: SanteDB.Core.Model (in SanteDB.Core.Model.dll) Version: 2.2.1

Syntax

C++

Copy

public class SecurityUser : SecurityEntity

Public Class SecurityUser
	Inherits SecurityEntity

public ref class SecurityUser : public SecurityEntity

type SecurityUser =  
    class
        inherit SecurityEntity
    end

The SecurityUser type exposes the following members.

Constructors

	Name	Description
	SecurityUser	Roles belonging to the user

Top

Properties

	Name	Description
	BatchOperation	Gets or sets the operation (Inherited from IdentifiedData.)
	CreatedBy	Gets or sets the user that created this base data (Inherited from BaseEntityData.)
	CreatedByKey	Gets or sets the security provenance object which represents the creation of this object (Inherited from BaseEntityData.)
	CreationTime	Gets or sets the time at which the data was created (Inherited from BaseEntityData.)
	CreationTimeXml	Gets or sets the creation time as an ISO date format (Inherited from BaseEntityData.)
	Email	Gets or sets the email address of the user
	EmailConfirmed	Gets or sets whether the email address is confirmed
	InvalidLoginAttempts	Gets or sets the number of invalid login attempts by the user
	IsDelayLoadEnabled	True if the class is currently loading associations when accessed (Inherited from IdentifiedData.)
	Key	Gets or sets the primary identifying UUID of this object (Inherited from IdentifiedData.)
	LastLoginTime	The last login time
	LastLoginTimeXml	Gets or sets the creation time in XML format
	LoadState	Gets or sets whether the object was partial loaded (Inherited from IdentifiedData.)
	Lockout	Gets or sets whether the account is locked out
	LockoutXml	Gets or sets the creation time in XML format
	ModifiedOn	Gets the time this item was modified (Inherited from NonVersionedEntityData.)
	ObsoletedBy	Gets or sets the user that obsoleted this base data (Inherited from BaseEntityData.)
	ObsoletedByKey	Gets or sets the security provenance object which represents the obsoletion of this data (Inherited from BaseEntityData.)
	ObsoletionTime	Gets or sets the time when the data is or will become invalid (Inherited from BaseEntityData.)
	ObsoletionTimeXml	Gets or sets the time that the data is no longer valid (was deleted/obsoleted) in ISO format (Inherited from BaseEntityData.)
	Password	Gets or sets whether the password hash is enabled
	PasswordExpiration	The last login time
	PasswordExpirationXml	Gets or sets the creation time in XML format
	PhoneNumber	Gets or sets the patient's phone number
	PhoneNumberConfirmed	Gets or sets whether the phone number was confirmed
	Policies	Gets or sets the policies for the user (Overrides SecurityEntityPolicies.)
	Roles	Represents roles
	SecurityHash	Gets or sets whether the security has is enabled
	Tag	Gets the etag (Overrides IdentifiedDataTag.)
	TwoFactorEnabled	Gets or sets whether two factor authentication is required
	TwoFactorMechnaismKey	Gets or sets the preferred tfa mechanism
	Type	Gets the type registration of this object (Inherited from IdentifiedData.)
	UpdatedBy	Gets or sets the user that updated this base data (Inherited from NonVersionedEntityData.)
	UpdatedByKey	Gets or sets the provenance identifier associated with the last update of this object (Inherited from NonVersionedEntityData.)
	UpdatedTime	Updated time (Inherited from NonVersionedEntityData.)
	UpdatedTimeXml	Gets or sets the time that this object was last modified in ISO format (Inherited from NonVersionedEntityData.)
	UserClass	Gets or sets the user class key
	UserEntity	Link from this security resource to an entity resource
	UserName	Gets or sets the logical user name ofthe user
	UserPhoto	Gets or sets the binary representation of the user's photo

Top

Methods

	Name	Description
	AddAnnotation	Add an annotated object (Inherited from IdentifiedData.)
	AddPolicy	Add a policy to this act (Inherited from SecurityEntity.)
	Clone	Clone this object (Inherited from IdentifiedData.)
	CopyAnnotations	Copy annotations from another resource (Inherited from IdentifiedData.)
	DeepCopy	Provide a deep copy of the specified data (Inherited from IdentifiedData.)
	DelayLoadTEntity	Get associated entity (Inherited from IdentifiedData.)
	Equals	Determines whether the specified object is equal to the current object. (Inherited from Object.)
	Finalize	Allows an object to try to free resources and perform other cleanup operations before it is reclaimed by garbage collection. (Inherited from Object.)
	GetAnnotationsT	Get annotations of specified T (Inherited from IdentifiedData.)
	GetHashCode	Serves as the default hash function. (Inherited from Object.)
	GetLocked	Clone the specified data (Inherited from IdentifiedData.)
	GetType	Gets the Type of the current instance. (Inherited from Object.)
	HasPolicy	Returns true if this object has the specified policy applied (Inherited from SecurityEntity.)
	IsEmpty	Determines w (Inherited from IdentifiedData.)
	MemberwiseClone	Creates a shallow copy of the current Object. (Inherited from Object.)
	RemoveAnnotation	Remove annotation (Inherited from IdentifiedData.)
	SemanticEquals	Determine semantic equality of user (Overrides IdentifiedDataSemanticEquals(Object).)
	ShouldSerializeBatchOperation	Should serialize batch operation (Inherited from IdentifiedData.)
	ShouldSerializeCreatedByKey	True if key should be serialized (Inherited from BaseEntityData.)
	ShouldSerializeKey	True if key should be serialized (Inherited from IdentifiedData.)
	ShouldSerializeModifiedOn	Never serialize modified on (Inherited from IdentifiedData.)
	ShouldSerializeObsoletedByKey	True if key should be serialized (Inherited from BaseEntityData.)
	ShouldSerializeUpdatedByKey	True if key should be serialized (Inherited from NonVersionedEntityData.)
	ToDisplay	Get the name of the object as a display string (Overrides IdentifiedDataToDisplay.)
	ToString	Represent the data as a string (Inherited from BaseEntityData.)

Top

Fields

	Name	Description
	m_annotations	A list of custom tags which were added to this object (Inherited from IdentifiedData.)
	m_policies	Policies applied to this entity (Inherited from SecurityEntity.)

Top

Extension Methods

	Name	Description
	ConvertTReturn	The purpose of this method is to convert object me to TReturn. Why? Because if you have an instance of Act that actually needs to be a SubstanceAdministration we can't just cast so we have to copy. (Defined by ExtensionMethods.)
	GetInstanceOfTDomain	Gets an instance of TDomain from me (Defined by ModelExtensions.)

Top

Reference

SanteDB.Core.Model.Security Namespace