handlers

package
v1.0.5 Latest Latest
Warning

This package is not in the latest version of its module.

 Go to latest Published: Sep 3, 2018 License: Apache-2.0 Imports: 14 Imported by: 0

Documentation

Overview

Package routes User-Manager

User-Manager service is service for managing users. 

 Version: 0.0.1
	Consumes:
	- application/json

	Produces:
	- application/json

swagger:meta

Index

Constants

This section is empty.

Variables

This section is empty.

Functions

func ActivateHandler 

func ActivateHandler(ctx *gin.Context)

swagger:operation POST /user/activation User ActivateHandler Activate user.

--- x-method-visibility: public parameters:

  • $ref: '#/parameters/UserRoleHeader'
  • $ref: '#/parameters/UserIDHeader'
  • name: body in: body schema: $ref: '#/definitions/Link'

responses: 

'200':
  description: user activated
  schema:
    $ref: '#/definitions/CreateTokenResponse'
default:
  $ref: '#/responses/error'

func AddBoundAccountHandler 

func AddBoundAccountHandler(ctx *gin.Context)

swagger:operation POST /user/bound_accounts BoundAccounts AddBoundAccountHandler Bind account.

--- x-method-visibility: public parameters:

  • $ref: '#/parameters/UserRoleHeader'
  • $ref: '#/parameters/UserIDHeader'
  • name: body in: body schema: $ref: '#/definitions/OAuthLoginRequest'

responses: 

'202':
  description: account added
default:
  $ref: '#/responses/error'

func AddGroupMembersHandler 

func AddGroupMembersHandler(ctx *gin.Context)

swagger:operation POST /groups/{group}/members UserGroups AddGroupMembersHandler Add members to the group.

--- x-method-visibility: public parameters:

  • $ref: '#/parameters/UserRoleHeader'
  • $ref: '#/parameters/UserIDHeader'
  • name: group in: path type: string required: true
  • name: body in: body schema: $ref: '#/definitions/UserGroupMembers'

responses: 

'202':
  description: user added
default:
  $ref: '#/responses/error'

func AdminResetPasswordHandler 

func AdminResetPasswordHandler(ctx *gin.Context)

swagger:operation POST /admin/user/password/reset Admin AdminResetPasswordHandler Make admin user.

--- x-method-visibility: public parameters:

  • $ref: '#/parameters/UserRoleHeader'
  • $ref: '#/parameters/UserIDHeader'
  • name: body in: body schema: $ref: '#/definitions/UserLogin'

responses: 

'202':
  description: user new credentials
  schema:
    $ref: '#/definitions/UserLogin'
default:
  $ref: '#/responses/error'

func AdminSetAdminHandler 

func AdminSetAdminHandler(ctx *gin.Context)

swagger:operation POST /admin Admin AdminSetAdminHandler Make user admin.

--- x-method-visibility: public parameters:

  • $ref: '#/parameters/UserRoleHeader'
  • $ref: '#/parameters/UserIDHeader'
  • name: body in: body schema: $ref: '#/definitions/UserLogin'

responses: 

'202':
  description: user becomes admin
default:
  $ref: '#/responses/error'

func AdminUnsetAdminHandler 

func AdminUnsetAdminHandler(ctx *gin.Context)

swagger:operation DELETE /admin Admin AdminUnsetAdminHandler Make admin user.

--- x-method-visibility: public parameters:

  • $ref: '#/parameters/UserRoleHeader'
  • $ref: '#/parameters/UserIDHeader'
  • name: body in: body schema: $ref: '#/definitions/UserLogin'

responses: 

'202':
  description: admin becomes user
default:
  $ref: '#/responses/error'

func AdminUserActivateHandler 

func AdminUserActivateHandler(ctx *gin.Context)

swagger:operation POST /admin/user/activation Admin AdminUserActivateHandler Activate user.

--- x-method-visibility: public parameters:

  • $ref: '#/parameters/UserRoleHeader'
  • $ref: '#/parameters/UserIDHeader'
  • name: body in: body schema: $ref: '#/definitions/UserLogin'

responses: 

'202':
  description: user activated
default:
  $ref: '#/responses/error'

func AdminUserCreateHandler 

func AdminUserCreateHandler(ctx *gin.Context)

swagger:operation POST /admin/user/sign_up Admin AdminUserCreateHandler Create user.

--- x-method-visibility: public parameters:

  • $ref: '#/parameters/UserRoleHeader'
  • $ref: '#/parameters/UserIDHeader'
  • name: body in: body schema: $ref: '#/definitions/UserLogin'

