Anonymous

Create temporary anonymous sessions.

This page documents the current Ruby port behavior. Ruby uses snake_case option names and auth.api method names; HTTP paths and JSON keys keep the upstream wire shape where implemented.

Configure

config/auth.rb
require "better_auth"

auth = BetterAuth.auth(
  secret: ENV.fetch("BETTER_AUTH_SECRET"),
  base_url: ENV.fetch("BETTER_AUTH_URL", "http://localhost:3000"),
  plugins: [
    BetterAuth::Plugins.anonymous
  ]
)

Usage

server.rb
status, headers, body = auth.api.sign_in_anonymous(as_response: true)
cookie = headers.fetch("set-cookie")
session = auth.api.get_session(headers: { "cookie" => cookie })

Routes

MethodPathRuby API method
POST/sign-in/anonymousauth.api.sign_in_anonymous
POST/delete-anonymous-userauth.api.delete_anonymous_user

Options

Current Ruby options accepted by BetterAuth::Plugins.anonymous:

  • disable_delete_anonymous_user
  • generate_random_email
  • email_domain_name
  • generate_name
  • on_link_account

Support Notes

  • The examples above are based on Ruby plugin source and tests in packages/better_auth.
  • If an upstream section is not represented here, treat it as not yet documented or not yet supported by the Ruby port until the matching Ruby implementation exists.
Edit on GitHub

Previous Page

Username

Next Page

Phone Number

On this page