api

Documentation

Index

• Constants
• func WithInstanceConfig(ctx context.Context, config *conf.Configuration, instanceID uuid.UUID) (context.Context, error)
• type API
  • func NewAPI(globalConfig *conf.GlobalConfiguration, db *storage.Connection) *API
  • func NewAPIFromConfigFile(filename string, version string) (*API, *conf.Configuration, error)
  • func NewAPIWithVersion(ctx context.Context, globalConfig *conf.GlobalConfiguration, ...) *API
  • func (a *API) CreateInstance(w http.ResponseWriter, r *http.Request) error
  • func (a *API) DeleteInstance(w http.ResponseWriter, r *http.Request) error
  • func (a *API) ExternalProviderCallback(w http.ResponseWriter, r *http.Request) error
  • func (a *API) ExternalProviderRedirect(w http.ResponseWriter, r *http.Request) error
  • func (a *API) GetAppManifest(w http.ResponseWriter, r *http.Request) error
  • func (a *API) GetInstance(w http.ResponseWriter, r *http.Request) error
  • func (a *API) HealthCheck(w http.ResponseWriter, r *http.Request) error
  • func (a *API) Invite(w http.ResponseWriter, r *http.Request) error
  • func (a *API) ListenAndServe(hostAndPort string)
  • func (a *API) Logout(w http.ResponseWriter, r *http.Request) error
  • func (a *API) Mailer(ctx context.Context) mailer.Mailer
  • func (a *API) Provider(ctx context.Context, name string) (provider.Provider, error)
  • func (a *API) Recover(w http.ResponseWriter, r *http.Request) error
  • func (a *API) RefreshTokenGrant(ctx context.Context, w http.ResponseWriter, r *http.Request) error
  • func (a *API) ResourceOwnerPasswordGrant(ctx context.Context, w http.ResponseWriter, r *http.Request) error
  • func (a *API) Settings(w http.ResponseWriter, r *http.Request) error
  • func (a *API) Signup(w http.ResponseWriter, r *http.Request) error
  • func (a *API) Token(w http.ResponseWriter, r *http.Request) error
  • func (a *API) UpdateInstance(w http.ResponseWriter, r *http.Request) error
  • func (a *API) UserGet(w http.ResponseWriter, r *http.Request) error
  • func (a *API) UserUpdate(w http.ResponseWriter, r *http.Request) error
  • func (a *API) Verify(w http.ResponseWriter, r *http.Request) error
• type AccessTokenResponse
• type ErrorCause
• type ExternalProviderClaims
• type ExternalProviderSettings
• type ExternalSignupParams
• type GoTrueClaims
• type HTTPError
  • func (e *HTTPError) Cause() error
  • func (e *HTTPError) Error() string
  • func (e *HTTPError) WithInternalError(err error) *HTTPError
  • func (e *HTTPError) WithInternalMessage(fmtString string, args ...interface{}) *HTTPError
• type HookEvent
• type InstanceRequestParams
• type InstanceResponse
• type InviteParams
• type NetlifyMicroserviceClaims
• type OAuthError
  • func (e *OAuthError) Cause() error
  • func (e *OAuthError) Error() string
  • func (e *OAuthError) WithInternalError(err error) *OAuthError
  • func (e *OAuthError) WithInternalMessage(fmtString string, args ...interface{}) *OAuthError
• type RecoverParams
• type Settings
• type SignupParams
• type UserUpdateParams
• type VerifyParams
• type Webhook
• type WebhookResponse

Constants

const (
	ValidateEvent = "validate"
	SignupEvent   = "signup"
	LoginEvent    = "login"
)

Functions

func WithInstanceConfig

func WithInstanceConfig(ctx context.Context, config *conf.Configuration, instanceID uuid.UUID) (context.Context, error)

Types

type API

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

API is the main REST API

func NewAPI

func NewAPI(globalConfig *conf.GlobalConfiguration, db *storage.Connection) *API

NewAPI instantiates a new REST API

func NewAPIFromConfigFile

func NewAPIFromConfigFile(filename string, version string) (*API, *conf.Configuration, error)

NewAPIFromConfigFile creates a new REST API using the provided configuration file.

func NewAPIWithVersion

func NewAPIWithVersion(ctx context.Context, globalConfig *conf.GlobalConfiguration, db *storage.Connection, version string) *API

