Get user details
- Annu
- Anand Inamdar
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
Parent | Parameter | Type | Description | Possible values or Examples |
|---|---|---|---|---|
jiraInfo | Object | This object consists of a number of data points that are retrieved directly via Jira & returned without any manipulation. |
| |
upRaiseInfo | Object | This 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. | |
upRaiseInfo | id | Number | Represents user's id within UpRaise company directory. | 1, 101, 12001 etc |
upRaiseInfo | key | Number | User key that is matched with Jira user information. | String |
upRaiseInfo | name | String | Display name | John Doe |
upRaiseInfo | jiraUserName | String | Jira username | john.doe |
upRaiseInfo | active | Boolean | Whether this user is active or inactive in UpRaise's company directory. |
|
upRaiseInfo | designation | Object | This object consists of details about the designation associated with the current user. |
|
designation | id | Number | Designation id in UpRaise company directory. | 1, 101, 12001 etc |
designation | name | String | User facing designation. |
|
upRaiseInfo | upraiseRole | Object | This object consists of details about the role associated with the current user. |
|
upraiseRole | id | Number | Role id in UpRaise company directory. | 1, 101, 12001 etc |
upraiseRole | name | String | User facing role. |
|
upRaiseInfo | directReports | Object | This object consists of details about each one of the users whose manager is current user. |
|
upRaiseInfo | teams | Object | This object consists of details about each one of the teams whose member or team lead is current user. | |
teams | id | Number | Team id in UpRaise company directory. | 1, 101, 12001 etc |
teams | name | String | User facing team name. |
|
teams | description | String | User facing description for each team | |
upRaiseInfo | created | Date | Date on which current user was created in UpRaise Company directory. | 08/Jan/18 8:36 PM |
upRaiseInfo | modifiedBy | Object | Details about the user who updated the current user last. | |
upRaiseInfo | modified | Date | Date on which current user was recently modified in UpRaise Company directory. | 08/Jan/18 8:36 PM |
upRaiseInfo | dateTimeFormat | String | Format definition of dateTime fields returned in response. | |
upRaiseInfo | dateFormat | Date | Format definition of date fields returned in response. |