Create a user

Description

When a project is created on MODE, developer must specify how user accounts should be handled. By default, a project uses the built-in user account system provided by MODE. But a project can also implement its own separate account system for its users. So based on the type of the project, this API call does one of the following.

Project Uses the Built-In Account System (Based on Phone Numbers)

Register a new user. The request body must be a valid user object containing the projectId, phoneNumber and name fields. The phone number must not be in use by a current user of the project. An SMS text containing a verification code will be sent to the user to confirm the registration. However, if request is made using an Admin User/Project API Key, the user is "pre-verified", and no confirmation text will be sent.

Project Uses the Built-In Account System (Based on Email Addresses)

If used for registering a new user, the request body must be a valid user object containing the projectId, email and name fields. In addition, a password field must also be present. The email address must not be in use by a current user of the project. An email message containing a verification URL will be sent to the user to confirm the registration. However, if request is made using an Admin User/Project API Key, only the projectId and email fields are required for the request. An invitation email will be sent to the user, and an "activation token" will be returned. The invitation email should contain an activation link for the user to activate their account, but in case the user has trouble receiving the email, the caller may share the link with them directly (constructed from the activation token returned).

Project is BYOU ("Bring-Your-Own-Users")

Create an entry in MODE that corresponds to an existing user in the project's own account system. The request object only needs to contain the projectId field. An optional externalKey field can be used to associate the user with an existing unique identifier. The request must also come with an Authorization header that contains a User/Project API Key with the permission to handle BYOU. The returned user object contains a unique user ID. The caller should store this user ID for future MODE API calls.

Request body

Content type: application/json

{
  "email": "jane@example.com",
  "name": "Jane Doe",
  "password": "a_secure_password",
  "projectId": 1264
}

Responses

{
  "creationTime": "2019-12-17T02:55:59.483Z",
  "email": "jane@example.com",
  "id": 2076,
  "name": "Jane Doe",
  "projectId": 1264,
  "verified": true
}