Manage users

All of the standard CRUD actions to manage users within your account.

List of users in your organization

GET /api/1/users/?auth_token=<your_auth_token>

1. Parameters

This method has no parameters except for authentication.

1. Example Response

[
  {
    id: 1,
    email: "[email protected]",
    full_name: "John Doe",
    invitation: "pending",
    role: "Administrator",
    restricted: false,
    shared_dimension_filter_set_ids: [ ],
    default_dimension_filter_set_id: null
  }
]

Add a user to your organization

šŸ“˜

Notice

Please note as part of Apptio's acquistion of Cloudability the function for adding a new user is moving to Apptio's Frontdoor API - please refer to the documention here: https://tbmcouncil.jiveon.com/docs/DOC-10515

The function and corresponding API for updating a user remains the same
https://developers.cloudability.com/v1.0/docs/users#section-update-a-user-to-your-organization

POST /api/1/users/?auth_token=<your_auth_token>

2. Parameters

All of the following paramaters must belong to a root parameter of user

email: Required (string) The email address of the user
full_name: (string) The full name of the user
role: (string) Role assigned to the user
restricted: (boolean) True if the user is allowed to have no filter set applied, false if they must always have a filter set applied
new_shared_dimension_filter_set_ids: (array) Array of filter sets ids available to the user
default_dimension_filter_set_id: (integer) Filter set id used by default for the user

2. Example Payload

{
  "user": {
    "full_name": "John Doe",
    "role": "Administrator",
    "restricted": false,
    "email": "[email protected]",
    "default_dimension_filter_set_id": null,
    "new_shared_dimension_filter_set_ids": [],
    "unshare_existing_dimension_filter_sets": true
  }
}

2. Example Response

[
  {
    id: 1,
    email: "[email protected]",
    full_name: "John Doe",
    invitation: "pending",
    role: "Administrator",
    restricted: false,
    shared_dimension_filter_set_ids: [],
    default_dimension_filter_set_id: null
  }
]

Update a user to your organization

PUT /api/1/users/:id?auth_token=<your_auth_token>

3. Parameters

All of the following paramaters must belong to a root parameter of user

  • Note: do NOT provide the email address with updates. This cannot be changed.

full_name: (string) The full name of the user
role: (string) Role assigned to the user
restricted: (boolean) True if the user is allowed to have no filter set applied, false if they must always have a filter set applied
new_shared_dimension_filter_set_ids: (array) Array of filter sets ids available to the user
default_dimension_filter_set_id: (integer) Filter set id used by default for the user

3. Example Payload

{
  "user": {
    "full_name": "John Doe",
    "role": "Administrator",
    "restricted": false,
    "default_dimension_filter_set_id": null,
    "new_shared_dimension_filter_set_ids": [],
    "unshare_existing_dimension_filter_sets": true
  }
}

3. Example Response

[
  {
    id: 1,
    email: "[email protected]",
    full_name: "John Doe",
    invitation: "pending",
    role: "Administrator",
    restricted: false,
    shared_dimension_filter_set_ids: [],
    default_dimension_filter_set_id: null
  }
]

Delete a user in your organization

šŸ“˜

Notice

Please note as part of Apptio's acquistion of Cloudability the function for deleting a user is moving to Apptio's Frontdoor API - please refer to the documention here: https://tbmcouncil.jiveon.com/docs/DOC-10512

The function and corresponding API for updating a user remains the same
https://developers.cloudability.com/v1.0/docs/users#section-update-a-user-to-your-organization

DELETE /api/1/users/:id?auth_token=<your_auth_token>

4. Parameters

id: integer (required)