auth

Documentation

Index

• type Credential
• type Scope
• type Token
• type TokenOption
  • func WithScope(scope Scope) TokenOption
• type TokenOptions

Types

type Credential

type Credential interface {
	Token(ctx context.Context, options ...TokenOption) (Token, error)
}

Credential is the interface that wraps around method Token.

type Scope

type Scope string

Scope represents a scope for a token.

const (
	// ScopeResourceManager is the scope needed for tokens to be used with Azure Resource Manager.
	ScopeResourceManager Scope = "https://management.azure.com/.default"
	// ScopeKeyVault is the scope needed for tokens to be used with Azure Key Vault.
	ScopeKeyVault Scope = "https://vault.azure.net/.default"
	// ScopeAppConfig is the scope needed for tokens to be used with Azure App Config.
	ScopeAppConfig Scope = "https://azconfig.io/.default"
)

type Token

type Token struct {
	ExpiresOn   time.Time
	AccessToken string
}

Token contains the access token and when it expires.

type TokenOption

type TokenOption func(o *TokenOptions)

TokenOption is a function that sets options for a token request.

func WithScope

func WithScope(scope Scope) TokenOption

WithScope sets the scope of the token request.

type TokenOptions

type TokenOptions struct {
	Scope Scope
}

TokenOptions contains options for a token request.