Chilkat Online Tools

Swift / Salesforce Platform APIs / OAuth App Users

Back to Collection Items

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

    let http = CkoHttp()
    var success: Bool

    let queryParams = CkoJsonObject()
    queryParams.UpdateInt("page", value: 0)
    queryParams.UpdateInt("pageSize", value: 100)

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

    var resp: CkoHttpResponse? = http.QuickRequestParams("GET", url: "https://login.salesforce.com{{site}}/services/data/v{{version}}/apps/oauth/usage/{{_appId}}/users", json: queryParams)
    if http.LastMethodSuccess == false {
        print("\(http.LastErrorText)")
        return
    }

    print("\(resp!.StatusCode.intValue)")
    print("\(resp!.BodyStr)")
    resp = nil

}

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/{{_appId}}/users

Postman Collection Item JSON

{
  "name": "OAuth App Users",
  "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/{{_appId}}/users?page=0&pageSize=100",
      "host": [
        "{{url}}{{site}}"
      ],
      "path": [
        "services",
        "data",
        "v{{version}}",
        "apps",
        "oauth",
        "usage",
        "{{_appId}}",
        "users"
      ],
      "query": [
        {
          "key": "page",
          "value": "0",
          "description": "Page number for the usage information. Defaults to 0."
        },
        {
          "key": "pageSize",
          "value": "100",
          "description": "Number of usage entries per page. Defaults to 100."
        }
      ]
    },
    "description": "Lists all users for the external client app indicated by the app ID. See [OAuth Users by App ID](https://developer.salesforce.com/docs/atlas.en-us.246.0.chatterapi.meta/chatterapi/connect_resources_usage_app_id_users.htm)."
  },
  "response": [
    {
      "name": "Successful OAuth App Users",
      "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//users?page=0&pageSize=100",
          "protocol": "https",
          "host": [
            "login",
            "salesforce",
            "com"
          ],
          "path": [
            "services",
            "data",
            "v59.0",
            "apps",
            "oauth",
            "usage",
            "",
            "users"
          ],
          "query": [
            {
              "key": "page",
              "value": "0",
              "description": "Page number for the usage information. Defaults to 0."
            },
            {
              "key": "pageSize",
              "value": "100",
              "description": "Number of usage entries per page. Defaults to 100."
            }
          ]
        }
      },
      "_postman_previewlanguage": null,
      "header": null,
      "cookie": [
      ],
      "body": "{\n  \"currentPageUrl\": \"/services/data/<version>/apps/oauth/usage/<identifier>/users?page=0&pageSize=100\",\n  \"nextPageUrl\": \"/services/data/<version>/apps/oauth/usage/<identifier>/users?page=1&pageSize=100\",\n  \"users\": [\n    {\n      \"accessTokenFormat\": \"<accessTokenFormat>\",\n      \"appDeveloperName\": \"<appDeveloperName>\",\n      \"appIdentifier\": \"<identifier>\",\n      \"initialConnectionAt\": \"<timestamp>\",\n      \"lastUsedAt\": \"<timestamp>\",\n      \"revocationUrl\": \"/services/data/<version>/apps/oauth/usage/<identifier>/<userIdentifier>/tokens\",\n      \"useCount\": integer,\n      \"userIdentifier\": \"<userIdentifier>\",\n      \"username\": \"<username>\"\n    }\n  ]\n}"
    }
  ]
}