Add user to project

POST 
/project/:id/users

Add new user to project

Request

Path Parameters

id stringrequired
A unique project ID
Example: 5e9602e7a39e5a46428b457f

application/json

Body

emailstring
User email
Example: admin@testomato.com
rolestring

4 - Project Admin 5 - Project Developer 6 - Project Guest

Possible values: [4, 5, 6]

Responses

200

User was successfully add to the project

application/json

Schema

Schema

emailstring
Main user email
Example: roman@testomato.com
phonenullable

A phone number (optional) and not required

confirmTokenExpiration

nullable

Date and time when current common confirm token expires

datedate-time

Example: 2022-10-21 13:10:35.000000

timezone_typeint32

Example: 3

timezonestring

Example: Europe/Prague
namestring
User name
Example: John Tomatoseeds
confirmedboolean

Was user email confirmed?

timezonestring
User time zone name
Example: Europe/Prague
reportPeriodstring
Possible values: [week]
Example: week
notificationEmailnullable
Example: roman+notifications@testomato.com
notificationDelayint32
Example: 1
apiKeystring
User API Key
Example: abcdef
idstring
Example: 7

role

object

idstring

Example: 4

users_idnullable

namestring

Example: project admin

permissionsstring[]

systemRoleboolean

Example: true

permissionsSwitches

object

Project permissions for current user

readboolean

Can current user view results?

runboolean

Can current user run checks?

editTestboolean

editboolean

Can current user edit project settings?

manageUsersboolean

Can current user manage others?

Default value: true

apiKeyboolean

Can current user view apiKey?

Default value: true

leaveboolean

Can current user leave project?

Default value: true
isPayerboolean
Is user owner of the Project?
Example: false
canBeRemovedboolean
Example: true

Example (from schema)

{
  "email": "roman@testomato.com",
  "phone": "string",
  "confirmTokenExpiration": {
    "date": "2022-10-21 13:10:35.000000",
    "timezone_type": 3,
    "timezone": "Europe/Prague"
  },
  "name": "John Tomatoseeds",
  "confirmed": true,
  "timezone": "Europe/Prague",
  "reportPeriod": "week",
  "notificationEmail": "roman+notifications@testomato.com",
  "notificationDelay": 1,
  "apiKey": "abcdef",
  "id": 7,
  "role": {
    "id": 4,
    "users_id": "string",
    "name": "project admin",
    "permissions": [
      [
        "read",
        "run",
        "editTests",
        "edit",
        "manageUsers",
        "apiKey"
      ]
    ],
    "systemRole": true,
    "permissionsSwitches": {
      "read": true,
      "run": true,
      "editTest": true,
      "edit": true,
      "manageUsers": true,
      "apiKey": true,
      "leave": true
    }
  },
  "isPayer": false,
  "canBeRemoved": true
}