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": "c64745e0-3144-4a34-9269-9299b5acaea9",
"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": "e4db8ad1-0eca-44e4-a04b-44257a3b1864",
"Name": "sample string 2",
"OrganizationId": "be0d019a-b812-4520-b83a-9e700e4c7b77"
},
{
"Id": "e4db8ad1-0eca-44e4-a04b-44257a3b1864",
"Name": "sample string 2",
"OrganizationId": "be0d019a-b812-4520-b83a-9e700e4c7b77"
}
]
}
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>c64745e0-3144-4a34-9269-9299b5acaea9</Id>
<LastName>sample string 4</LastName>
<Phone>sample string 7</Phone>
<Roles>
<RoleSimple>
<Id>e4db8ad1-0eca-44e4-a04b-44257a3b1864</Id>
<Name>sample string 2</Name>
<OrganizationId>be0d019a-b812-4520-b83a-9e700e4c7b77</OrganizationId>
</RoleSimple>
<RoleSimple>
<Id>e4db8ad1-0eca-44e4-a04b-44257a3b1864</Id>
<Name>sample string 2</Name>
<OrganizationId>be0d019a-b812-4520-b83a-9e700e4c7b77</OrganizationId>
</RoleSimple>
</Roles>
<Title>sample string 5</Title>
<Username>sample string 2</Username>
</UserSimple>
application/x-www-form-urlencoded
Sample:
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": "6da603d2-fe15-4eb3-8557-9582399fbec2",
"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": "95dbac65-0e77-4a68-8308-ebafb0f92f93",
"Name": "sample string 2",
"OrganizationId": "7878c20a-4e59-48a7-8876-1d9e21c86f57"
},
{
"Id": "95dbac65-0e77-4a68-8308-ebafb0f92f93",
"Name": "sample string 2",
"OrganizationId": "7878c20a-4e59-48a7-8876-1d9e21c86f57"
}
]
}
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>6da603d2-fe15-4eb3-8557-9582399fbec2</Id>
<LastName>sample string 4</LastName>
<Phone>sample string 7</Phone>
<Roles>
<RoleSimple>
<Id>95dbac65-0e77-4a68-8308-ebafb0f92f93</Id>
<Name>sample string 2</Name>
<OrganizationId>7878c20a-4e59-48a7-8876-1d9e21c86f57</OrganizationId>
</RoleSimple>
<RoleSimple>
<Id>95dbac65-0e77-4a68-8308-ebafb0f92f93</Id>
<Name>sample string 2</Name>
<OrganizationId>7878c20a-4e59-48a7-8876-1d9e21c86f57</OrganizationId>
</RoleSimple>
</Roles>
<Title>sample string 5</Title>
<Username>sample string 2</Username>
</UserSimple>