POST api/organizations/{organizationId}/users

Add a user with the provided information Requires adminstrator for the specificied organization

Request Information

URI Parameters

NameDescriptionTypeAdditional information
organizationId

The id of the organization to add user to

globally unique identifier

Required

Body Parameters

UserSimple
NameDescriptionTypeAdditional information
Id

globally unique identifier

None.

Username

string

None.

FirstName

string

None.

LastName

string

None.

Title

string

None.

Email

string

None.

Phone

string

None.

ExternalId

string

None.

Roles

Collection of RoleSimple

None.

Request Formats

application/json, text/json

Sample:
{
  "Id": "b6937726-0dc3-4182-8c00-b2733f75af98",
  "Username": "sample string 2",
  "FirstName": "sample string 3",
  "LastName": "sample string 4",
  "Title": "sample string 5",
  "Email": "sample string 6",
  "Phone": "sample string 7",
  "ExternalId": "sample string 8",
  "Roles": [
    {
      "Id": "19ada5b2-8d0e-4ee7-84fe-9bf21f0cc790",
      "Name": "sample string 2",
      "OrganizationId": "3ceccccc-e35d-42b6-84d6-59f26f964095"
    },
    {
      "Id": "19ada5b2-8d0e-4ee7-84fe-9bf21f0cc790",
      "Name": "sample string 2",
      "OrganizationId": "3ceccccc-e35d-42b6-84d6-59f26f964095"
    }
  ]
}

application/xml, text/xml

Sample:
<UserSimple xmlns:i="http://www.w3.org/2001/XMLSchema-instance" xmlns="http://schemas.datacontract.org/2004/07/XCapture.DTO">
  <Email>sample string 6</Email>
  <ExternalId>sample string 8</ExternalId>
  <FirstName>sample string 3</FirstName>
  <Id>b6937726-0dc3-4182-8c00-b2733f75af98</Id>
  <LastName>sample string 4</LastName>
  <Phone>sample string 7</Phone>
  <Roles>
    <RoleSimple>
      <Id>19ada5b2-8d0e-4ee7-84fe-9bf21f0cc790</Id>
      <Name>sample string 2</Name>
      <OrganizationId>3ceccccc-e35d-42b6-84d6-59f26f964095</OrganizationId>
    </RoleSimple>
    <RoleSimple>
      <Id>19ada5b2-8d0e-4ee7-84fe-9bf21f0cc790</Id>
      <Name>sample string 2</Name>
      <OrganizationId>3ceccccc-e35d-42b6-84d6-59f26f964095</OrganizationId>
    </RoleSimple>
  </Roles>
  <Title>sample string 5</Title>
  <Username>sample string 2</Username>
</UserSimple>

application/x-www-form-urlencoded

Sample:

Failed to generate the sample for media type 'application/x-www-form-urlencoded'. Cannot use formatter 'JQueryMvcFormUrlEncodedFormatter' to write type 'UserSimple'.

Response Information

Resource Description

UserSimple
NameDescriptionTypeAdditional information
Id

globally unique identifier

None.

Username

string

None.

FirstName

string

None.

LastName

string

None.

Title

string

None.

Email

string

None.

Phone

string

None.

ExternalId

string

None.

Roles

Collection of RoleSimple

None.

Response Formats

application/json, text/json

Sample:
{
  "Id": "b2d9e550-14e5-4186-b15f-77466f4dbf83",
  "Username": "sample string 2",
  "FirstName": "sample string 3",
  "LastName": "sample string 4",
  "Title": "sample string 5",
  "Email": "sample string 6",
  "Phone": "sample string 7",
  "ExternalId": "sample string 8",
  "Roles": [
    {
      "Id": "dd2ac3e6-c9ff-4874-9a3b-5e8c86b59a3f",
      "Name": "sample string 2",
      "OrganizationId": "d7f223ff-798f-4232-b65c-4c636fe61cd9"
    },
    {
      "Id": "dd2ac3e6-c9ff-4874-9a3b-5e8c86b59a3f",
      "Name": "sample string 2",
      "OrganizationId": "d7f223ff-798f-4232-b65c-4c636fe61cd9"
    }
  ]
}

application/xml, text/xml

Sample:
<UserSimple xmlns:i="http://www.w3.org/2001/XMLSchema-instance" xmlns="http://schemas.datacontract.org/2004/07/XCapture.DTO">
  <Email>sample string 6</Email>
  <ExternalId>sample string 8</ExternalId>
  <FirstName>sample string 3</FirstName>
  <Id>b2d9e550-14e5-4186-b15f-77466f4dbf83</Id>
  <LastName>sample string 4</LastName>
  <Phone>sample string 7</Phone>
  <Roles>
    <RoleSimple>
      <Id>dd2ac3e6-c9ff-4874-9a3b-5e8c86b59a3f</Id>
      <Name>sample string 2</Name>
      <OrganizationId>d7f223ff-798f-4232-b65c-4c636fe61cd9</OrganizationId>
    </RoleSimple>
    <RoleSimple>
      <Id>dd2ac3e6-c9ff-4874-9a3b-5e8c86b59a3f</Id>
      <Name>sample string 2</Name>
      <OrganizationId>d7f223ff-798f-4232-b65c-4c636fe61cd9</OrganizationId>
    </RoleSimple>
  </Roles>
  <Title>sample string 5</Title>
  <Username>sample string 2</Username>
</UserSimple>