responses: 

'201':
  description: account created
  schema:
    $ref: '#/definitions/UserLogin'
default:
  $ref: '#/responses/error'

func AdminUserDeactivateHandler 

func AdminUserDeactivateHandler(ctx *gin.Context)

swagger:operation POST /admin/user/deactivation Admin AdminUserDeactivateHandler Deactivate user.

--- x-method-visibility: public parameters:

  • $ref: '#/parameters/UserRoleHeader'
  • $ref: '#/parameters/UserIDHeader'
  • name: body in: body schema: $ref: '#/definitions/UserLogin'

responses: 

'202':
  description: user deactivated
default:
  $ref: '#/responses/error'

func BasicLoginHandler 

func BasicLoginHandler(ctx *gin.Context)

swagger:operation POST /login/basic Login BasicLoginHandler Basic login.

--- x-method-visibility: public parameters:

  • $ref: '#/parameters/UserAgentHeader'
  • $ref: '#/parameters/FingerprintHeader'
  • $ref: '#/parameters/ClientIPHeader'
  • name: body in: body schema: $ref: '#/definitions/LoginRequest'

responses: 

'200':
  description: user logged in
  schema:
    $ref: '#/definitions/CreateTokenResponse'
default:
  $ref: '#/responses/error'

func BlacklistDomainAddHandler 

func BlacklistDomainAddHandler(ctx *gin.Context)

swagger:operation POST /domain DomainBlacklist BlacklistDomainAddHandler Add domain to blacklist.

--- x-method-visibility: public parameters:

  • $ref: '#/parameters/UserRoleHeader'
  • $ref: '#/parameters/UserIDHeader'
  • name: body in: body schema: $ref: '#/definitions/Domain'

responses: 

'202':
  description: domain added to blacklist
default:
  $ref: '#/responses/error'

func BlacklistDomainDeleteHandler 

func BlacklistDomainDeleteHandler(ctx *gin.Context)

swagger:operation DELETE /domain/{domain} DomainBlacklist BlacklistDomainDeleteHandler Remove domain from blacklist.

--- x-method-visibility: public parameters:

  • $ref: '#/parameters/UserRoleHeader'
  • $ref: '#/parameters/UserIDHeader'
  • name: domain in: path type: string required: true

responses: 

'202':
  description: domain removed from blacklist
default:
  $ref: '#/responses/error'

func BlacklistDomainGetHandler 

func BlacklistDomainGetHandler(ctx *gin.Context)

swagger:operation GET /domain/{domain} DomainBlacklist BlacklistDomainGetHandler Check if domain is in blacklist.

--- x-method-visibility: public parameters:

  • $ref: '#/parameters/UserRoleHeader'
  • $ref: '#/parameters/UserIDHeader'
  • name: domain in: path type: string required: true

responses: 

'200':
  description: blacklisted domain
  schema:
    $ref: '#/definitions/Domain'
default:
  $ref: '#/responses/error'

func BlacklistDomainsListGetHandler 

func BlacklistDomainsListGetHandler(ctx *gin.Context)

swagger:operation GET /domain DomainBlacklist BlacklistDomainsListGetHandler Get blacklisted domains list.

--- x-method-visibility: public parameters:

  • $ref: '#/parameters/UserRoleHeader'
  • $ref: '#/parameters/UserIDHeader'

responses: 

'200':
  description: blacklisted domains
  schema:
    $ref: '#/definitions/DomainListResponse'
default:
  $ref: '#/responses/error'

func BlacklistGetHandler 

func BlacklistGetHandler(ctx *gin.Context)

swagger:operation GET /user/blacklist UsersBlacklist BlacklistGetHandler Users blacklist

--- x-method-visibility: public parameters:

  • $ref: '#/parameters/UserRoleHeader'
  • $ref: '#/parameters/UserIDHeader'
  • name: page in: query type: string required: false
  • name: per_page in: query type: string required: false

responses: 

'200':
  description: blacklisted users list
  schema:
    $ref: '#/definitions/UserList'
default:
  $ref: '#/responses/error'

func CompleteDeleteHandler 

func CompleteDeleteHandler(ctx *gin.Context)

swagger:operation POST /user/delete/complete User CompleteDeleteHandler Delete user completely (almost).

--- x-method-visibility: public parameters:

  • $ref: '#/parameters/UserAgentHeader'
  • $ref: '#/parameters/FingerprintHeader'
  • $ref: '#/parameters/ClientIPHeader'
  • name: body in: body schema: $ref: '#/definitions/UserLogin'

