De-provisioning Users

Identify which of your Customers you want to de-provision

Review the API reference documentation here to get the full list of your provisioned Companies. Recall that each Company gets an endpointID. An endpoint is the user/token's connection to their company file. Note that on the call the argument IsActive is optional. You can select all by not passing in IsActive or by passing in a value (true/false) you can select all the active (true) or not active (false).

Here's an example of a request:

curl --request GET \
  --url https://api.propelware.com/v1/manage/Endpoint?IsActive=true \
  --header 'authorization: {YOUR API KEY}' \

Here is the response:

{
  "Meta": {
    "CommandGuid": null,
    "StatusCode": "0",
    "Severity": null,
    "Message": "Found 1 endpoint ids"
  },
  "Detail": [
    {
      "isActive": true,
      "endpointId": "YOUR_ENDPOINT_ID",
      "endpoint": "quickbooks",
      "fullPath": "YOUR_FILE_PATH",
      "companyName": "YOUR_COMPANY_LABEL",
      "dateTimeCreated": "2019-03-29T11:57:30.743",
      "appName": "YOUR_APP_NAME"
    }
  ]
}

You should expect an array at the Detail node of the returned JSON.

Make the de-provisioning request

De-provisioning a Company is done one at a time. To make the de-provisioning call, make this request:

curl --request PATCH \
  --url https://api.propelware.com/v1/manage/Endpoint \
  --header 'authorization: {YOUR API KEY}' \
  --data '{"endpointId":"YOUR_ENDPOINT_ID","isActive":"false"}'

Here is the response:

{
  "Meta": {
    "CommandGuid": null,
    "StatusCode": "0",
    "Severity": null,
    "Message": "Updated endpoint YOUR_ENDPOINT_ID"
  },
  "Detail": [
    {
      "isActive": false,
      "endpointId": "YOUR_ENDPOINT_ID",
      "endpoint": "qbd",
      "fullPath": "YOUR_QBD_FILE_PATH",
      "companyName": "YOUR_QBD_COMPANY_LABEL",
      "dateTimeCreated": "2019-03-29T17:50:42.937",
      "appName": "YOUR_APP_NAME"
    }
  ]
}

The response confirms the details of the Company (endpointID) that you have de-provisioned.

Confirm

There are 3 ways to confirm that you have indeed removed your end Customer from the API:

Review the response of the de-provisioning call (in step 2 above).
Select list of inactive Companies (endpointIDs).

curl --request GET \
  --url https://api.propelware.com/v1/manage/Endpoint?IsActive=false \
  --header 'authorization: {YOUR API KEY}' \

Make a call to an inactive Company (endpointID) and confirm the response.