model

type ETag [12]byte

type Email string

type Features struct {
	// RBAC
	RBAC bool `json:"rbac" bson:"rbac"`

	// audit logs
	AuditLogs bool `json:"audit_logs" bson:"audit_logs"`

	// dynamic groups
	DynamicGroups bool `json:"dynamic_groups" bson:"dynamic_groups"`

	// remote terminal
	Terminal bool `json:"terminal" bson:"terminal"`

	// file transfer
	FileTransfer bool `json:"file_transfer" bson:"file_transfer"`

	// configuration
	Configuration bool `json:"configuration" bson:"configuration"`

	// monitoring
	Monitoring bool `json:"monitoring" bson:"monitoring"`

	// reporting
	Reporting bool `json:"reporting" bson:"reporting"`
}

type NewTenant struct {
	ID string `json:"tenant_id"`
}

type PersonalAccessToken struct {
	// system-generated user ID
	ID oid.ObjectID `json:"id,omitempty" bson:"_id,omitempty"`
	// token name
	Name *string `json:"name,omitempty" on:"name,omitempty"`
	// timestamp of the last usage
	LastUsed *time.Time `json:"last_used,omitempty" bson:"last_used,omitempty"`
	// the absolute time when the token expires.
	ExpirationDate *jwt.Time `json:"expiration_date,omitempty" bson:"exp,omitempty"`
	// CreatedTs is the absolute time the token was created.
	CreatedTs jwt.Time `json:"created_ts,omitempty" bson:"iat,omitempty"`
}

type Plan struct {
	// unique name used as identifier
	Name string `json:"name" bson:"_id"`

	// name to display
	DisplayName string `json:"display_name" bson:"display_name"`

	// feature set
	Features *Features `json:"features" bson:"features"`
}

type PlanBinding struct {
	// tenant can only have single plan binding
	TenantID string `json:"-" bson:"_id"`

	// plan name
	PlanName string `json:"plan_name" bson:"plan_name"`

	// limits
	Limits *PlanLimits `json:"limits,omitempty" bson:"limits,omitempty"`
}

type PlanBindingDetails struct {
	// tenant can only have single plan binding
	TenantID string `json:"-" bson:"_id"`

	// plan name
	Plan Plan `json:"plan" bson:"plan"`

	// limits
	Limits *PlanLimits `json:"limits,omitempty" bson:"limits,omitempty"`
}

type PlanLimits struct {
	// maximum number of devices
	Devices int `json:"devices" bson:"devices"`

	// maximum number of users
	Users int `json:"users" bson:"users"`

	// audit logs history in days
	AuditLogsDays int `json:"audit_logs_days" bson:"audit_logs_days"`
}

type Settings struct {
	ID     string         `json:"id"`
	ETag   string         `json:"etag"`
	UserID string         `json:"-"`
	Values SettingsValues `json:"-"`
}

type SettingsValues map[string]interface{}

type TokenRequest struct {
	Name      *string `json:"name"`
	ExpiresIn int64   `json:"expires_in"`
}

type User struct {
	// system-generated user ID
	ID string `json:"id" bson:"_id"`

	// ETag is the entity tag that together with ID uniquely identifies
	// the User document.
	// NOTE: The v1 API does not support ETags, so this is only used
	// internally for checking pre-conditions before performing updates.
	ETag *ETag `json:"-" bson:"etag,omitempty"`

	// user email address
	Email Email `json:"email" bson:"email"`

	// user password
	Password string `json:"password,omitempty" bson:"password"`

	// timestamp of the user creation
	CreatedTs *time.Time `json:"created_ts,omitempty" bson:"created_ts,omitempty"`

	// timestamp of the last user information update
	UpdatedTs *time.Time `json:"updated_ts,omitempty" bson:"updated_ts,omitempty"`

	// LoginTs is the timestamp of the last login for this user.
	LoginTs *time.Time `json:"login_ts,omitempty" bson:"login_ts,omitempty"`
}

type UserFilter struct {
	ID    []string `json:"id,omitempty"`
	Email []Email  `json:"email,omitempty"`

	CreatedAfter  *time.Time `json:"created_after,omitempty"`
	CreatedBefore *time.Time `json:"created_before,omitempty"`

	UpdatedAfter  *time.Time `json:"updated_after,omitempty"`
	UpdatedBefore *time.Time `json:"updated_before,omitempty"`
}

type UserInternal struct {
	User
	PasswordHash string `json:"password_hash,omitempty" bson:"-"`
	Propagate    *bool  `json:"propagate,omitempty" bson:"-"`
}

type UserUpdate struct {
	// ETag selects user ETag for the user to update
	// NOTE: This is the only parameter that goes into the query condition if set.
	// NOTE: If set to ETagNil, it will match users without an ETag.
	ETag *ETag `json:"-" bson:"-"`

	// ETagUpdate sets the updated ETag value. If not set, it is incremented from the
	// ETag field if that field is set.
	ETagUpdate *ETag `json:"-" bson:"etag,omitempty"`

	// user email address
	Email Email `json:"email,omitempty" bson:",omitempty" valid:"email"`

	// user password
	Password string `json:"password,omitempty" bson:"password,omitempty"`

	// user password
	CurrentPassword string `json:"current_password,omitempty" bson:"-"`

	// timestamp of the last user information update
	UpdatedTs *time.Time `json:"-" bson:"updated_ts,omitempty"`

	// token used to update the user, optional
	Token *jwt.Token `json:"-" bson:"-"`

	LoginTs *time.Time `json:"-" bson:"login_ts,omitempty"`
}