apikey

package

v0.0.0-...-0888c38 Latest Latest Go to latest Published: Apr 24, 2024 License: Apache-2.0 Imports: 16 Imported by: 0

Details

Valid go.mod file

The Go module system was introduced in Go 1.11 and is the official dependency management solution for Go.
Redistributable license

Redistributable licenses place minimal restrictions on how software can be used, modified, and redistributed.
Tagged version

Modules with tagged versions give importers more predictable builds.
Stable version

When a project reaches major version v1 it is considered stable.
Learn more about best practices

This section is empty.

View Source

var (
	// ErrAPIKeyNotFound is used when the specified API key cannot be located.
	ErrAPIKeyNotFound = errors.New("invalid API key")
)

This section is empty.

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

Service is used to provision and manage API keys.

func New(db *sqlx.DB, dbKey string) *Service

New creates a new Service.

func (s *Service) Create(ctx context.Context, req *authpb.CreateAPIKeyRequest) (*authpb.APIKey, error)

Create a key with the org/user as an owner.

func (s *Service) Delete(ctx context.Context, req *uuidpb.UUID) (*types.Empty, error)

Delete will remove the key.

func (s *Service) FetchOrgUserIDUsingAPIKey(ctx context.Context, key string) (uuid.UUID, uuid.UUID, error)

FetchOrgUserIDUsingAPIKey gets the org and user ID based on the API key.

func (s *Service) Get(ctx context.Context, req *authpb.GetAPIKeyRequest) (*authpb.GetAPIKeyResponse, error)

Get returns a specific key if it's owned by the org.

func (s *Service) List(ctx context.Context, req *authpb.ListAPIKeyRequest) (*authpb.ListAPIKeyResponse, error)

List returns all the keys belonging to an org.

func (s *Service) LookupAPIKey(ctx context.Context, req *authpb.LookupAPIKeyRequest) (*authpb.LookupAPIKeyResponse, error)

LookupAPIKey gets the complete API key information using just the Key.