Adds members to the specified role with the specified scopes

Required Params

• entity_ids - List of the entity IDs for which roles will be assigned. These can be Org IDs, Team IDs or Channel IDs ex: ['T00000001', 'E00000002']
• role_id - ID of the role to which users will be assigned ex: R0001
• user_ids - List of IDs from the users to be added to the given role ex: ['U00000001', 'U00000002', 'U00000003']

Errors the API can return:

• token_revoked - Authentication token is for a deleted user or workspace or the app has been removed when using a user token.
• 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.
• two_factor_setup_required - Two factor setup is required.
• feature_not_enabled - This API is currently not enabled.
• 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.
• no_valid_entities - None of the entities passed were valid.
• 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.
• deprecated_endpoint - The endpoint has been deprecated.
• ratelimited - The request has been ratelimited. Refer to the Retry-After header for when to retry the request.
• ekm_access_denied - Administrators have suspended the ability to post a message.
• service_unavailable - The service is temporarily unavailable
• team_access_not_granted - The token used is not granted the specific workspace access required to complete this request.
• cannot_modify_role_admin - The user does not have permission to modify the admin role.
• invalid_actor - This API is only enabled for the Admins/Owners.
• invalid_arguments - The method was called with invalid arguments.
• invalid_array_arg - The method was passed an array as an argument. Please only input valid strings.
• request_timeout - The method was called via a POST request, but the POST data was either missing or truncated.
• account_inactive - Authentication token is for a deleted user or workspace when using a bot token.
• not_authed - No authentication token provided.
• 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.
• enterprise_is_restricted - The method cannot be called from an Enterprise.
• 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.
• access_denied - Access to a resource specified in the request is denied.
• 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.
• missing_scope - The token used is not granted the specific scope permissions required to complete this request.
• 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.
• accesslimited - Access to this method is limited on the current network
• too_many_entities - More than 10 role scopes were passed.
• token_expired - Authentication token has expired
• 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.
• failed_for_some_users_and_entities - At least one role scope ID was invalid
• failed_for_some_entities - At least one role scope ID was invalid
• method_deprecated - The method has been deprecated.
• no_valid_users - None of the users passed were valid.
• not_allowed_token_type - The token type used in this request is not allowed.
• org_login_required - The workspace is undergoing an enterprise migration and will not be available until migration is complete.
• too_many_users - More than 10 users were passed.
• 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.
• invalid_role_id - The role type passed does not exist.
• failed_for_some_users - At least one user ID was invalid

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

Optional Params

• cursor - Set cursor to next_cursor returned by the previous call to list items in the next page. Search for specific roles by providing the optional role_ids argument, and feel free to bring your own pagination with limit and cursor. ex: 5c3e53d5
• entity_ids - The entities for which the roles apply ex: ['T12345', 'C12345']
• limit - The maximum number of items to return. Must be between 1 - 200 both inclusive. Search for specific roles by providing the optional role_ids argument, and feel free to bring your own pagination with limit and cursor. ex: 50
• role_ids - collection of role ids to scope results by. Search for specific roles by providing the optional role_ids argument, and feel free to bring your own pagination with limit and cursor. ex: ['Rl01', 'Rl0A']
• sort_dir - Sort direction. Default is descending on date_create, can be either ASC or DESC ex: DESC

Errors the API can return:

• invalid_cursor - The passed cursor was invalid.
• token_revoked - Authentication token is for a deleted user or workspace or the app has been removed when using a user token.
• 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.
• two_factor_setup_required - Two factor setup is required.
• feature_not_enabled - This API is currently not enabled.
• 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.
• 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.
• deprecated_endpoint - The endpoint has been deprecated.
• ratelimited - The request has been ratelimited. Refer to the Retry-After header for when to retry the request.
• ekm_access_denied - Administrators have suspended the ability to post a message.
• service_unavailable - The service is temporarily unavailable
• team_access_not_granted - The token used is not granted the specific workspace access required to complete this request.
• invalid_actor - This API is only enabled for the Admins/Owners.
• invalid_arguments - Required arguments either were not provided or contain invalid values.
• invalid_sort - Sort parameters are invalid.
• invalid_array_arg - The method was passed an array as an argument. Please only input valid strings.
• request_timeout - The method was called via a POST request, but the POST data was either missing or truncated.
• account_inactive - Authentication token is for a deleted user or workspace when using a bot token.
• not_authed - No authentication token provided.
• 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.
• enterprise_is_restricted - The method cannot be called from an Enterprise.
• 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.
• access_denied - Access to a resource specified in the request is denied.
• 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.
• missing_scope - The token used is not granted the specific scope permissions required to complete this request.
• 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.
• accesslimited - Access to this method is limited on the current network
• token_expired - Authentication token has expired
• 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.
• method_deprecated - The method has been deprecated.
• not_allowed_token_type - The token type used in this request is not allowed.
• org_login_required - The workspace is undergoing an enterprise migration and will not be available until migration is complete.
• 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.
• invalid_role_id - One or more role IDs could not be validated.

Removes a set of users from a role for the given scopes and entities

Required Params

• entity_ids - List of the entity IDs for which roles will be revoked. These can be Org IDs, Team IDs or Channel IDs ex: ['T00000001', 'E00000002']
• role_id - ID of the role to which users will be assigned ex: R0001
• user_ids - List of IDs of the users whose roles will be revoked ex: ['U00000001', 'U00000002', 'U00000003']

Errors the API can return:

• token_revoked - Authentication token is for a deleted user or workspace or the app has been removed when using a user token.
• 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.
• two_factor_setup_required - Two factor setup is required.
• feature_not_enabled - This API is currently not enabled.
• 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.
• no_valid_entities - None of the entities passed were valid.
• 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.
• deprecated_endpoint - The endpoint has been deprecated.
• ratelimited - The request has been ratelimited. Refer to the Retry-After header for when to retry the request.
• ekm_access_denied - Administrators have suspended the ability to post a message.
• service_unavailable - The service is temporarily unavailable
• team_access_not_granted - The token used is not granted the specific workspace access required to complete this request.
• cannot_modify_role_admin - Cannot modify role admin.
• invalid_actor - This API is only enabled for the Admins/Owners.
• invalid_arguments - The method was called with invalid arguments.
• invalid_array_arg - The method was passed an array as an argument. Please only input valid strings.
• request_timeout - The method was called via a POST request, but the POST data was either missing or truncated.
• account_inactive - Authentication token is for a deleted user or workspace when using a bot token.
• not_authed - No authentication token provided.
• 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.
• enterprise_is_restricted - The method cannot be called from an Enterprise.
• 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.
• access_denied - Access to a resource specified in the request is denied.
• 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.
• missing_scope - The token used is not granted the specific scope permissions required to complete this request.
• 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.
• accesslimited - Access to this method is limited on the current network
• too_many_entities - More than 10 role scopes were passed.
• token_expired - Authentication token has expired
• 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.
• failed_for_some_users_and_entities - At least one role scope ID was invalid
• failed_for_some_entities - At least one role scope ID was invalid
• method_deprecated - The method has been deprecated.
• no_valid_users - None of the users passed were valid.
• not_allowed_token_type - The token type used in this request is not allowed.
• org_login_required - The workspace is undergoing an enterprise migration and will not be available until migration is complete.
• too_many_users - More than 10 users were passed.
• 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.
• invalid_role_id - The role type passed does not exist.
• failed_for_some_users - At least one user ID was invalid