api

func ExtractToken ¶

func ExtractToken(c *gin.Context) string

ExtractToken delegates to the canonical middleware.ExtractToken.

func HandleAddUserToGroupAPI ¶

func HandleAddUserToGroupAPI(c *gin.Context)

HandleAddUserToGroupAPI handles POST /api/v1/users/:id/groups.

@Summary		Add user to group
@Description	Add a user to a group
@Tags			Users
@Accept			json
@Produce		json
@Param			id		path		int		true	"User ID"
@Param			group	body		object	true	"Group data (group_id, permission)"
@Success		200		{object}	map[string]interface{}	"User added to group"
@Failure		400		{object}	map[string]interface{}	"Invalid request"
@Failure		401		{object}	map[string]interface{}	"Unauthorized"
@Security		BearerAuth
@Router			/users/{id}/groups [post]

func HandleCreateUserAPI ¶

func HandleCreateUserAPI(c *gin.Context)

HandleCreateUserAPI handles POST /api/v1/users.

@Summary		Create user
@Description	Create a new agent user
@Tags			Users
@Accept			json
@Produce		json
@Param			user	body		object	true	"User data (login, email, first_name, last_name, password)"
@Success		201		{object}	map[string]interface{}	"Created user"
@Failure		400		{object}	map[string]interface{}	"Invalid request"
@Failure		401		{object}	map[string]interface{}	"Unauthorized"
@Security		BearerAuth
@Router			/users [post]

func HandleDeleteUserAPI ¶

func HandleDeleteUserAPI(c *gin.Context)

HandleDeleteUserAPI handles DELETE /api/v1/users/:id. This performs a soft delete by setting valid_id = 2 (OTRS pattern).

@Summary		Delete user
@Description	Soft delete a user (deactivate)
@Tags			Users
@Accept			json
@Produce		json
@Param			id	path		int	true	"User ID"
@Success		200	{object}	map[string]interface{}	"User deleted"
@Failure		401	{object}	map[string]interface{}	"Unauthorized"
@Failure		404	{object}	map[string]interface{}	"User not found"
@Security		BearerAuth
@Router			/users/{id} [delete]

func HandleGetUserAPI ¶

func HandleGetUserAPI(c *gin.Context)

HandleGetUserAPI handles GET /api/v1/users/:id.

@Summary		Get user by ID
@Description	Retrieve a single user by their ID
@Tags			Users
@Accept			json
@Produce		json
@Param			id	path		int	true	"User ID"
@Success		200	{object}	map[string]interface{}	"User details"
@Failure		401	{object}	map[string]interface{}	"Unauthorized"
@Failure		404	{object}	map[string]interface{}	"User not found"
@Security		BearerAuth
@Router			/users/{id} [get]

func HandleGetUserGroupsAPI ¶

func HandleGetUserGroupsAPI(c *gin.Context)

HandleGetUserGroupsAPI handles GET /api/v1/users/:id/groups.

@Summary		Get user groups
@Description	List groups a user belongs to
@Tags			Users
@Accept			json
@Produce		json
@Param			id	path		int	true	"User ID"
@Success		200	{object}	map[string]interface{}	"List of groups"
@Failure		401	{object}	map[string]interface{}	"Unauthorized"
@Failure		404	{object}	map[string]interface{}	"User not found"
@Security		BearerAuth
@Router			/users/{id}/groups [get]

func HandleListUsersAPI ¶

func HandleListUsersAPI(c *gin.Context)

HandleListUsersAPI handles GET /api/v1/users.

@Summary		List users
@Description	Retrieve a paginated list of users (agents)
@Tags			Users
@Accept			json
@Produce		json
@Param			page		query		int		false	"Page number"		default(1)
@Param			per_page	query		int		false	"Items per page"	default(20)
@Param			search		query		string	false	"Search in login, name, email"
@Param			group_id	query		int		false	"Filter by group membership"
@Success		200			{object}	map[string]interface{}	"List of users"
@Failure		401			{object}	map[string]interface{}	"Unauthorized"
@Security		BearerAuth
@Router			/users [get]

func HandleLoginAPI ¶

func HandleLoginAPI(c *gin.Context)

