---
title: UserStructure
summary: API reference for UserStructure.
status: draft
owner: SAIF
last_reviewed: 2026-07-24
library: SAIF.Business.Security.SystemUser
reference_type: package
---

# UserStructure

`UserStructure` is the public data carrier used by `clsSystemUser` create and update operations to supply user-account fields for Active Directory persistence.

## Purpose
- Group account attributes needed by `AddNewUser(...)` and `UpdateUser(...)` into one value type.

## Context
- Namespace: `SAIF.Business.Security.SystemUser`
- Assembly/package: `SAIF.Business.Security.SystemUser` / `SAIF.BOF.Business.Security.SystemUser`

## Public members
| Member | Signature | Purpose |
| --- | --- | --- |
| `userID` | `userID As String` | Carries the portal user ID to create or update. |
| `password` | `password As String` | Carries the account password used during create or update flows. |
| `idNum` | `idNum As String` | Carries the identifier number associated with the user record. |
| `firstName` | `firstName As String` | Carries the user's first name. |
| `lastName` | `lastName As String` | Carries the user's last name. |
| `companyName` | `companyName As String` | Carries the company name associated with the user. |
| `jobTitle` | `jobTitle As String` | Carries the user's job title. |
| `phoneNum` | `phoneNum As String` | Carries the user's phone number. |
| `faxNum` | `faxNum As String` | Carries the user's fax number. |
| `emailAddress` | `emailAddress As String` | Carries the user's email address. |
| `physAddress` | `physAddress As String` | Carries the user's physical address. |
| `isTestUser` | `isTestUser As Boolean` | Flags whether the account should be persisted as a test user under [BR-012](../../business-rules.md#br-012-test-user-flags-are-stored-in-the-ad-description-attribute). |

## Behavioral notes
- `AddNewUser(...)` and `UpdateUser(...)` map these fields onto an underlying `clsUser` object.
- `isTestUser` affects the AD `Description` attribute through [BR-012](../../business-rules.md#br-012-test-user-flags-are-stored-in-the-ad-description-attribute).

## Constraints and usage notes
- All field types above are declared directly in the `UserStructure` structure definition in `clsSystemUser.vb` and are source-verified.

## Sources
- `Business\SAIF.Business.Security.SystemUser\clsSystemUser.vb`