Project roles

GET 
/project/:id/roles

Get array of project roles

Request

Path Parameters

id stringrequired
A unique project ID
Example: 5e9602e7a39e5a46428b457f

Responses

200

List of Project Areas/Groups

application/json

Schema

Schema

• Array [
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?

• ]

Example (from schema)

[
  {
    "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
    }
  }
]

Loading...