Grant a user access to an environment

Edit online

Purpose - Grant a user access to an environment.

URL - https://<frontdoor-url>/api/environmentuser

Note: Replace <frontdoor-url> with the Frontdoor URL for the region your Apptio product is hosted in.

Method - POST

JSON parameters:

Parameter Description
environment The universally unique identifier (UUID) of the environment to which grant the user access to.
user Login or UUID of the user. For example, user@customer.com
defaultRoles (Optional) Set of default roles to assign to the user in the environment.
customRoles (Optional) Set of custom roles to assign to the user in the environment.

Headers - Pass apptio-opentoken header received as a response from the authentication call. See Basic authentication using user name and password.

Constraints:

  • The user must have an account
  • A minimum of one default or custom role must be assigned

Sample request:

POST /api/user HTTP/1.1
Host: frontdoor.apptio.com
Content-Type: application/json
Apptio-opentoken: *****************************************************************************************
{
  "environment": "1234567-98e3-42f2-b22d-abcd1234",
  "user": "testuser1@test.com",
  "defaultRoles": [{
     "name": "Budget Process Owner"
  }],
  "customRoles": []
}