okta

Documentation

Index

• type FetchStrategy
• type MetadataProvider
  • func NewMetadataProvider(issuer string, options ...Option) (*MetadataProvider, error)
  • func (mp *MetadataProvider) GetMetadata(ctx context.Context) (metadata.Metadata, error)
• type Option
  • func WithBackgroundCtx(ctx context.Context) Option
  • func WithCacheTtl(ttl time.Duration) Option
  • func WithFetchStrategy(fetchStrategy FetchStrategy) Option
  • func WithHttpClient(httpClient *http.Client) Option
• type Options

Types

type FetchStrategy

type FetchStrategy int64

const (
	Lazy FetchStrategy = iota // Fetch new metadata inline with requests (when not cached)
	// Background Fetch new metadata in the background regardless of requests being made. This option was designed
	// for eliminating in-line metadata calls and minimizing latency in production use. Warning: this option will
	// attempt to seed metadata on initialization and block.
	Background

	DefaultCacheTtl = 5 * time.Minute
)

type MetadataProvider

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

MetadataProvider is an implementation of metadata.Provider that retrieves metadata from Okta's well known openid configuration

func NewMetadataProvider

func NewMetadataProvider(issuer string, options ...Option) (*MetadataProvider, error)

NewMetadataProvider creates a new MetadataProvider for the specified Okta issuer.

func (*MetadataProvider) GetMetadata

func (mp *MetadataProvider) GetMetadata(ctx context.Context) (metadata.Metadata, error)

GetMetadata gets metadata for the specified Okta issuer.

type Option

type Option func(*Options)

Option for the MetadataProvider.

func WithBackgroundCtx

func WithBackgroundCtx(ctx context.Context) Option

WithBackgroundCtx specified the context to use in order to control the lifecycle of the background fetching goroutine.

func WithCacheTtl

func WithCacheTtl(ttl time.Duration) Option

WithCacheTtl specifies the TTL on the Okta JWK set.

func WithFetchStrategy

func WithFetchStrategy(fetchStrategy FetchStrategy) Option

WithFetchStrategy specifies a strategy for fetching new metadata.

func WithHttpClient

func WithHttpClient(httpClient *http.Client) Option

WithHttpClient allows for a configurable http client.

type Options

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

Options are configurable options for the MetadataProvider.