Chilkat Online Tools

SQL Server / Salesforce Platform APIs / OAuth Usage

Back to Collection Items

-- Important: See this note about string length limitations for strings returned by sp_OAMethod calls.
--
CREATE PROCEDURE ChilkatSample
AS
BEGIN
    DECLARE @hr int
    DECLARE @iTmp0 int
    -- Important: Do not use nvarchar(max).  See the warning about using nvarchar(max).
    DECLARE @sTmp0 nvarchar(4000)
    -- This example assumes the Chilkat API to have been previously unlocked.
    -- See Global Unlock Sample for sample code.

    DECLARE @http int
    -- Use "Chilkat_9_5_0.Http" for versions of Chilkat < 10.0.0
    EXEC @hr = sp_OACreate 'Chilkat.Http', @http OUT
    IF @hr <> 0
    BEGIN
        PRINT 'Failed to create ActiveX component'
        RETURN
    END

    DECLARE @success int

    DECLARE @queryParams int
    -- Use "Chilkat_9_5_0.JsonObject" for versions of Chilkat < 10.0.0
    EXEC @hr = sp_OACreate 'Chilkat.JsonObject', @queryParams OUT

    EXEC sp_OAMethod @queryParams, 'UpdateInt', @success OUT, 'page', 0
    EXEC sp_OAMethod @queryParams, 'UpdateInt', @success OUT, 'pageSize', 100

    -- Adds the "Authorization: Bearer <token>" header.
    EXEC sp_OASetProperty @http, 'AuthToken', '<token>'

    DECLARE @resp int
    EXEC sp_OAMethod @http, 'QuickRequestParams', @resp OUT, 'GET', 'https://login.salesforce.com{{site}}/services/data/v{{version}}/apps/oauth/usage', @queryParams
    EXEC sp_OAGetProperty @http, 'LastMethodSuccess', @iTmp0 OUT
    IF @iTmp0 = 0
      BEGIN
        EXEC sp_OAGetProperty @http, 'LastErrorText', @sTmp0 OUT
        PRINT @sTmp0
        EXEC @hr = sp_OADestroy @http
        EXEC @hr = sp_OADestroy @queryParams
        RETURN
      END

    EXEC sp_OAGetProperty @resp, 'StatusCode', @iTmp0 OUT
    PRINT @iTmp0
    EXEC sp_OAGetProperty @resp, 'BodyStr', @sTmp0 OUT
    PRINT @sTmp0
    EXEC @hr = sp_OADestroy @resp


    EXEC @hr = sp_OADestroy @http
    EXEC @hr = sp_OADestroy @queryParams


END
GO

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