v1

latestOpenAPI 3.0.02026-07-141,4077,1665.2 MB

Users

Create a user

Create a user for your organization.

post/api/v2/users

Request body

Example request

{
  "data": {
    "attributes": {
      "email": "jane.doe@example.com"
    },
    "relationships": {
      "roles": {
        "data": [
          {
            "id": "3653d3c6-0c75-11ea-ad28-fb5701eabc7d",
            "type": "roles"
          }
        ]
      }
    },
    "type": "users"
  }
}

Response

Example response

{
  "data": {
    "relationships": {
      "org": {
        "data": {
          "id": "00000000-0000-beef-0000-000000000000",
          "type": "orgs"
        }
      },
      "other_orgs": {
        "data": []
      },
      "other_users": {
        "data": []
      },
      "roles": {
        "data": [
          {
            "id": "3653d3c6-0c75-11ea-ad28-fb5701eabc7d",
            "type": "roles"
          }
        ]
      }
    },
    "type": "users"
  },
  "included": [
    {
      "type": "orgs"
    }
  ]
}