| AdminForthDataSource | Data source describes database connection which will be used to fetch data for resources. Each resource should use one data source. |
| AdminForthExpressSchemaInput | - |
| AdminForthMenuContributionProvider | - |
| AdminUserAuthorizationResult | Result of IAdminForthAuth.authorizeByCookies. Statuses are separated because caller decides how to answer: authenticated endpoints answer 401 on any non-ok status except verifyFailed (which is a server side problem and must not logout user), while noAuth endpoints just treat caller as anonymous. |
| AdminUserAuthorizeFunction | Allow to make extra authorization |
| AfterCreateSaveFunction | - |
| AfterDataSourceResponseFunction | Modify response to change how data is returned after fetching from database. Return ok: false and error: string to stop execution and show error message to user. Return ok: true to continue execution. |
| AfterDeleteSaveFunction | Modify record to change how data is saved to database. Return ok: false and error: string to stop execution and show error message to user. Return ok: true to continue execution. |
| AfterEditSaveFunction | - |
| AfterLoginFailedFunction | Called after password login attempt failed, right before AdminForth answers with 401. Not called for attempts blocked by auth.rateLimit. Useful to log failed attempts or to notify user about bruteforce of their account. |
| AfterSessionCreatedFunction | Called right after auth cookie with new session was issued, no matter which login method issued it (password login, OAuth, passkey, two-factor confirmation or any plugin which calls auth.setAuthCookie). Useful to persist sessions to revoke them later, or to log logins. |
| AgentResourceMeta | - |
| AgentToolMeta | - |
| AllowedActions | - |
| AllowedActionsInput | Object which describes allowed actions for user. |
| AllowedActionValue | Defines whether user has access to an action, can statically be Boolean or function which returns Boolean or string with error message |
| BackendOnlyInput | - |
| BeforeCreateSaveFunction | - |
| BeforeDataSourceRequestFunction | Modify query to change how data is fetched from database. Return ok: false and error: string to stop execution and show error message to user. Return ok: true to continue execution. |
| BeforeDeleteSaveFunction | Modify record to change how data is saved to database. Return ok: false and error: string to stop execution and show error message to user. Return ok: true to continue execution. |
| BeforeEditSaveFunction | - |
| BeforeLoginAttemptFunction | Allows to reject login attempt before AdminForth checks credentials in the database. Called on every call of login endpoint, even if username does not exist or password is wrong, so it is a right place for captcha and other anti-bruteforce checks: user gets the same response regardless of whether credentials were correct. |
| BeforeLoginConfirmationFunction | Allow to get user data before login confirmation, will triger when user try to login. |
| BeforeLogoutFunction | Called when user logs out, before AdminForth removes auth cookie. Useful for cleanup of things issued for the session (e.g. revoking tokens on external identity provider, removing custom cookies set by plugins) or for logging logout event. |
| CreateResourceRecordParams | Parameters for IAdminForth.createResourceRecord. |
| CreateResourceRecordResult | Result of IAdminForth.createResourceRecord. |
| DeleteResourceRecordParams | Parameters for IAdminForth.deleteResourceRecord. |
| DeleteResourceRecordResult | Result of IAdminForth.deleteResourceRecord. |
| ExpressErrorCallbackFunction | Callback called when an unhandled error is thrown inside an AdminForth API endpoint handler. Useful to report errors to external services (e.g. Sentry) or to do custom logging. Thrown errors / rejections from this callback are caught and logged, they do not affect the response. |
| FDataFilter | - |
| FDataSort | - |
| IAdminForthEndpointOptions | - |
| IGroupByRule | - |
| LoginFailureReason | Why password login attempt failed: - rejected: one of auth.beforeLoginAttempt hooks rejected the attempt, credentials were not checked - user_not_found: there is no user with such username - invalid_password: user exists, but password is wrong |
| OperationalResourceUserOptions | - |
| PeriodString | - |
| PeriodUnit | - |
| RateLimitString | - |
| ShowIn | - |
| ShowInInput | Object which describes on what pages should column be displayed on. |
| UpdateResourceRecordParams | Parameters for IAdminForth.updateResourceRecord. |
| UpdateResourceRecordResult | Result of IAdminForth.updateResourceRecord. |