namespace

Documentation

Index

• Constants
• Variables
• func Authorize(ctx context.Context, namespace string, opts ...AuthorizeOption) error
• type AuthorizeOption
  • func Public(ns string) AuthorizeOption
• type AuthorizeOptions

Constants

const (
	// DefaultNamespace used by the server
	DefaultNamespace = "micro"
)

Variables

var (
	// ErrUnauthorized is returned by Authorize when a context without a blank account tries to access
	// a restricted namespace
	ErrUnauthorized = errors.New("An account is required")
	// ErrForbidden is returned by Authorize when a context is trying to access a namespace it doesn't
	// have access to
	ErrForbidden = errors.New("Access denied to namespace")
)

Functions

func Authorize

func Authorize(ctx context.Context, namespace string, opts ...AuthorizeOption) error

Authorize will return an error if the context cannot access the given namespace

Types

type AuthorizeOption

type AuthorizeOption func(o *AuthorizeOptions)

AuthorizeOption sets an attribute on AuthorizeOptions

func Public

func Public(ns string) AuthorizeOption

Public indicates a namespace is public and can be accessed by anyone

type AuthorizeOptions

type AuthorizeOptions struct {
	PublicNamespace string
}

AuthorizeOptions are used to configure the Authorize method