mgmnt

package
v1.0.0 Latest Latest
Warning

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

Go to latest
Published: Oct 14, 2020 License: Apache-2.0, Apache-2.0 Imports: 16 Imported by: 0

Documentation

Index

Constants

This section is empty.

Variables

View Source
var (
	// UserRepo is a user Repository instance
	UserRepo connector.UserRepository
	// GroupRepo is a group repository instance
	GroupRepo connector.GroupRepository
	// RoleRepo is a role repository instance
	RoleRepo connector.RoleRepository
	// UserGroupRepo is a user group repository instance
	UserGroupRepo connector.UserGroupRepository
	// UserRoleRepo is a user role repository instance
	UserRoleRepo connector.UserRoleRepository
	// GroupRoleRepo is a group role repository instance
	GroupRoleRepo connector.GroupRoleRepository
	// EmailSender is email sender instance
	EmailSender connector.EmailSender
)

Functions

func Activate2FA

func Activate2FA(w http.ResponseWriter, r *http.Request)

Activate2FA handle 2FA activation request

func ActivateUser

func ActivateUser(w http.ResponseWriter, r *http.Request)

ActivateUser serve user activation process

func ChangePassphrase

func ChangePassphrase(w http.ResponseWriter, r *http.Request)

ChangePassphrase handles the change password request

func CreateGroupRole

func CreateGroupRole(w http.ResponseWriter, r *http.Request)

CreateGroupRole serving reqest to create new group role

func CreateGroupUser

func CreateGroupUser(w http.ResponseWriter, r *http.Request)

CreateGroupUser serving request to create new User-Group

func CreateNewGroup

func CreateNewGroup(w http.ResponseWriter, r *http.Request)

CreateNewGroup serving request to create new Group

func CreateNewUser

func CreateNewUser(w http.ResponseWriter, r *http.Request)

CreateNewUser handles request to create new user

func CreateRole

func CreateRole(w http.ResponseWriter, r *http.Request)

CreateRole serve the creation new role endpoint

func CreateRoleGroup

func CreateRoleGroup(w http.ResponseWriter, r *http.Request)

CreateRoleGroup serving request to create new group-role

func CreateRoleUser

func CreateRoleUser(w http.ResponseWriter, r *http.Request)

CreateRoleUser serving request to create new user-role

func CreateUserGroup

func CreateUserGroup(w http.ResponseWriter, r *http.Request)

CreateUserGroup serve creation of user-group relation

func CreateUserRole

func CreateUserRole(w http.ResponseWriter, r *http.Request)

CreateUserRole serve a user-role relation

func DeleteGroup

func DeleteGroup(w http.ResponseWriter, r *http.Request)

DeleteGroup serving request to delete a group

func DeleteGroupRole

func DeleteGroupRole(w http.ResponseWriter, r *http.Request)

DeleteGroupRole serving request to delete group-role

func DeleteGroupRoles

func DeleteGroupRoles(w http.ResponseWriter, r *http.Request)

func DeleteGroupUser

func DeleteGroupUser(w http.ResponseWriter, r *http.Request)

DeleteGroupUser serving request to delete user-group

func DeleteGroupUsers

func DeleteGroupUsers(w http.ResponseWriter, r *http.Request)

func DeleteRole

func DeleteRole(w http.ResponseWriter, r *http.Request)

DeleteRole serving request to delete a role

func DeleteRoleGroup

func DeleteRoleGroup(w http.ResponseWriter, r *http.Request)

DeleteRoleGroup serving request to delete group-role

func DeleteRoleGroups

func DeleteRoleGroups(w http.ResponseWriter, r *http.Request)

func DeleteRoleUser

func DeleteRoleUser(w http.ResponseWriter, r *http.Request)

DeleteRoleUser serving request to delete user-role

func DeleteRoleUsers

func DeleteRoleUsers(w http.ResponseWriter, r *http.Request)

func DeleteUser

func DeleteUser(w http.ResponseWriter, r *http.Request)

DeleteUser serve user deletion

func DeleteUserGroup

func DeleteUserGroup(w http.ResponseWriter, r *http.Request)

