Skip to content

AuthSettingsManager

Authentication Settings Manager

Manages global authentication settings including password requirements, session timeouts, and signup configuration.

const authSettings = client.admin.authSettings
// Get current settings
const settings = await authSettings.get()
// Update settings
await authSettings.update({
password_min_length: 12,
password_require_uppercase: true,
session_timeout_minutes: 120
})

new AuthSettingsManager(fetch): AuthSettingsManager

ParameterType
fetchFluxbaseFetch

AuthSettingsManager

get(): Promise<AuthSettings>

Get current authentication settings

Retrieves all authentication configuration settings.

Promise<AuthSettings>

Promise resolving to AuthSettings

const settings = await client.admin.authSettings.get()
console.log('Password min length:', settings.password_min_length)
console.log('Signup enabled:', settings.enable_signup)
console.log('Session timeout:', settings.session_timeout_minutes, 'minutes')

update(request): Promise<UpdateAuthSettingsResponse>

Update authentication settings

Updates one or more authentication settings. All fields are optional - only provided fields will be updated.

ParameterTypeDescription
requestUpdateAuthSettingsRequestSettings to update

Promise<UpdateAuthSettingsResponse>

Promise resolving to UpdateAuthSettingsResponse

// Strengthen password requirements
await client.admin.authSettings.update({
password_min_length: 16,
password_require_uppercase: true,
password_require_lowercase: true,
password_require_number: true,
password_require_special: true
})
// Extend session timeout
await client.admin.authSettings.update({
session_timeout_minutes: 240,
max_sessions_per_user: 10
})
// Disable email verification during development
await client.admin.authSettings.update({
require_email_verification: false
})