Chilkat Online Tools

Node.js / Salesforce Platform APIs / OAuth Usage

Back to Collection Items

var os = require('os');
if (os.platform() == 'win32') {  
    if (os.arch() == 'ia32') {
        var chilkat = require('@chilkat/ck-node21-win-ia32');
    } else {
        var chilkat = require('@chilkat/ck-node21-win64'); 
    }
} else if (os.platform() == 'linux') {
    if (os.arch() == 'arm') {
        var chilkat = require('@chilkat/ck-node21-arm');
    } else if (os.arch() == 'x86') {
        var chilkat = require('@chilkat/ck-node21-linux32');
    } else {
        var chilkat = require('@chilkat/ck-node21-linux64');
    }
} else if (os.platform() == 'darwin') {
    if (os.arch() == 'arm64') {
        var chilkat = require('@chilkat/ck-node21-mac-m1');
    } else {
        var chilkat = require('@chilkat/ck-node21-macosx');
    }
}


function chilkatExample() {

    // This example assumes the Chilkat API to have been previously unlocked.
    // See Global Unlock Sample for sample code.

    var http = new chilkat.Http();
    var success;

    var queryParams = new chilkat.JsonObject();
    queryParams.UpdateInt("page",0);
    queryParams.UpdateInt("pageSize",100);

    // Adds the "Authorization: Bearer <token>" header.
    http.AuthToken = "<token>";

    // resp: HttpResponse
    var resp = http.QuickRequestParams("GET","https://login.salesforce.com{{site}}/services/data/v{{version}}/apps/oauth/usage",queryParams);
    if (http.LastMethodSuccess == false) {
        console.log(http.LastErrorText);
        return;
    }

    console.log(resp.StatusCode);
    console.log(resp.BodyStr);


}

chilkatExample();

Curl Command

curl -G -d "page=0"
	-d "pageSize=100"
	-H "Authorization: Bearer <token>"
https://login.salesforce.com{{site}}/services/data/v{{version}}/apps/oauth/usage

Postman Collection Item JSON

{
  "name": "OAuth Usage",
  "protocolProfileBehavior": {
    "disabledSystemHeaders": {},
    "followOriginalHttpMethod": false,
    "disableUrlEncoding": false
  },
  "request": {
    "auth": {
      "type": "noauth"
    },
    "method": "GET",
    "header": [
      {
        "key": "Authorization",
        "value": "Bearer <token>",
        "description": "Replace <token> with your access token",
        "type": "text"
      }
    ],
    "url": {
      "raw": "{{url}}{{site}}/services/data/v{{version}}/apps/oauth/usage?page=0&pageSize=100",
      "host": [
        "{{url}}{{site}}"
      ],
      "path": [
        "services",
        "data",
        "v{{version}}",
        "apps",
        "oauth",
        "usage"
      ],
      "query": [
        {
          "key": "page",
          "value": "0",
          "description": "Number of the page you want returned. Starts at 0. If you don’t specify a value or if you specify 0, the first page is returned."
        },
        {
          "key": "pageSize",
          "value": "100",
          "description": "Number of usage entries per page. Defaults to 100.\t"
        }
      ]
    },
    "description": "Lists all the external client apps for the current org. See [OAuth Usage](https://developer.salesforce.com/docs/atlas.en-us.246.0.chatterapi.meta/chatterapi/connect_resources_usage.htm)."
  },
  "response": [
    {
      "name": "Successful OAuth Usage",
      "originalRequest": {
        "method": "GET",
        "header": [
          {
            "key": "Authorization",
            "value": "Bearer <token>",
            "description": "Replace <token> with your access token",
            "type": "text"
          }
        ],
        "url": {
          "raw": "https://login.salesforce.com/services/data/v59.0/apps/oauth/usage/?page=0&pageSize=100",
          "protocol": "https",
          "host": [
            "login",
            "salesforce",
            "com"
          ],
          "path": [
            "services",
            "data",
            "v59.0",
            "apps",
            "oauth",
            "usage",
            ""
          ],
          "query": [
            {
              "key": "page",
              "value": "0",
              "description": "Number of the page you want returned. Starts at 0. If you don’t specify a value or if you specify 0, the first page is returned."
            },
            {
              "key": "pageSize",
              "value": "100",
              "description": "Number of usage entries per page. Defaults to 100.\t"
            }
          ]
        }
      },
      "_postman_previewlanguage": null,
      "header": null,
      "cookie": [
      ],
      "body": "{\n  \"apps\": [\n    {\n      \"accessTokenFormat\": \"<accessTokenFormat>\",\n      \"availableActions\": \"disable, enable\",\n      \"description\": \"<description>\",\n      \"developerName\": \"<developerName>\",\n      \"identifier\": \"<identifier>\",\n      \"isFromPackage\": bool,\n      \"usageDetailsUrl\": \"/services/data/<version>/apps/oauth/usage/<identifier>/users\"\n    }\n  ],\n  \"currentPageUrl\": \"/services/data/<version>/apps/oauth/usage?page=0&pageSize=100\",\n  \"nextPageUrl\": \"/services/data/<version>/apps/oauth/usage?page=1&pageSize=100\"\n}"
    }
  ]
}