POST api/users

Create a new User (Available to Admin Accounts Only)

Request Information

URI Parameters

None.

Body Parameters

The Users details

CreateUserDTO
NameDescriptionTypeAdditional information
userName

User Name - User account required to logon to the system

string

None.

firstName

First Name

string

None.

lastName

Last Name

string

None.

email

Users email address

string

None.

password

Initial password for the user

string

None.

encryptPassword

Flag indicating if supplied password should be encrypted (should be false if password is already encrypted).

boolean

None.

groupTags

The tags of the groups the user should be added to.

Collection of string

None.

isTsIngestUser

The bit for tsingestuser defaults 0.

integer

None.

ssoUser

The bit for SSO User defaults 0.

integer

None.

Request Formats

application/json, text/json

Sample:
{
  "userName": "sample string 1",
  "firstName": "sample string 2",
  "lastName": "sample string 3",
  "email": "sample string 4",
  "password": "sample string 5",
  "encryptPassword": true,
  "groupTags": [
    "sample string 1",
    "sample string 2"
  ],
  "isTsIngestUser": 7,
  "ssoUser": 8
}

application/x-www-form-urlencoded

Sample:

Failed to generate the sample for media type 'application/x-www-form-urlencoded'. Cannot use formatter 'JQueryMvcFormUrlEncodedFormatter' to write type 'CreateUserDTO'.

Response Information

Resource Description

IHttpActionResult

None.

Response Formats

application/json, text/json

Sample:

Sample not available.