SecurityHub Class

Defines a SignalR security hub for managing users, groups and SID management.

Inheritance Hierarchy

SystemObject
  HubBase
    Hub
      GSF.Web.HubsRecordOperationsHubSecurityHub
        GSF.Web.SecuritySecurityHub

Namespace: GSF.Web.Security
Assembly: GSF.Web (in GSF.Web.dll) Version: 2.4.218-beta

Syntax

C++

JavaScript

Copy

[AuthorizeHubRoleAttribute]
public class SecurityHub : RecordOperationsHub<SecurityHub>

<AuthorizeHubRoleAttribute>
Public Class SecurityHub
	Inherits RecordOperationsHub(Of SecurityHub)

[AuthorizeHubRoleAttribute]
public ref class SecurityHub : public RecordOperationsHub<SecurityHub^>

[<AuthorizeHubRoleAttribute>]
type SecurityHub = 
    class
        inherit RecordOperationsHub<SecurityHub>
    end

GSF.Web.Security.SecurityHub = function();

Type.createClass(
	'GSF.Web.Security.SecurityHub',
	GSF.Web.Hubs.RecordOperationsHub`1);

View Source

The SecurityHub type exposes the following members.

Constructors

	Name	Description
	SecurityHub	Creates a new SecurityHub.
	SecurityHub(ActionString, UpdateType, ActionException)	Creates a new SecurityHub with the specified logging functions.
	SecurityHub(String, ActionString, UpdateType, ActionException)	Creates a new SecurityHub with the specified DataContext and logging functions.

Top

Properties

	Name	Description
	AzureADSettings	Gets Azure AD settings.
	Clients	(Inherited from Hub)
	ClientScript	Gets reference to SignalR hub client browser DOM functionality. (Inherited from RecordOperationsHubT)
	ConnectionID	Gets active connection ID from current hub context or assigns one to use. (Inherited from RecordOperationsHubT)
	Context	Provides information about the calling client. (Inherited from HubBase)
	DataContext	Gets DataContext created for this RecordOperationsHubT instance. (Inherited from RecordOperationsHubT)
	GraphClient	Gets Graph client.
	Groups	The group manager for this hub instance. (Inherited from HubBase)
	RecordOperationsCache	Gets RecordOperationsCache for SignalR hub. (Inherited from RecordOperationsHubT)

Top

Methods

	Name	Description
	AddGroupToRole	Adds group to a role.
	AddNewSecurityGroup	Adds a new security group.
	AddNewUserAccount	Adds a new user account.
	AddUserToRole	Adds user to a role.
	DeleteSecurityGroup	Deletes security group.
	DeleteUserAccount	Deletes user account.
	Dispose	(Inherited from HubBase)
	Dispose(Boolean)	Releases the unmanaged resources used by the RecordOperationsHubT object and optionally releases the managed resources. (Inherited from RecordOperationsHubT)
	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)
	GetAzureADGroupList	Gets the list of Azure AD groups that are defined.
	GetAzureADUserList	Gets the list of Azure AD users that are defined.
	GetConnectionID	Gets connection ID for active hub context, if any. (Inherited from RecordOperationsHubT)
	GetDefaultNodeID	Gets the default NodeID based on the current configuration.
	GetHashCode	Serves as the default hash function. (Inherited from Object)
	GetType	Gets the Type of the current instance. (Inherited from Object)
	GroupIsInRole	Determines if group is in role based on database ID values.
	GroupNameToSID	Gets SID for a given group name.
	IsGroupSID	Determines if SID is for a group.
	IsUserSID	Determines if SID is for a user.
	IsValidAzureADGroupName	Gets flag that determines if specified group name can be found on Azure AD.
	IsValidAzureADUserName	Gets flag that determines if specified user name can be found on Azure AD.
	LogException	Logs an exception to hub client and any provided log exception delegate. (Inherited from RecordOperationsHubT)
	Logout	Resets the current provider cache.
	LogStatusMessage	Logs a status message to hub client and any provided log status message delegate. (Inherited from RecordOperationsHubT)
	MemberwiseClone	Creates a shallow copy of the current Object. (Inherited from Object)
	NewSecurityGroup	Creates a new security group model instance.
	NewUserAccount	Creates a new user account model instance.
	OnConnected	Called when the connection connects to this hub instance. (Inherited from RecordOperationsHubT)
	OnDisconnected	Called when a connection disconnects from this hub gracefully or due to a timeout. (Inherited from RecordOperationsHubT)
	OnReconnected	Called when the connection reconnects to this hub instance. (Inherited from HubBase)
	QueryApplicationRoles	Gets the current application role records.
	QuerySecurityGroup	Finds the specified security group record.
	QuerySecurityGroupByName	Finds the specified security group record by SID or database account name.
	QuerySecurityGroupCount	Queries count of security groups.
	QuerySecurityGroups	Queries page of security groups.
	QueryUserAccount	Finds the specified user account record.
	QueryUserAccountByName	Finds the specified user account record by SID or database account name.
	QueryUserAccountCount	Queries count of user accounts.
	QueryUserAccounts	Queries page of user accounts.
	RemoveGroupFromRole	Removes group from a role.
	RemoveUserFromRole	Removes user from a role.
	SearchSecurityGroups	Searches security groups by resolved names.
	SearchUserAccounts(String)	Searches user accounts by resolved names with no limit on total returned records.
	SearchUserAccounts(String, Int32)	Searches user accounts by resolved names limited to the specified number of records.
	SIDToAccountName	Gets account name for a given SID.
	ToString	Returns a string that represents the current object. (Inherited from Object)
	UpdateSecurityGroup	Updates security group.
	UpdateUserAccount	Updates user account.
	UserIsInRole	Determines if user is in role based on database ID values.
	UserNameToSID	Gets SID for a given user name.

Top

Fields

	Name	Description
	DefaultNodeID	Gets current default Node ID for security.

Top

Extension Methods

	Name	Description
	GetEnumValueOrDefault	Gets the enumeration constant for value, if defined in the enumeration, or a default value. (Defined by EnumExtensions)
	GetEnumValueOrDefaultT	Gets the enumeration constant for this value, if defined in the enumeration, or a default value. (Defined by EnumExtensions)

Top

Reference

GSF.Web.Security Namespace