enums

Documentation

Index

• Constants
• type AUTH_TYPE
• type ENVIRONMENT
• type MEDIA
• type PERMISSION
• type RESOURCE
• type ROLE
• type ROLE_UPDATE_OPTION
• type STATUS
• type TOKEN_TYPE
• type USER_REGISTRATION_ACTION
• type USER_UPDATE_ACTION

Constants

const (
	// PRODUCTION production environment
	PRODUCTION = ENVIRONMENT("PRODUCTION")
	// DEVELOP development environment
	DEVELOP = ENVIRONMENT("DEVELOP")
	// TEST test environment
	TEST = ENVIRONMENT("TEST")
)

const (
	// MONGO mongo as db
	MONGO = "MONGO"
	// INMEMORY in memory storage as db
	INMEMORY = "INMEMORY"
)

const (
	// APPEND_PERMISSION refers to append permission update option
	APPEND_PERMISSION = ROLE_UPDATE_OPTION("append")
	// REMOVE_PERMISSION refers to remove permission update option
	REMOVE_PERMISSION = ROLE_UPDATE_OPTION("remove")
)

const (
	// REGULAR_TOKEN refers to limited lifetime token and refresh token
	REGULAR_TOKEN = TOKEN_TYPE("regular")
	// CTL_TOKEN refers to long lifetime token and refresh token
	CTL_TOKEN = TOKEN_TYPE("ctl")
)

const (
	// RESET_PASSWORD refers to password reset action
	RESET_PASSWORD = USER_UPDATE_ACTION("reset_password")
	// FORGOT_PASSWORD refers to password forgot action
	FORGOT_PASSWORD = USER_UPDATE_ACTION("forgot_password")
	// ATTACH_COMPANY refers to company attachment action
	ATTACH_COMPANY = USER_UPDATE_ACTION("attach_company")
	// UPDATE_STATUS refers to status update action
	UPDATE_STATUS = USER_UPDATE_ACTION("update_status")
)

const (
	// ACTIVE user status for active user
	ACTIVE = STATUS("active")
	// INACTIVE user status for inactive user
	INACTIVE = STATUS("inactive")
	// DELETED user status for deleted user
	DELETED = STATUS("deleted")
)

const (
	// EMAIL refers to email media
	EMAIL = MEDIA("email")
	// PHONE refers to phone media
	PHONE = MEDIA("phone")
)

const (
	// ADMIN refers to admin role
	ADMIN = ROLE("ADMIN")
	// VIEWER refers to user role
	VIEWER = ROLE("VIEWER")
)

const (
	// USER refers to user resource
	USER = RESOURCE("user")
	// PIPELINE refers to pipeline resource
	PIPELINE = RESOURCE("pipeline")
	// PROCESS refers to process resource
	PROCESS = RESOURCE("process")
	// COMPANY refers to company resource
	COMPANY = RESOURCE("company")
	// REPOSITORY refers to repository resource
	REPOSITORY = RESOURCE("repository")
	// APPLICATION refers to application resource
	APPLICATION = RESOURCE("application")
	// ROLE_RESOURCE refers to role resource
	ROLE_RESOURCE = RESOURCE("role")
	// PERMISSION_RESOURCE refers to permission resource
	PERMISSION_RESOURCE = RESOURCE("permission")
)

const (
	// CREATE refers to CREATE permission
	CREATE = PERMISSION("CREATE")
	// READ refers to READ permission
	READ = PERMISSION("READ")
	// UPDATE refers to UPDATE permission
	UPDATE = PERMISSION("UPDATE")
	// DELETE refers to DELETE permission
	DELETE = PERMISSION("DELETE")
)

const (
	// CREATE_USER refers to create user by admin
	CREATE_USER = USER_REGISTRATION_ACTION("create_user")
)

const (
	// PASSWORD grand_type of users authentication
	PASSWORD = AUTH_TYPE("password")
)

Types

type AUTH_TYPE

type AUTH_TYPE string

AUTH_TYPE AuthType update action

type ENVIRONMENT

type ENVIRONMENT string

ENVIRONMENT run environment

type MEDIA

type MEDIA string

MEDIA otp media

type PERMISSION

type PERMISSION string

PERMISSION permission string

type RESOURCE

type RESOURCE string

RESOURCE resource string

type ROLE

type ROLE string

ROLE role string

type ROLE_UPDATE_OPTION

type ROLE_UPDATE_OPTION string

ROLE_UPDATE_OPTION role update option type

type STATUS

type STATUS string

STATUS status update action

type TOKEN_TYPE

type TOKEN_TYPE string

TOKEN_TYPE token type of user

type USER_REGISTRATION_ACTION

type USER_REGISTRATION_ACTION string

USER_REGISTRATION_ACTION user registration action

type USER_UPDATE_ACTION

type USER_UPDATE_ACTION string

USER_UPDATE_ACTION users update action