ISecurityManager Authenticate Method (Credentials)NFX Class Library

[This is preliminary documentation and is subject to change.]

Authenticates user by checking the supplied credentials against the authentication store that this manager represents. If credential are invalid then UserKind.Invalid is returned. This method may populate user access rights completely or partially - depending on store implementation. If rights are computed on authentication than Authorize() just checks existing in-memory structure, otherwise Authorize() may re-fetch permissions from store on every call or cache them for the specified interval in memory

Namespace: NFX.Security
Assembly: NFX (in NFX.dll) Version: 3.0.0.1 (3.0.0.1)
Syntax

User Authenticate(
	Credentials credentials
)

Parameters

credentials
Type: NFX.Security Credentials
User credentials. Particular manager implementation may elect to support multiple credential types, i.e. IdPassword, Twitter, Facebook, OAuth, LegacySystemA/B/C etc.

Return Value

Type: User
User object. Check User.Status for UserStatus.Invalid flag to see if authentication succeeded
See Also