HS.Registry.Person.User.WebServices.Containers.UserLoginID
persistent class HS.Registry.Person.User.WebServices.Containers.UserLoginID extends %Library.Persistent, HS.Util.WebServices.ServiceStatus, HS.Util.WebServices.SuperContainerListItem
SQL Table Name: HS_Registry_Person_User_WebServices_Containers.UserLoginID
Property Inventory
- ChallengeAnswer
- ChallengeQuestion
- ChangePassword
- Domain
- EmailID
- ExpirationDate
- LastModifiedBy
- LoginID
- Password
- PasswordHashAlgorithm
- PasswordHashWorkFactor
- PhoneNumber
- PhoneProvider
- Roles
- Salt
- UserClinician
Method Inventory
Parameters
parameter %JSONENABLED = 1;
If this parameter is true then JSON-enabling methods will be generated.
Otherwise, the method generators do not produce a runnable method.
Properties
property ChallengeAnswer as %String (MAXLEN = 256);
Property methods: ChallengeAnswerDisplayToLogical(), ChallengeAnswerGet(), ChallengeAnswerGetStored(), ChallengeAnswerIsValid(), ChallengeAnswerLogicalToDisplay(), ChallengeAnswerLogicalToOdbc(), ChallengeAnswerNormalize(), ChallengeAnswerSet()
property ChallengeQuestion as %String (MAXLEN = 256);
Property methods: ChallengeQuestionDisplayToLogical(), ChallengeQuestionGet(), ChallengeQuestionGetStored(), ChallengeQuestionIsValid(), ChallengeQuestionLogicalToDisplay(), ChallengeQuestionLogicalToOdbc(), ChallengeQuestionNormalize(), ChallengeQuestionSet()
property ChangePassword as %Boolean;
Property methods: ChangePasswordDisplayToLogical(), ChangePasswordGet(), ChangePasswordGetStored(), ChangePasswordIsValid(), ChangePasswordLogicalToDisplay(), ChangePasswordLogicalToXSD(), ChangePasswordNormalize(), ChangePasswordSet(), ChangePasswordXSDToLogical()
property Domain as %String (MAXLEN = 128);
This property is flagged as required from UI, please also ensure to check it as required when using server side API
To avoid confusion, this is DomainCode as in HS.Registry.Person.UserLoginID
Property methods: DomainDisplayToLogical(), DomainGet(), DomainGetStored(), DomainIsValid(), DomainLogicalToDisplay(), DomainLogicalToOdbc(), DomainNormalize(), DomainSet()
property EmailID as %String (MAXLEN = 500);
Used for password reset workflows.
MAXLEN set to match HS.Registry.Person.UserEmail
MAXLEN set to match HS.Registry.Person.UserEmail
Property methods: EmailIDDisplayToLogical(), EmailIDGet(), EmailIDGetStored(), EmailIDIsValid(), EmailIDLogicalToDisplay(), EmailIDLogicalToOdbc(), EmailIDNormalize(), EmailIDSet()
property ExpirationDate as %String;
Property methods: ExpirationDateDisplayToLogical(), ExpirationDateGet(), ExpirationDateGetStored(), ExpirationDateIsValid(), ExpirationDateLogicalToDisplay(), ExpirationDateLogicalToOdbc(), ExpirationDateNormalize(), ExpirationDateSet()
property LastModifiedBy as %String (MAXLEN = 128, TRUNCATE = 1);
The user who most recently changed this login ID - for auditing purposes
Property methods: LastModifiedByDisplayToLogical(), LastModifiedByGet(), LastModifiedByGetStored(), LastModifiedByIsValid(), LastModifiedByLogicalToDisplay(), LastModifiedByLogicalToOdbc(), LastModifiedByNormalize(), LastModifiedBySet()
property LoginID as %String (MAXLEN = 128);
This property is flagged as required from UI, please also ensure to check it as required when using server side API
Property methods: LoginIDDisplayToLogical(), LoginIDGet(), LoginIDGetStored(), LoginIDIsValid(), LoginIDLogicalToDisplay(), LoginIDLogicalToOdbc(), LoginIDNormalize(), LoginIDSet()
property Password as HS.Registry.Person.UserPassword;
This is the encrypted password, and is generated when you invoke method EncryptPassword
Property methods: PasswordGet(), PasswordGetStored(), PasswordIsValid(), PasswordJSONToLogical(), PasswordLogicalToDisplay(), PasswordLogicalToJSON(), PasswordLogicalToOdbc(), PasswordLogicalToXSD(), PasswordSet(), PasswordXSDToLogical()
property PasswordHashAlgorithm as %String;
Algorithm used to calculate user's current PBKDF2 password hash.
Irrelevant for users without passwords.
Property methods: PasswordHashAlgorithmDisplayToLogical(), PasswordHashAlgorithmGet(), PasswordHashAlgorithmGetStored(), PasswordHashAlgorithmIsValid(), PasswordHashAlgorithmLogicalToDisplay(), PasswordHashAlgorithmLogicalToOdbc(), PasswordHashAlgorithmNormalize(), PasswordHashAlgorithmSet()
property PasswordHashWorkFactor as %Integer (MINVAL = 1024);
Work Factor used to calculate user's current PBKDF2 password hash.
Irrelevant for users without passwords.
Property methods: PasswordHashWorkFactorDisplayToLogical(), PasswordHashWorkFactorGet(), PasswordHashWorkFactorGetStored(), PasswordHashWorkFactorIsValid(), PasswordHashWorkFactorLogicalToDisplay(), PasswordHashWorkFactorNormalize(), PasswordHashWorkFactorSet(), PasswordHashWorkFactorXSDToLogical()
property PhoneNumber as %String (MAXLEN = 64);
If the domain uses two factor authentication, this will be the phone number (usually a mobile phone)
Property methods: PhoneNumberDisplayToLogical(), PhoneNumberGet(), PhoneNumberGetStored(), PhoneNumberIsValid(), PhoneNumberLogicalToDisplay(), PhoneNumberLogicalToOdbc(), PhoneNumberNormalize(), PhoneNumberSet()
property PhoneProvider as %String (MAXLEN = 128);
If the domain uses two factor authentication, this will be the phone provider
Property methods: PhoneProviderDisplayToLogical(), PhoneProviderGet(), PhoneProviderGetStored(), PhoneProviderIsValid(), PhoneProviderLogicalToDisplay(), PhoneProviderLogicalToOdbc(), PhoneProviderNormalize(), PhoneProviderSet()
property Roles as list of %String (MAXLEN = 64);
Property methods: RolesBuildValueArray(), RolesCollectionToDisplay(), RolesCollectionToOdbc(), RolesDisplayToCollection(), RolesDisplayToLogical(), RolesGet(), RolesGetObject(), RolesGetObjectId(), RolesGetStored(), RolesGetSwizzled(), RolesIsValid(), RolesLogicalToDisplay(), RolesLogicalToOdbc(), RolesNormalize(), RolesOdbcToCollection(), RolesSet(), RolesSetObject(), RolesSetObjectId()
property Salt as %Binary (MAXLEN = 64);
This is generated when you encrypt the password
Property methods: SaltGet(), SaltGetStored(), SaltIsValid(), SaltJSONToLogical(), SaltLogicalToJSON(), SaltLogicalToXSD(), SaltSet(), SaltXSDToLogical()
property UserClinician as %String);
Property methods: UserClinicianDisplayToLogical(), UserClinicianGet(), UserClinicianGetStored(), UserClinicianIsValid(), UserClinicianLogicalToDisplay(), UserClinicianLogicalToOdbc(), UserClinicianNormalize(), UserClinicianSet()
Methods
method EncryptPassword(pPasswordExternal)
API Method: Call this to generate the encryption salt and encrypted password
Indexes
index (IDKEY on ) [IdKey, Type = key];
Index methods: IDKEYCheck(), IDKEYDelete(), IDKEYExists(), IDKEYOpen(), IDKEYSQLCheckUnique(), IDKEYSQLExists(), IDKEYSQLFindPKeyByConstraint(), IDKEYSQLFindRowIDByConstraint()
Inherited Members
Inherited Properties
Inherited Methods
- %%CLASSNAMELogicalToStorage()
- %%CLASSNAMEStorageToLogical()
- %AddToSaveSet()
- %AddToSyncSet()
- %BMEBuilt()
- %BuildIndicesAsync()
- %BuildIndicesAsyncResponse()
- %CheckConstraints()
- %CheckConstraintsForExtent()
- %ClassIsLatestVersion()
- %ClassName()
- %ComposeOid()
- %ConstructClone()
- %Delete()
- %DeleteExtent()
- %DeleteId()
- %DispatchClassMethod()
- %DispatchGetModified()
- %DispatchGetProperty()
- %DispatchMethod()
- %DispatchSetModified()
- %DispatchSetMultidimProperty()
- %DispatchSetProperty()
- %Exists()
- %ExistsId()
- %Extends()
- %GUID()
- %GUIDSet()
- %GetLock()
- %GetParameter()
- %GetSwizzleObject()
- %Id()
- %InsertBatch()
- %IsA()
- %IsModified()
- %IsNull()
- %JSONExport()
- %JSONExportToStream()
- %JSONExportToString()
- %JSONImport()
- %JSONNew()
- %KillExtent()
- %KillExtentData()
- %LoadFromMemory()
- %LockExtent()
- %LockId()
- %New()
- %NormalizeObject()
- %ObjectIsNull()
- %ObjectModified()
- %Oid()
- %OnBeforeAddToSync()
- %OnDeleteFinally()
- %OnDetermineClass()
- %OnOpenFinally()
- %OnSaveFinally()
- %Open()
- %OpenId()
- %OriginalNamespace()
- %PackageName()
- %PhysicalAddress()
- %PurgeIndices()
- %Reload()
- %RemoveFromSaveSet()
- %ResolveConcurrencyConflict()
- %RollBack()
- %Save()
- %SaveDirect()
- %SaveIndices()
- %SerializeObject()
- %SetModified()
- %SortBegin()
- %SortEnd()
- %SyncObjectIn()
- %SyncTransport()
- %UnlockExtent()
- %UnlockId()
- %ValidateIndices()
- %ValidateObject()
- %ValidateTable()
- CopyFrom()
- XMLDTD()
- XMLExport()
- XMLExportToStream()
- XMLExportToString()
- XMLNew()
- XMLSchema()
- XMLSchemaNamespace()
- XMLSchemaType()
Storage
Storage Model: Storage (HS.Registry.Person.User.WebServices.Containers.UserLoginID)
^HS.Registry.Pe1585.UserLoginIDD(ID) |
= | %%CLASSNAME
Action
%User
%Roles
%Gateway
Salt
ChangePassword
ExpirationDate
Roles
ChallengeQuestion
ChallengeAnswer
Domain
ID
LoginID
Name
Password
Status
UserClinician
PhoneProvider
PhoneNumber
LastModifiedBy
EmailID
PasswordHashAlgorithm
PasswordHashWorkFactor
|