POST users

Request Information

URI Parameters

None.

Body Parameters

Name	Type	Additional information
UserName	string	Required
FederatedUserId	string	Required
DisplayName	string	None.
FirstName	string	Required
LastName	string	Required
EmailAddress	string	Required Matching regular expression pattern: ^([0-9a-zA-Z]([-.\w][0-9a-zA-Z])@([0-9a-zA-Z][-\w]*[0-9a-zA-Z]\.)+[a-zA-Z]{2,9})$
EmailOn	boolean	None.
ExternalUserId	string	Required
UserType	UserType	None.
EmployeeNumber	integer	None.

Request Formats

application/json, text/json

Sample:

{
  "UserName": "sample string 1",
  "FederatedUserId": "sample string 2",
  "DisplayName": "sample string 3",
  "FirstName": "sample string 4",
  "LastName": "sample string 5",
  "EmailAddress": "sample string 6",
  "EmailOn": true,
  "ExternalUserId": "sample string 8",
  "UserType": 1,
  "EmployeeNumber": 1
}

Response Information

Resource Description

UserDto

Name	Type	Additional information
Id	integer	None.
FederatedUserId	string	None.
UserName	string	None.
FirstName	string	None.
LastName	string	None.
DisplayName	string	None.
EmailAddress	string	None.
ExternalUserId	string	None.
EmailOn	boolean	None.
TFCNumber	integer	None.
FOLAccountName	string	None.
UserType	UserType	None.
RoleType	RoleType	None.
UserPreferences	UserPreferencesDto	None.
Active	boolean	None.

Response Information

Response body formats

application/json, text/json

Sample:

{
  "Id": 1,
  "FederatedUserId": "sample string 2",
  "UserName": "sample string 3",
  "FirstName": "sample string 4",
  "LastName": "sample string 5",
  "DisplayName": "sample string 6",
  "EmailAddress": "sample string 7",
  "ExternalUserId": "sample string 8",
  "EmailOn": true,
  "TFCNumber": 1,
  "FOLAccountName": "sample string 10",
  "UserType": 1,
  "RoleType": 0,
  "UserPreferences": {
    "DefaultSiteDashboardViewType": 1,
    "DefaultDashboardVendorFilterType": 0
  },
  "Active": true
}