Interface: CallbacksOptions<P, A>
index.CallbacksOptions
Type parameters
| Name | Type |
|---|---|
P | Profile |
A | Account |
Properties
jwt
• jwt: (params: { token: JWT ; account?: null | A ; isNewUser?: boolean ; profile?: P ; user?: User | AdapterUser }) => Awaitable<JWT>
Type declaration
▸ (params): Awaitable<JWT>
This callback is called whenever a JSON Web Token is created (i.e. at sign in)
or updated (i.e whenever a session is accessed in the client).
Its content is forwarded to the session callback,
where you can control what should be returned to the client.
Anything else will be kept from your front-end.
⚠ By default the JWT is signed, but not encrypted.
Documentation |
session callback
Parameters
| Name | Type |
|---|---|
params | Object |
params.token | JWT |
params.account? | null | A |
params.isNewUser? | boolean |
params.profile? | P |
params.user? | User | AdapterUser |
Returns
Awaitable<JWT>
redirect
• redirect: (params: { baseUrl: string ; url: string }) => Awaitable<string>
Type declaration
▸ (params): Awaitable<string>
This callback is called anytime the user is redirected to a callback URL (e.g. on signin or signout). By default only URLs on the same URL as the site are allowed, you can use this callback to customise that behaviour.
Parameters
| Name | Type | Description |
|---|---|---|
params | Object | - |
params.baseUrl | string | Default base URL of site (can be used as fallback) |
params.url | string | URL provided as callback URL by the client |
Returns
Awaitable<string>
session
• session: (params: { session: Session ; token: JWT ; user: User | AdapterUser }) => Awaitable<Session>
Type declaration
▸ (params): Awaitable<Session>
This callback is called whenever a session is checked.
(Eg.: invoking the /api/session endpoint, using useSession or getSession)
⚠ By default, only a subset (email, name, image) of the token is returned for increased security.
If you want to make something available you added to the token through the jwt callback,
you have to explicitly forward it here to make it available to the client.
Documentation |
jwt callback |
useSession |
getSession |
Parameters
| Name | Type |
|---|---|
params | Object |
params.session | Session |
params.token | JWT |
params.user | User | AdapterUser |
Returns
Awaitable<Session>
signIn
• signIn: (params: { account: null | A ; user: User | AdapterUser ; credentials?: Record<string, CredentialInput> ; email?: { verificationRequest?: boolean } ; profile?: P }) => Awaitable<string | boolean>
Type declaration
▸ (params): Awaitable<string | boolean>
Use this callback to control if a user is allowed to sign in. Returning true will continue the sign-in flow. Throwing an error or returning a string will stop the flow, and redirect the user.
Parameters
| Name | Type | Description |
|---|---|---|
params | Object | - |
params.account | null | A | - |
params.user | User | AdapterUser | - |
params.credentials? | Record<string, CredentialInput> | If Credentials provider is used, it contains the user credentials |
params.email? | Object | If Email provider is used, on the first call, it contains a verificationRequest: true property to indicate it is being triggered in the verification request flow. When the callback is invoked after a user has clicked on a sign in link, this property will not be present. You can check for the verificationRequest property to avoid sending emails to addresses or domains on a blocklist or to only explicitly generate them for email address in an allow list. |
params.email.verificationRequest? | boolean | - |
params.profile? | P | If OAuth provider is used, it contains the full OAuth profile returned by your provider. |
Returns
Awaitable<string | boolean>