Users reference
This page lists the fields and paths supported by users.
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
| Route | Description |
|---|---|
/docs/users/{user-id} | User overview page. |
/docs/users/{user-id}/resources | Everything the user owns, in a searchable table. Only created when the user owns at least one resource. (Added in 5.12.0) |
The Owned Resources table can be opened filtered to resource types with the type query parameter, for example /docs/users/dboyne/resources?type=services.
Required fields
id
- Type:
string
Unique id of the user. EventCatalog uses this for URLs and resource references.
Example
---
id: dboyne
---
name
- Type:
string
Display name of the user.
Example
---
name: David Boyne
---
Optional fields
avatarUrl
- Type:
string
Avatar URL for the user.
Example
---
avatarUrl: https://github.com/dboyne.png
---
role
- Type:
string
User role or title.
Example
---
role: Staff Engineer
---
email
- Type:
string
User email address.
Example
---
email: david@example.com
---
slackDirectMessageUrl
- Type:
string
Slack direct message URL.
Example
---
slackDirectMessageUrl: https://slack.example.com/team/dboyne
---
msTeamsDirectMessageUrl
- Type:
string
Microsoft Teams direct message URL.
Example
---
msTeamsDirectMessageUrl: https://teams.microsoft.com/l/chat/example
---