SuperTokens Golang SDK

When using verifySession in optional mode (SessionRequired: false), you can access the SessionContainer object within your API handlers to check for an active session.

Because the session is optional, you must check if the SessionContainer object is nil before attempting to use it. If it is not nil, you can retrieve information such as the userId or session data, or perform actions like revoking the session.

// Conceptual pattern for checking session in an API handler
if sessionContainer != nil {
    // Access userId or session data
    userId := sessionContainer.UserId
    // Or revoke session
}

To use the Session recipe, you must initialize it using the Init function. This returns a supertokens.Recipe instance that must be part of your SuperTokens configuration.

import "github.com/supertokens/supertokens-golang/recipe/session"
import "github.com/supertokens/supertokens-golang/recipe/session/sessmodels"

// Inside your SuperTokens initialization
session.Init(&sessmodels.TypeInput{
    // configuration options here
})

Use Init to register the Email Verification recipe with your SuperTokens instance. It requires a configuration object of type evmodels.TypeInput.

import "github.com/supertokens/supertokens-golang/recipe/emailverification"

// config should be of type evmodels.TypeInput
emailVerificationRecipe := emailverification.Init(config)

func Init(config evmodels.TypeInput) supertokens.Recipe

To use the Passwordless recipe, call Init with a configuration object of type plessmodels.TypeInput. This returns a supertokens.Recipe instance that must be registered during the SuperTokens initialization process.

import "github.com/supertokens/supertokens-golang/recipe/passwordless"

// ... inside your SuperTokens initialization
passwordless.Init(plessmodels.TypeInput{
    // configuration options here
})

To run the demonstration server that integrates the go-zero framework with SuperTokens, use the standard Go run command from the root of the example directory.

go run main.go

This example demonstrates how to integrate the Gorilla Mux router with the SuperTokens Golang SDK. It provides a template for setting up authentication and session management within a Gorilla Mux-based web server.

go run main.go

To execute the example server demonstrating the integration between Go-Chi and SuperTokens, navigate to the example directory and use the Go CLI to run the main entry point.

go run main.go

To run the example demonstrating how to integrate Labstack Echo with SuperTokens, navigate to the example directory and use the Go CLI to execute the main entry point.

go run main.go

This example demonstrates how to integrate the SuperTokens Golang SDK with the Fiber web framework. To run the provided integration example, navigate to the directory and use the Go CLI.

go run main.go

This example demonstrates how to combine SuperTokens with Oso (an authorization framework) within a Go application using the go-chi router. It provides a pattern for managing access rights alongside SuperTokens authentication.

Note: The example uses a file database/database.go which contains pre-configured emails with different access rights (sourced from the Oso quickstarter) to facilitate testing authorization logic.

go run main.go