Update an existing Information Barrier
This API method can only be used on Enterprise Grid workspaces.
GEThttps://slack.com/api/admin.barriers.update
application/x-www-form-urlencoded
token
Authentication token bearing required scopes. Tokens should be passed as an HTTP Authorization header or alternatively, as a POST parameter.
xxxx-xxxxxxxxx-xxxx
A list of IDP Groups ids that the primary usergroup is to be barriered from.
The id of the primary IDP Group
This Admin API method updates an existing information barrier. Similar to admin.barriers.create
it has a unique required arguement called restricted_subjects
that allows you to block interaction between barriers. Currently you must pass all three im,mpim,call
.
The response includes enterprise ID
, barrier ID
{
"ok": true,
"barrier": {
"id": "Ba03T70KB2H3",
"enterprise_id": "E03055H6DAS",
"primary_usergroup": {
"id": "S03TZK4A9H6",
"name": "Company That Pays Contracting Teams"
},
"barriered_from_usergroups": [
{
"id": "S03TNHGAUGZ",
"name": "Another External Contracting Team"
}
],
"restricted_subjects": [
"im",
"mpim",
"call"
],
"date_update": 1660224825
}
}
Typical error response if you do not have information barrier enabled. Reach out to your CSM.
{
"ok": false,
"error": "feature_not_enabled"
}
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 |
---|---|
barrier_already_exists | There already exists another barrier restricting activity between two or more of your requested usergroups. |
barrier_not_found | The barrier you're trying to update cannot be found. |
barriered_from_usergroups_not_found | One or more of the ids passed in for barriered_from_usergroup_ids can’t be found. |
feature_not_enabled | The information barrier feature is not enabled, please reach out to your CSM. |
invalid_restricted_subjects | The restricted subjects provided are invalid or not currently supported. |
not_an_admin | The token provided is not associated with an org admin. |
primary_usergroup_not_found | The id passed in for primary_usergroup_id can’t be found. |
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 |
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 |
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 |
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 |
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 |
ratelimited | The request has been ratelimited. Refer to the |
request_timeout | The method was called via a |
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. |
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 |