Skip to end of metadata
Go to start of metadata

You are viewing an old version of this page. View the current version.

Compare with Current View Page History

« Previous Version 10 Current »

Use below endpoint to get the user details. 

  • Syntax - <Jira base URL>/rest/amoeboids-upraise/1.0/getuser/{username}
  • Example - jira.amoeboids.com/rest/amoeboids-upraise/1.0/getuser/AliceT

Jira username is expected in the endpoint. If the user is deleted/inactive or user name is incorrect, relevant message will be returned by the API. 

Request

  • Apart from the Jira username added to the end of the endpoint, no other request parameters are allowed for this API.

Response 

ParentParameterTypeDescriptionPossible values or Examples

jiraInfoObjectThis object consists of a number of data points that are retrieved directly via Jira & returned without any manipulation.
  • email address
  • display name
  • user key
  • etc

upRaiseInfoObjectThis object consists of data points that are available about the user within UpRaise's company directory.All data points are listed below in the form of table rows.
upRaiseInfoidNumberRepresents user's id within UpRaise company directory.1, 101, 12001 etc
upRaiseInfokeyNumberUser key that is matched with Jira user information.String
upRaiseInfonameStringDisplay nameJohn Doe
upRaiseInfojiraUserNameStringJira usernamejohn.doe
upRaiseInfoactiveBooleanWhether this user is active or inactive in UpRaise's company directory.
  • True
  • False
upRaiseInfodesignationObjectThis object consists of details about the designation associated with the current user.
  • Id
  • name
designationidNumberDesignation id in UpRaise company directory.1, 101, 12001 etc
designationnameStringUser facing designation.
  • Software engineer
  • CEO
  • etc
upRaiseInfoupraiseRoleObjectThis object consists of details about the role associated with the current user.
  • Id
  • Name
upraiseRoleidNumberRole id in UpRaise company directory.1, 101, 12001 etc
upraiseRolenameStringUser facing role.
  • User
  • Admin
  • Super admin
upRaiseInfodirectReportsObjectThis object consists of details about each one of the users whose manager is current user.
  • email address
  • display name
  • user key
  • etc
upRaiseInfoteamsObjectThis object consists of details about each one of the teams whose member or team lead is current user.
teamsidNumberTeam id in UpRaise company directory.1, 101, 12001 etc
teamsnameStringUser facing team name.
  • Marketing
  • Sales
  • Development
  • etc
teamsdescriptionStringUser facing description for each team
upRaiseInfocreatedDateDate on which current user was created in UpRaise Company directory.08/Jan/18 8:36 PM
upRaiseInfomodifiedByObjectDetails about the user who updated the current user last.
upRaiseInfomodifiedDateDate on which current user was recently modified in UpRaise Company directory.08/Jan/18 8:36 PM
upRaiseInfodateTimeFormatStringFormat definition of dateTime fields returned in response.
upRaiseInfodateFormatDateFormat definition of date fields returned in response.

On this page


In this section

  • No labels