Users

Add Project Member

Required scopes: project.member (Read and Write).

post/projects/{projectId}/members

Request

Path parameters

projectIdinteger required

Project Identifier. Get via List Projects

Request body

OR
OR

Example request

{
  "userIds": [
    1
  ],
  "usernames": [
    "john_smith"
  ],
  "emails": [
    "john@example.com"
  ],
  "permissions": {
    "it": {
      "workflowStepIds": [
        313
      ]
    },
    "de": {
      "workflowStepIds": "all"
    }
  },
  "roles": [
    {
      "name": "translator",
      "permissions": {
        "allLanguages": false,
        "languagesAccess": {
          "uk": {
            "allContent": false,
            "workflowStepIds": [
              882
            ]
          },
          "it": {
            "allContent": true
          }
        }
      }
    },
    {
      "name": "proofreader",
      "permissions": {
        "allLanguages": true,
        "languagesAccess": []
      }
    },
    {
      "name": "language_coordinator",
      "permissions": {
        "allLanguages": false,
        "languagesAccess": {
          "uk": {
            "allContent": true
          },
          "it": {
            "allContent": true
          }
        }
      }
    }
  ]
}

Response

Members were successfully added

Example response

{
  "skipped": [
    {
      "data": {
        "id": 12,
        "username": "john_smith",
        "firstName": "John",
        "lastName": "Smith",
        "roles": [
          {
            "name": "translator",
            "permissions": {
              "allLanguages": false,
              "languagesAccess": {
                "uk": {
                  "allContent": false,
                  "workflowStepIds": [
                    882
                  ]
                },
                "it": {
                  "allContent": true
                }
              }
            }
          },
          {
            "name": "proofreader",
            "permissions": {
              "allLanguages": true,
              "languagesAccess": []
            }
          },
          {
            "name": "language_coordinator",
            "permissions": {
              "allLanguages": false,
              "languagesAccess": {
                "uk": {
                  "allContent": true
                },
                "it": {
                  "allContent": true
                }
              }
            }
          }
        ],
        "managerOfGroup": {
          "id": 1,
          "name": "KB materials"
        },
        "permissions": {
          "it": {
            "workflowStepIds": [
              313
            ]
          }
        },
        "givenAccessAt": "2019-10-23T11:44:02+00:00"
      }
    }
  ],
  "updated": [
    {
      "data": {
        "id": 12,
        "username": "john_smith",
        "firstName": "John",
        "lastName": "Smith",
        "roles": [
          {
            "name": "translator",
            "permissions": {
              "allLanguages": false,
              "languagesAccess": {
                "uk": {
                  "allContent": false,
                  "workflowStepIds": [
                    882
                  ]
                },
                "it": {
                  "allContent": true
                }
              }
            }
          },
          {
            "name": "proofreader",
            "permissions": {
              "allLanguages": true,
              "languagesAccess": []
            }
          },
          {
            "name": "language_coordinator",
            "permissions": {
              "allLanguages": false,
              "languagesAccess": {
                "uk": {
                  "allContent": true
                },
                "it": {
                  "allContent": true
                }
              }
            }
          }
        ],
        "managerOfGroup": {
          "id": 1,
          "name": "KB materials"
        },
        "permissions": {
          "it": {
            "workflowStepIds": [
              313
            ]
          }
        },
        "givenAccessAt": "2019-10-23T11:44:02+00:00"
      }
    }
  ],
  "added": [
    {
      "data": {
        "id": 12,
        "username": "john_smith",
        "firstName": "John",
        "lastName": "Smith",
        "roles": [
          {
            "name": "translator",
            "permissions": {
              "allLanguages": false,
              "languagesAccess": {
                "uk": {
                  "allContent": false,
                  "workflowStepIds": [
                    882
                  ]
                },
                "it": {
                  "allContent": true
                }
              }
            }
          },
          {
            "name": "proofreader",
            "permissions": {
              "allLanguages": true,
              "languagesAccess": []
            }
          },
          {
            "name": "language_coordinator",
            "permissions": {
              "allLanguages": false,
              "languagesAccess": {
                "uk": {
                  "allContent": true
                },
                "it": {
                  "allContent": true
                }
              }
            }
          }
        ],
        "managerOfGroup": {
          "id": 1,
          "name": "KB materials"
        },
        "permissions": {
          "it": {
            "workflowStepIds": [
              313
            ]
          }
        },
        "givenAccessAt": "2019-10-23T11:44:02+00:00"
      }
    }
  ],
  "pagination": {
    "limit": 25
  }
}

Changes

No recorded changes to this operation across all 1 revision of this API.