create_user

create_user

Create a new user (requires admin privileges). Returns:

201 Created: user was created
422 Unprocessable Entity: validation failed Available since Redmine 1.1

Input Schema

Name	Required	Description
`auth_source_id`	No	Authentication mode ID
`custom_fields`	No	Custom field values (key: field_id, value: field_value)
`firstname`	Yes	User's first name
`generate_password`	No	Generate random password
`lastname`	Yes	User's last name
`login`	Yes	User login name
`mail`	Yes	User's email address
`mail_notification`	No	Email notification options
`must_change_passwd`	No	Force password change on next login
`password`	No	User's password (optional if generate_password is true)
`send_information`	No	Send account information to the user

Input Schema (JSON Schema)

{
  "properties": {
    "auth_source_id": {
      "description": "Authentication mode ID",
      "type": "number"
    },
    "custom_fields": {
      "additionalProperties": true,
      "description": "Custom field values (key: field_id, value: field_value)",
      "type": "object"
    },
    "firstname": {
      "description": "User's first name",
      "type": "string"
    },
    "generate_password": {
      "default": false,
      "description": "Generate random password",
      "type": "boolean"
    },
    "lastname": {
      "description": "User's last name",
      "type": "string"
    },
    "login": {
      "description": "User login name",
      "type": "string"
    },
    "mail": {
      "description": "User's email address",
      "format": "email",
      "type": "string"
    },
    "mail_notification": {
      "description": "Email notification options",
      "enum": [
        "all",
        "selected",
        "only_my_events",
        "only_assigned",
        "only_owner",
        "none"
      ],
      "type": "string"
    },
    "must_change_passwd": {
      "default": false,
      "description": "Force password change on next login",
      "type": "boolean"
    },
    "password": {
      "description": "User's password (optional if generate_password is true)",
      "type": "string"
    },
    "send_information": {
      "default": false,
      "description": "Send account information to the user",
      "type": "boolean"
    }
  },
  "required": [
    "login",
    "firstname",
    "lastname",
    "mail"
  ],
  "type": "object"
}

Input Schema

Input Schema (JSON Schema)

Other Tools