ISecurityProvider Interface

Defines a provider of role-based security in applications.

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

Syntax

C++

JavaScript

Copy

public interface ISecurityProvider : IPersistSettings

Public Interface ISecurityProvider
	Inherits IPersistSettings

public interface class ISecurityProvider : IPersistSettings

type ISecurityProvider = 
    interface
        interface IPersistSettings
    end

GSF.Security.ISecurityProvider = function();
GSF.Security.ISecurityProvider.createInterface('GSF.Security.ISecurityProvider');

View Source

The ISecurityProvider type exposes the following members.

Properties

	Name	Description
	ApplicationName	Gets or sets the name of the application being secured as defined in the backend security data store.
	AuthenticationFailureReason	Gets an authentication failure reason, if set by the provider when authentication fails.
	CanChangePassword	Gets a boolean value that indicates whether ChangePassword(String, String) operation is supported.
	CanRefreshData	Gets a boolean value that indicates whether RefreshData operation is supported.
	CanResetPassword	Gets a boolean value that indicates whether ResetPassword(String) operation is supported.
	ConnectionString	Gets or sets the connection string to be used for connection to the backend security data store.
	IsRedirectRequested	Gets the flag that indicates whether the user needs to be redirected after the Authentication attempt. Could be used for asking Users to confirm Messages etc.
	IsUserAuthenticated	Gets the flag that indicates whether the user was authenticated during the last authentication attempt.
	LogEvent	Gets or sets the LogEventFunctionSignature to use for logging security events for the SecurityProviderBase implementation.
	PassthroughPrincipal	Gets or sets the principal used for passthrough authentication.
	Password	Gets or sets SecurePassword as clear text password.
	PersistSettings	Determines whether the object settings are to be persisted to the config file. (Inherited from IPersistSettings)
	RequestedRedirect	Gets the URI that user will be redirected to if IsRedirectRequested is set.
	SecurePassword	Gets or sets the password as a SecureString.
	SettingsCategory	Gets or sets the category name under which the object settings are persisted in the config file. (Inherited from IPersistSettings)
	UserData	Gets the UserData object containing information about the user.

Top

Methods

	Name	Description
	Authenticate	Authenticates the user.
	ChangePassword	Changes user password in the backend data store.
	GetUserRoles	Gets a list of Roles for this user for a specified ApplicationId.
	LoadSettings	Loads saved settings from the config file. (Inherited from IPersistSettings)
	RefreshData	Refreshes the UserData from the backend data store.
	ResetPassword	Resets user password in the backend data store.
	SaveSettings	Saves settings to the config file. (Inherited from IPersistSettings)
	TranslateRedirect	Performs a translation of the default login page to a different endpoint.
	TranslateRole	Performs a translation of the specified user role.

Top

Reference

GSF.Security Namespace