auth-go

KO | EN

gitlite — search

#javascript #python #hacktoberfest #react #ai #typescript #llm #go #golang #android #machine-learning #rust #deep-learning #linux

(★ 61)

A Golang client library for the Supabase Auth API.

auth-go Latest Version Download

Download Latest Version (.zip)

// repository documentation

Was this content helpful?

★ 0 (0 ratings)

# auth-go

![example branch parameter](https://github.com/supabase-community/auth-go/actions/workflows/test.yaml/badge.svg?branch=main)
[![codecov](https://codecov.io/gh/supabase-community/auth-go/branch/main/graph/badge.svg?token=JQQJKETMRX)](https://codecov.io/gh/supabase-community/auth-go)
![GitHub](https://img.shields.io/github/license/supabase-community/auth-go)
[![Go Reference](https://pkg.go.dev/badge/github.com/supabase-community/auth-go.svg)](https://pkg.go.dev/github.com/supabase-community/auth-go)

A Golang client library for the [Supabase Auth](https://github.com/supabase/auth) API.

For more information about the Supabase fork of GoTrue, [check out the project here](https://github.com/supabase/auth).

## Project status

This library is a pre-release work in progress. It has not been thoroughly tested, and the API may be subject to breaking changes, and so it should not be used in production.

The endpoints for SSO SAML are not tested and `POST /sso/saml/acs` does not provide request and response types. If you need additional support for SSO SAML, please create an issue or a pull request.

## Quick start

### Install

```sh
go get github.com/supabase-community/auth-go
```

### Usage

```go
package main

import (
    "github.com/supabase-community/auth-go"
    "github.com/supabase-community/auth-go/types"
)

const (
    projectReference = "<your_supabase_project_reference>"
    apiKey = "<your_supabase_anon_key>"
)

func main() {
    // Initialise client
    client := auth.New(
        projectReference,
        apiKey,
    )

// Log in a user (get access and refresh tokens)
    resp, err := client.Token(types.TokenRequest{
        GrantType: "password",
        Email: "<user_email>",
        Password: "<user_password>",
    })
    if err != nil {
        log.Fatal(err.Error())
    }
    log.Printf("%+v", resp)
}
```

## Options

The client can be customized with the options below.

In all cases, **these functions return a copy of the client**. To use the configured value, you must use the returned client. For example:

```go
client := auth.New(
    projectRefernce,
    apiKey,
)

token, err := client.Token(types.TokenRequest{
        GrantType: "password",
        Email: email,
        Password: password,
})
if err != nil {
    // Handle error...
}

authedClient := client.WithToken(
    token.AccessToken,
)
user, err := authedClient.GetUser()
if err != nil {
    // Handle error...
}
```

### WithToken

```go
func (*Client) WithToken(token string) *Client
```

Returns a client that will use the provided token in the `Authorization` header on all requests.

### WithCustomAuthURL

```go
func (*Client) WithCustomAuthURL(url string) *Client
```

Returns a client that will use the provided URL instead of `https://<project_ref>.supabase.com/auth/v1/`. This allows you to use the client with your own deployment of the Auth server without relying on a Supabase-hosted project.

### WithClient

```go
func (*Client) WithClient(client http.Client) *Client
```

By default, the library uses a default http.Client. If you want to configure your own, pass one in using `WithClient` and it will be used for all requests made with the returned `*auth.Client`.

## Contributing

We welcome contributions! This project uses [Conventional Commits](https://www.conventionalcommits.org/) for clear and automated changelog generation.

### Commit Message Format

```
<type>(<scope>): <description>
```

**Types:**
- `feat`: New feature (triggers minor version bump)
- `fix`: Bug fix (triggers patch version bump)
- `docs`: Documentation changes
- `test`: Adding or updating tests
- `refactor`: Code refactoring
- `perf`: Performance improvements
- `chore`: Maintenance tasks

**Examples:**
```bash
feat: add retry logic with exponential backoff
fix(admin): handle pagination errors properly
docs: update README with examples
```

For more details, see [CONTRIBUTING.md](CONTRIBUTING.md).

## Testing

> You don't need to know this stuff to use the library

The library is tested against a real Auth server running in a docker image. This also requires a postgres server to back it. These are configured using docker compose.

To run these tests, simply `make test`.

To interact with docker compose, you can also use `make up` and `make down`.

## Differences from auth-js

Prior users of [`auth-js`](https://github.com/supabase/auth-js) may be familiar with its subscription mechanism and session management - in line with its ability to be used as a client-side authentication library, in addition to use on the server.

As Go is typically used on the backend, this library acts purely as a convenient wrapper for interacting with a Auth server. It provides no session management or subscription mechanism.

## Migrating from gotrue-go

This repository was created as a duplicate of [gotrue-go](https://github.com/supabase-community/gotrue-go).

As part of renaming the package, breaking changes to the API were also introduced, to keep consistency with the new naming. The changes can generally be boiled down to:

1. Rename instances of `gotrue-go` to `auth-go`
2. Rename instances of `GoTrue` to `Auth`

There are a small number of exceptions where required to maintain compatibility with the implementation of the Auth server. No other changes were introduced, so you should find the exact same functionality under a very similar name if updating your codebase from gotrue-go to auth-go.

auth-go

auth-go Latest Version Download

Today's picks

Was this content helpful?

Recent Feedback

auth-go

auth-go Latest Version Download

Today's picks

Was this content helpful?

Recent Feedback

Download README