KronoDesk: REST Web Service (v4.0)
Click here for a complete list of operations.
GET: users/email-address/{email_address}
Description
Retrieves the user that has a specific email address
How to Execute
To access this REST web service, you need to use the following URL:
https://api.inflectra.com/KronoDesk/Services/v3_0/RestService.svc/users/email-address/{email_address}
Request Parameters
|
Name
|
Description
|
|
email_address
|
The email address
|
Request Body
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.v3_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}