Authentication (suave)

Authentication Module

Namespace: Suave
Assembly: Suave.dll

Nested modules

Modules	Description
HttpContext

Functions and values

Function or value	Description
`SessionAuthCookie` Full Usage: `SessionAuthCookie` Returns: `string`	Returns: `string`
`SessionIdLength` Full Usage: `SessionIdLength` Returns: `int`	Returns: `int`
`StateStoreType` Full Usage: `StateStoreType` Returns: `string`	The key used in `context.user_state` to save the session id for downstream web parts. Returns: `string`
`UserNameKey` Full Usage: `UserNameKey` Returns: `string`	The key of the username placed in the userState map if present in the request Returns: `string`
`authenticate relativeExpiry secure missingCookie decryptionFailure fSuccess` Full Usage: `authenticate relativeExpiry secure missingCookie decryptionFailure fSuccess` Parameters: relativeExpiry : `CookieLife` secure : `bool` missingCookie : `unit -> Choice<byte[], WebPart>` decryptionFailure : `SecretboxDecryptionError -> Choice<byte[], WebPart>` fSuccess : `WebPart` Returns: `WebPart`	relativeExpiry : `CookieLife` secure : `bool` missingCookie : `unit -> Choice<byte[], WebPart>` decryptionFailure : `SecretboxDecryptionError -> Choice<byte[], WebPart>` fSuccess : `WebPart` Returns: `WebPart`
`authenticateBasic f protectedPart` Full Usage: `authenticateBasic f protectedPart` Parameters: f : `string * string -> bool` protectedPart : `WebPart` Returns: `WebPart`	Perform basic authentication on the request, applying a predicate to check the request for authentication tokens such as 'username' and 'password'. Otherwise, if failing, challenge the client again. f : `string * string -> bool` protectedPart : `WebPart` Returns: `WebPart`
`authenticateBasicAsync f protectedPart` Full Usage: `authenticateBasicAsync f protectedPart` Parameters: f : `string * string -> Async<bool>` protectedPart : `WebPart` Returns: `WebPart`	Perform basic authentication on the request, applying an asynchronous predicate to check the request for authentication tokens such as 'username' and 'password'. Otherwise, if failing, challenge the client again. f : `string * string -> Async<bool>` protectedPart : `WebPart` Returns: `WebPart`
`authenticateWithLogin relativeExpiry loginPage fSuccess` Full Usage: `authenticateWithLogin relativeExpiry loginPage fSuccess` Parameters: relativeExpiry : `CookieLife` loginPage : `string` fSuccess : `WebPart` Returns: `WebPart`	relativeExpiry : `CookieLife` loginPage : `string` fSuccess : `WebPart` Returns: `WebPart`
`authenticated relativeExpiry secure` Full Usage: `authenticated relativeExpiry secure` Parameters: relativeExpiry : `CookieLife` secure : `bool` Returns: `WebPart`	Set server-signed cookies to make the response contain a cookie with a valid session id. It's worth having in mind that when you use this web part, you're setting cookies on the response; so you'll need to have the client re-send a request if you require authentication for it, after this web part has run. Parameters: - `relativeExpiry`: how long does the authentication cookie last? - `secure`: HttpsOnly? Always succeeds. relativeExpiry : `CookieLife` secure : `bool` Returns: `WebPart`
`deauthenticate` Full Usage: `deauthenticate` Returns: `WebPart`	Deauthenticates, or 'logs out' the user Returns: `WebPart`
`deauthenticateWithLogin loginPage` Full Usage: `deauthenticateWithLogin loginPage` Parameters: loginPage : `string` Returns: `WebPart`	Deauthenticates the user and then sends them to path specified by loginPage string loginPage : `string` Returns: `WebPart`