apikey

Documentation

Index

• func Generate(params CreateParams) (database.InsertAPIKeyParams, string, error)
• type CreateParams

Functions

func Generate

func Generate(params CreateParams) (database.InsertAPIKeyParams, string, error)

Generate generates an API key, returning the key as a string as well as the database representation. It is the responsibility of the caller to insert it into the database.

Types

type CreateParams

type CreateParams struct {
	UserID    uuid.UUID
	LoginType database.LoginType
	// DefaultLifetime is configured in DeploymentValues.
	// It is used if both ExpiresAt and LifetimeSeconds are not set.
	DefaultLifetime time.Duration

	// Optional.
	ExpiresAt       time.Time
	LifetimeSeconds int64
	Scope           database.APIKeyScope
	TokenName       string
	RemoteAddr      string
}