users

Documentation

Index

• type Client
  • func New(client client.Client, namespace string) *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) Update(ctx context.Context, organizationID, userID string, request *openapi.UserWrite) (*openapi.UserRead, error)

Types

type Client

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

Client is responsible for user management.

func New

func New(client client.Client, namespace string) *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 and issues an access token.

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) 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.