Chilkat Online Tools

phpExt / Salesforce Platform APIs / OAuth Usage

Back to Collection Items

<?php

include("chilkat.php");
// Use "chilkat_9_5_0.php" for versions of Chilkat < 10.0.0

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

$http = new CkHttp();

$queryParams = new CkJsonObject();
$queryParams->UpdateInt('page',0);
$queryParams->UpdateInt('pageSize',100);

// Adds the "Authorization: Bearer <token>" header.
$http->put_AuthToken('<token>');

// resp is a CkHttpResponse
$resp = $http->QuickRequestParams('GET','https://login.salesforce.com{{site}}/services/data/v{{version}}/apps/oauth/usage',$queryParams);
if ($http->get_LastMethodSuccess() == false) {
    print $http->lastErrorText() . "\n";
    exit;
}

print $resp->get_StatusCode() . "\n";
print $resp->bodyStr() . "\n";


?>

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}"
    }
  ]
}