directory

Documentation

Index

• Constants
• func NewHandler(provider Provider) http.Handler
• type Group
• type Provider
• type ProviderFunc
  • func (p ProviderFunc) GetDirectory(ctx context.Context) ([]Group, []User, error)
• type User

Constants

const (
	GroupRecordType = "pomerium.io/DirectoryGroup"
	UserRecordType  = "pomerium.io/DirectoryUser"
)

Functions

func NewHandler

func NewHandler(provider Provider) http.Handler

NewHandler creates a new Handler.

Types

type Group

type Group struct {
	ID    string `json:"id,omitempty"`
	Name  string `json:"name,omitempty"`
	Email string `json:"email,omitempty"`
}

A Group represents a group in a directory.

type Provider

type Provider interface {
	GetDirectory(context.Context) ([]Group, []User, error)
}

A Provider returns all the groups and users in a directory.

type ProviderFunc

type ProviderFunc func(context.Context) ([]Group, []User, error)

A ProviderFunc implements the Provider interface via a function.

func (ProviderFunc) GetDirectory

func (p ProviderFunc) GetDirectory(ctx context.Context) ([]Group, []User, error)

GetDirectory gets all the groups and users in a directory.

type User

type User struct {
	ID          string   `json:"id,omitempty"`
	GroupIDs    []string `json:"group_ids,omitempty"`
	DisplayName string   `json:"display_name,omitempty"`
	Email       string   `json:"email,omitempty"`
}

A User represents a user in a directory.