auth

Documentation

Index

• func NewCmdAuth(ctx *cmd.Context) *cmd.Command
• func NewCmdLogin(ctx *cmd.Context) *cmd.Command
• func NewCmdLogout(ctx *cmd.Context) *cmd.Command
• func NewCmdPrintAccessToken(ctx *cmd.Context) *cmd.Command
• type GetIAMClientFunc
• type LoginOpts
  • func (o *LoginOpts) Validate() error
• type LogoutOpts
• type NewConfigFunc

Functions

func NewCmdAuth

func NewCmdAuth(ctx *cmd.Context) *cmd.Command

func NewCmdLogin

func NewCmdLogin(ctx *cmd.Context) *cmd.Command

func NewCmdLogout

func NewCmdLogout(ctx *cmd.Context) *cmd.Command

func NewCmdPrintAccessToken

func NewCmdPrintAccessToken(ctx *cmd.Context) *cmd.Command

Types

type GetIAMClientFunc

type GetIAMClientFunc func(c hcpconf.HCPConfig) (iam_service.ClientService, error)

GetIAMClientFunc is the function definition for retrieving an IAM service client from a HCP Config.

type LoginOpts

type LoginOpts struct {
	Ctx     context.Context
	IO      iostreams.IOStreams
	Profile *profile.Profile
	Quiet   bool

	// GetIAM retrieves an IAM service client using the passed HCP Config.
	GetIAM GetIAMClientFunc

	// ConfigFn is used to retrieve a new HCP Config
	ConfigFn NewConfigFunc

	// CredentialDir is the directory to store any necessary credential files.
	CredentialDir string

	// CredentialFile is the path to a credential file to use to login
	CredentialFile string

	// ClientID and ClientSecret are used to authenticate using service
	// principal credentials.
	ClientID     string
	ClientSecret string
}

func (*LoginOpts) Validate

func (o *LoginOpts) Validate() error

type LogoutOpts

type LogoutOpts struct {
	IO iostreams.IOStreams

	// CredentialDir is the directory to store any necessary credential files.
	CredentialDir string
	// contains filtered or unexported fields
}

type NewConfigFunc

type NewConfigFunc func(opts ...hcpconf.HCPConfigOption) (hcpconf.HCPConfig, error)

NewConfigFunc is the function definition for retrieving a new HCPConfig