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

email string
User email
Example: admin@testomato.com
role string

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

email string
Main user email
Example: roman@testomato.com
phone nullable

A phone number (optional) and not required

confirmTokenExpiration

nullable

Date and time when current common confirm token expires

date date-time

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

timezone_type int32

Example: 3

timezone string

Example: Europe/Prague
name string
User name
Example: John Tomatoseeds
confirmed boolean

Was user email confirmed?

timezone string
User time zone name
Example: Europe/Prague
reportPeriod string
Possible values: [week]
Example: week
notificationEmail nullable
Example: roman+notifications@testomato.com
notificationDelay int32
Example: 1
apiKey string
User API Key
Example: abcdef
id string
Example: 7

role

object

id string

Example: 4

users_id nullable

name string

Example: project admin

permissions string[]

systemRole boolean

Example: true

permissionsSwitches

object

Project permissions for current user

read boolean

Can current user view results?

run boolean

Can current user run checks?

editTest boolean

edit boolean

Can current user edit project settings?

manageUsers boolean

Can current user manage others?

Default value: true

apiKey boolean

Can current user view apiKey?

Default value: true

leave boolean

Can current user leave project?

Default value: true
isPayer boolean
Is user owner of the Project?
Example: false
canBeRemoved boolean
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
}