reference

package
v0.4.0 Latest Latest
Warning

This package is not in the latest version of its module.

Go to latest
Published: Sep 11, 2026 License: MIT Imports: 14 Imported by: 0

Documentation

Overview

Package reference builds the canonical Auth-All configuration.

The configuration enables every first-party v1 capability. The command line tool uses it to emit the schema, the OpenAPI contract, and the generated TypeScript client, so the published artifacts describe the complete v1 API.

Index

Constants

View Source
const BaseURL = "https://app.example.com"

BaseURL is the placeholder application URL of the reference configuration.

View Source
const DefaultRole = "viewer"

DefaultRole is the role of a user whose role column is empty.

Variables

View Source
var RoleHierarchy = []string{"viewer", "operator", "editor", "admin"}

RoleHierarchy is the example role hierarchy of the guides. The reference configuration and the command line tool use it.

Functions

func New

func New() (*authall.Auth, error)

New returns the canonical Auth-All instance over a temporary in-memory database. It never writes to an application database.

func NewWithStore

func NewWithStore(s store.Store) (*authall.Auth, error)

NewWithStore returns the canonical Auth-All instance over one store.

func Options

func Options(s store.Store) []authall.Option

Options returns the option list of the canonical configuration.

func OrganizationRoles added in v0.4.0

func OrganizationRoles() []organizations.RoleDefinition

OrganizationRoles are the example organization roles of the guides. An owner holds every permission, and each other role holds a named set.

Types

This section is empty.

Jump to

Keyboard shortcuts

? : This menu
/ : Search site
f or F : Jump to
y or Y : Canonical URL