POST https://api.legendonlineservices.co.uk/users/user

Creates a new user within the Legend database.
If refGroupId is not passed, the user will be created in the database with no permissions.
Note that a matching Active Directory user - along with a password - is not automatically created.

Request Parameters

From Body Type Description
FirstName String First Name of the user.
Max 30 characters. If this limit is exceeded, the request returns 400 "BadRequest".
LastName String Last Name of the user.
Max 30 characters. If this limit is exceeded, the request returns 400 "BadRequest".
LoginName String Login Name of the user, which will be used to authenticate. This needs to be unique for each user.
Max 20 characters. If this limit is exceeded, the request returns 400 "BadRequest".
RefGroupID Int32 Optional. If a security group is provided, this will allow the user to be created with permissions in place.
There is currently not a place in the API where groups are listed. These can be identified within the UI and are specific to each customer. If the security group is omitted, the user will be successfully created without a group membership. 




{
  "FirstName": "sample string 1",
  "LastName": "sample string 2",
  "LoginName": "sample string 3",
  "RefGroupID": 1
}

Response - (Status 200 - OK)

No object is returned by this request

Remarks

Returns HTTP status code 201 ("Created") if the user has been created.
Returns HTTP status code 200 ("OK") if the user already exists.

Bundle(s)
Users