POST/people.json

Creates a new User Account

Notes:

There is a few different account types you can add via the api.

  • Administrator
  • Project Administrator
  • Standard User
  • Collaborator
  • Contact

For more information on these take a look at our helpdocs for site admins, project admins and users & collaborators.

Administrator

  • "administrator":"true"
  • "canAddProjects":"true"
  • "canManagePeople":"true"
  • "canAccessAllProjects":"true"
  • "user-type": "account"

Project Administrator

  • "administrator":"false"
  • "canAddProjects":"false"
  • "canManagePeople":"false"
  • "canAccessAllProjects":"true"
  • "user-type": "account"
  • "setProjectAdmin": "true"

User

  • "administrator":"false"
  • "canAddProjects":"false"
  • "canManagePeople":"false"
  • "canAccessAllProjects":"true"
  • "setProjectAdmin":"false"
  • "user-type": "account"

**These can change depending on the permissions you want the user to have. For example, you can have a standard user, but you can allow them to create projects.

Collaborator

  • "user-type":"collaborator"

Contact

  • "user-type":"contact"

Body Params

    • Name
      person
      Type
      object

    Responses

    • Code
      201
      Type
      object
      Schema
      Description
      201 Response

    Examples

    201 Response

    application/json
    {
  "id": "1",
  "STATUS": "OK",
  "user": {
    "avatarUrl": "",
    "firstName": "Una",
    "id": "1",
    "lastName": "McBracken "
  }
}
    Download Swagger