# `OCSF.User`
[🔗](https://github.com/docjerem/ocsf/blob/v0.1.0/lib/ocsf/objects/user.ex#L1)

OCSF User object.

Represents a user identity in an OCSF event. Corresponds to the
OCSF [User](https://schema.ocsf.io/1.8.0/objects/user) object.

## Fields

- `:uid` -- unique user identifier. Classified as `:identifier`.
- `:name` -- display name. Classified as `:identity` (PII, erasable).
- `:email_addr` -- email address. Classified as `:contact` (PII, erasable).
- `:org` -- `%OCSF.Organization{}` or `nil`. Classified as `:tenant`.
- `:type_id` -- user type identifier. Classified as `:taxonomic`.

## PII classification

See `OCSF.Classification` for data class definitions. Call
`__ocsf_fields__/0` to inspect this module's field classifications.

See `OCSF.Organization`, `OCSF.Actor`, and `OCSF.Classification` for
related modules.

# `t`

```elixir
@type t() :: %OCSF.User{
  email_addr: String.t() | nil,
  name: String.t() | nil,
  org: OCSF.Organization.t() | nil,
  type_id: integer() | nil,
  uid: String.t() | nil
}
```

# `__ocsf_fields__`

```elixir
@spec __ocsf_fields__() :: keyword()
```

Return field classification metadata for PII policy enforcement.

---

*Consult [api-reference.md](api-reference.md) for complete listing*