user.go

package models

import "time"

const (
	StateUnapproved int32 = iota
	StateApproved
	StateRejected
	StateUnlicensed
)

const (
	StatusUnActivated int32 = iota
	StatusActive            // Only users assigned this status can log in to OneLogin.
	StatusSuspended
	StatusLocked
	StatusPasswordExpired
	StatusAwaitingPasswordReset     // The user is required to reset their password.
	statusUnused6                   // There is not user status with a value of 6.
	StatusPasswordPending           // The user has not yet set their password.
	StatusSecurityQuestionsRequired // The user has not yet set their security questions.
)

// UserQuery represents available query parameters
type UserQuery struct {
	Limit          string     `json:"limit,omitempty"`
	Page           string     `json:"page,omitempty"`
	Cursor         string     `json:"cursor,omitempty"`
	CreatedSince   *time.Time `json:"created_since,omitempty"`
	CreatedUntil   *time.Time `json:"created_until,omitempty"`
	UpdatedSince   *time.Time `json:"updated_since,omitempty"`
	UpdatedUntil   *time.Time `json:"updated_until,omitempty"`
	LastLoginSince *time.Time `json:"last_login_since,omitempty"`
	LastLoginUntil *time.Time `json:"last_login_until,omitempty"`
	Firstname      *string    `json:"firstname,omitempty"`
	Lastname       *string    `json:"lastname,omitempty"`
	Email          *string    `json:"email,omitempty"`
	Username       *string    `json:"username,omitempty"`
	Samaccountname *string    `json:"samaccountname,omitempty"`
	DirectoryID    *string    `json:"directory_id,omitempty"`
	ExternalID     *string    `json:"external_id,omitempty"`
	AppID          *string    `json:"app_id,omitempty"`
	UserIDs        *string    `json:"user_ids,omitempty"`
	Fields         *string    `json:"fields,omitempty"`
}

// User represents a OneLogin User
type User struct {
	Firstname            *string                `json:"firstname,omitempty"`
	Lastname             *string                `json:"lastname,omitempty"`
	Username             *string                `json:"username,omitempty"`
	Email                *string                `json:"email,omitempty"`
	DistinguishedName    *string                `json:"distinguished_name,omitempty"`
	Samaccountname       *string                `json:"samaccountname,omitempty"`
	UserPrincipalName    *string                `json:"userprincipalname,omitempty"`
	MemberOf             *string                `json:"member_of,omitempty"`
	Phone                *string                `json:"phone,omitempty"`
	Password             *string                `json:"password,omitempty"`
	PasswordConfirmation *string                `json:"password_confirmation,omitempty"`
	PasswordAlgorithm    *string                `json:"password_algorithm,omitempty"`
	Salt                 *string                `json:"salt,omitempty"`
	Title                *string                `json:"title,omitempty"`
	Company              *string                `json:"company,omitempty"`
	Department           *string                `json:"department,omitempty"`
	Comment              *string                `json:"comment,omitempty"`
	CreatedAt            *time.Time             `json:"created_at,omitempty"`
	UpdatedAt            *time.Time             `json:"updated_at,omitempty"`
	ActivatedAt          *time.Time             `json:"activated_at,omitempty"`
	LastLogin            *time.Time             `json:"last_login,omitempty"`
	PasswordChangedAt    *time.Time             `json:"password_changed_at,omitempty"`
	LockedUntil          *time.Time             `json:"locked_until,omitempty"`
	InvitationSentAt     *time.Time             `json:"invitation_sent_at,omitempty"`
	State                *int32                 `json:"state,omitempty"`
	Status               *int32                 `json:"status,omitempty"`
	InvalidLoginAttempts *int32                 `json:"invalid_login_attempts,omitempty"`
	GroupID              *int32                 `json:"group_id,omitempty"`
	DirectoryID          *int32                 `json:"directory_id,omitempty"`
	TrustedIDPID         *int32                 `json:"trusted_idp_id,omitempty"`
	ManagerADID          *int32                 `json:"manager_ad_id,omitempty"`
	ManagerUserID        *int32                 `json:"manager_user_id,omitempty"`
	ExternalID           *int32                 `json:"external_id,omitempty"`
	ID                   *int32                 `json:"id,omitempty"`
	CustomAttributes     map[string]interface{} `json:"custom_attributes,omitempty"`
}

func (q *UserQuery) GetKeyValidators() map[string]func(interface{}) bool {
	return map[string]func(interface{}) bool{
		"limit":          validateString,
		"page":           validateString,
		"cursor":         validateString,
		"createdSince":   validateTime,
		"createdUntil":   validateTime,
		"updatedSince":   validateTime,
		"updatedUntil":   validateTime,
		"lastLoginSince": validateTime,
		"lastLoginUntil": validateTime,
		"firstname":      validateString,
		"lastname":       validateString,
		"email":          validateString,
		"username":       validateString,
		"samaccountname": validateString,
		"directoryID":    validateString,
		"externalID":     validateString,
		"appID":          validateString,
		"userIDs":        validateString,
		"fields":         validateString,
	}
}

// UserApp is the contract for a users app.
type UserApp struct {
	ID                  *int32  `json:"id,omitempty"`
	IconURL             *string `json:"icon_url,omitempty"`
	LoginID             *int32  `json:"login_id,omitempty"`
	ProvisioningStatus  *string `json:"provisioning_status,omitempty"`
	ProvisioningState   *string `json:"provisioning_state,omitempty"`
	ProvisioningEnabled *bool   `json:"provisioning_enabled,omitempty"`
}