Authentication via API keys
Authenticate a local user account to log in using Application Programming Interface (API) keys.
Purpose - Authenticate a local user account to log in using Application Programming Interface (API) keys.
SEE ALSO:
URL - https://<frontdoor-url>/service/apikeylogin
Note: Replace <frontdoor-url> with the Frontdoor
URL for the region your Apptio product is hosted in.
Method - POST
JSON parameters
| Parameter | Description |
|---|---|
keyAccess |
The public access key to use for a login |
keySecret |
The secret key to use for a login |
Sample request:
POST /service/nonuilogin HTTP/1.1
Host: frontdoor.apptio.com (or your frontdoor region i.e. frontdoor-eu.apptio.com, frontdoor.au.apptio.com)
Content-Type: application/json
Accept: application/json
{
"keyAccess": "d2eab6af-78ec-47db-98c1-ec1416b29ac8",
"keySecret": "rg0yprL0NR563pPpJbOtLa0feIx0HtMymberRyVAzKHTybumVGCv0Z4Zr7ET"
}NOTICE
- Host header should be set to match the host name for the request url. Almost all http request libraries should set this header automatically. The request is invalid if the user specifies anything else.
- It is still necessary to specify the Content-Type and Accept, but it is not necessary to specify the Host.
Return codes
| HTTP Status Code | Reason |
|---|---|
| 200 | Login successful. |
| 400 | Invalid request data submitted. Unable to log the user in. |
Response - Open token for user authentication via the return header:
apptio-opentoken
NOTICE
When using API keys, make sure that the API key is granted access to the environment you are trying to work with. See Overview of API keys and FAQ.