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

role string

Possible values: [4, 5, 6]

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

Responses

200

User was successfully add to the project

application/json

Schema

Schema

email string

Main user email

phone nullable

A phone number (optional) and not required

confirmTokenExpiration nullable
Date and time when current common confirm token expires
date date-time
timezone_type int32
timezone string
name string

User name

confirmed boolean

Was user email confirmed?

timezone string

User time zone name

reportPeriod string

Possible values: [week]

notificationEmail nullable
notificationDelay int32
apiKey string

User API Key

id string
role object

id string

users_id nullable

name string

permissions string[]

systemRole boolean

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

Default value: true

Can current user manage others?

apiKey boolean

Default value: true

Can current user view apiKey?

leave boolean

Default value: true

Can current user leave project?

isPayer boolean

Is user owner of the Project?

canBeRemoved boolean

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
}

Loading...