handlers

package
v1.0.0-rc.4 Latest Latest
Warning

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

 Go to latest Published: May 31, 2018 License: Apache-2.0 Imports: 12 Imported by: 0

Documentation

Overview

Package routes User-Manager

User-Manager service is service for managing users. 

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. https://ch.pages.containerum.net/api-docs/modules/user-manager/index.html#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 GetBoundAccountsHandler Bind account. https://ch.pages.containerum.net/api-docs/modules/user-manager/index.html#add-bound-accounts

--- 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 AdminResetPassword 

func AdminResetPassword(ctx *gin.Context)

swagger:operation POST /admin/user/password/reset Admin AdminResetPassword Make admin user. https://ch.pages.containerum.net/api-docs/modules/user-manager/index.html#admin-reset-password

--- 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 AdminSetAdmin 

func AdminSetAdmin(ctx *gin.Context)

swagger:operation POST /admin Admin AdminSetAdmin Make user admin. https://ch.pages.containerum.net/api-docs/modules/user-manager/index.html#set-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 AdminUnsetAdmin 

func AdminUnsetAdmin(ctx *gin.Context)

swagger:operation DELETE /admin Admin AdminSetAdmin 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 AdminUserActivate 

func AdminUserActivate(ctx *gin.Context)

swagger:operation POST /admin/user/activation Admin AdminUserActivate Activate user. https://ch.pages.containerum.net/api-docs/modules/user-manager/index.html#admin-user-activation

--- 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. https://ch.pages.containerum.net/api-docs/modules/user-manager/index.html#admin-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 AdminUserDeactivate 

func AdminUserDeactivate(ctx *gin.Context)

swagger:operation POST /admin/user/deactivation Admin AdminUserDeactivate Deactivate user. https://ch.pages.containerum.net/api-docs/modules/user-manager/index.html#admin-user-deactivation

--- 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. https://ch.pages.containerum.net/api-docs/modules/user-manager/index.html#sign-in-with-login-and-password

--- 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. https://ch.pages.containerum.net/api-docs/modules/user-manager/index.html#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. https://ch.pages.containerum.net/api-docs/modules/user-manager/index.html#delete-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. https://ch.pages.containerum.net/api-docs/modules/user-manager/index.html#get-blacklist-domain

--- 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. https://ch.pages.containerum.net/api-docs/modules/user-manager/index.html#get-blacklist-domain-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 https://ch.pages.containerum.net/api-docs/modules/user-manager/index.html#blacklist-users

--- 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). https://ch.pages.containerum.net/api-docs/modules/user-manager/index.html#delete-user-from-everywhere

--- 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 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 GetBoundAccountsHandler 

func GetBoundAccountsHandler(ctx *gin.Context)

swagger:operation GET /user/bound_accounts BoundAccounts GetBoundAccountsHandler Get users bound accounts. https://ch.pages.containerum.net/api-docs/modules/user-manager/index.html#get-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 LinkResendHandler 

func LinkResendHandler(ctx *gin.Context)

swagger:operation POST /user/sign_up/resend Links LinkResendHandler Resend activation link. https://ch.pages.containerum.net/api-docs/modules/user-manager/index.html#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. https://ch.pages.containerum.net/api-docs/modules/user-manager/index.html#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. https://ch.pages.containerum.net/api-docs/modules/user-manager/index.html#sign-out

--- 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. https://ch.pages.containerum.net/api-docs/modules/user-manager/index.html#sign-in-with-third-party-resource-oauth

--- 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. https://ch.pages.containerum.net/api-docs/modules/user-manager/index.html#sign-in-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. https://ch.pages.containerum.net/api-docs/modules/user-manager/index.html#delete-user-pseudo

--- 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. https://ch.pages.containerum.net/api-docs/modules/user-manager/index.html#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. https://ch.pages.containerum.net/api-docs/modules/user-manager/index.html#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. https://ch.pages.containerum.net/api-docs/modules/user-manager/index.html#reseted-password-change

--- 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 UserCreateHandler 

func UserCreateHandler(ctx *gin.Context)

swagger:operation POST /user/sign_up User UserCreateHandler Create user. https://ch.pages.containerum.net/api-docs/modules/user-manager/index.html#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. https://ch.pages.containerum.net/api-docs/modules/user-manager/index.html#get-user-info-by-id-for-mail

--- 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. https://ch.pages.containerum.net/api-docs/modules/user-manager/index.html#get-user-info-by-login-for-resource

--- 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. https://ch.pages.containerum.net/api-docs/modules/user-manager/index.html#get-profile-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. https://ch.pages.containerum.net/api-docs/modules/user-manager/index.html#change-profile-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. https://ch.pages.containerum.net/api-docs/modules/user-manager/index.html#get-user-list

--- 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 GET /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. https://ch.pages.containerum.net/api-docs/modules/user-manager/index.html#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.