POST: users

Description

Creates a new user (with profile) in the system and adds them to the specified roles

How to Execute

To access this REST web service, you need to use the following URL:

https://api.inflectra.com/KronoDesk/Services/v1_0/RestService.svc/users

Request Body

Property	Description
Password	The user's password
PasswordQuestion	The user's password reset question
PasswordAnswer	The user's password reset answer
Roles	The list of roles the user belongs to
UserId	The id of the user
FirstName	The first (given) name of the user
LastName	The last name (surname) of the user
MiddleInitial	The middle initials of the user
Login	The login used by the user
LdapDn	The LDAP Distinguished Name for the user (null for non-LDAP users) Not currently used by the API
EmailAddress	The email address of the user
Active	Whether the user is active in the system
Approved	Is this user approved by the system administrator
Locked	Is this user locked-out of their account
RssToken	What is the RSS token for this user
FullName	The full name of the user concatenated (First + Middle + Last)

<RemoteUserCreateInfo xmlns:i="http://www.w3.org/2001/XMLSchema-instance" xmlns="http://schemas.datacontract.org/2004/07/Inflectra.KronoDesk.Web.Services.v1_0.DataObjects">
  <Active>false</Active>
  <Approved>false</Approved>
  <EmailAddress i:nil="true" />
  <FirstName i:nil="true" />
  <FullName i:nil="true" />
  <LastName i:nil="true" />
  <LdapDn i:nil="true" />
  <Locked>false</Locked>
  <Login i:nil="true" />
  <MiddleInitial i:nil="true" />
  <RssToken i:nil="true" />
  <UserId i:nil="true" />
  <Password i:nil="true" />
  <PasswordAnswer i:nil="true" />
  <PasswordQuestion i:nil="true" />
  <Roles xmlns:d2p1="http://schemas.microsoft.com/2003/10/Serialization/Arrays" i:nil="true" />
</RemoteUserCreateInfo>

{"Active":false,
"Approved":false,
"EmailAddress":null,
"FirstName":null,
"FullName":null,
"LastName":null,
"LdapDn":null,
"Locked":false,
"Login":null,
"MiddleInitial":null,
"RssToken":null,
"UserId":null,
"Password":null,
"PasswordAnswer":null,
"PasswordQuestion":null,
"Roles":null}

Return Data

Property	Description
UserId	The id of the user
FirstName	The first (given) name of the user
LastName	The last name (surname) of the user
MiddleInitial	The middle initials of the user
Login	The login used by the user
LdapDn	The LDAP Distinguished Name for the user (null for non-LDAP users) Not currently used by the API
EmailAddress	The email address of the user
Active	Whether the user is active in the system
Approved	Is this user approved by the system administrator
Locked	Is this user locked-out of their account
RssToken	What is the RSS token for this user
FullName	The full name of the user concatenated (First + Middle + Last)

<RemoteUser xmlns:i="http://www.w3.org/2001/XMLSchema-instance" xmlns="http://schemas.datacontract.org/2004/07/Inflectra.KronoDesk.Web.Services.v1_0.DataObjects">
  <Active>false</Active>
  <Approved>false</Approved>
  <EmailAddress i:nil="true" />
  <FirstName i:nil="true" />
  <FullName i:nil="true" />
  <LastName i:nil="true" />
  <LdapDn i:nil="true" />
  <Locked>false</Locked>
  <Login i:nil="true" />
  <MiddleInitial i:nil="true" />
  <RssToken i:nil="true" />
  <UserId i:nil="true" />
</RemoteUser>

{"Active":false,
"Approved":false,
"EmailAddress":null,
"FirstName":null,
"FullName":null,
"LastName":null,
"LdapDn":null,
"Locked":false,
"Login":null,
"MiddleInitial":null,
"RssToken":null,
"UserId":null}