Opensearch dashboards.authtoolkit
Home > opensearch-dashboards > AuthToolkit
AuthToolkit interface
A tool set defining an outcome of Auth interceptor for incoming request.
Signature:
export interface AuthToolkit
Properties
| Property | Type | Description |
|---|---|---|
| authenticated | (data?: AuthResultParams) => AuthResult | Authentication is successful with given credentials, allow request to pass through |
| notHandled | () => AuthResult | User has no credentials. Allows user to access a resource when authRequired: 'optional' Rejects a request when authRequired: true |
| redirected | (headers: { location: string; } & ResponseHeaders) => AuthResult | Redirects user to another location to complete authentication when authRequired: true Allows user to access a resource without redirection when authRequired: 'optional' |