POST apioauth/v4/createuser
Create a user on the system
Request Information
URI Parameters
None.
Body Parameters
The OAuthCreateUserRequestModel
OAuthCreateUserRequestModelName | Description | Type | Additional information |
---|---|---|---|
ParentGroupID |
The group id of the parent group |
unsigned integer |
None. |
Company |
The name of the group to create |
string |
None. |
Username |
The desired username used to log into the system |
string |
None. |
Password |
The desired password used to log into the system |
string |
None. |
Name |
The name of the new user |
string |
None. |
Address |
The address of the new user |
string |
None. |
Postcode |
The postcode of the new user |
string |
None. |
EmailAddress |
The email address of the new user |
string |
None. |
PhoneNumber |
The phone number of the new user |
string |
None. |
FaxNumber |
The fax number of the new user |
string |
None. |
MobileNumber |
The mobile number of the new user |
string |
None. |
Timezone |
The timezone of the new user |
Timezone |
None. |
Culture |
The culture of the new user |
Culture |
None. |
Request Formats
application/json, text/json
Sample:
{ "ParentGroupID": 1, "Company": "sample string 2", "Username": "sample string 3", "Password": "sample string 4", "Name": "sample string 5", "Address": "sample string 6", "Postcode": "sample string 7", "EmailAddress": "sample string 8", "PhoneNumber": "sample string 9", "FaxNumber": "sample string 10", "MobileNumber": "sample string 11", "Timezone": 0, "Culture": 0 }
application/xml, text/xml
Sample:
<OAuthCreateUserRequestModel xmlns:xsd="http://www.w3.org/2001/XMLSchema" xmlns:xsi="http://www.w3.org/2001/XMLSchema-instance"> <ParentGroupID>1</ParentGroupID> <Company>sample string 2</Company> <Username>sample string 3</Username> <Password>sample string 4</Password> <Name>sample string 5</Name> <Address>sample string 6</Address> <Postcode>sample string 7</Postcode> <EmailAddress>sample string 8</EmailAddress> <PhoneNumber>sample string 9</PhoneNumber> <FaxNumber>sample string 10</FaxNumber> <MobileNumber>sample string 11</MobileNumber> <Timezone>Africa_Cairo</Timezone> <Culture>en_HSS</Culture> </OAuthCreateUserRequestModel>
application/x-www-form-urlencoded
Sample:
Sample not available.
Response Information
Resource Description
A CreateUserResponseModel
CreateUserResponseModelName | Description | Type | Additional information |
---|---|---|---|
CreatedUserID |
The user id of the created user |
unsigned integer |
None. |
CreatedGroupID |
The id of the created group |
unsigned integer |
None. |
Response Formats
application/json, text/json
Sample:
{ "CreatedUserID": 1, "CreatedGroupID": 2 }
application/xml, text/xml
Sample:
<CreateUserResponseModel xmlns:xsd="http://www.w3.org/2001/XMLSchema" xmlns:xsi="http://www.w3.org/2001/XMLSchema-instance"> <CreatedUserID>1</CreatedUserID> <CreatedGroupID>2</CreatedGroupID> </CreateUserResponseModel>