Skip to main content
Create a new user in the system. Note: Password is required for email login. For other authentication types, the Auth Data and Auth Service fields are required. Required Permissions:
  • No permission is required for creating email/username accounts on an open server.
  • An auth token is required for other authentication types such as LDAP or SAML.
External DocumentationTo learn more, visit the Mattermost documentation.

​
Basic Parameters

ParameterDescription
EmailThe email address of the new user.
Email Token IDThe token ID from an email verification link.
First NameThe first name of the new user.
Invitation IDThe token ID from an invitation link.
Last NameThe last name of the new user.
Manual TimezoneThe timezone value when setting it manually.
NicknameThe nickname of the new user.
Notify PropsA JSON object of custom notification properties.
PasswordThe password used for email authentication.

Note: This field is required for email authentication.
PositionThe position or title of the new user.
UsernameThe username of the new user.

​
Advanced Parameters

ParameterDescription
Auth DataThe service-specific authentication data required for verification, such as an email address.
Auth ServiceThe authentication service to use for this user.
LocaleThe locale for the new user.
PropsA JSON object of custom user properties.
Use Automatic TimezoneSet to use the browser/system timezone.

​
Example Output

{
	"id": "string",
	"create_at": -9007199254740991,
	"update_at": -9007199254740991,
	"delete_at": -9007199254740991,
	"username": "string",
	"first_name": "string",
	"last_name": "string",
	"nickname": "string",
	"email": "string",
	"email_verified": true,
	"auth_service": "string",
	"roles": "string",
	"locale": "string",
	"notify_props": {
		"email": "string",
		"push": "string",
		"desktop": "string",
		"desktop_sound": "string",
		"mention_keys": "string",
		"channel": "string",
		"first_name": "string"
	},
	"props": {},
	"last_password_update": -9007199254740991,
	"last_picture_update": -9007199254740991,
	"failed_attempts": 0,
	"mfa_active": true,
	"timezone": {
		"useAutomaticTimezone": "string",
		"manualTimezone": "string",
		"automaticTimezone": "string"
	}
}

​
Workflow Library Example

Create User with Mattermost and Send Results Via Email
Workflow LibraryPreview this Workflow on desktop