admin.roles.addAssignments

Adds members to the specified role with the specified scopes

Facts

Method access

HTTP
JavaScript
Python
Java
HTTP
GEThttps://slack.com/api/admin.roles.addAssignments
Bolt for Java
app.client().adminRolesAddAssignments
Powered by Bolt
Bolt for Python
app.client.admin_roles_addAssignments
Powered by Bolt
Bolt for JavaScript
app.client.admin.roles.addAssignments
Powered by Bolt

Content types

application/x-www-form-urlencoded
  • Rate limits

    Tier 2
  • 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

    List of the entity IDs for which roles will be assigned. These can be Org IDs, Team IDs or Channel IDs

    Example
    ['T00000001', 'E00000002']

    ID of the role to which users will be assigned

    Example
    R0001

    List of IDs from the users to be added to the given role

    Example
    ['U00000001', 'U00000002', 'U00000003']

    Usage info

    With admin.roles.addAssignments, you can add members to a specified role, granting them the permission scopes that are assigned to that role.

    The API will process all user, team, and org IDs passed. In cases where an invalid user or other entity ID is passed, the ID will be rejected and details (including the reason for the rejection) will be provided in the respective rejected_users and/or rejected_entities response.

    The following roles and their respective scope types can be assigned by Org Owners and Org Admins on Enterprise plans:

    Role Scope type
    Audit Logs Admin Team or Org
    Channel Admin Team or Org
    Channel Manager Channels
    Compliance Admin Org
    Role Admin Team or Org
    User Admin Team or Org

    Example responses

    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
    feature_not_enabled

    This API is currently not enabled.

    invalid_role_id

    The role type passed does not exist.

    invalid_actor

    This API is only enabled for the Admins/Owners.

    no_valid_users

    None of the users passed were valid.

    no_valid_entities

    None of the entities passed were valid.

    too_many_entities

    More than 10 role scopes were passed.

    too_many_users

    More than 10 users were passed.

    failed_for_some_users

    At least one user ID was invalid

    failed_for_some_entities

    At least one role scope ID was invalid

    failed_for_some_users_and_entities

    At least one role scope ID was invalid

    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.

    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.

    token_revoked

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

    token_expired

    Authentication token has expired

    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.

    not_allowed_token_type

    The token type used in this request is not allowed.

    method_deprecated

    The method has been deprecated.

    deprecated_endpoint

    The endpoint has been deprecated.

    two_factor_setup_required

    Two factor setup is required.

    enterprise_is_restricted

    The method cannot be called from an Enterprise.

    is_bot

    This method cannot be called by a bot user.

    invalid_arguments

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

    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.

    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.

    ratelimited

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

    accesslimited

    Access to this method is limited on the current network

    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

    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.

    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.

    Arguments

    Need a token? Create and install a Slack app to begin.
    This will make a real API request. Beware of using it with live workspaces.

    API response


    Submit your arguments to see the API response

    Was this page helpful?