DeleteUserGroup serve deleting a user-group relation

func DeleteUserGroups

func DeleteUserGroups(w http.ResponseWriter, r *http.Request)

func DeleteUserRole

func DeleteUserRole(w http.ResponseWriter, r *http.Request)

DeleteUserRole serve the user deletion

func DeleteUserRoles

func DeleteUserRoles(w http.ResponseWriter, r *http.Request)

func GetGroupDetail

func GetGroupDetail(w http.ResponseWriter, r *http.Request)

GetGroupDetail serving request to fetch group detail

func GetRoleDetail

func GetRoleDetail(w http.ResponseWriter, r *http.Request)

GetRoleDetail serving request to get role detail

func GetUserDetail

func GetUserDetail(w http.ResponseWriter, r *http.Request)

GetUserDetail serve fetch user detail

func InitializeRouter

func InitializeRouter(router *mux.Router)

InitializeRouter will initialize router to execute management endpoints

func ListAllGroup

func ListAllGroup(w http.ResponseWriter, r *http.Request)

ListAllGroup serving the listing of group request

func ListAllRole

func ListAllRole(w http.ResponseWriter, r *http.Request)

ListAllRole handling endpoint to serve Listing all roles in database.

func ListAllUserRole

func ListAllUserRole(w http.ResponseWriter, r *http.Request)

ListAllUserRole serve listing of all roles belong to user, both direct or indirect

func ListAllUsers

func ListAllUsers(w http.ResponseWriter, r *http.Request)

ListAllUsers serving listing all user request

func ListGroupRole

func ListGroupRole(w http.ResponseWriter, r *http.Request)

ListGroupRole serving request to list all group-role

func ListGroupUser

func ListGroupUser(w http.ResponseWriter, r *http.Request)

ListGroupUser serving request to list Users of a group

func ListRoleGroup

func ListRoleGroup(w http.ResponseWriter, r *http.Request)

ListRoleGroup endpoint to serve group-role

func ListRoleUser

func ListRoleUser(w http.ResponseWriter, r *http.Request)

ListRoleUser serving request to list user-role.

func ListUserGroup

func ListUserGroup(w http.ResponseWriter, r *http.Request)

ListUserGroup serve a user-group listing

func ListUserRole

func ListUserRole(w http.ResponseWriter, r *http.Request)

ListUserRole serve listing all role that directly owned by user

func RecoverPassphrase

func RecoverPassphrase(w http.ResponseWriter, r *http.Request)

RecoverPassphrase serving request for recovering passphrase

func ResetPassphrase

func ResetPassphrase(w http.ResponseWriter, r *http.Request)

ResetPassphrase serving passphrase reset request

func SetGroupRoles

func SetGroupRoles(w http.ResponseWriter, r *http.Request)

func SetGroupUsers

func SetGroupUsers(w http.ResponseWriter, r *http.Request)

func SetRoleGroups

func SetRoleGroups(w http.ResponseWriter, r *http.Request)

func SetRoleUsers

func SetRoleUsers(w http.ResponseWriter, r *http.Request)

func SetUserGroups

func SetUserGroups(w http.ResponseWriter, r *http.Request)

func SetUserRoles

func SetUserRoles(w http.ResponseWriter, r *http.Request)

func Show2FAQrCode

func Show2FAQrCode(w http.ResponseWriter, r *http.Request)

Show2FAQrCode shows 2FA QR code. It returns a PNG image bytes.

func UpdateGroup

func UpdateGroup(w http.ResponseWriter, r *http.Request)

UpdateGroup serving request to update group detail

func UpdateRole

func UpdateRole(w http.ResponseWriter, r *http.Request)

UpdateRole serving request to update role detail

func UpdateUserDetail

func UpdateUserDetail(w http.ResponseWriter, r *http.Request)

UpdateUserDetail rest endpoint to update user detail

func WhoAmI

func WhoAmI(w http.ResponseWriter, r *http.Request)

WhoAmI handles who am I inquiry request

Types

type Activate2FARequest

type Activate2FARequest struct {
	Token string `json:"2FA_token"`
}

Activate2FARequest hold request structure for activating the 2FA request