responses: 

'202':
  description: user deleted
default:
  $ref: '#/responses/error'

func CreateGroupHandler 

func CreateGroupHandler(ctx *gin.Context)

swagger:operation POST /groups UserGroups CreateGroupHandler Create user group.

--- x-method-visibility: public parameters:

  • $ref: '#/parameters/UserRoleHeader'
  • $ref: '#/parameters/UserIDHeader'
  • name: body in: body schema: $ref: '#/definitions/UserGroup'

responses: 

'201':
  description: group created
default:
  $ref: '#/responses/error'

func DeleteBoundAccountHandler 

func DeleteBoundAccountHandler(ctx *gin.Context)

swagger:operation DELETE /user/bound_accounts BoundAccounts DeleteBoundAccountHandler Unbind account. https://ch.pages.containerum.net/api-docs/modules/user-manager/index.html#delete-bound-account

--- x-method-visibility: public parameters:

  • $ref: '#/parameters/UserRoleHeader'
  • $ref: '#/parameters/UserIDHeader'
  • name: body in: body schema: $ref: '#/definitions/BoundAccountDeleteRequest'

responses: 

'202':
  description: account deleted
default:
  $ref: '#/responses/error'

func DeleteGroupHandler 

func DeleteGroupHandler(ctx *gin.Context)

swagger:operation DELETE /groups/{group} UserGroups DeleteGroupHandler Delete user group.

--- x-method-visibility: public parameters:

  • $ref: '#/parameters/UserRoleHeader'
  • $ref: '#/parameters/UserIDHeader'
  • name: group in: path type: string required: true

responses: 

'202':
  description: group deleted
default:
  $ref: '#/responses/error'

func DeleteGroupMemberHandler 

func DeleteGroupMemberHandler(ctx *gin.Context)

swagger:operation DELETE /groups/{group}/members/{member} UserGroups DeleteGroupMemberHandler Remove members from the group.

--- x-method-visibility: public parameters:

  • $ref: '#/parameters/UserRoleHeader'
  • $ref: '#/parameters/UserIDHeader'
  • name: group in: path type: string required: true
  • name: member in: path type: string required: true

responses: 

'202':
  description: user removed from the group
default:
  $ref: '#/responses/error'

func GetBoundAccountsHandler 

func GetBoundAccountsHandler(ctx *gin.Context)

swagger:operation GET /user/bound_accounts BoundAccounts GetBoundAccountsHandler Get users bound accounts.

--- x-method-visibility: public parameters:

  • $ref: '#/parameters/UserRoleHeader'
  • $ref: '#/parameters/UserIDHeader'

responses: 

'200':
  description: bound accounts list
  schema:
    $ref: '#/definitions/BoundAccounts'
default:
  $ref: '#/responses/error'

func GetGroupHandler 

func GetGroupHandler(ctx *gin.Context)

swagger:operation GET /groups/{group} UserGroups GetGroupHandler Get user groups list.

--- x-method-visibility: public parameters:

  • $ref: '#/parameters/UserRoleHeader'
  • $ref: '#/parameters/UserIDHeader'
  • name: group in: path type: string required: true

responses: 

'200':
  description: group
  schema:
    $ref: '#/definitions/UserGroup'
default:
  $ref: '#/responses/error'

func GetGroupsListHandler 

func GetGroupsListHandler(ctx *gin.Context)

swagger:operation GET /groups UserGroups GetGroupsListHandler Get user groups list.

--- x-method-visibility: public parameters:

  • $ref: '#/parameters/UserRoleHeader'
  • $ref: '#/parameters/UserIDHeader'

responses: 

'200':
  description: groups list
  schema:
    $ref: '#/definitions/UserGroups'
default:
  $ref: '#/responses/error'

func GroupListLabelID added in v1.0.3 

func GroupListLabelID(ctx *gin.Context)

func LinkResendHandler 

func LinkResendHandler(ctx *gin.Context)

swagger:operation POST /user/sign_up/resend Links LinkResendHandler Resend activation link.

--- x-method-visibility: public parameters:

  • name: body in: body schema: $ref: '#/definitions/UserLogin'

responses: 

'202':
  description: link sent
default:
  $ref: '#/responses/error'

func LinksGetHandler 

func LinksGetHandler(ctx *gin.Context)

swagger:operation GET /user/links/{user_id} Links LinksGetHandler Get user links.

--- x-method-visibility: public parameters:

  • $ref: '#/parameters/UserRoleHeader'
  • $ref: '#/parameters/UserIDHeader'
  • name: user_id in: path type: string required: true

