auth0

README

📚 Documentation • 🚀 Getting Started • 💬 Feedback

---

Documentation

• Godoc - explore the Go SDK documentation.
• Docs site — explore our docs site and learn more about Auth0.
• Examples - Further examples around usage of the SDK.

Getting started

Requirements

This library follows the same support policy as Go. The last two major Go releases are actively supported and compatibility issues will be fixed. While you may find that older versions of Go may work, we will not actively test and fix compatibility issues with these versions.

• Go 1.21+

Installation

go get github.com/auth0/go-auth0

Usage

Authentication API Client

The Authentication API client is based on the Authentication API docs.

Create an Authentication API client by providing the details of your Auth0 Application.

package main

import (
	"context"
	"log"

	"github.com/auth0/go-auth0/authentication"
	"github.com/auth0/go-auth0/authentication/database"
	"github.com/auth0/go-auth0/authentication/oauth"
)

func main() {
	// Get these from your Auth0 Application Dashboard.
	domain := "example.us.auth0.com"
	clientID := "EXAMPLE_16L9d34h0qe4NVE6SaHxZEid"
	clientSecret := "EXAMPLE_XSQGmnt8JdXs23407hrK6XXXXXXX"

	// Initialize a new client using a domain, client ID and client secret.
	authAPI, err := authentication.New(
		context.TODO(), // Replace with a Context that better suits your usage
		domain,
		authentication.WithClientID(clientID),
		authentication.WithClientSecret(clientSecret), // Optional depending on the grants used
	)
	if err != nil {
		log.Fatalf("failed to initialize the auth0 authentication API client: %+v", err)
	}

	// Now we can interact with the Auth0 Authentication API.
	// Sign up a user
	userData := database.SignupRequest{
		Connection: "Username-Password-Authentication",
		Username:   "mytestaccount",
		Password:   "mypassword",
		Email:      "mytestaccount@example.com",
	}

	createdUser, err := authAPI.Database.Signup(context.Background(), userData)
	if err != nil {
		log.Fatalf("failed to sign user up: %+v", err)
	}

	// Login using OAuth grants
	tokenSet, err := authAPI.OAuth.LoginWithAuthCodeWithPKCE(context.Background(), oauth.LoginWithAuthCodeWithPKCERequest{
		Code:         "test-code",
		CodeVerifier: "test-code-verifier",
	}, oauth.IDTokenValidationOptions{})
	if err != nil {
		log.Fatalf("failed to retrieve tokens: %+v", err)
	}
}

Note The context package can be used to pass cancellation signals and deadlines to the Client for handling a request. If there is no context available then context.Background() can be used.

Management API Client

The Management API client is based on the Management API docs.

package main

import (
	"context"
	"log"

	"github.com/auth0/go-auth0"
	"github.com/auth0/go-auth0/management"
)

func main() {
	// Get these from your Auth0 Application Dashboard.
	// The application needs to be a Machine To Machine authorized
	// to request access tokens for the Auth0 Management API,
	// with the desired permissions (scopes).
	domain := "example.auth0.com"
	clientID := "EXAMPLE_16L9d34h0qe4NVE6SaHxZEid"
	clientSecret := "EXAMPLE_XSQGmnt8JdXs23407hrK6XXXXXXX"

	// Initialize a new client using a domain, client ID and client secret.
	// Alternatively you can specify an access token:
	// `management.WithStaticToken("token")`
	auth0API, err := management.New(
		domain,
		management.WithClientCredentials(context.TODO(), clientID, clientSecret),  // Replace with a Context that better suits your usage
	)
	if err != nil {
		log.Fatalf("failed to initialize the auth0 management API client: %+v", err)
	}

	// Now we can interact with the Auth0 Management API.
	// Example: Creating a new client.
	client := &management.Client{
		Name:        auth0.String("My Client"),
		Description: auth0.String("Client created through the Go SDK"),
	}

	// The passed in client will get hydrated with the response.
	// This means that after this request, we will have access
	// to the client ID on the same client object.
	err = auth0API.Client.Create(context.TODO(), client)  // Replace with a Context that better suits your usage
	if err != nil {
		log.Fatalf("failed to create a new client: %+v", err)
	}

	// Make use of the getter functions to safely access
	// fields without causing a panic due nil pointers.
	log.Printf(
		"Created an auth0 client successfully. The ID is: %q",
		client.GetClientID(),
	)
}

Note The context package can be used to pass cancellation signals and deadlines to the Client for handling a request. If there is no context available then context.Background() can be used.

