With this update the Cloudability Users end point is available on the v3 API. This is the final endpoint being launched on Cloudability’s latest-gen public API this month.

This API endpoint enables admins to perform programmatic reading and updating of their organization’s users.  

The key differences between v1 Users API and v3 Users API are as follows:

• Narrowed the scope of what attributes can be updated to full name, default and shared
• The roles and permissions attributes have been removed as they are now managed through Frontdoor.
• Simplified the JSON payload when updating a user’s details.

All the fields other than those mentioned above, must be updated in Frontdoor. While a user’s name can be customized within Cloudability, note that changes made to a name in the v3 Users API will not be reflected in Frontdoor.

Example request

A list of your organization’s users can be retrieved by running a GET request at https://api.cloudability.com/v3/users/

To retrieve an individual users simply run a HTTP GET request at https://api.cloudability.com/v3/users/:id

General considerations when moving from v1 to v3 API end points

Individual API documents have been added to the v3 user documentation for each endpoint. Changes at the endpoint interface level between v1 and v3 are reflected within the endpoint documentation.

Some general differences between the v1 and v3 APIs:

• Base URL: https://app.cloudability.com/api/1/ https://api.cloudability.com/v3/
• Authentication: standard method for v1 is via URL query parameter while v3 is via Basic Auth HTTP header.
• Rate Limiting: the v3 API is limited to 300 calls per minute for each user

For more help on migrating to the v3 endpoints checkout this video guide on the Apptio Community.

The complete set of Cloudability v3 API end points are now available.