Corbado Go SDK

The Corbado Go SDK provides convenient access to the Corbado Backend API from applications written in the Go language.

⚠️ The Corbado Go SDK is commonly referred to as a private client, specifically designed for usage within closed backend applications. This particular SDK should exclusively be utilized in such environments, as it is crucial to ensure that the API secret remains strictly confidential and is never shared.

🚀 Getting started | 🛠️ Services | 📚 Advanced | 💬 Support & Feedback

🚀 Getting started

Requirements

• Go 1.18 or later

Installation

Use the following command to install the Corbado Go SDK:

go get github.com/corbado/corbado-go@v1.0.3

Usage

To create a Corbado Go SDK instance you need to provide your Project ID and API secret which can be found at the Developer Panel.

package main

import (
    "github.com/corbado/corbado-go"
)

func main() {
    config, err := corbado.NewConfig("<Project ID>", "<API secret>")
    if err != nil {
        panic(err)
    }

    sdk, err := corbado.NewSDK(config)
    if err != nil {
        panic(err)
    }
}

Examples

A list of examples can be found in the examples directory. Integration tests are good examples as well.

🛠️ Services

The Corbado Go SDK provides the following services:

• AuthTokens for managing authentication tokens needed for own session management (examples)
• EmailMagicLinks for managing email magic links (examples)
• EmailOTPs for managing email OTPs (examples)
• Sessions for managing sessions (examples)
• SmsOTPs for managing SMS OTPs (examples)
• Users for managing users (examples)
• Validations for validating email addresses and phone numbers (examples)

To use a specific service, such as Users, invoke it as shown below:

users, err := sdk.Users().List(context.Background(), nil)
if err != nil {
    panic(err)
}

📚 Advanced

Error handling

The Corbado Go SDK uses Go standard error handling (error interface). If the Backend API returns a HTTP status code other than 200, the Corbado Go SDK returns a ServerError error (which implements the error interface):

package main

import (
    "context"
    "fmt"

    "github.com/corbado/corbado-go"
)

func main() {
    config, err := corbado.NewConfig("<Project ID>", "<API secret>")
    if err != nil {
        panic(err)
    }

    sdk, err := corbado.NewSDK(config)
    if err != nil {
        panic(err)
    }

    // Try to get non-existing user with ID 'usr-123456789'
    user, err := sdk.Users().Get(context.Background(), "usr-123456789", nil)
    if err != nil {
        if serverErr := corbado.AsServerError(err); serverErr != nil {
            // Show HTTP status code (404 in this case)
            fmt.Println(serverErr.HTTPStatusCode)

            // Show request ID (can be used in developer panel to look up the full request
            // and response, see https://app.corbado.com/app/logs/requests)
            fmt.Println(serverErr.RequestData.RequestID)

            // Show runtime of request in seconds (server side)
            fmt.Println(serverErr.Runtime)

            // Show validation error messages (server side validation in case of HTTP
            // status code 400 (Bad Request))
            fmt.Printf("%+v\n", serverErr.Validation)
        } else {
            // Handle other errors
            panic(err)
        }

        return
    }

    fmt.Println(user.Data.ID)
}

💬 Support & Feedback

Report an issue

If you encounter any bugs or have suggestions, please open an issue.

Slack channel

Join our Slack channel to discuss questions or ideas with the Corbado team and other developers.

Email

You can also reach out to us via email at vincent.delitz@corbado.com.

Vulnerability reporting

Please report suspected security vulnerabilities in private to security@corbado.com. Please do NOT create publicly viewable issues for suspected security vulnerabilities.