# Users reference

Copy as Markdown[View as Markdown](/docs/development/guides/owners/users-reference.md)

***

This page lists the fields and paths supported by users.

## Paths[​](#paths "Direct link to Paths")

Users are created in the `users` folder:

```
/users/{user-id}.mdx
```

Users can also be synced from directory sources such as GitHub or Microsoft Entra.

## Routes[​](#routes "Direct link to Routes")

| Route                   | Description              |
| ----------------------- | ------------------------ |
| `/docs/users/{user-id}` | User documentation page. |

## Required fields[​](#required-fields "Direct link to Required fields")

### `id`[​](#id "Direct link to id")

* Type: `string`

Unique id of the user. EventCatalog uses this for URLs and resource references.

Example

```
---
id: dboyne
---
```

### `name`[​](#name "Direct link to name")

* Type: `string`

Display name of the user.

Example

```
---
name: David Boyne
---
```

## Optional fields[​](#optional-fields "Direct link to Optional fields")

### `avatarUrl`[​](#avatarUrl "Direct link to avatarUrl")

* Type: `string`

Avatar URL for the user.

Example

```
---
avatarUrl: https://github.com/dboyne.png
---
```

### `role`[​](#role "Direct link to role")

* Type: `string`

User role or title.

Example

```
---
role: Staff Engineer
---
```

### `email`[​](#email "Direct link to email")

* Type: `string`

User email address.

Example

```
---
email: david@example.com
---
```

### `hidden`[​](#hidden "Direct link to hidden")

* Type: `boolean`

Hide the user from generated lists.

Example

```
---
hidden: true
---
```

### `slackDirectMessageUrl`[​](#slackDirectMessageUrl "Direct link to slackDirectMessageUrl")

* Type: `string`

Slack direct message URL.

Example

```
---
slackDirectMessageUrl: https://slack.example.com/team/dboyne
---
```

### `msTeamsDirectMessageUrl`[​](#msTeamsDirectMessageUrl "Direct link to msTeamsDirectMessageUrl")

* Type: `string`

Microsoft Teams direct message URL.

Example

```
---
msTeamsDirectMessageUrl: https://teams.microsoft.com/l/chat/example
---
```