userapi

Documentation

Index

• func Create(c *gin.Context)
• func Delete(c *gin.Context)
• func GetUserByEmailOrID(c *gin.Context)
• func GetUserInfo(c *gin.Context)
• func List(c *gin.Context)
• func ListAllGroups(c *gin.Context)
• func PatchSlackID(c *gin.Context)
• func Update(c *gin.Context)

Functions

func Create

func Create(c *gin.Context)

InviteUser

@Summary		Invite User
@Description	Inviting a user will pre configure user definitions like display name, profile picture, groups or his slack id
@Tags			User Management
@Accept			json
@Produce		json
@Param			request			body		openapi.User	true	"The request body resource"
@Success		201				{object}	openapi.User
@Failure		400,409,422,500	{object}	openapi.HTTPError
@Router			/users [post]

func Delete

func Delete(c *gin.Context)

DeleteUser

@Summary		Delete User
@Description	Delete a user.
@Tags			User Management
@Produce		json
@Param			id	path	string	true	"The subject identifier of the user"
@Success		204
@Failure		404,422,500	{object}	openapi.HTTPError
@Router			/users/{id} [delete]

func GetUserByEmailOrID

func GetUserByEmailOrID(c *gin.Context)

GetUserByEmailOrID

@Summary		Get User
@Description	Get user by email or subject id
@Tags			User Management
@Produce		json
@Param			emailOrID	path		string	true	"The subject identifier or email of the user"
@Success		200			{object}	openapi.User
@Failure		404,500		{object}	openapi.HTTPError
@Router			/users/{emailOrID} [get]

func GetUserInfo

func GetUserInfo(c *gin.Context)

GetUserInfo

@Summary		Get UserInfo
@Description	Get own user's information
@Tags			User Management
@Produce		json
@Success		200	{object}	openapi.UserInfo
@Failure		500	{object}	openapi.HTTPError
@Router			/userinfo [get]

func List

func List(c *gin.Context)

ListUsers

@Summary		List Users
@Description	List all users
@Tags			User Management
@Produce		json
@Success		200	{array}		openapi.User
@Failure		500	{object}	openapi.HTTPError
@Router			/users [get]

func ListAllGroups

func ListAllGroups(c *gin.Context)

ListUserGroups

@Summary		List User Groups
@Description	List all groups from all users
@Tags			User Management
@Produce		json
@Success		200	{array}		string
@Failure		500	{object}	openapi.HTTPError
@Router			/users/groups [get]

func PatchSlackID

func PatchSlackID(c *gin.Context)

PatchUserSlackID

@Summary		Patch User Slack ID
@Description	Patch own user's slack id
@Tags			User Management
@Param			request	body	openapi.UserPatchSlackID	true	"The request body resource"
@Produce		json
@Success		200			{object}	openapi.User
@Failure		400,422,500	{object}	openapi.HTTPError
@Router			/users/self/slack [patch]

func Update

func Update(c *gin.Context)

UpdateUser

@Summary		Update User
@Description	Updates an existing user
@Tags			User Management
@Accept			json
@Produce		json
@Param			id			path		string			true	"The subject identifier of the user"
@Param			request		body		openapi.User	true	"The request body resource"
@Success		200			{object}	openapi.User
@Failure		400,422,500	{object}	openapi.HTTPError
@Router			/users/{id} [put]