Find User by Username
mattermost.get_user_by_username
ActionChat & messagingconnection required
Calls the Mattermost API with the connection's credentials.
Look up a user by username and return their profile, including the id.
Connection
- Required
- Yes — the node will not save without one
- Auth type
- Bearer token
- Providers
- Mattermost
- Secret shape
- the personal access token, or {"token": "…"}
- Config it needs
- base_url, team_id
- Resolved by
- config.connection_id, else node.connection_id
Configuration
1 field, 1 required. A dotted path is a nested object and name[] an array of objects — the editor renders the same tree.
| Field | Type | Required | Default | Constraints | Example |
|---|---|---|---|---|---|
username The Mattermost username, with or without a leading '@'. | string | Yes | — | — | jane.doe |
Example configuration
Every value below is the contract’s own example or default — nothing invented.
{
"username": "jane.doe"
}Output
One shape.
result
| Field | Type | Example |
|---|---|---|
id The user id — what memberships, DMs and reactions need. | string | — |
username The Mattermost username. | string | jane.doe |
email The user's email address, when the token may see it. | string | — |
first_name The user's first name. | string | — |
last_name The user's last name. | string | — |
nickname The user's nickname. | string | — |
roles Space-separated role names, e.g. 'system_user'. | string | — |
{
"email": "",
"first_name": "",
"id": "",
"last_name": "",
"nickname": "",
"roles": "",
"username": "jane.doe"
}See Find User by Username run in a workflow.
In a technical demo we add the Mattermost connection, drop the node on the canvas and let Workflow Health pre-flight it before the first real run.