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": "7102fa97-31c1-4c73-99fa-e51459b99267",
"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": "5cb853a5-6f8b-4c5c-b5ab-29cc6e37752d",
"Name": "sample string 2",
"OrganizationId": "4ad6c9f6-230c-4d84-9a45-ddcf54f2462a"
},
{
"Id": "5cb853a5-6f8b-4c5c-b5ab-29cc6e37752d",
"Name": "sample string 2",
"OrganizationId": "4ad6c9f6-230c-4d84-9a45-ddcf54f2462a"
}
]
}
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>7102fa97-31c1-4c73-99fa-e51459b99267</Id>
<LastName>sample string 4</LastName>
<Phone>sample string 7</Phone>
<Roles>
<RoleSimple>
<Id>5cb853a5-6f8b-4c5c-b5ab-29cc6e37752d</Id>
<Name>sample string 2</Name>
<OrganizationId>4ad6c9f6-230c-4d84-9a45-ddcf54f2462a</OrganizationId>
</RoleSimple>
<RoleSimple>
<Id>5cb853a5-6f8b-4c5c-b5ab-29cc6e37752d</Id>
<Name>sample string 2</Name>
<OrganizationId>4ad6c9f6-230c-4d84-9a45-ddcf54f2462a</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": "87361d3b-deb0-42de-b36d-3d0426755a70",
"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": "e5af11ad-0f77-4515-8a40-c11828a30e68",
"Name": "sample string 2",
"OrganizationId": "6848ba02-36f8-4525-8851-5da86f7e06c6"
},
{
"Id": "e5af11ad-0f77-4515-8a40-c11828a30e68",
"Name": "sample string 2",
"OrganizationId": "6848ba02-36f8-4525-8851-5da86f7e06c6"
}
]
}
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>87361d3b-deb0-42de-b36d-3d0426755a70</Id>
<LastName>sample string 4</LastName>
<Phone>sample string 7</Phone>
<Roles>
<RoleSimple>
<Id>e5af11ad-0f77-4515-8a40-c11828a30e68</Id>
<Name>sample string 2</Name>
<OrganizationId>6848ba02-36f8-4525-8851-5da86f7e06c6</OrganizationId>
</RoleSimple>
<RoleSimple>
<Id>e5af11ad-0f77-4515-8a40-c11828a30e68</Id>
<Name>sample string 2</Name>
<OrganizationId>6848ba02-36f8-4525-8851-5da86f7e06c6</OrganizationId>
</RoleSimple>
</Roles>
<Title>sample string 5</Title>
<Username>sample string 2</Username>
</UserSimple>