auth

package

v0.22.0 Latest Latest Go to latest Published: Sep 1, 2026 License: MPL-2.0 Imports: 11 Imported by: 0

Details

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

Repository

github.com/zeabur/cli

Links

Open Source Insights

Documentation ¶

Overview ¶

Package auth implements the authentication flow for the CLI

Index ¶

Constants
func IsLegacyAPIKey(token string) bool
type CallbackServer
- func NewCallbackServer() (*CallbackServer, error)
type Client
type ImplicitFlowClient
- func NewImplicitFlowClient(callbackServer *CallbackServer) *ImplicitFlowClient
- func (c *ImplicitFlowClient) GenerateToken(ctx context.Context) (token string, err error)
type TokenResponse

Constants ¶

View Source

const (
	// ZeaburAccessTokenConfirmEndpoint is the dashboard page that mints an access token for the CLI.
	// The path keeps its historical "api-key" name so older CLI builds continue to resolve it.
	ZeaburAccessTokenConfirmEndpoint = constant.ZeaburDashURL + "/auth/api-key/confirm"

	ZeaburAccessTokenSettingsURL = constant.ZeaburDashURL + "/account/api-keys"
)

View Source

const (
	// AccessTokenPrefix marks a scoped personal access token issued by createAccessToken.
	AccessTokenPrefix = "zat_"
	// LegacyAPIKeyPrefix marks an unscoped API key issued by the deprecated createApiKey.
	LegacyAPIKeyPrefix = "sk-"
)

View Source

const LegacyAPIKeyDeprecationMessage = "You are authenticated with a legacy API key, which is deprecated. " +
	"Run `zeabur auth login` to migrate to an access token, " +
	"or create one at " + ZeaburAccessTokenSettingsURL + " for use with ZEABUR_TOKEN."

Variables ¶

This section is empty.

Functions ¶

func IsLegacyAPIKey ¶ added in v0.22.0

func IsLegacyAPIKey(token string) bool

Types ¶

type CallbackServer ¶

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

func NewCallbackServer ¶

func NewCallbackServer() (*CallbackServer, error)

func (*CallbackServer) Close ¶

func (s *CallbackServer) Close() error

func (*CallbackServer) GetCallbackURL ¶

func (s *CallbackServer) GetCallbackURL() string

func (*CallbackServer) Port ¶

func (s *CallbackServer) Port() int

func (*CallbackServer) Serve ¶

func (s *CallbackServer) Serve() error

func (*CallbackServer) WaitForToken ¶

func (s *CallbackServer) WaitForToken(ctx context.Context) (TokenResponse, error)

type Client ¶

type Client interface {
	GenerateToken(ctx context.Context) (string, error)
}

type ImplicitFlowClient ¶

type ImplicitFlowClient struct {
	Endpoint url.URL
	// contains filtered or unexported fields
}

func NewImplicitFlowClient ¶

func NewImplicitFlowClient(callbackServer *CallbackServer) *ImplicitFlowClient

func (*ImplicitFlowClient) GenerateToken ¶

func (c *ImplicitFlowClient) GenerateToken(ctx context.Context) (token string, err error)

type TokenResponse ¶

type TokenResponse struct {
	Token string
	State string
}

Source Files ¶

View all Source files

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