responses: 

'200':
  description: link sent
  schema:
    $ref: '#/definitions/Links'
default:
  $ref: '#/responses/error'

func LogoutHandler 

func LogoutHandler(ctx *gin.Context)

swagger:operation POST /logout Login LogoutHandler Logout for users who used one-time token login.

--- x-method-visibility: public parameters:

  • $ref: '#/parameters/TokenIDHeader'
  • $ref: '#/parameters/SessionIDHeader'

responses: 

'200':
  description: user logged out
default:
  $ref: '#/responses/error'

func OAuthLoginHandler 

func OAuthLoginHandler(ctx *gin.Context)

swagger:operation POST /login/oauth Login OAuthLoginRequest Login using oauth service.

--- x-method-visibility: public parameters:

  • $ref: '#/parameters/UserAgentHeader'
  • $ref: '#/parameters/FingerprintHeader'
  • $ref: '#/parameters/ClientIPHeader'
  • name: body in: body schema: $ref: '#/definitions/OAuthLoginRequest'

responses: 

'200':
  description: user logged in
  schema:
    $ref: '#/definitions/CreateTokenResponse'
default:
  $ref: '#/responses/error'

func OneTimeTokenLoginHandler 

func OneTimeTokenLoginHandler(ctx *gin.Context)

swagger:operation POST /login/token Login OneTimeTokenLoginHandler Login with one-time token.

--- x-method-visibility: public parameters:

  • $ref: '#/parameters/UserAgentHeader'
  • $ref: '#/parameters/FingerprintHeader'
  • $ref: '#/parameters/ClientIPHeader'
  • name: body in: body schema: $ref: '#/definitions/OneTimeTokenLoginRequest'

responses: 

'200':
  description: user logged in
  schema:
    $ref: '#/definitions/CreateTokenResponse'
default:
  $ref: '#/responses/error'

func PartialDeleteHandler 

func PartialDeleteHandler(ctx *gin.Context)

swagger:operation POST /user/delete/partial User PartialDeleteHandler Mark user as deleted.

--- x-method-visibility: public parameters:

  • $ref: '#/parameters/UserRoleHeader'
  • $ref: '#/parameters/UserIDHeader'

responses: 

'202':
  description: user deleted
default:
  $ref: '#/responses/error'

func PasswordChangeHandler 

func PasswordChangeHandler(ctx *gin.Context)

swagger:operation POST /password/change Password PasswordChangeHandler Change password.

--- x-method-visibility: public parameters:

  • $ref: '#/parameters/UserRoleHeader'
  • $ref: '#/parameters/UserIDHeader'
  • name: body in: body schema: $ref: '#/definitions/PasswordChangeRequest'

responses: 

'200':
  description: password changed
  schema:
    $ref: '#/definitions/CreateTokenResponse'
default:
  $ref: '#/responses/error'

func PasswordResetHandler 

func PasswordResetHandler(ctx *gin.Context)

swagger:operation POST /password/reset Password PasswordResetHandler Reset password.

--- x-method-visibility: public parameters:

  • name: body in: body schema: $ref: '#/definitions/UserLogin'

responses: 

'202':
  description: password reset link sent
default:
  $ref: '#/responses/error'

func PasswordRestoreHandler 

func PasswordRestoreHandler(ctx *gin.Context)

swagger:operation POST /password/restore Password PasswordRestoreHandler Change password with token from email.

--- x-method-visibility: public parameters:

  • name: body in: body schema: $ref: '#/definitions/PasswordRestoreRequest'

responses: 

'200':
  description: password changed
  schema:
    $ref: '#/definitions/CreateTokenResponse'
default:
  $ref: '#/responses/error'

func UpdateGroupMemberHandler 

func UpdateGroupMemberHandler(ctx *gin.Context)

swagger:operation POST /groups/{group}/members/{member} UserGroups UpdateGroupMemberHandler Change group member access.

--- x-method-visibility: public parameters:

  • $ref: '#/parameters/UserRoleHeader'
  • $ref: '#/parameters/UserIDHeader'
  • name: group in: path type: string required: true
  • name: member in: path type: string required: true
  • name: body in: body schema: $ref: '#/definitions/UserGroupMember'

responses: 

'202':
  description: user access changed
default:
  $ref: '#/responses/error'

func UserCreateHandler 

func UserCreateHandler(ctx *gin.Context)

swagger:operation POST /user/sign_up User UserCreateHandler Create user.

