See all operations

GET: users/{user_id}

Description

Retrieves a single user in the system

How to Execute

To access this REST web service, you need to use the following URL (make sure to replace any parameters (eg {project_id}) with the relevant value (eg 1):

https://api.inflectra.com/spira/services/v5_0/RestService.svc/users/{user_id}

Request Parameters

Name	Description
user_id	The id of the user

Request Body

Nothing Expected

Nothing Expected

Return Data

The JSON and XML examples below show the shape of one entry that will be returned. It does not show an example of how that entry will be populated.

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
UserName	The login used by the user
LdapDn	The LDAP Distinguished Name for the user (null for non-LDAP users)
EmailAddress	The email address of the user
Admin	Whether the user is a system administrator
Active	Whether the user is active in the system
Department	The department of the user
Approved	Is this user approved by the system administrator
Locked	Is this user locked-out of their account
RssToken	This is the RSS token for this user For security reasons, you have to access the API as a system administrator to retrieve this field
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.SpiraTest.Web.Services.v5_0.DataObjects">
  <Active>false</Active>
  <Admin>false</Admin>
  <Approved>false</Approved>
  <Department i:nil="true" />
  <EmailAddress i:nil="true" />
  <FirstName i:nil="true" />
  <FullName i:nil="true" />
  <LastName i:nil="true" />
  <LdapDn i:nil="true" />
  <Locked>false</Locked>
  <MiddleInitial i:nil="true" />
  <RssToken i:nil="true" />
  <UserId i:nil="true" />
  <UserName i:nil="true" />
</RemoteUser>

{"Active":false,
"Admin":false,
"Approved":false,
"Department":null,
"EmailAddress":null,
"FirstName":null,
"FullName":null,
"LastName":null,
"LdapDn":null,
"Locked":false,
"MiddleInitial":null,
"RssToken":null,
"UserId":null,
"UserName":null}��������������������������