Create

Operation: Create

Creates a user account.


POST /api/v01/User/rest/Create
Content-Type: application/json


Request body

FieldTypeRequiredDescription
UserData.FirstNamestringyesFirst name
UserData.LastNamestringyesLast name
UserData.UserIDstringone of twoExplicit login
UserData.UserIDGeneratebooleanone of twotrue — generate the login automatically
UserData.EmployeeIDstringnoExplicit employee ID
UserData.EmployeeIDGeneratebooleannotrue — generate the employee ID
UserData.EmailstringyesEmail
UserData.InstanceIDstringnoInstance to bind to
UserData.AvatarURLstringnoAvatar URL
UserData.Passwordstringone of twoExplicit password
UserData.PasswordGeneratebooleanone of twotrue — generate the password
UserData.ChangeAfterFirstLogonbooleannoRequire password change after first logon
UserData.SendEmailNotificationbooleannoSend an email with generated credentials to the user
UserData.IntegrationIDstringnoExternal ID
UserData.KeyWordstringnoRecord type (defaults to 'Employee')
UserData.SpaceIDstringnoInitial space
UserData.TemplatestringnoInvitation email template
UserData.HoststringnoHost for links in the email
UserData.Rolesarray<{RolesID}>noGlobal roles
UserData.Projectsarray<{ProjectID, PermissionID}>noInitial project memberships
UserData.Teamsarray<{TeamID, PermissionID}>noTeams
UserData.Spacesarray<{SpaceID}>noAdditional spaces
UserData.UsersIDstringnoAlternative explicit UserID (for imports)


Validation

  • The request body must contain UserData (or the fields at the top level).
  • First name, last name, and email are required (their absence results in a business error with the corresponding MessageCode).


Response

{
  "status": "Success",
  "statusCode": 200,
  "details": {
    "UserID": "0000001234",
    "EmployeeID": "EMP001"
  }
}


Example

POST /api/v01/User/rest/Create
Content-Type: application/json

{
  "UserData": {
    "FirstName": "John",
    "LastName": "Smith",
    "Email": "john.smith@company.com",
    "UserIDGenerate": true,
    "PasswordGenerate": true,
    "ChangeAfterFirstLogon": true,
    "SendEmailNotification": true,
    "Roles": [{ "RolesID": "USER" }],
    "Projects": [{ "ProjectID": "0000000123", "PermissionID": "MEMBER" }]
  }
}