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": "bcd2ea2f-6f2a-4863-a83d-94a753d066df",
"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": "edb6fe5b-871e-4dbf-8a44-78927b8f9fa1",
"Name": "sample string 2",
"OrganizationId": "8b65c042-3e83-417f-b53c-6d794173aa56"
},
{
"Id": "edb6fe5b-871e-4dbf-8a44-78927b8f9fa1",
"Name": "sample string 2",
"OrganizationId": "8b65c042-3e83-417f-b53c-6d794173aa56"
}
]
}
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>bcd2ea2f-6f2a-4863-a83d-94a753d066df</Id>
<LastName>sample string 4</LastName>
<Phone>sample string 7</Phone>
<Roles>
<RoleSimple>
<Id>edb6fe5b-871e-4dbf-8a44-78927b8f9fa1</Id>
<Name>sample string 2</Name>
<OrganizationId>8b65c042-3e83-417f-b53c-6d794173aa56</OrganizationId>
</RoleSimple>
<RoleSimple>
<Id>edb6fe5b-871e-4dbf-8a44-78927b8f9fa1</Id>
<Name>sample string 2</Name>
<OrganizationId>8b65c042-3e83-417f-b53c-6d794173aa56</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": "6431aacb-646e-47cc-911f-f4eecabc1a2b",
"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": "fc56e5bd-e44b-4cdb-839a-0a3b5e958c82",
"Name": "sample string 2",
"OrganizationId": "18391bda-955e-4d87-9a37-e122bc547437"
},
{
"Id": "fc56e5bd-e44b-4cdb-839a-0a3b5e958c82",
"Name": "sample string 2",
"OrganizationId": "18391bda-955e-4d87-9a37-e122bc547437"
}
]
}
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>6431aacb-646e-47cc-911f-f4eecabc1a2b</Id>
<LastName>sample string 4</LastName>
<Phone>sample string 7</Phone>
<Roles>
<RoleSimple>
<Id>fc56e5bd-e44b-4cdb-839a-0a3b5e958c82</Id>
<Name>sample string 2</Name>
<OrganizationId>18391bda-955e-4d87-9a37-e122bc547437</OrganizationId>
</RoleSimple>
<RoleSimple>
<Id>fc56e5bd-e44b-4cdb-839a-0a3b5e958c82</Id>
<Name>sample string 2</Name>
<OrganizationId>18391bda-955e-4d87-9a37-e122bc547437</OrganizationId>
</RoleSimple>
</Roles>
<Title>sample string 5</Title>
<Username>sample string 2</Username>
</UserSimple>