token

Documentation

Index

• Constants
• type AccessToken
• type Options
  • func OptionsWithEnv() *Options
• type TokenProvider
  • func GetTokenProvider(options *Options) (TokenProvider, error)

Constants

const (
	ServicePrincipalLogin = token.ServicePrincipalLogin
	MSILogin              = token.MSILogin
	WorkloadIdentityLogin = token.WorkloadIdentityLogin
)

Types

type AccessToken

type AccessToken = azcore.AccessToken

AccessToken represents an Azure service bearer access token with expiry information.

type Options

type Options struct {
	LoginMethod string

	Environment string
	TenantID    string
	ServerID    string
	ClientID    string

	ClientSecret       string
	ClientCert         string
	ClientCertPassword string
	IsPoPTokenEnabled  bool
	PoPTokenClaims     string

	IdentityResourceID string

	AuthorityHost      string
	FederatedTokenFile string
}

Options defines the options for getting token. This struct is a subset of internal/token.Options where its values are copied to internal type. See internal/token/options.go for details

func OptionsWithEnv

func OptionsWithEnv() *Options

OptionsWithEnv loads options from environment variables.

type TokenProvider

type TokenProvider interface {
	// GetAccessToken returns an access token from given settings.
	GetAccessToken(ctx context.Context) (AccessToken, error)
}

TokenProvider provides access to tokens.

func GetTokenProvider

func GetTokenProvider(options *Options) (TokenProvider, error)

GetTokenProvider returns a token provider based on the given options.