NewAPIWithVersion creates a new REST API using the specified version

func (*API) CreateInstance

func (a *API) CreateInstance(w http.ResponseWriter, r *http.Request) error

func (*API) DeleteInstance

func (a *API) DeleteInstance(w http.ResponseWriter, r *http.Request) error

func (*API) ExternalProviderCallback

func (a *API) ExternalProviderCallback(w http.ResponseWriter, r *http.Request) error

func (*API) ExternalProviderRedirect

func (a *API) ExternalProviderRedirect(w http.ResponseWriter, r *http.Request) error

func (*API) GetAppManifest

func (a *API) GetAppManifest(w http.ResponseWriter, r *http.Request) error

func (*API) GetInstance

func (a *API) GetInstance(w http.ResponseWriter, r *http.Request) error

func (*API) HealthCheck

func (a *API) HealthCheck(w http.ResponseWriter, r *http.Request) error

func (*API) Invite

func (a *API) Invite(w http.ResponseWriter, r *http.Request) error

Invite is the endpoint for inviting a new user

func (*API) ListenAndServe

func (a *API) ListenAndServe(hostAndPort string)

ListenAndServe starts the REST API

func (*API) Logout

func (a *API) Logout(w http.ResponseWriter, r *http.Request) error

Logout is the endpoint for logging out a user and thereby revoking any refresh tokens

func (*API) Mailer

func (a *API) Mailer(ctx context.Context) mailer.Mailer

func (*API) Provider

func (a *API) Provider(ctx context.Context, name string) (provider.Provider, error)

Provider returns a Provider interface for the given name.

func (*API) Recover

func (a *API) Recover(w http.ResponseWriter, r *http.Request) error

Recover sends a recovery email

func (*API) RefreshTokenGrant

func (a *API) RefreshTokenGrant(ctx context.Context, w http.ResponseWriter, r *http.Request) error

RefreshTokenGrant implements the refresh_token grant type flow

func (*API) ResourceOwnerPasswordGrant

func (a *API) ResourceOwnerPasswordGrant(ctx context.Context, w http.ResponseWriter, r *http.Request) error

ResourceOwnerPasswordGrant implements the password grant type flow

func (*API) Settings

func (a *API) Settings(w http.ResponseWriter, r *http.Request) error

func (*API) Signup

func (a *API) Signup(w http.ResponseWriter, r *http.Request) error

Signup is the endpoint for registering a new user

func (*API) Token

func (a *API) Token(w http.ResponseWriter, r *http.Request) error

Token is the endpoint for OAuth access token requests

func (*API) UpdateInstance

func (a *API) UpdateInstance(w http.ResponseWriter, r *http.Request) error

func (*API) UserGet

func (a *API) UserGet(w http.ResponseWriter, r *http.Request) error

UserGet returns a user

func (*API) UserUpdate

func (a *API) UserUpdate(w http.ResponseWriter, r *http.Request) error

UserUpdate updates fields on a user

func (*API) Verify

func (a *API) Verify(w http.ResponseWriter, r *http.Request) error

Verify exchanges a confirmation or recovery token to a refresh token

type AccessTokenResponse

type AccessTokenResponse struct {
	Token        string `json:"access_token"`
	TokenType    string `json:"token_type"` // Bearer
	ExpiresIn    int    `json:"expires_in"`
	RefreshToken string `json:"refresh_token"`
}

AccessTokenResponse represents an OAuth2 success response

type ErrorCause

type ErrorCause interface {
	Cause() error
}

type ExternalProviderClaims

type ExternalProviderClaims struct {
	NetlifyMicroserviceClaims
	Provider    string `json:"provider"`
	InviteToken string `json:"invite_token,omitempty"`
	Referrer    string `json:"referrer,omitempty"`
}

type ExternalProviderSettings

type ExternalProviderSettings struct {
	BitBucket bool `json:"bitbucket"`
	GitHub    bool `json:"github"`
	GitLab    bool `json:"gitlab"`
	Google    bool `json:"google"`
}

type ExternalSignupParams

type ExternalSignupParams struct {
	Provider string `json:"provider"`
	Code     string `json:"code"`
}

SignupParams are the parameters the Signup endpoint accepts

type GoTrueClaims

