This document outlines the changes to the BitBrew management APIs and Dashboard application that will be released August 10, 2017. Changes to existing endpoints and new endpoints should be carefully read and understood.

BitBrew's API documentation will be updated when the release has been successfully deployed to our production environment.

Table of Contents

API Changes

  • New Method to Delete Clients

  • New Method to Create Clients

  • New Method to List Users

  • Updated Response Body for List Clients

Dashboard Changes

  • User and Client Management Moved to Settings Tab

New Method to Delete Clients

The management API now allows deletion of clients by client ID.

New Endpoint

[DELETE] /v1/tenants/{tenantId}/clients/{clientId}

New Method to Create Clients

Client creation will now take place on tenant-specific endpoints to be consistent with their other resources. The response body of this call has been updated to provide useful information about the client, such as the scope and the user-provided name and description.

Old Endpoint

[POST] /v1/admin/clients

New Endpoint

[POST] /v1/tenants/{tenantId}/clients

Response Diff

{
+   "name": "myClientApp",
+   "description": "optionalDescription",
+   "scope": "app"
    "id": "41a269ad-8766-4703-9df7-b943c5a645d9",
    "secret": "Y2Q4NjhkM2QtODc2Zi00MzRiLWE2MDUtZWNhZjdjNTdjYTU2"
}

New Method to List Users

Listing users will now take place on tenant-specific endpoints to be consistent with their other resources. The response body of this call has been updated to reflect to provide relevant information about the user when available.

Old Endpoint

[GET] /v1/admin/users

New Endpoint

[GET] /v1/tenants/{tenantId}/users

Response Diff

{
   "users": [
       {
           "email": "twilliams@lostgen.com",
           "id": "7e980334-5b70-4b66-b1ec-c852d465b322",
+          "name": "Tennessee Williams",
+          "role": "tenantAdmin",
-          "roles": [
-              "tenantAdmin"
-          ],
-          "permissions": [],
-          "tenantId": "lost-generation"
        }
    ]
}

Updated Response Body for List Clients

The response body of this call has been updated to reflect to provide the username of the creator of each client.

Endpoint

[GET] /v1/tenants/{tenantId}/clients

Response Diff

{
 "clients": [
       {
+        "id": "0f1b01d3-36d2-4d28-9867-8e467c957b01",
-        "clientId": "0f1b01d3-36d2-4d28-9867-8e467c957b01",
          "name": "jays-client",
          "description": "Jay's Client",
+         "username": "jgatsby@eastegg.com"
        },
        ...
    ]
}

User and Client Management Moved to Settings Tab

The user and client management tabs have been moved into a menu item called "Settings," located in a dropdown under your account name.

Did this answer your question?