Get app permissions | Sample

1 parameter

tokenstringoptional

Optional authentication token with no additional required scope.

2 status codes

200Returns an object with `ok` set to true and an `info` object containing permission details for `team`, `channel`, `group`, `mpim`, `im`, and `app_home` resources.

infoobjectrequired

okbooleanrequired

Allowed:true

defaultReturns an object with `ok` set to false and an `error` value describing the authentication or request failure.

callstackstringoptional

Note: PHP callstack is only visible in dev/qa

errorstringrequired

Allowed:not_authedinvalid_authaccount_inactivetoken_revokedno_permissionorg_login_requireduser_is_botinvalid_arg_nameinvalid_array_arginvalid_charsetinvalid_form_datainvalid_post_type

okbooleanrequired

Allowed:false

Error handling

token is optional, but when supplied it must be a valid authentication token. Use the appropriate token context when you need permission details for a specific workspace or installation.

import { Client } from "acme-sdk";

const client = new Client({
  baseUrl: "https://api.acme.com",
  retry: {
    maxAttempts: 3,
    retryOn: [
      408,
      425,
      429,
      500,
      502,
      503,
      504,
    ],
    backoffMs: 500,
    maxBackoffMs: 8000,
  },
  timeoutMs: 30000,
});

const result = await client.appsPermissionsInfo.list({ token: "sk_live_4eC39Hq" });

{
  "info": {
    "app_home": {
      "resources": {
        "ids": [
          "D0C0NU1Q8",
          "D0BH95DLH"
        ]
      },
      "scopes": [
        "chat:write",
        "im:history",
        "im:read"
      ]
    },
    "channel": {
      "resources": {
        "excluded_ids": [],
        "ids": [
          "C061FA5PB"
        ],
        "wildcard": false
      },
      "scopes": [
        "channels:read"
      ]
    },
    "group": {
      "resources": {
        "ids": []
      },
      "scopes": []
    },
    "im": {
      "resources": {
        "ids": []
      },
      "scopes": []
    },
    "mpim": {
      "resources": {
        "ids": []
      },
      "scopes": []
    },
    "team": {
      "resources": {
        "ids": []
      },
      "scopes": []
    }
  },
  "ok": true
}

Request

Response

Errors