HS.Types.AuthDomainInfo
class HS.Types.AuthDomainInfo extends %Library.RegisteredObject, %XML.Adaptor, %pkg.isc.json.adaptor, HS.Util.CopyFrom
Property Inventory
- AuthenticationServiceName
- AuthorizationServiceName
- CallbackClass
- DefaultFlag
- Description
- DomainCode
- FacilityCode
- Hidden
- Notes
- PasswordResetEnabled
- Roles
- UseTwoFactor
Method Inventory
Properties
property AuthenticationServiceName as HS.HC.DataType.ServiceName;
For non-%HS* domains
Name of the (SOAP) service registry entry that is used to authenticate this domain,
Property methods: AuthenticationServiceNameDisplayToLogical(), AuthenticationServiceNameGet(), AuthenticationServiceNameIsValid(), AuthenticationServiceNameLogicalToDisplay(), AuthenticationServiceNameLogicalToOdbc(), AuthenticationServiceNameNormalize(), AuthenticationServiceNameSet()
property AuthorizationServiceName as HS.HC.DataType.ServiceName;
For non-%HS* domains
Name of the (SOAP) service registry entry that is used to get authorization info for this domain,
Property methods: AuthorizationServiceNameDisplayToLogical(), AuthorizationServiceNameGet(), AuthorizationServiceNameIsValid(), AuthorizationServiceNameLogicalToDisplay(), AuthorizationServiceNameLogicalToOdbc(), AuthorizationServiceNameNormalize(), AuthorizationServiceNameSet()
property CallbackClass as %Dictionary.Classname [ InitialExpression = "HS.Registry.Person.User.HSAuth" , Required ];
This is the name of the class that will contain the callback methods OnAuthenticate and OnAuthorize
It should extend HS.Registry.Person.User.HSAuth
Property methods: CallbackClassGet(), CallbackClassIsValid(), CallbackClassSet()
property DefaultFlag as %Boolean;
One domain is designated as the default
Property methods: DefaultFlagDisplayToLogical(), DefaultFlagGet(), DefaultFlagIsValid(), DefaultFlagLogicalToDisplay(), DefaultFlagLogicalToXSD(), DefaultFlagNormalize(), DefaultFlagSet(), DefaultFlagXSDToLogical()
property Description as HS.HC.DataType.AnyString;
Property methods: DescriptionDisplayToLogical(), DescriptionGet(), DescriptionIsValid(), DescriptionLogicalToDisplay(), DescriptionLogicalToOdbc(), DescriptionNormalize(), DescriptionSet()
property DomainCode as HS.HC.DataType.LoginDomain [ Required ];
%HS* domains are internal to HealthShare. Authentication and Authorization data is maintained in
the UserLogin table. Other domains are maintained externally
Property methods: DomainCodeDisplayToLogical(), DomainCodeGet(), DomainCodeIsValid(), DomainCodeLogicalToDisplay(), DomainCodeLogicalToOdbc(), DomainCodeNormalize(), DomainCodeSet()
deprecated property FacilityCode as HS.HC.DataType.AnyString (%JSONINCLUDE = "None", XMLPROJECTION = "None") [ Calculated ];
Facility code which uses this domain.
DEPRECATED. Use Notes instead.
Property methods: FacilityCodeCompute(), FacilityCodeDisplayToLogical(), FacilityCodeIsValid(), FacilityCodeLogicalToDisplay(), FacilityCodeLogicalToOdbc(), FacilityCodeNormalize(), FacilityCodeSQLCompute()
property Hidden as %Boolean [ InitialExpression = 0 ];
Whether to hide this domain when displaying domains in the Universal Login Application.
Property methods: HiddenDisplayToLogical(), HiddenGet(), HiddenIsValid(), HiddenLogicalToDisplay(), HiddenLogicalToXSD(), HiddenNormalize(), HiddenSet(), HiddenXSDToLogical()
property Notes as HS.HC.DataType.AnyString;
Information only notes, e.g. facility code.
Property methods: NotesDisplayToLogical(), NotesGet(), NotesIsValid(), NotesLogicalToDisplay(), NotesLogicalToOdbc(), NotesNormalize(), NotesSet()
property PasswordResetEnabled as %Boolean [ InitialExpression = 0 ];
(For all domains,) Enable or disable password reset via domain callback class.
Property methods: PasswordResetEnabledDisplayToLogical(), PasswordResetEnabledGet(), PasswordResetEnabledIsValid(), PasswordResetEnabledLogicalToDisplay(), PasswordResetEnabledLogicalToXSD(), PasswordResetEnabledNormalize(), PasswordResetEnabledSet(), PasswordResetEnabledXSDToLogical()
property Roles as list of %String (MAXLEN = 64);
Roles (which includes consent groups) that this domain is allowed to assign
Property methods: RolesBuildValueArray(), RolesCollectionToDisplay(), RolesCollectionToOdbc(), RolesDisplayToCollection(), RolesDisplayToLogical(), RolesGet(), RolesGetObject(), RolesGetObjectId(), RolesGetSwizzled(), RolesIsValid(), RolesLogicalToDisplay(), RolesLogicalToOdbc(), RolesNormalize(), RolesOdbcToCollection(), RolesSet(), RolesSetObject(), RolesSetObjectId()
property UseTwoFactor as %Boolean;
Two factor is only supported starting with 2015.1.
If turned on for a domain, it means that users logging in on that domain will be required
to provide a second factor
Property methods: UseTwoFactorDisplayToLogical(), UseTwoFactorGet(), UseTwoFactorIsValid(), UseTwoFactorLogicalToDisplay(), UseTwoFactorLogicalToXSD(), UseTwoFactorNormalize(), UseTwoFactorSet(), UseTwoFactorXSDToLogical()
Methods
method FacilityCodeGet()
For backwards compatibility, return saved notes for FacilityCode
method FacilityCodeSet(value As HS.HC.DataType.AnyString) as %Status
For backwards compatibility, save updates of FacilityCode to Notes
Inherited Members
Inherited Methods
- %AddToSaveSet()
- %ClassIsLatestVersion()
- %ClassName()
- %ConstructClone()
- %DispatchClassMethod()
- %DispatchGetModified()
- %DispatchGetProperty()
- %DispatchMethod()
- %DispatchSetModified()
- %DispatchSetMultidimProperty()
- %DispatchSetProperty()
- %Extends()
- %GetParameter()
- %IsA()
- %IsModified()
- %JSONExport()
- %JSONExportArray()
- %JSONExportToDynamicObject()
- %JSONExportToStream()
- %JSONExportToString()
- %JSONImport()
- %JSONImportArray()
- %JSONMappingInfo()
- %JSONNew()
- %JSONNewDefault()
- %New()
- %NormalizeObject()
- %ObjectModified()
- %OriginalNamespace()
- %PackageName()
- %RemoveFromSaveSet()
- %SerializeObject()
- %SetModified()
- %ValidateObject()
- CopyFrom()
- XMLDTD()
- XMLExport()
- XMLExportToStream()
- XMLExportToString()
- XMLNew()
- XMLSchema()
- XMLSchemaNamespace()
- XMLSchemaType()