type Activate2FAResponse

type Activate2FAResponse struct {
	Codes []string `json:"2FA_recovery_codes"`
}

Activate2FAResponse hold response structure for activating the 2FA request

type ActivateUserRequest

type ActivateUserRequest struct {
	Email           string `json:"email"`
	ActivationToken string `json:"activation_token"`
	NewPassphrase   string `json:"new_passphrase"`
}

ActivateUserRequest hold request data for activating user

type ChangePassphraseRequest

type ChangePassphraseRequest struct {
	OldPassphrase string `json:"old_passphrase"`
	NewPassphrase string `json:"new_passphrase"`
}

ChangePassphraseRequest stores change password request

type CreateGroupRequest

type CreateGroupRequest struct {
	GroupName   string `json:"group_name"`
	Description string `json:"description"`
}

CreateGroupRequest hold model for Create new Group.

type CreateNewUserRequest

type CreateNewUserRequest struct {
	Email      string `json:"email"`
	Passphrase string `json:"passphrase"`
}

CreateNewUserRequest hold the data model for requesting to create new user.

type CreateNewUserResponse

type CreateNewUserResponse struct {
	RecordID    string    `json:"rec_id"`
	Email       string    `json:"email"`
	Enabled     bool      `json:"enabled"`
	Suspended   bool      `json:"suspended"`
	LastSeen    time.Time `json:"last_seen"`
	LastLogin   time.Time `json:"last_login"`
	TotpEnabled bool      `json:"enabled_2fa"`
}

CreateNewUserResponse hold the data model for responding CreateNewUser request

type CreateRoleRequest

type CreateRoleRequest struct {
	RoleName    string `json:"role_name"`
	Description string `json:"description"`
}

CreateRoleRequest hold dta model for requesting to create new role

type GroupSummary

type GroupSummary struct {
	RecordID  string         `json:"rec_id"`
	GroupName string         `json:"group_name"`
	Roles     []*RoleSummary `json:"roles"`
}

GroupSummary hold group information summay

type RecoverPassphraseRequest

type RecoverPassphraseRequest struct {
	Email string `json:"email"`
}

RecoverPassphraseRequest hold the model for requesting passphrase recovery

type ResetPassphraseRequest

type ResetPassphraseRequest struct {
	ResetToken    string `json:"passphraseResetToken"`
	NewPassphrase string `json:"newPassphrase"`
}

ResetPassphraseRequest hold data model for reseting passphrase

type RoleSummary

type RoleSummary struct {
	RecordID string `json:"rec_id"`
	RoleName string `json:"role_name"`
}

RoleSummary hold role information summay

type SimpleGroup

type SimpleGroup struct {
	RecID     string `json:"rec_id"`
	GroupName string `json:"group_name"`
}

SimpleGroup hold basic data of group

type SimpleRole

type SimpleRole struct {
	RecID    string `json:"rec_id"`
	RoleName string `json:"role_name"`
}

SimpleRole define structure or request body used to list role

type SimpleUser

type SimpleUser struct {
	RecID     string `json:"rec_id"`
	Email     string `json:"email"`
	Enabled   bool   `json:"enabled"`
	Suspended bool   `json:"suspended"`
}

SimpleUser hold data model of user. showing important attributes only.

type UpdateUserRequest

type UpdateUserRequest struct {
	Email     string `json:"email"`
	Enabled   bool   `json:"enabled"`
	Suspended bool   `json:"suspended"`
	Enable2FA bool   `json:"enabled_2fa"`
}

UpdateUserRequest hold request data for requesting to update user information.

type WhoAmIResponse

type WhoAmIResponse struct {
	RecordID   string          `json:"rec_id"`
	Email      string          `json:"email"`
	Enabled    bool            `json:"enabled"`
	Suspended  bool            `json:"suspended"`
	Roles      []*RoleSummary  `json:"roles"`
	Groups     []*GroupSummary `json:"groups"`
	Enabled2FA bool            `json:"enabled_2fa"`
}

WhoAmIResponse holds the response structure for WhoAmI request

Jump to

Keyboard shortcuts

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