user

package

v0.0.0-...-36c55c0 Latest Latest Go to latest Published: Apr 11, 2026 License: MIT Imports: 14 Imported by: 0

Details

Valid go.mod file
Redistributable license
Tagged version
Stable version
Learn more about best practices

Repository

github.com/retr0h/osapi

Links

Open Source Insights

Documentation ¶

Overview ¶

Package user provides user and group API handlers.

Index ¶

func Handler(logger *slog.Logger, jobClient client.JobClient, signingKey string, ...) []func(e *echo.Echo)
type User
- func New(logger *slog.Logger, jobClient client.JobClient) *User

Constants ¶

This section is empty.

Variables ¶

This section is empty.

Functions ¶

func Handler ¶

func Handler(
	logger *slog.Logger,
	jobClient client.JobClient,
	signingKey string,
	customRoles map[string][]string,
) []func(e *echo.Echo)

Handler returns User and Group route registration functions.

Types ¶

type User ¶

type User struct {
	// JobClient provides job-based operations for user and group management.
	JobClient client.JobClient
	// contains filtered or unexported fields
}

User implementation of the User and Group APIs operations.

func New ¶

func New(
	logger *slog.Logger,
	jobClient client.JobClient,
) *User

New factory to create a new instance.

func (*User) DeleteNodeGroup ¶

func (u *User) DeleteNodeGroup(
	ctx context.Context,
	request gen.DeleteNodeGroupRequestObject,
) (gen.DeleteNodeGroupResponseObject, error)

DeleteNodeGroup deletes a group on a target node.

func (*User) DeleteNodeUser ¶

func (u *User) DeleteNodeUser(
	ctx context.Context,
	request gen.DeleteNodeUserRequestObject,
) (gen.DeleteNodeUserResponseObject, error)

DeleteNodeUser deletes a user on a target node.

func (*User) DeleteNodeUserSSHKey ¶

func (u *User) DeleteNodeUserSSHKey(
	ctx context.Context,
	request gen.DeleteNodeUserSSHKeyRequestObject,
) (gen.DeleteNodeUserSSHKeyResponseObject, error)

DeleteNodeUserSSHKey removes an SSH authorized key by fingerprint for a user on a target node.

func (*User) GetNodeGroup ¶

func (u *User) GetNodeGroup(
	ctx context.Context,
	request gen.GetNodeGroupRequestObject,
) (gen.GetNodeGroupResponseObject, error)

GetNodeGroup lists all groups on a target node.

func (*User) GetNodeGroupByName ¶

func (u *User) GetNodeGroupByName(
	ctx context.Context,
	request gen.GetNodeGroupByNameRequestObject,
) (gen.GetNodeGroupByNameResponseObject, error)

GetNodeGroupByName gets a single group by name on a target node.

func (*User) GetNodeUser ¶

func (u *User) GetNodeUser(
	ctx context.Context,
	request gen.GetNodeUserRequestObject,
) (gen.GetNodeUserResponseObject, error)

GetNodeUser lists all users on a target node.

func (*User) GetNodeUserByName ¶

func (u *User) GetNodeUserByName(
	ctx context.Context,
	request gen.GetNodeUserByNameRequestObject,
) (gen.GetNodeUserByNameResponseObject, error)

GetNodeUserByName gets a single user by name on a target node.

func (*User) GetNodeUserSSHKey ¶

func (u *User) GetNodeUserSSHKey(
	ctx context.Context,
	request gen.GetNodeUserSSHKeyRequestObject,
) (gen.GetNodeUserSSHKeyResponseObject, error)

GetNodeUserSSHKey lists SSH authorized keys for a user on a target node.

func (*User) PostNodeGroup ¶

func (u *User) PostNodeGroup(
	ctx context.Context,
	request gen.PostNodeGroupRequestObject,
) (gen.PostNodeGroupResponseObject, error)

PostNodeGroup creates a group on a target node.

func (*User) PostNodeUser ¶

func (u *User) PostNodeUser(
	ctx context.Context,
	request gen.PostNodeUserRequestObject,
) (gen.PostNodeUserResponseObject, error)

PostNodeUser creates a user on a target node.

func (*User) PostNodeUserPassword ¶

func (u *User) PostNodeUserPassword(
	ctx context.Context,
	request gen.PostNodeUserPasswordRequestObject,
) (gen.PostNodeUserPasswordResponseObject, error)

PostNodeUserPassword changes a user's password on a target node.

func (*User) PostNodeUserSSHKey ¶

func (u *User) PostNodeUserSSHKey(
	ctx context.Context,
	request gen.PostNodeUserSSHKeyRequestObject,
) (gen.PostNodeUserSSHKeyResponseObject, error)

PostNodeUserSSHKey adds an SSH authorized key for a user on a target node.

func (*User) PutNodeGroup ¶

func (u *User) PutNodeGroup(
	ctx context.Context,
	request gen.PutNodeGroupRequestObject,
) (gen.PutNodeGroupResponseObject, error)

PutNodeGroup updates a group on a target node.

func (*User) PutNodeUser ¶

func (u *User) PutNodeUser(
	ctx context.Context,
	request gen.PutNodeUserRequestObject,
) (gen.PutNodeUserResponseObject, error)

PutNodeUser updates a user on a target node.

Directories ¶

Path	Synopsis
gen Package gen contains generated code for the user and group API.	Package gen contains generated code for the user and group API.

?	: This menu
/	: Search site
f or F	: Jump to
y or Y	: Canonical URL