@valon-technologies/gestalt
Preparing search index...
index
AuthenticationProviderOptions
Interface AuthenticationProviderOptions
Runtime hooks required to implement a Gestalt authentication provider.
interface
AuthenticationProviderOptions
{
authorize
:
(
request
:
AuthorizeRequest
,
)
=>
MaybePromise
<
AuthorizeResponse
>
;
token
:
(
request
:
TokenRequest
)
=>
MaybePromise
<
TokenResponse
>
;
introspect
:
(
request
:
IntrospectRequest
,
)
=>
MaybePromise
<
IntrospectResponse
>
;
listGrants
:
(
request
:
Record
<
string
,
never
>
,
call
:
AuthCallContext
,
)
=>
MaybePromise
<
{
grantIds
:
string
[]
}
>
;
getGrant
:
(
request
:
{
grantId
:
string
}
,
call
:
AuthCallContext
,
)
=>
MaybePromise
<
GrantDetails
>
;
revokeGrant
:
(
request
:
{
grantId
:
string
}
,
call
:
AuthCallContext
,
)
=>
MaybePromise
<
void
>
;
name
?:
string
;
displayName
?:
string
;
description
?:
string
;
version
?:
string
;
configure
?:
ConfigureHandler
;
healthCheck
?:
HealthCheckHandler
;
warnings
?:
string
[]
|
WarningsHandler
;
start
?:
StartHandler
;
close
?:
CloseHandler
;
}
Hierarchy (
View Summary
)
ProviderBaseOptions
AuthenticationProviderOptions
Index
Properties
authorize
token
introspect
list
Grants
get
Grant
revoke
Grant
name?
display
Name?
description?
version?
configure?
health
Check?
warnings?
start?
close?
Properties
authorize
authorize
:
(
request
:
AuthorizeRequest
)
=>
MaybePromise
<
AuthorizeResponse
>
token
token
:
(
request
:
TokenRequest
)
=>
MaybePromise
<
TokenResponse
>
introspect
introspect
:
(
request
:
IntrospectRequest
)
=>
MaybePromise
<
IntrospectResponse
>
list
Grants
listGrants
:
(
request
:
Record
<
string
,
never
>
,
call
:
AuthCallContext
,
)
=>
MaybePromise
<
{
grantIds
:
string
[]
}
>
get
Grant
getGrant
:
(
request
:
{
grantId
:
string
}
,
call
:
AuthCallContext
,
)
=>
MaybePromise
<
GrantDetails
>
revoke
Grant
revokeGrant
:
(
request
:
{
grantId
:
string
}
,
call
:
AuthCallContext
,
)
=>
MaybePromise
<
void
>
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
Theme
OS
Light
Dark
On This Page
Properties
authorize
token
introspect
list
Grants
get
Grant
revoke
Grant
name
display
Name
description
version
configure
health
Check
warnings
start
close
@valon-technologies/gestalt
Loading...
Runtime hooks required to implement a Gestalt authentication provider.