Returns list of user grants and corresponding scopes this app has on a team.
Method URL: | https://slack.com/api/apps.permissions.users.list | ||
---|---|---|---|
Preferred HTTP method: | GET | ||
Accepted content types: | application/x-www-form-urlencoded | ||
Rate limiting: | Tier 2 | ||
Works with: |
|
This feature was exclusive to our workspace apps developer preview. The preview has now ended, but fan-favorite features such as token rotation and the Conversations API will become available to classic Slack apps over the coming months.
This method returns a list of all the user-centric permissions awarded to a workspace token.
It's part of the Permissions API, which is available only to workspace apps.
To request user-centric permissions, use apps.permissions.users.request
.
Argument | Example | Required | Description |
---|---|---|---|
token | xxxx-xxxxxxxxx-xxxx | Required | Authentication token bearing required scopes. |
cursor | dXNlcjpVMDYxTkZUVDI= | Optional | Paginate through collections of data by setting the |
limit | 20 | Optional | The maximum number of items to return. |
application/x-www-form-urlencoded
querystring or POST body. This method does not currently accept application/json
.
Typical successful paginated response
{
"ok": true,
"resources": [
{
"id": "U0DES3UAN",
"scopes": [
"dnd:write:user",
"reminders:write:user"
]
},
{
"id": "U024BFF1M",
"scopes": [
"reminders:write:user"
]
}
],
"response_metadata": {
"next_cursor": "dGVhbTdPMUg5UkFTT0w="
}
}
Typical error response
{
"ok": false,
"error": "invalid_cursor"
}
This method uses cursor-based pagination to make it easier to incrementally collect information. To begin pagination, specify a limit
value under 1000
. We recommend no more than 200
results at a time.
Responses will include a top-level response_metadata
attribute containing a next_cursor
value. By using this value as a cursor
parameter in a subsequent request, along with limit
, you may navigate through the collection page by virtual page.
See pagination for more information.
This table lists the expected errors that this method could return. However, other errors can be returned in the case where the service is down or other unexpected factors affect processing. Callers should always check the value of the ok
params in the response.
Error | Description |
---|---|
invalid_cursor | Value passed for |
not_authed | No authentication token provided. |
invalid_auth | Some aspect of authentication cannot be validated. Either the provided token is invalid or the request originates from an IP address disallowed from making the request. |
account_inactive | Authentication token is for a deleted user or workspace. |
token_revoked | Authentication token is for a deleted user or workspace or the app has been removed. |
no_permission | The workspace token used in this request does not have the permissions necessary to complete the request. Make sure your app is a member of the conversation it's attempting to post a message to. |
org_login_required | The workspace is undergoing an enterprise migration and will not be available until migration is complete. |
ekm_access_denied | Administrators have suspended the ability to post a message. |
missing_scope | The token used is not granted the specific scope permissions required to complete this request. |
is_bot | This method cannot be called by a bot user. |
invalid_arguments | The method was called with invalid arguments. |
invalid_arg_name | The method was passed an argument whose name falls outside the bounds of accepted or expected values. This includes very long names and names with non-alphanumeric characters other than |
invalid_charset | The method was called via a |
invalid_form_data | The method was called via a |
invalid_post_type | The method was called via a |
missing_post_type | The method was called via a |
team_added_to_org | The workspace associated with your request is currently undergoing migration to an Enterprise Organization. Web API and other platform operations will be intermittently unavailable until the transition is complete. |
request_timeout | The method was called via a |
fatal_error | The server could not complete your operation(s) without encountering a catastrophic error. It's possible some aspect of the operation succeeded before the error was raised. |
This table lists the expected warnings that this method will return. However, other warnings can be returned in the case where the service is experiencing unexpected trouble.
Warning | Description |
---|---|
missing_charset | The method was called via a |
superfluous_charset | The method was called via a |