Documentation and Best Practices

Learn how to use Cloudability and get the most out of our cloud cost management tool.

Follow

Frontdoor API: Update user

Purpose - Update a user.

URL - Select the URL for your location:

  • https://frontdoor.apptio.com/api/user/
  • https://frontdoor-eu.apptio.com/api/user/
  • https://frontdoor-au.apptio.com/api/user
  • https://frontdoor-usgov.apptio.com/api/user
  • https://frontdoor-aug.apptio.com/api/user

Method - PUT

JSON parameters:

The user object must contain either the login or the universally unique identifier (UUID) of the user.

Parameter Description
login (Key 1) Log in for the user.
id (Key 2) The universally unique identifier (UUID) of the user. Defaults to a random identifier.
email The email of the user.
full The full name of the user.
forcePwdChange Boolean flag that forces the user to change their password on their next login. Defaults to FALSE.

 

Headers - Pass apptio-opentoken header received as a response from the authentication call. See Basic authentication using user name and password. (For security reasons, this link requires TBM credentials).

Constraints:

  • ID or login for the user account must map to an existing user account.
  • Email of the user must be a valid email address.

Required permissions:

  • The caller must have permissions to update users in the authentication domain specified.
    • If the user is in the same authentication domain as the caller, then the caller must have the manageUser permission in any environment in that authentication domain.
    • If the user is in an authentication domain that is different from the caller's authentication domain, then the caller must have the manageDomainUsers permission in the environment of that authentication domain.
  • The logged-in user can update their email or full name.

 

Sample request:

PUT /api/user HTTP/1.1
Host: frontdoor.apptio.com
Content-Type: application/json
Apptio-opentoken: *****************************************************************************************
{
"login": "[your_login]",
"email": "[your_email]",
"full": "Test User"
}

 

Return codes:

HTTP Status Code Reason
200 User updated
400 Invalid data submitted
403 You don't have the required permissions to perform this operation
404 The user specified does not exist

 

Response class (success):

{
  "id": "<string>",
  "login": "<string>",
  "active": <true/false>,
  "full": "<string>",
  "email": "<string>",
  "forcePwdChange": <true/false>,
  "domain": "<string>",
  "failedLoginCount": <int>,
  "createdBy": "<string>",
  "updatedBy": "<string>",
  "accountType": "STANDARD",
  "external": <true/false>,
  "acco
untStatus": "<string>"
}

Was this article helpful?
0 out of 0 found this helpful
Have more questions? Submit a request

0 Comments

Please sign in to leave a comment.