Interface AuthCustomizer<S>
interface AuthCustomizer<
S extends SchemaTypeDefinition = AnySchemaTypeDefinition,
> {
isAllowedToLogin?: (
params: IsAllowedToLoginParameters<S>,
) => null | LoginDeniedInfo | Promise<null | LoginDeniedInfo>;
lookupUsername?: (
params: LookupUsernameParameters<S>,
) => null | number | Promise<null | number>;
onFrontendIdToken?: (
params: FrontendRequestParameters<S>,
payload: JWTPayload,
) => void | Promise<void>;
onFrontendUserInfo?: (
params: FrontendRequestParameters<S>,
) => object | Promise<object>;
onOpenIdReturn?: (
params: OpenIdRequestParameters<S>,
) => null | NavigateInstruction | Promise<(NavigateInstruction | null)>;
onOpenIdToken?: (
params: OpenIdRequestParameters<S>,
payload: JWTPayload,
) => void | Promise<void>;
onOpenIdUserInfo?: (
params: OpenIdRequestParameters<S>,
userinfo: ReportedUserInfo,
) => void | Promise<void>;
}
S extends SchemaTypeDefinition = AnySchemaTypeDefinition,
> {
isAllowedToLogin?: (
params: IsAllowedToLoginParameters<S>,
) => null | LoginDeniedInfo | Promise<null | LoginDeniedInfo>;
lookupUsername?: (
params: LookupUsernameParameters<S>,
) => null | number | Promise<null | number>;
onFrontendIdToken?: (
params: FrontendRequestParameters<S>,
payload: JWTPayload,
) => void | Promise<void>;
onFrontendUserInfo?: (
params: FrontendRequestParameters<S>,
) => object | Promise<object>;
onOpenIdReturn?: (
params: OpenIdRequestParameters<S>,
) => null | NavigateInstruction | Promise<(NavigateInstruction | null)>;
onOpenIdToken?: (
params: OpenIdRequestParameters<S>,
payload: JWTPayload,
) => void | Promise<void>;
onOpenIdUserInfo?: (
params: OpenIdRequestParameters<S>,
userinfo: ReportedUserInfo,
) => void | Promise<void>;
}
Type Parameters
- S extends SchemaTypeDefinition = AnySchemaTypeDefinition
Properties
Optionalis
isAllowedToLogin?: (
params: IsAllowedToLoginParameters<S>,
) => null | LoginDeniedInfo | Promise<null | LoginDeniedInfo>
params: IsAllowedToLoginParameters<S>,
) => null | LoginDeniedInfo | Promise<null | LoginDeniedInfo>
Optionallookup
Invoked to look up a login name
Optionalon
onFrontendIdToken?: (
params: FrontendRequestParameters<S>,
payload: JWTPayload,
) => void | Promise<void>
params: FrontendRequestParameters<S>,
payload: JWTPayload,
) => void | Promise<void>
Invoked when creating an access token. Allows you to add or modify claims before it's signed
Optionalon
Invoked when the user logged in to the frontend, returned to clientside JavaScript
Optionalon
onOpenIdReturn?: (
params: OpenIdRequestParameters<S>,
) => null | NavigateInstruction | Promise<(NavigateInstruction | null)>
params: OpenIdRequestParameters<S>,
) => null | NavigateInstruction | Promise<(NavigateInstruction | null)>
Invoked after authenticating a user but before returning him to the openid client. Can be used to implement additional authorization and reject the user
Optionalon
Invoked when creating an OpenID Token for a third party. Allows you to add or modify claims before it's signed
Optionalon
onOpenIdUserInfo?: (
params: OpenIdRequestParameters<S>,
userinfo: ReportedUserInfo,
) => void | Promise<void>
params: OpenIdRequestParameters<S>,
userinfo: ReportedUserInfo,
) => void | Promise<void>
Invoked when the /userinfo endpoint is requested. Allows you to add or modify the returned fields
Invoked to verify whether a user is allowed to login