static/jsvm/interfaces/core.collectionAuthOptions.html
collectionAuthOptions defines the options for the "auth" type collection.
authAlertauthRule?authTokenconfirmEmailChangeTemplateemailChangeTokenfileTokenmanageRule?mfaoauth2otppasswordAuthpasswordResetTokenresetPasswordTemplateverificationTemplateverificationToken
authAlert: AuthAlertConfig
AuthAlert defines options related to the auth alerts on new device login.
Optional authRuleauthRule?: string
AuthRule could be used to specify additional record constraints applied after record authentication and right before returning the auth token response to the client.
For example, to allow only verified users you could set it to "verified = true".
Set it to empty string to allow any Auth collection record to authenticate.
Set it to nil to disallow authentication altogether for the collection (that includes password, OAuth2, etc.).
authToken: TokenConfig
confirmEmailChangeTemplate: EmailTemplate
emailChangeToken: TokenConfig
fileToken: TokenConfig
Optional manageRulemanageRule?: string
ManageRule gives admin-like permissions to allow fully managing the auth record(s), eg. changing the password without requiring to enter the old one, directly updating the verified state and email, etc.
This rule is executed in addition to the Create and Update API rules.
mfa: MFAConfig
MFA defines options related to the Multi-factor authentication (MFA).
oauth2: OAuth2Config
OAuth2 specifies whether OAuth2 auth is enabled for the collection and which OAuth2 providers are allowed.
otp: OTPConfig
OTP defines options related to the One-time password authentication (OTP).
passwordAuth: PasswordAuthConfig
PasswordAuth defines options related to the collection password authentication.
passwordResetToken: TokenConfig
resetPasswordTemplate: EmailTemplate
verificationTemplate: EmailTemplate
verificationToken: TokenConfig
OSLightDark
Generated using TypeDoc