admin.roles.listAssignments

View other methods

Lists assignments for all roles across entities. Options to scope results by any combination of roles or entities

Reference docs Tester

Facts

Method access

HTTP

JavaScript

Python

Java

HTTP

GEThttps://slack.com/api/admin.roles.listAssignments

Bolt for Java

app.client().adminRolesListAssignments

Bolt for Python

app.client.admin_roles_listAssignments

Bolt for JavaScript

app.client.admin.roles.listAssignments

Required scopes

User tokensadmin.roles:read

Content types

application/x-www-form-urlencoded

Rate limits

Tier 3

Arguments

Required arguments

token

token

·Required

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

cursor

string

·Optional

Set cursor to next_cursor returned by the previous call to list items in the next page

Example

5c3e53d5

entity_ids

array

·Optional

The entities for which the roles apply

Example

['T12345', 'C12345']

limit

integer

·Optional

The maximum number of items to return. Must be between 1 - 200 both inclusive.

Default

200

Example

50

role_ids

array

·Optional

collection of role ids to scope results by

Example

['Rl01', 'Rl0A']

sort_dir

string

·Optional

Sort direction. Default is descending on date_create, can be either ASC or DESC

Example

DESC

Usage info

By default, admin.roles.listAssignments will return all existing role assignments across your entire org. Search for specific roles by providing the optional role_ids argument, and feel free to bring your own pagination with limit and cursor.

Utilizing Admin API endpoints

This admin scope is obtained through version two of the OAuth V2 flow, but there are a few additional requirements. The app requesting this scope must be installed by an Admin or Owner of an Enterprise Grid organization. Also, the app must be installed on the entire org, not on an individual workspace. See below for more details.

If the app is installed by an Org Admin or Owner, ensure the Channel Management settings provide the appropriate permissions. In order to manage channels after they are created, you must update your token to enable permissions for Org Admins or Owners (not just the Primary Org Owner).

Admin API endpoints reach across an entire Enterprise Grid organization, not individual workspaces.

For a token to be imbued with admin scopes, it must be obtained from installing an app on the entire Grid org, not just a workspace within the organization.

To configure and install an app supporting Admin API endpoints on your Enterprise Grid organization:

Create a new Slack app. Your app will need to be able to handle a standard OAuth 2 flow.
In the app's settings, select OAuth & Permissions from the left navigation. Scroll down to the section titled Scopes and add the admin.* scope you want. Click the green Save Changes button.
In the app's settings, select Manage Distribution from the left navigation. Under the section titled Share Your App with Other Workspaces, make sure all four sections have the green check. Then click the green Activate Public Distribution button.
Under the Share Your App with Your Workspace section, copy the Sharable URL and paste it into a browser to initiate the OAuth handshake that will install the app on your organization. You must be logged in as an Admin or Owner of your Enterprise Grid organization to install the app.
Check the dropdown in the upper right of the installation screen to make sure you are installing the app on the organization, not an individual workspace within the organization. See the image below for a visual.
Once your app completes the OAuth flow, you will be granted an OAuth token that can be used for calling Admin API methods for your organization.

When installing an app to use an Admin API endpoint, be sure to install it on your Grid organization, not a workspace within the organization.

Example responses

Common successful response

The response includes the role_id, entity_id, user_id, and a date the role assignment was created.

{
    "ok": true,
    "role_assignments": [
        {
            "role_id": "Rl0C",
            "entity_id": "T123ABC456",
            "user_id": "U123ABC456",
            "date_create": 1677038902
        },
        {
            "role_id": "Rl0C",
            "entity_id": "T123ABC456",
            "user_id": "U123ABC456",
            "date_create": 1677038902
        },
        {
            "role_id": "Rl0A",
            "entity_id": "C123ABC456",
            "user_id": "U123ABC456",
            "date_create": 1666624374
        },
        {
            "role_id": "Rl03",
            "entity_id": "E123ABC456",
            "user_id": "U123ABC456",
            "date_create": 1663617026
        },
        {
            "role_id": "Rl01",
            "entity_id": "E123ABC456",
            "user_id": "U123ABC456",
            "date_create": 1643231331
        }
    ],
    "response_metadata": {
        "next_cursor": "dXNlcl9pZDozMDA1NjIwNTc0MjYyO2VudGl0eV90eXBlOjE7ZW50aXR5X2lkOjMwMDUxODcyMTczNjY7ZGF0ZV9jcmVhdGU6MTY0MzIzMTMzMQ=="
    }
}

Common error response

Typical error response if you're attempting to call this without a token created by an Admin, or an Owner.

{
    "ok": false,
    "error": "invalid_actor"
}

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.

Error	Description
`feature_not_enabled`	This API is currently not enabled.
`invalid_actor`	This API is only enabled for the Admins/Owners.
`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_cursor`	The passed cursor was invalid.
`invalid_sort`	Sort parameters are invalid.
`invalid_role_id`	One or more role IDs could not be validated.
`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.
`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_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_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.

Warning	Description
`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.

API response

URL

POST body

Submit your arguments to see the API response