okta

Documentation

Overview

Package okta contains the Okta directory provider.

Index

• Constants
• Variables
• type APIError
  • func (err *APIError) Error() string
• type Option
  • func WithBatchSize(batchSize int) Option
  • func WithHTTPClient(httpClient *http.Client) Option
  • func WithProviderURL(uri *url.URL) Option
  • func WithServiceAccount(serviceAccount *ServiceAccount) Option
• type Provider
  • func New(options ...Option) *Provider
  • func (p *Provider) User(ctx context.Context, userID, accessToken string) (*directory.User, error)
  • func (p *Provider) UserGroups(ctx context.Context) ([]*directory.Group, []*directory.User, error)
• type ServiceAccount
  • func ParseServiceAccount(rawServiceAccount string) (*ServiceAccount, error)

Constants

const Name = "okta"

Name is the provider name.

Variables

var (
	ErrAPIKeyRequired           = errors.New("okta: api_key is required")
	ErrServiceAccountNotDefined = errors.New("okta: service account not defined")
	ErrProviderURLNotDefined    = errors.New("okta: provider url not defined")
)

Errors.

Types

type APIError

type APIError struct {
	HTTPStatusCode int
	Body           string
	ErrorCode      string   `json:"errorCode"`
	ErrorSummary   string   `json:"errorSummary"`
	ErrorLink      string   `json:"errorLink"`
	ErrorID        string   `json:"errorId"`
	ErrorCauses    []string `json:"errorCauses"`
}

An APIError is an error from the okta API.

func (*APIError) Error

func (err *APIError) Error() string

type Option

type Option func(cfg *config)

An Option configures the Okta Provider.

func WithBatchSize

func WithBatchSize(batchSize int) Option

WithBatchSize sets the batch size option.

func WithHTTPClient

func WithHTTPClient(httpClient *http.Client) Option

WithHTTPClient sets the http client option.

func WithProviderURL

func WithProviderURL(uri *url.URL) Option

WithProviderURL sets the provider URL option.

func WithServiceAccount

func WithServiceAccount(serviceAccount *ServiceAccount) Option

WithServiceAccount sets the service account option.

type Provider

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

A Provider is an Okta user group directory provider.

func New

func New(options ...Option) *Provider

New creates a new Provider.

func (*Provider) User

func (p *Provider) User(ctx context.Context, userID, accessToken string) (*directory.User, error)

User returns the user record for the given id.

func (*Provider) UserGroups

func (p *Provider) UserGroups(ctx context.Context) ([]*directory.Group, []*directory.User, error)

UserGroups fetches the groups of which the user is a member https://developer.okta.com/docs/reference/api/users/#get-user-s-groups

type ServiceAccount

type ServiceAccount struct {
	APIKey string `json:"api_key"`
}

A ServiceAccount is used by the Okta provider to query the API.

func ParseServiceAccount

func ParseServiceAccount(rawServiceAccount string) (*ServiceAccount, error)

ParseServiceAccount parses the service account in the config options.