apps.event.authorizations.list

Get a list of authorizations for the given event context. Each authorization represents an app installation that the event is visible to.

Facts

Method access

HTTP
JavaScript
Python
Java
HTTP
POSThttps://slack.com/api/apps.event.authorizations.list
Bolt for Java
app.client().appsEventAuthorizationsList
Powered by Bolt
Bolt for Python
app.client.apps_event_authorizations_list
Powered by Bolt
Bolt for JavaScript
app.client.apps.event.authorizations.list
Powered by Bolt

Content types

application/x-www-form-urlencodedapplication/json
  • Rate limits

    Tier 4
  • Arguments

    Required arguments

    Authentication token bearing required scopes. Tokens should be passed as an HTTP Authorization header or alternatively, as a POST parameter.

    Example
    xxxx-xxxxxxxxx-xxxx
    Optional arguments

    Usage info

    This method returns a list of authorizations for the given event specified by event_context. Each authorization represents an app installation that the event is visible to.

    How do I find an event_context to call this method with?

    You'll receive an event_context identifying an event in each event payload sent to your app.

    What do authorizations signify?

    Authorizations are installations of your app. If your app has been installed multiple times, you'll probably have multiple authorizations for some events.

    When should I call this method?

    Call this method to see all the installations of your app than an event is visible to. Sometimes, only certain installations have permission to know about an event.

    How do I get permission to call this method

    Calling this method is just like any other Web API method. However, since this method lists multiple installations of your app, you'll need an app-level token.

    You'll obtain the app-level token by going to your app settings and scrolling down to the App-Level Tokens section on the Basic Information page. CLick Generate Token and Scopes to get the token. You'll also request the authorizations:read scope.

    For this method, you will need to pass this token in the HTTP Authorization header of your request; passing it as a POST parameter will result in an error.

    Example responses

    Common successful response

    Typical success response

    {
        "ok": true,
        "authorizations": [
            {
                "enterprise_id": "string",
                "team_id": "string",
                "user_id": "string",
                "is_bot": "string"
            },
            {
                "enterprise_id": "string2",
                "team_id": "string2",
                "user_id": "string2",
                "is_bot": "string2"
            }
        ]
    }

    Errors

    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.

    ErrorDescription
    auth_mismatch

    The given authorization token is not associated with the app that sent this event.

    internal_error

    The server could not complete your operation(s) without encountering an error, likely due to a transient issue on our end. It's possible some aspect of the operation succeeded before the error was raised.

    invalid_cursor

    The cursor argument was invalid.

    invalid_event_context

    The given event_context didn't match an event.

    access_denied

    Access to a resource specified in the request is denied.

    account_inactive

    Authentication token is for a deleted user or workspace when using a bot token.

    deprecated_endpoint

    The endpoint has been deprecated.

    ekm_access_denied

    Administrators have suspended the ability to post a message.

    enterprise_is_restricted

    The method cannot be called from an Enterprise.

    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.

    is_bot

    This method cannot be called by a legacy bot.

    method_deprecated

    The method has been deprecated.

    missing_scope

    The token used is not granted the specific scope permissions required to complete this request.

    not_allowed_token_type

    The token type used in this request is not allowed.

    not_authed

    No authentication token provided.

    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.

    token_expired

    Authentication token has expired

    token_revoked

    Authentication token is for a deleted user or workspace or the app has been removed when using a user token.

    two_factor_setup_required

    Two factor setup is required.

    accesslimited

    Access to this method is limited on the current network

    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.

    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 _. If you get this error, it is typically an indication that you have made a very malformed API call.

    invalid_arguments

    The method was either called with invalid arguments or some detail about the arguments passed is invalid, which is more likely when using complex arguments like blocks or attachments.

    invalid_array_arg

    The method was passed an array as an argument. Please only input valid strings.

    invalid_charset

    The method was called via a POST request, but the charset specified in the Content-Type header was invalid. Valid charset names are: utf-8 iso-8859-1.

    invalid_form_data

    The method was called via a POST request with Content-Type application/x-www-form-urlencoded or multipart/form-data, but the form data was either missing or syntactically invalid.

    invalid_post_type

    The method was called via a POST request, but the specified Content-Type was invalid. Valid types are: application/json application/x-www-form-urlencoded multipart/form-data text/plain.

    missing_post_type

    The method was called via a POST request and included a data payload, but the request did not include a Content-Type header.

    ratelimited

    The request has been ratelimited. Refer to the Retry-After header for when to retry the request.

    request_timeout

    The method was called via a POST request, but the POST data was either missing or truncated.

    service_unavailable

    The service is temporarily unavailable

    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.

    Warnings

    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.

    WarningDescription
    missing_charset

    The method was called via a POST request, and recommended practice for the specified Content-Type is to include a charset parameter. However, no charset was present. Specifically, non-form-data content types (e.g. text/plain) are the ones for which charset is recommended.

    superfluous_charset

    The method was called via a POST request, and the specified Content-Type is not defined to understand the charset parameter. However, charset was in fact present. Specifically, form-data content types (e.g. multipart/form-data) are the ones for which charset is superfluous.