type GoTrueClaims struct {
	jwt.StandardClaims
	Email        string                 `json:"email"`
	AppMetaData  map[string]interface{} `json:"app_metadata"`
	UserMetaData map[string]interface{} `json:"user_metadata"`
}

type HTTPError

type HTTPError struct {
	Code            int    `json:"code"`
	Message         string `json:"msg"`
	InternalError   error  `json:"-"`
	InternalMessage string `json:"-"`
	ErrorID         string `json:"error_id,omitempty"`
}

HTTPError is an error with a message and an HTTP status code.

func (*HTTPError) Cause

func (e *HTTPError) Cause() error

Cause returns the root cause error

func (*HTTPError) Error

func (e *HTTPError) Error() string

func (*HTTPError) WithInternalError

func (e *HTTPError) WithInternalError(err error) *HTTPError

WithInternalError adds internal error information to the error

func (*HTTPError) WithInternalMessage

func (e *HTTPError) WithInternalMessage(fmtString string, args ...interface{}) *HTTPError

WithInternalMessage adds internal message information to the error

type HookEvent

type HookEvent string

type InstanceRequestParams

type InstanceRequestParams struct {
	UUID       uuid.UUID           `json:"uuid"`
	BaseConfig *conf.Configuration `json:"config"`
}

type InstanceResponse

type InstanceResponse struct {
	models.Instance
	Endpoint string `json:"endpoint"`
	State    string `json:"state"`
}

type InviteParams

type InviteParams struct {
	Email string                 `json:"email"`
	Data  map[string]interface{} `json:"data"`
}

InviteParams are the parameters the Signup endpoint accepts

type NetlifyMicroserviceClaims

type NetlifyMicroserviceClaims struct {
	jwt.StandardClaims
	SiteURL       string            `json:"site_url"`
	InstanceID    string            `json:"id"`
	NetlifyID     string            `json:"netlify_id"`
	FunctionHooks map[string]string `json:"function_hooks"`
}

type OAuthError

type OAuthError struct {
	Err             string `json:"error"`
	Description     string `json:"error_description,omitempty"`
	InternalError   error  `json:"-"`
	InternalMessage string `json:"-"`
}

OAuthError is the JSON handler for OAuth2 error responses

func (*OAuthError) Cause

func (e *OAuthError) Cause() error

Cause returns the root cause error

func (*OAuthError) Error

func (e *OAuthError) Error() string

func (*OAuthError) WithInternalError

func (e *OAuthError) WithInternalError(err error) *OAuthError

WithInternalError adds internal error information to the error

func (*OAuthError) WithInternalMessage

func (e *OAuthError) WithInternalMessage(fmtString string, args ...interface{}) *OAuthError

WithInternalMessage adds internal message information to the error

type RecoverParams

type RecoverParams struct {
	Email string `json:"email"`
}

RecoverParams holds the parameters for a password recovery request

type Settings

type Settings struct {
	ExternalProviders ExternalProviderSettings `json:"external"`
	DisableSignup     bool                     `json:"disable_signup"`
	Autoconfirm       bool                     `json:"autoconfirm"`
}

type SignupParams

type SignupParams struct {
	Email    string                 `json:"email"`
	Password string                 `json:"password"`
	Data     map[string]interface{} `json:"data"`
	Provider string                 `json:"-"`
	Aud      string                 `json:"-"`
}

SignupParams are the parameters the Signup endpoint accepts

type UserUpdateParams

type UserUpdateParams struct {
	Email            string                 `json:"email"`
	Password         string                 `json:"password"`
	EmailChangeToken string                 `json:"email_change_token"`
	Data             map[string]interface{} `json:"data"`
	AppData          map[string]interface{} `json:"app_metadata,omitempty"`
}

UserUpdateParams parameters for updating a user

type VerifyParams

type VerifyParams struct {
	Type     string `json:"type"`
	Token    string `json:"token"`
	Password string `json:"password"`
}

VerifyParams are the parameters the Verify endpoint accepts

type Webhook

type Webhook struct {
	*conf.WebhookConfig
	// contains filtered or unexported fields
}

type WebhookResponse

type WebhookResponse struct {
	AppMetaData  map[string]interface{} `json:"app_metadata,omitempty"`
	UserMetaData map[string]interface{} `json:"user_metadata,omitempty"`
}