users

Documentation

Index

• Variables
• type Client
  • func New(host string, client client.Client, namespace string, issuer *jose.JWTIssuer, ...) *Client
  • func (c *Client) Create(ctx context.Context, organizationID string, request *openapi.UserWrite) (*openapi.UserRead, error)
  • func (c *Client) Delete(ctx context.Context, organizationID, userID string) error
  • func (c *Client) List(ctx context.Context, organizationID string) (openapi.Users, error)
  • func (c *Client) Signup(w http.ResponseWriter, r *http.Request)
  • func (c *Client) Update(ctx context.Context, organizationID, userID string, request *openapi.UserWrite) (*openapi.UserRead, error)
• type Options
  • func (o *Options) AddFlags(f *pflag.FlagSet)
• type SignupClaims

Variables

var (
	ErrConfiguration = goerrors.New("configuration error")

	ErrReference = goerrors.New("resource reference error")
)

Types

type Client

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

Client is responsible for user management.

func New

func New(host string, client client.Client, namespace string, issuer *jose.JWTIssuer, options *Options) *Client

New creates a new user client.

func (*Client) Create

func (c *Client) Create(ctx context.Context, organizationID string, request *openapi.UserWrite) (*openapi.UserRead, error)

Create makes a new user. This creates a new user in an organization, but they reference a unique user resource, so we need to get or create the underlying record first, then add to the organization.

func (*Client) Delete

func (c *Client) Delete(ctx context.Context, organizationID, userID string) error

Delete removes the user and revokes the access token.

func (*Client) List

func (c *Client) List(ctx context.Context, organizationID string) (openapi.Users, error)

List retrieves information about all users in the organization.

func (*Client) Signup

func (c *Client) Signup(w http.ResponseWriter, r *http.Request)

Signup is called when a user clicks on the email verification link, it verifies the token is valid, and transitions the user into an active state.

func (*Client) Update

func (c *Client) Update(ctx context.Context, organizationID, userID string, request *openapi.UserWrite) (*openapi.UserRead, error)

Update modifies any metadata for the user if it exists. If a matching account doesn't exist it raises an error.

type Options

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

func (*Options) AddFlags

func (o *Options) AddFlags(f *pflag.FlagSet)

type SignupClaims

type SignupClaims struct {
	jwt.Claims `json:",inline"`

	UserID string `json:"unikorn:uid"`
}