.signin()

Signs in to a root, namespace, database or scope user.

Method Syntax
async db.signin({`{ ... }`})

Arguments

Example usage

// Authenticate with a root user
const token = await db.signin({
	username: 'root',
	password: 'surrealdb',
});

// Authenticate with a Namespace user
const token = await db.signin({
	namespace: 'surrealdb',
	username: 'tobie',
	password: 'surrealdb',
});

// Authenticate with a Database user
const token = await db.signin({
	namespace: 'surrealdb',
	database: 'docs',
	username: 'tobie',
	password: 'surrealdb',
});

// Authenticate with Record Access
const token = await db.signin({
	namespace: 'surrealdb',
	database: 'docs',
	access: 'user',

    // Also pass any properties required by the access definition
	variables: {
    	email: 'info@surrealdb.com',
    	pass: '123456',
    },
});

// Authenticate with Scopes
const token = await db.signin({
	namespace: 'surrealdb',
	database: 'docs',
	scope: 'user',

	// Also pass any properties required by the scope definition
	email: 'info@surrealdb.com',
	pass: '123456',
});

You can invalidate the authentication for the current connection using the invalidate() method. Learn more about handling authentication.