login

package

v0.8.1 Latest Latest Go to latest Published: Jul 12, 2023 License: Apache-2.0 Imports: 22 Imported by: 0

Details

Valid go.mod file
Redistributable license
Tagged version
Stable version
Learn more about best practices

Repository

github.com/hookdeck/hookdeck-cli

Links

Open Source Insights

Documentation ¶

Index ¶

func CILogin(config *config.Config, apiKey string, name string) error
func GuestLogin(config *config.Config) (string, error)
func InteractiveLogin(config *config.Config) error
func Login(config *config.Config, input io.Reader) error
func SuccessMessage(displayName string, teamName string, isConsole bool) string
type Links
type PollAPIKeyResponse
- func PollForKey(pollURL string, interval time.Duration, maxAttempts int) (*PollAPIKeyResponse, error)
type ValidateAPIKeyResponse
- func ValidateKey(baseURL string, key string, teamId string) (*ValidateAPIKeyResponse, error)

Constants ¶

This section is empty.

Variables ¶

This section is empty.

Functions ¶

func CILogin ¶

func CILogin(config *config.Config, apiKey string, name string) error

func GuestLogin ¶

func GuestLogin(config *config.Config) (string, error)

func InteractiveLogin ¶

func InteractiveLogin(config *config.Config) error

InteractiveLogin lets the user set configuration on the command line

func Login(config *config.Config, input io.Reader) error

Login function is used to obtain credentials via hookdeck dashboard.

func SuccessMessage ¶

func SuccessMessage(displayName string, teamName string, isConsole bool) string

SuccessMessage returns the display message for a successfully authenticated user

Types ¶

type Links ¶

type Links struct {
	BrowserURL string `json:"browser_url"`
	PollURL    string `json:"poll_url"`
}

Links provides the URLs for the CLI to continue the login flow

type PollAPIKeyResponse ¶

type PollAPIKeyResponse struct {
	Claimed  bool   `json:"claimed"`
	UserID   string `json:"user_id"`
	UserName string `json:"user_name"`
	TeamID   string `json:"team_id"`
	TeamName string `json:"team_name"`
	TeamMode string `json:"team_mode"`
	APIKey   string `json:"key"`
	ClientID string `json:"client_id"`
}

PollAPIKeyResponse returns the data of the polling client login

func PollForKey ¶

func PollForKey(pollURL string, interval time.Duration, maxAttempts int) (*PollAPIKeyResponse, error)

PollForKey polls Hookdeck at the specified interval until either the API key is available or we've reached the max attempts.

type ValidateAPIKeyResponse ¶

type ValidateAPIKeyResponse struct {
	UserID   string `json:"user_id"`
	UserName string `json:"user_name"`
	TeamID   string `json:"team_id"`
	TeamName string `json:"team_name"`
	TeamMode string `json:"team_mode"`
	ClientID string `json:"client_id"`
}

ValidateAPIKeyResponse returns the user and team associated with a key

func ValidateKey ¶

func ValidateKey(baseURL string, key string, teamId string) (*ValidateAPIKeyResponse, error)

Source Files ¶

View all Source files

?	: This menu
/	: Search site
f or F	: Jump to
y or Y	: Canonical URL