Get User
Purpose - Retrieve user information for the specified login.
URL - https://<frontdoor-url>/api/user/{name}
Note: Replace <frontdoor-url> with the Frontdoor
URL for the region your Apptio product is hosted in.
Method - GET
URL path parameters -
name: UserID of the user for which you want to retrieve information.Required permissions - The logged-in user must belong to the same authentication domain and have permissions to read users belonging to the searched-for user's authentication domain. A user can read users of an authentication domain if they have the manageUser or readUser permission in an environment shared with the searched-for user's authentication domain.
Sample request - GET https://frontdoor.apptio.com/api/user/foo@acme.com
Return codes:
| HTTP Status Code | Reason |
|---|---|
| 200 | Requested user |
| 403 | You don't have the required permissions to perform this operation |
| 404 | Requested user not found |
Response:
{
"id": "<string>",
"login": "<string>",
"active": <true/false>,
"full": "<string>",
"email": "<string>",
"persona": {
"enumValue": "APPLICATION_PLATFORM_OWNER"
},
"forcePwdChange": <true/false>,
"domain": "<string>",
"failedLoginCount": <int>,
"createdBy": "<string>",
"updatedBy": "<string>",
"accountType": "STANDARD",
"external": <true/false>,
"accountStatus": "<string>"
}