Rate Limiting

The Auth0 Management API imposes a rate limit on all API clients. When the limit is reached, the SDK will handle it in the background by retrying the API request when the limit is lifted.

Note The SDK does not prevent http.StatusTooManyRequests errors, instead it waits for the rate limit to be reset based on the value of the X-Rate-Limit-Reset header as the amount of seconds to wait.

Feedback

Contributing

We appreciate feedback and contribution to this repo! Before you get started, please see the following:

• Contribution Guide
• Auth0's General Contribution Guidelines
• Auth0's Code of Conduct Guidelines

Raise an issue

To provide feedback or report a bug, please raise an issue on our issue tracker.

Vulnerability Reporting

Please do not report security vulnerabilities on the public Github issue tracker. The Responsible Disclosure Program details the procedure for disclosing security issues.

---

Auth0 is an easy to implement, adaptable authentication and authorization platform.
To learn more checkout Why Auth0?

This project is licensed under the MIT license. See the LICENSE file for more info.

Documentation

Overview

Package auth0 is the Auth0 SDK for Go.

The SDK provides clients that interact with the Auth0 Authentication and Management APIs and is split into separate packages as such.

• auth0 - Provides helpers for providing values as pointers.
• authentication - Provides an Authentication Client for use when interacting with the Authentication API.
• management - Provides a Management Client for use when interacting with the Auth0 Management API.

Getting Started

Install the SDK using `go get`

go get github.com/auth0/go-auth0

Authentication

Below is an example of using the Authentication client, for full documentation visit the authentication client docs.

authAPI, err := authentication.New(
	context.TODO(),
	domain,
	authentication.WithClientID(id),
	authentication.WithClientSecret(secret), // Optional depending on the grants used
)
if err != nil {
	// handle err
}
// Now we have an authentication client, we can interact with the Auth0 Authentication API.
// Sign up a user
userData := database.SignupRequest{
	Connection: "Username-Password-Authentication",
	Username:   "mytestaccount",
	Password:   "mypassword",
	Email:      "mytestaccount@example.com",
}
createdUser, err := authAPI.Database.Signup(context.TODO(), userData)
if err != nil {
	// handle err
}

Management

Below is an example of using the Management client, for full documentation visit the management client docs.

import (
	"github.com/auth0/go-auth0"
	"github.com/auth0/go-auth0/management"
)
// Initialize a new client using a domain, client ID and secret.
m, err := management.New(
	domain,
	management.WithClientCredentials(context.TODO(), id, secret),
)
if err != nil {
	// handle err
}
c := &management.Client{
	Name:        auth0.String("Client Name"),
	Description: auth0.String("Long description of client"),
}
err = m.Client.Create(context.TODO(), c)
if err != nil {
	// handle err
}

Index

• Variables
• func Bool(b bool) *bool
• func BoolValue(b *bool) bool
• func Float64(f float64) *float64
• func Float64Value(f *float64) float64
• func Int(i int) *int
• func IntValue(i *int) int
• func String(s string) *string
• func StringValue(v *string) string
• func Stringf(s string, v ...interface{}) *string
• func Time(t time.Time) *time.Time
• func TimeValue(t *time.Time) time.Time

Variables

var Version = "1.9.0"

Version is the package version.

Functions

func Bool

func Bool(b bool) *bool

Bool returns a pointer to the bool value passed in.

func BoolValue

func BoolValue(b *bool) bool

BoolValue returns the value of the bool pointer passed in or false if the pointer is nil.

func Float64

func Float64(f float64) *float64

Float64 returns a pointer to the float64 value passed in.

func Float64Value

func Float64Value(f *float64) float64

Float64Value returns the value of the float64 pointer passed in or 0 if the pointer is nil.

func Int

func Int(i int) *int

Int returns a pointer to the int value passed in.

func IntValue

func IntValue(i *int) int

IntValue returns the value of the int pointer passed in or 0 if the pointer is nil.

func String

func String(s string) *string

String returns a pointer to the string value passed in.

func StringValue

func StringValue(v *string) string

StringValue returns the value of the string pointer passed in or "" if the pointer is nil.

func Stringf

func Stringf(s string, v ...interface{}) *string

Stringf returns a pointer to the string value passed in formatted using fmt.Sprintf.

func Time

func Time(t time.Time) *time.Time

Time returns a pointer to the time value passed in.

func TimeValue

func TimeValue(t *time.Time) time.Time

TimeValue returns the value of the time pointer passed in or the zero value of time if the pointer is nil.