> ## Documentation Index
> Fetch the complete documentation index at: https://docs.mx.com/llms.txt
> Use this file to discover all available pages before exploring further.

# Users Overview

> Users represent an end user using the Platform API through your web or mobile app.

Users are created by MX clients and belong to a specific [client](/products/connectivity/overview/data-architecture#clients) on the platform.

## User Fields

| Field         | Data Type | Description                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                            |
| :------------ | :-------- | :------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------- |
| `email`       | String    | The end user's email address. When set with Create User, this must adhere to the following format and rules: `{user_name}@{domain}.{top_level_domain}`.<ul><li>`user_name` can include alphanumeric characters (letters and numbers) and special characters: `.`, `!`, `#`, `$`, `%`, `&`, `'`, `*`, `+`, `/`, `=`, `?`, `^`, `_`, `{`, `}`, `\|`, `~`, `-`.</li><li>`@` symbol must exist between the `user_name` and `domain`.</li><li>`domain` must start/end with an alphanumeric character. It can include hyphens (-), but not consecutive hyphens. If there are multiple domain levels (for example, subdomains), they must follow the same rules.</li><li>At least one dot `.` must separate the `domain` and `top_level_domain`.</li></ul>Examples of **correct** formatting:<ul><li>`user@example.com`</li><li>`user.name+test@sub-domain.example.co.uk`</li></ul>Examples of **incorrect** formatting:<ul><li>`@example.com` (missing `user_name`)</li><li>`user@domain..com` (double dot in domain)</li><li>`user@domain-.com` (hyphen at the end of the domain)</li></ul> |
| `guid`        | String    | The unique identifier for the `user` defined by MX, beginning with the prefix `USR-`.                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                  |
| `id`          | String    | A unique, partner-defined, enforced identifier for the `user`. This value must be URL-safe. The `id` field must only contain letters, numbers, and the dash and underscore characters.                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                 |
| `is_disabled` | Boolean   | This indicates whether the user has been disabled. Defaults to `false`.                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                |
| `metadata`    | String    | Additional information you can store about this user. MX recommends using JSON-structured data.                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                        |
