POST api/organizations/{organizationId}/users
Add a user with the provided information Requires adminstrator for the specificied organization
Request Information
URI Parameters
| Name | Description | Type | Additional information |
|---|---|---|---|
| organizationId |
The id of the organization to add user to |
globally unique identifier |
Required |
Body Parameters
UserSimple| Name | Description | Type | Additional information |
|---|---|---|---|
| Id | globally unique identifier |
None. |
|
| Username | string |
None. |
|
| FirstName | string |
None. |
|
| LastName | string |
None. |
|
| Title | string |
None. |
|
| string |
None. |
||
| Phone | string |
None. |
|
| ExternalId | string |
None. |
|
| Roles | Collection of RoleSimple |
None. |
Request Formats
application/json, text/json
Sample:
{
"Id": "8b7eb9f1-56e3-4a38-864c-b5f2ed508af7",
"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": "c03b0ee5-8c41-4b86-8e7e-0af380039567",
"Name": "sample string 2",
"OrganizationId": "5d36062e-53d5-4518-acf4-92faf56372c2"
},
{
"Id": "c03b0ee5-8c41-4b86-8e7e-0af380039567",
"Name": "sample string 2",
"OrganizationId": "5d36062e-53d5-4518-acf4-92faf56372c2"
}
]
}
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>8b7eb9f1-56e3-4a38-864c-b5f2ed508af7</Id>
<LastName>sample string 4</LastName>
<Phone>sample string 7</Phone>
<Roles>
<RoleSimple>
<Id>c03b0ee5-8c41-4b86-8e7e-0af380039567</Id>
<Name>sample string 2</Name>
<OrganizationId>5d36062e-53d5-4518-acf4-92faf56372c2</OrganizationId>
</RoleSimple>
<RoleSimple>
<Id>c03b0ee5-8c41-4b86-8e7e-0af380039567</Id>
<Name>sample string 2</Name>
<OrganizationId>5d36062e-53d5-4518-acf4-92faf56372c2</OrganizationId>
</RoleSimple>
</Roles>
<Title>sample string 5</Title>
<Username>sample string 2</Username>
</UserSimple>
application/x-www-form-urlencoded
Sample:
Sample not available.
Response Information
Resource Description
UserSimple| Name | Description | Type | Additional information |
|---|---|---|---|
| Id | globally unique identifier |
None. |
|
| Username | string |
None. |
|
| FirstName | string |
None. |
|
| LastName | string |
None. |
|
| Title | string |
None. |
|
| string |
None. |
||
| Phone | string |
None. |
|
| ExternalId | string |
None. |
|
| Roles | Collection of RoleSimple |
None. |
Response Formats
application/json, text/json
Sample:
{
"Id": "7cc81d2b-fec8-430d-aa19-f3e0b4a02cc6",
"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": "3f8c6c95-a95c-4c6c-a86d-2e146e64cced",
"Name": "sample string 2",
"OrganizationId": "67721194-593e-4dc0-8ad1-72f46e0d6863"
},
{
"Id": "3f8c6c95-a95c-4c6c-a86d-2e146e64cced",
"Name": "sample string 2",
"OrganizationId": "67721194-593e-4dc0-8ad1-72f46e0d6863"
}
]
}
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>7cc81d2b-fec8-430d-aa19-f3e0b4a02cc6</Id>
<LastName>sample string 4</LastName>
<Phone>sample string 7</Phone>
<Roles>
<RoleSimple>
<Id>3f8c6c95-a95c-4c6c-a86d-2e146e64cced</Id>
<Name>sample string 2</Name>
<OrganizationId>67721194-593e-4dc0-8ad1-72f46e0d6863</OrganizationId>
</RoleSimple>
<RoleSimple>
<Id>3f8c6c95-a95c-4c6c-a86d-2e146e64cced</Id>
<Name>sample string 2</Name>
<OrganizationId>67721194-593e-4dc0-8ad1-72f46e0d6863</OrganizationId>
</RoleSimple>
</Roles>
<Title>sample string 5</Title>
<Username>sample string 2</Username>
</UserSimple>