auth

package

v0.12.0 Latest Latest Go to latest Published: Dec 1, 2023 License: MIT Imports: 13 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

Repository

github.com/axiomhq/cli

Links

Open Source Insights

Documentation ¶

Overview ¶

Package auth implements the authentication flow to login to Axiom by visiting a URL. A personal token is retrieved in exchange.

Index ¶

func Login(ctx context.Context, clientID, baseURL string, loginFunc LoginFunc) (string, error)
type LoginFunc

Constants ¶

This section is empty.

Variables ¶

This section is empty.

Functions ¶

func Login(ctx context.Context, clientID, baseURL string, loginFunc LoginFunc) (string, error)

Login to the given Axiom deployment and retrieve a personal token in exchange. This will execute the OAuth2 Authorization Code Flow with Proof Key for Code Exchange (PKCE).

Types ¶

type LoginFunc ¶

type LoginFunc func(ctx context.Context, loginURL string) error

LoginFunc is a function that is called with the URL the user has to visit in order to authenticate.

Source Files ¶

View all Source files

Directories ¶

Path	Synopsis
assets Package assets contains assets for the auth package.	Package assets contains assets for the auth package.
pkce Package PKCE implements Proof Key for Code Exchange by OAuth Public Clients.	Package PKCE implements Proof Key for Code Exchange by OAuth Public Clients.

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