ory

Documentation

Overview

Package ory provides a high-level client for using Ory Kratos

Index

• type Cache
  • func (c *Cache) GetIdentifierByID(id IdentityID) (IdentityIdentifier, bool, error)
  • func (c *Cache) SetIdentifierByID(id IdentityID, identifier IdentityIdentifier, costWeight float32) error
  • func (c *Cache) UnsetIdentifierByID(id IdentityID)
• type Client
  • func NewClient(c Config, cache clientcache.Cache, l godest.Logger) *Client
  • func (c *Client) GetIdentifier(ctx context.Context, id IdentityID) (IdentityIdentifier, error)
  • func (c *Client) GetIdentities(ctx context.Context) ([]Identity, error)
  • func (c *Client) GetIdentity(ctx context.Context, id IdentityID) (Identity, error)
  • func (c *Client) GetPath(ctx context.Context, endpoint, route string) (string, error)
  • func (c *Client) InitializeLoginFlow(ctx context.Context) (*ory.SelfServiceLoginFlow, *http.Cookie, error)
  • func (c *Client) PerformLogout(ctx context.Context, cookies []*http.Cookie) ([]*http.Cookie, error)
  • func (c *Client) SubmitLoginFlow(ctx context.Context, flow, csrfToken, identifier, password string, ...) (*ory.SuccessfulSelfServiceLoginWithoutBrowser, []*http.Cookie, error)
• type Config
  • func GetConfig() (c Config, err error)
• type Identity
• type IdentityID
• type IdentityIdentifier

Types

type Cache

type Cache struct {
	Cache clientcache.Cache
}

func (*Cache) GetIdentifierByID

func (c *Cache) GetIdentifierByID(id IdentityID) (IdentityIdentifier, bool, error)

func (*Cache) SetIdentifierByID

func (c *Cache) SetIdentifierByID(
	id IdentityID, identifier IdentityIdentifier, costWeight float32,
) error

func (*Cache) UnsetIdentifierByID

func (c *Cache) UnsetIdentifierByID(id IdentityID)

type Client

type Client struct {
	Config Config
	Ory    *ory.APIClient
	Logger godest.Logger
	Cache  *Cache
}

func NewClient

func NewClient(c Config, cache clientcache.Cache, l godest.Logger) *Client

func (*Client) GetIdentifier

func (c *Client) GetIdentifier(ctx context.Context, id IdentityID) (IdentityIdentifier, error)

func (*Client) GetIdentities

func (c *Client) GetIdentities(ctx context.Context) ([]Identity, error)

func (*Client) GetIdentity

func (c *Client) GetIdentity(ctx context.Context, id IdentityID) (Identity, error)

func (*Client) GetPath

func (c *Client) GetPath(ctx context.Context, endpoint, route string) (string, error)

func (*Client) InitializeLoginFlow

func (c *Client) InitializeLoginFlow(
	ctx context.Context,
) (*ory.SelfServiceLoginFlow, *http.Cookie, error)

func (*Client) PerformLogout

func (c *Client) PerformLogout(
	ctx context.Context, cookies []*http.Cookie,
) ([]*http.Cookie, error)

func (*Client) SubmitLoginFlow

func (c *Client) SubmitLoginFlow(
	ctx context.Context, flow, csrfToken, identifier, password string, cookies []*http.Cookie,
) (*ory.SuccessfulSelfServiceLoginWithoutBrowser, []*http.Cookie, error)

type Config

type Config struct {
	NoAuth            bool
	KratosAPI         *ory.Configuration
	NetworkCostWeight float32
}

func GetConfig

func GetConfig() (c Config, err error)

type Identity

type Identity struct {
	ID         IdentityID
	Identifier IdentityIdentifier
	Email      string
}

type IdentityID

type IdentityID string

type IdentityIdentifier

type IdentityIdentifier string