Interface AuthCustomizer<S>
S extends SchemaTypeDefinition = AnySchemaTypeDefinition,
> {
isAllowedToLogin?: (
params: IsAllowedToLoginParameters<S>,
) => MaybePromise<null | LoginDeniedInfo>;
lookupUsername?: (
params: LookupUsernameParameters<S>,
) => MaybePromise<null | number>;
onFrontendIdToken?: (
params: FrontendRequestParameters<S>,
payload: JWTPayload,
) => MaybePromise<void>;
onFrontendUserInfo?: (
params: FrontendRequestParameters<S>,
) => MaybePromise<object>;
onOpenIdReturn?: (
params: OpenIdRequestParameters<S>,
) => MaybePromise<null | NavigateInstruction>;
onOpenIdToken?: (
params: OpenIdRequestParameters<S>,
payload: JWTPayload,
) => MaybePromise<void>;
onOpenIdUserInfo?: (
params: OpenIdRequestParameters<S>,
userinfo: ReportedUserInfo,
) => MaybePromise<void>;
processOpenIdAuth?: (
params: OpenIdAuthenticationParameters<S>,
) => MaybePromise<null | number | NavigateInstruction | LoginDeniedInfo>;
}
Type Parameters
- S extends SchemaTypeDefinition = AnySchemaTypeDefinition
Properties
Optionalis
params: IsAllowedToLoginParameters<S>,
) => MaybePromise<null | LoginDeniedInfo>
Optionallookup
Invoked to look up a login name. Override to modify how accounts are mapped to IDs or to do just-in-time account creation
Optionalon
params: FrontendRequestParameters<S>,
payload: JWTPayload,
) => MaybePromise<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
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
params: OpenIdRequestParameters<S>,
userinfo: ReportedUserInfo,
) => MaybePromise<void>
Invoked when the /userinfo endpoint is requested. Allows you to add or modify the returned fields
Optionalprocess
params: OpenIdAuthenticationParameters<S>,
) => MaybePromise<null | number | NavigateInstruction | LoginDeniedInfo>
Invoked to handle incoming OIDC authentication. Override to modify how OIDC accounts are mapped or to do just-in-time account creation. Invoked before the loginfield is checked and before lookupUsername is invoked
Type declaration
- (
params: OpenIdAuthenticationParameters<S>,
): MaybePromise<null | number | NavigateInstruction | LoginDeniedInfo> Parameters
- params: OpenIdAuthenticationParameters<S>
Returns MaybePromise<null | number | NavigateInstruction | LoginDeniedInfo>
User ID to directly log in this user, null to attempt to login using the username in the token or a NavigateInstruction or LoginDeniedInfo for immediate handling or rejection
- (
Invoked to verify whether a user is allowed to login