HandleLoginAPI authenticates a user and returns JWT tokens.

@Summary		Login
@Description	Authenticate user with login/password and return JWT tokens
@Tags			Authentication
@Accept			json
@Produce		json
@Param			credentials	body		object	true	"Login credentials (login, password)"
@Success		200			{object}	map[string]interface{}	"JWT tokens (access_token, refresh_token)"
@Failure		400			{object}	map[string]interface{}	"Invalid request"
@Failure		401			{object}	map[string]interface{}	"Invalid credentials"
@Router			/auth/login [post]

func HandleLogoutAPI ¶

func HandleLogoutAPI(c *gin.Context)

HandleLogoutAPI logs out a user (client-side token removal).

@Summary		Logout
@Description	Logout user (invalidates session, client should discard tokens)
@Tags			Authentication
@Accept			json
@Produce		json
@Success		200	{object}	map[string]interface{}	"Logout successful"
@Security		BearerAuth
@Router			/auth/logout [post]

func HandleRefreshTokenAPI ¶

func HandleRefreshTokenAPI(c *gin.Context)

HandleRefreshTokenAPI refreshes an expired JWT token.

@Summary		Refresh token
@Description	Exchange a refresh token for a new access token
@Tags			Authentication
@Accept			json
@Produce		json
@Param			token	body		object	true	"Refresh token"
@Success		200		{object}	map[string]interface{}	"New access token"
@Failure		400		{object}	map[string]interface{}	"Invalid request"
@Failure		401		{object}	map[string]interface{}	"Invalid or expired refresh token"
@Router			/auth/refresh [post]

func HandleRegisterAPI ¶

func HandleRegisterAPI(c *gin.Context)

HandleRegisterAPI registers a new user (if enabled).

@Summary		Register user
@Description	Register a new user (if self-registration is enabled)
@Tags			Authentication
@Accept			json
@Produce		json
@Param			user	body		object	true	"User registration data"
@Success		201		{object}	map[string]interface{}	"Registered user"
@Failure		400		{object}	map[string]interface{}	"Invalid request or registration disabled"
@Router			/auth/register [post]

func HandleRemoveUserFromGroupAPI ¶

func HandleRemoveUserFromGroupAPI(c *gin.Context)

HandleRemoveUserFromGroupAPI handles DELETE /api/v1/users/:id/groups/:group_id.

@Summary		Remove user from group
@Description	Remove a user from a group
@Tags			Users
@Accept			json
@Produce		json
@Param			id			path		int	true	"User ID"
@Param			group_id	path		int	true	"Group ID"
@Success		200			{object}	map[string]interface{}	"User removed from group"
@Failure		401			{object}	map[string]interface{}	"Unauthorized"
@Failure		404			{object}	map[string]interface{}	"Not found"
@Security		BearerAuth
@Router			/users/{id}/groups/{group_id} [delete]

func HandleUpdateUserAPI ¶

func HandleUpdateUserAPI(c *gin.Context)

HandleUpdateUserAPI handles PUT /api/v1/users/:id.

@Summary		Update user
@Description	Update an existing user's properties
@Tags			Users
@Accept			json
@Produce		json
@Param			id		path		int		true	"User ID"
@Param			user	body		object	true	"User update data"
@Success		200		{object}	map[string]interface{}	"Updated user"
@Failure		400		{object}	map[string]interface{}	"Invalid request"
@Failure		401		{object}	map[string]interface{}	"Unauthorized"
@Failure		404		{object}	map[string]interface{}	"User not found"
@Security		BearerAuth
@Router			/users/{id} [put]

func HandleUserMeAPI ¶

func HandleUserMeAPI(c *gin.Context)

HandleUserMeAPI returns the current authenticated user's information.

@Summary		Get current user
@Description	Get the authenticated user's profile
@Tags			Users
@Accept			json
@Produce		json
@Success		200	{object}	map[string]interface{}	"User profile"
@Failure		401	{object}	map[string]interface{}	"Unauthorized"
@Security		BearerAuth
@Router			/users/me [get]

func JWTAuthMiddleware ¶

func JWTAuthMiddleware() gin.HandlerFunc

JWTAuthMiddleware is a middleware that requires JWT authentication.