access

Documentation

Overview

Package access contains commands related to API access for the CLI.

Index

• Constants
• Variables
• func WithClient(f func(ctx context.Context, client *client.Client) error, ...) error
• func WithContext(f func(ctx context.Context) error) error
• type ClientOption
  • func WithSkipAuth(skipAuth bool) ClientOption
• type ServiceAccountKey

Constants

const (
	// EndpointEnvVar is the name of the environment variable that contains the Omni endpoint.
	EndpointEnvVar = "OMNI_ENDPOINT"
	// ServiceAccountKeyEnvVar is the name of the environment variable that contains the base64-encoded service account key JSON.
	ServiceAccountKeyEnvVar = "OMNI_SERVICE_ACCOUNT_KEY"
)

const ServiceAccountKeyEnvVar = "OMNI_SERVICE_ACCOUNT_KEY"

ServiceAccountKeyEnvVar is the name of the environment variable that contains the base64-encoded service account key JSON.

Variables

var CmdFlags struct {
	Omniconfig string
	Context    string
}

CmdFlags contains the common CLI flags.

Functions

func WithClient

func WithClient(f func(ctx context.Context, client *client.Client) error, clientOpts ...ClientOption) error

WithClient initializes the Omni API client.

func WithContext

func WithContext(f func(ctx context.Context) error) error

WithContext wraps with CLI context.

Types

type ClientOption

type ClientOption func(*clientOptions)

ClientOption is a functional option for the client.

func WithSkipAuth

func WithSkipAuth(skipAuth bool) ClientOption

WithSkipAuth configures the client to skip the authentication interception.

type ServiceAccountKey

type ServiceAccountKey struct {
	// Name is the name (identity) of the service account key.
	Name string `json:"name"`

	// PGPKey is the armored PGP private key.
	PGPKey string `json:"pgp_key"`
}

ServiceAccountKey is the JSON representation of a service account key.