--- x-method-visibility: public parameters:

  • $ref: '#/parameters/UserAgentHeader'
  • $ref: '#/parameters/FingerprintHeader'
  • $ref: '#/parameters/ClientIPHeader'
  • name: body in: body schema: $ref: '#/definitions/RegisterRequest'

responses: 

'200':
  description: user created
  schema:
    $ref: '#/definitions/UserLogin'
default:
  $ref: '#/responses/error'

func UserDeleteFromBlacklistHandler 

func UserDeleteFromBlacklistHandler(ctx *gin.Context)

swagger:operation DELETE /user/blacklist UsersBlacklist UserDeleteFromBlacklistHandler Remove user from blacklist.

--- x-method-visibility: public parameters:

  • $ref: '#/parameters/UserRoleHeader'
  • $ref: '#/parameters/UserIDHeader'
  • name: body in: body schema: $ref: '#/definitions/UserLogin'

responses: 

'202':
  description: user removed from blacklist
default:
  $ref: '#/responses/error'

func UserGetByIDHandler 

func UserGetByIDHandler(ctx *gin.Context)

swagger:operation GET /user/info/id/{user_id} UserInfo UserGetByIDHandler Get user info by ID.

--- x-method-visibility: private parameters:

  • name: user_id in: path type: string required: true

responses: 

'200':
  description: user info
  schema:
    $ref: '#/definitions/User'
default:
  $ref: '#/responses/error'

func UserGetByLoginHandler 

func UserGetByLoginHandler(ctx *gin.Context)

swagger:operation GET /user/info/login/{login} UserInfo UserGetByLoginHandler Get user info by ID.

--- x-method-visibility: private parameters:

  • name: login in: path type: string required: true

responses: 

'200':
  description: user info
  schema:
    $ref: '#/definitions/User'
default:
  $ref: '#/responses/error'

func UserInfoGetHandler 

func UserInfoGetHandler(ctx *gin.Context)

swagger:operation GET /user/info UserInfo UserInfoGetHandler Get user info.

--- x-method-visibility: public parameters:

  • $ref: '#/parameters/UserRoleHeader'
  • $ref: '#/parameters/UserIDHeader'

responses: 

'202':
  description: user info
  schema:
    $ref: '#/definitions/User'
default:
  $ref: '#/responses/error'

func UserInfoUpdateHandler 

func UserInfoUpdateHandler(ctx *gin.Context)

swagger:operation POST /user/info UserInfo UserInfoUpdateHandler Update user info.

--- x-method-visibility: private parameters:

  • $ref: '#/parameters/UserRoleHeader'
  • $ref: '#/parameters/UserIDHeader'
  • name: body in: body schema: $ref: '#/definitions/UserData'

responses: 

'202':
  description: updated user info
  schema:
    $ref: '#/definitions/User'
default:
  $ref: '#/responses/error'

func UserListGetHandler 

func UserListGetHandler(ctx *gin.Context)

swagger:operation GET /user/list UserInfo UserListGetHandler Get user info.

--- x-method-visibility: public parameters:

  • $ref: '#/parameters/UserRoleHeader'
  • $ref: '#/parameters/UserIDHeader'
  • name: page in: query type: string required: false
  • name: per_page in: query type: string required: false

responses: 

'200':
  description: users list
  schema:
    $ref: '#/definitions/UserList'
default:
  $ref: '#/responses/error'

func UserListLoginID 

func UserListLoginID(ctx *gin.Context)

swagger:operation POST /user/loginid UserInfo UserListLoginID Get users list.

--- x-method-visibility: public parameters:

  • name: body in: body schema: $ref: '#/definitions/IDList'

responses: 

'200':
  description: users list
  schema:
    $ref: '#/definitions/LoginID'
default:
  $ref: '#/responses/error'

func UserToBlacklistHandler 

func UserToBlacklistHandler(ctx *gin.Context)

swagger:operation POST /user/blacklist UsersBlacklist UserToBlacklistHandler Add user to blacklist.

--- x-method-visibility: public parameters:

  • $ref: '#/parameters/UserRoleHeader'
  • $ref: '#/parameters/UserIDHeader'
  • name: body in: body schema: $ref: '#/definitions/UserLogin'

responses: 

'202':
  description: user added to blacklist
default:
  $ref: '#/responses/error'

Types

This section is empty.

Source Files

View all Source files

Jump to

Keyboard shortcuts

? : This menu
/ : Search site
f or F : Jump to
y or Y : Canonical URL
go.dev uses cookies from Google to deliver and enhance the quality of its services and to analyze traffic. Learn more.