auth0

Documentation

Overview

Package auth0 contains the Auth0 directory provider. Note that Auth0 refers to groups as roles.

Index

• Constants
• type Option
  • func WithDomain(domain string) Option
  • func WithServiceAccount(serviceAccount *ServiceAccount) Option
• type Provider
  • func New(options ...Option) *Provider
  • func (p *Provider) User(ctx context.Context, userID, accessToken string) (*directory.User, error)
  • func (p *Provider) UserGroups(ctx context.Context) ([]*directory.Group, []*directory.User, error)
• type RoleManager
• type ServiceAccount
  • func ParseServiceAccount(options directory.Options) (*ServiceAccount, error)
• type UserManager

Constants

const Name = "auth0"

Name is the provider name.

Types

type Option

type Option func(cfg *config)

Option provides config for the Auth0 Provider.

func WithDomain

func WithDomain(domain string) Option

WithDomain sets the provider domain option.

func WithServiceAccount

func WithServiceAccount(serviceAccount *ServiceAccount) Option

WithServiceAccount sets the service account option.

type Provider

type Provider struct {
	// contains filtered or unexported fields
}

Provider is an Auth0 user group directory provider.

func New

func New(options ...Option) *Provider

New creates a new Provider.

func (*Provider) User

func (p *Provider) User(ctx context.Context, userID, accessToken string) (*directory.User, error)

User returns the user record for the given id.

func (*Provider) UserGroups

func (p *Provider) UserGroups(ctx context.Context) ([]*directory.Group, []*directory.User, error)

UserGroups fetches a slice of groups and users.

type RoleManager

type RoleManager interface {
	List(opts ...management.RequestOption) (r *management.RoleList, err error)
	Users(id string, opts ...management.RequestOption) (u *management.UserList, err error)
}

RoleManager defines what is needed to get role info from Auth0.

type ServiceAccount

type ServiceAccount struct {
	Domain       string `json:"domain"`
	ClientID     string `json:"client_id"`
	ClientSecret string `json:"client_secret"`
	Secret       string `json:"secret"`
}

A ServiceAccount is used by the Auth0 provider to query the API.

func ParseServiceAccount

func ParseServiceAccount(options directory.Options) (*ServiceAccount, error)

ParseServiceAccount parses the service account in the config options.

type UserManager

type UserManager interface {
	Read(id string, opts ...management.RequestOption) (*management.User, error)
	Roles(id string, opts ...management.RequestOption) (r *management.RoleList, err error)
}

UserManager defines what is needed to get user info from Auth0.