apikey

Documentation

Index

• Variables
• type Service
  • func New(db *sqlx.DB, dbKey string) *Service
  • func (s *Service) Create(ctx context.Context, req *authpb.CreateAPIKeyRequest) (*authpb.APIKey, error)
  • func (s *Service) Delete(ctx context.Context, req *uuidpb.UUID) (*types.Empty, error)
  • func (s *Service) FetchOrgUserIDUsingAPIKey(ctx context.Context, key string) (uuid.UUID, uuid.UUID, error)
  • func (s *Service) Get(ctx context.Context, req *authpb.GetAPIKeyRequest) (*authpb.GetAPIKeyResponse, error)
  • func (s *Service) List(ctx context.Context, req *authpb.ListAPIKeyRequest) (*authpb.ListAPIKeyResponse, error)
  • func (s *Service) LookupAPIKey(ctx context.Context, req *authpb.LookupAPIKeyRequest) (*authpb.LookupAPIKeyResponse, error)

Variables

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

Types

type Service

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

Service is used to provision and manage API keys.

func New

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

New creates a new Service.

func (*Service) Create

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

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

func (*Service) Delete

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

Delete will remove the key.

func (*Service) FetchOrgUserIDUsingAPIKey

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 (*Service) Get

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 (*Service) List

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

List returns all the keys belonging to an org.

func (*Service) LookupAPIKey

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

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