Create User

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 Documentation

To learn more, visit the Mattermost documentation.

​

Basic Parameters

Parameter	Description
Email	The email address of the new user.
Email Token ID	The token ID from an email verification link.
First Name	The first name of the new user.
Invitation ID	The token ID from an invitation link.
Last Name	The last name of the new user.
Manual Timezone	The timezone value when setting it manually.
Nickname	The nickname of the new user.
Notify Props	A JSON object of custom notification properties.
Password	The password used for email authentication. Note: This field is required for email authentication.
Position	The position or title of the new user.
Username	The username of the new user.

​

Advanced Parameters

Parameter	Description
Auth Data	The service-specific authentication data required for verification, such as an email address.
Auth Service	The authentication service to use for this user.
Locale	The locale for the new user.
Props	A JSON object of custom user properties.
Use Automatic Timezone	Set 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"
	}
}