@valon-technologies/gestalt
Preparing search index...
@valon-technologies/gestalt
AuthenticationProviderOptions
Interface AuthenticationProviderOptions
Runtime hooks required to implement a Gestalt authentication provider.
interface
AuthenticationProviderOptions
{
beginLogin
:
(
request
:
BeginLoginRequest
,
)
=>
MaybePromise
<
BeginLoginResponse
>
;
completeLogin
:
(
request
:
CompleteLoginRequest
,
)
=>
MaybePromise
<
AuthenticatedUser
>
;
validateExternalToken
?:
(
token
:
string
,
)
=>
MaybePromise
<
AuthenticatedUser
|
null
|
undefined
>
;
sessionSettings
?:
()
=>
MaybePromise
<
AuthenticationSessionSettings
>
;
name
?:
string
;
displayName
?:
string
;
description
?:
string
;
version
?:
string
;
configure
?:
ConfigureHandler
;
healthCheck
?:
HealthCheckHandler
;
warnings
?:
string
[]
|
WarningsHandler
;
start
?:
StartHandler
;
close
?:
CloseHandler
;
}
Hierarchy (
View Summary
)
RuntimeProviderOptions
AuthenticationProviderOptions
Index
Properties
begin
Login
complete
Login
validate
External
Token?
session
Settings?
name?
display
Name?
description?
version?
configure?
health
Check?
warnings?
start?
close?
Properties
begin
Login
beginLogin
:
(
request
:
BeginLoginRequest
)
=>
MaybePromise
<
BeginLoginResponse
>
complete
Login
completeLogin
:
(
request
:
CompleteLoginRequest
,
)
=>
MaybePromise
<
AuthenticatedUser
>
Optional
validate
External
Token
validateExternalToken
?:
(
token
:
string
,
)
=>
MaybePromise
<
AuthenticatedUser
|
null
|
undefined
>
Optional
session
Settings
sessionSettings
?:
()
=>
MaybePromise
<
AuthenticationSessionSettings
>
Optional
name
name
?:
string
Optional
display
Name
displayName
?:
string
Optional
description
description
?:
string
Optional
version
version
?:
string
Optional
configure
configure
?:
ConfigureHandler
Optional
health
Check
healthCheck
?:
HealthCheckHandler
Optional
warnings
warnings
?:
string
[]
|
WarningsHandler
Optional
start
start
?:
StartHandler
Optional
close
close
?:
CloseHandler
Settings
Member Visibility
Inherited
External
Theme
OS
Light
Dark
On This Page
Properties
begin
Login
complete
Login
validate
External
Token
session
Settings
name
display
Name
description
version
configure
health
Check
warnings
start
close
@valon-technologies/gestalt
Loading...
Runtime hooks required to implement a Gestalt authentication provider.