Users End Point

Summary

While user CRUD actions are now managed in Apptio's Frontdoor API , administrators can still retrieve a list of their users and update users’ default views, and view shares through the Cloudability V3 Users API. To use this endpoint you must have the UserManagementFeatureFullAccess permission.

End Point Particulars

/users for viewing user records and editing some attributes

User Object

id (int): The unique identifier for the User object.
frontdoor_user_id (string): The Frontdoor user UUID, a unique identifier for the user in a given Frontdoor environment.
frontdoor_login (string): The user’s Frontdoor login, a unique identifier for the user in a given Frontdoor environment.
email (string): The user’s Frontdoor email address.
full_name (string): The full name of the user as it will appear in user lists.
default_dimension_filter_set_id (int): The view filter id that will load by default when the user opens the app.
shared_dimension_filter_set_ids (array of ints): The IDs of the views that are available to the user, including views that are shared with the user or the organization.

Example User Object

{
   "id": 1,
   "frontdoor_user_id": "33ab2211-2b2b-4411-ee99-d90v98475n", 
   "frontdoor_login": "john@cloudability.com",
   "email": "john@cloudability.com",
   "full_name": "John Doe",
   "default_dimension_filter_set_id": null,
   "shared_dimension_filter_set_ids": [12, 999, 3646]
}

Example Request - List Users in Your Organization

curl https://api.cloudability.com/v3/users -u ‘[auth_token]:’

Example Response

[
  {
    "id": 1,
    "frontdoor_user_id": "33ab2211-2b2b-4411-ee99-d90v98475n",
    "frontdoor_login": "john@cloudability.com",
    "email": "john@cloudability.com",
    "full_name": "John Doe",
    "default_dimension_filter_set_id": null,
    "shared_dimension_filter_set_ids": [12, 999, 3646]
  },
  {
    "id”: 2,
    "frontdoor_user_id": "22dd2222-2b2b-4444-ee99-d90v9847an",
    "frontdoor_login": "lisa@cloudability.com",
    "email": "lisa@cloudability.com",
    "full_name": "Lisa Smith",
    "default_dimension_filter_set_id": null,
    "shared_dimension_filter_set_ids": [12, 999, 3646]
  }
]

Example Request – Retrieve User From Your Organization

curl https://api.cloudability.com/v3/users/1 -u ‘[auth_token]:’

Example Request - Update a User in Your Organization

Note:

Only full_name and filter sets (views) can be changed through this endpoint. All other fields must be updated in Access Administration . While a user’s name can be customized within Cloudability , be aware that any changes made to a name here will not be reflected in Access Administration .

Parameters

full_name (string): The full name of the user.
new_shared_dimension_filter_set_ids (array): Array of filter set IDs available to the user.
unshare_existing_dimension_filter_sets (bool): If set to true, all existing user view shares will be deleted and replaced with the shares from new_shared_dimension_filter_set_ids .
default_dimension_filter_set_id (integer): Filter set ID used by default for the user.

Example Query

curl –X PUT https://api.cloudability.com/v3/users/1 \\
     -H ‘Content-Type: application/json’ \\
     -u ‘[auth_token]:’ \\
     -d @- << EOF
{
     "full_name": "Joan Doe",
     "default_dimension_filter_set_id": 12,
     "new_shared_dimension_filter_set_ids": [12, 999]
}
EOF

(Replace the value 1 in the example with the unique ID of your user.)

Example Query - Remove All User View Shares

curl –X PUT https://api.cloudability.com/v3/users/1 \\
     -H ‘Content-Type: application/json’ \\
     -u ‘[auth_token]:’ \\
     -d @- << EOF
{
     "full_name": "Joan Doe",
     "default_dimension_filter_set_id": 1,
     "unshare_existing_dimension_filter_sets": true,
     "new_shared_dimension_filter_set_ids": []
}
EOF

(Replace the value 1 in the example with the unique ID of your user.)