Purpose - Delete 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 - DELETE
JSON parameters:
Parameter | Description |
---|---|
id |
Login or user ID for the user |
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:
- Users cannot delete their accounts
- All roles must be revoked from the user before the user can be deleted
Required permissions:
- The caller must have permissions to delete 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.
Sample request:
DELETE /api/user HTTP/1.1
Host: frontdoor.apptio.com
Content-Type: application/json
Apptio-opentoken: *****************************************************************************************
{
"id": "[your_id]"
}
Return codes:
HTTP Status Code | Reason |
---|---|
204 | The user was deleted |
403 | You don't have the required permissions to perform this operation |
404 | The user specified does not exist |
Response class:
{
}
0 Comments